계약 부분 수정
curl --request PATCH \
--url https://openapi.pluuug.com/v1/contract/{contract_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Signature: <api-key>' \
--data '
{
"contractNumber": "<string>",
"title": "<string>",
"amount": 1,
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": {
"id": 123
},
"client": {
"id": 123
},
"categorySet": [
{
"id": 123
}
],
"fieldSet": [
{
"field": {
"id": 123
},
"value": "<string>"
}
]
}
'import requests
url = "https://openapi.pluuug.com/v1/contract/{contract_id}"
payload = {
"contractNumber": "<string>",
"title": "<string>",
"amount": 1,
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": { "id": 123 },
"client": { "id": 123 },
"categorySet": [{ "id": 123 }],
"fieldSet": [
{
"field": { "id": 123 },
"value": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"X-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-Key': '<api-key>',
'X-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contractNumber: '<string>',
title: '<string>',
amount: 1,
startDate: '2023-12-25',
endDate: '2023-12-25',
vatType: 'E',
settlementFrequency: 1,
settlementCycle: 'M',
settlementDay: 1,
inquiry: {id: 123},
client: {id: 123},
categorySet: [{id: 123}],
fieldSet: [{field: {id: 123}, value: '<string>'}]
})
};
fetch('https://openapi.pluuug.com/v1/contract/{contract_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.pluuug.com/v1/contract/{contract_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'contractNumber' => '<string>',
'title' => '<string>',
'amount' => 1,
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'vatType' => 'E',
'settlementFrequency' => 1,
'settlementCycle' => 'M',
'settlementDay' => 1,
'inquiry' => [
'id' => 123
],
'client' => [
'id' => 123
],
'categorySet' => [
[
'id' => 123
]
],
'fieldSet' => [
[
'field' => [
'id' => 123
],
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Signature: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openapi.pluuug.com/v1/contract/{contract_id}"
payload := strings.NewReader("{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://openapi.pluuug.com/v1/contract/{contract_id}")
.header("X-API-Key", "<api-key>")
.header("X-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.pluuug.com/v1/contract/{contract_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"title": "<string>",
"amount": 1,
"created": "2023-11-07T05:31:56Z",
"contractNumber": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": {
"id": 123,
"uniqueId": "<string>",
"status": {
"id": 123,
"title": "<string>",
"folder": {
"id": 123,
"name": "<string>"
}
},
"name": "<string>",
"estimate": "<string>",
"inquiryDate": "2023-12-25"
},
"client": {
"id": 123,
"status": {
"id": 123,
"title": "<string>"
},
"companyName": "<string>",
"inCharge": "<string>",
"position": "<string>",
"contact": "<string>",
"email": "jsmith@example.com"
},
"categorySet": [
{
"id": 123,
"title": "<string>"
}
],
"fieldSet": [
{
"field": {
"id": 123,
"name": "<string>",
"optionSet": [
{
"id": "<string>",
"title": "<string>"
}
],
"memberSet": [
{
"id": 123,
"nickname": "<string>",
"email": "<string>",
"isActive": true,
"grade": {
"id": 123,
"title": "<string>"
}
}
]
},
"value": "<string>"
}
]
}{
"nonField": [
"<string>"
],
"contractNumber": [
"<string>"
],
"title": [
"<string>"
],
"amount": [
"<string>"
],
"type": [
"<string>"
],
"startDate": [
"<string>"
],
"endDate": [
"<string>"
],
"vatType": [
"<string>"
],
"settlementFrequency": [
"<string>"
],
"settlementCycle": [
"<string>"
],
"settlementDay": [
"<string>"
],
"inquiry": {
"id": [
"<string>"
]
},
"client": {
"id": [
"<string>"
]
},
"categorySet": [
"<string>"
],
"fieldSet": [
"<string>"
]
}계약
계약 부분 수정
계약 정보를 부분 수정합니다. inquiry 변경 시 의뢰 ↔ 계약 1:1 관계가 재설정되며, 기존 연결된 의뢰는 자동으로 해제됩니다. category_set은 전체 재설정 방식.
PATCH
/
v1
/
contract
/
{contract_id}
계약 부분 수정
curl --request PATCH \
--url https://openapi.pluuug.com/v1/contract/{contract_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'X-Signature: <api-key>' \
--data '
{
"contractNumber": "<string>",
"title": "<string>",
"amount": 1,
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": {
"id": 123
},
"client": {
"id": 123
},
"categorySet": [
{
"id": 123
}
],
"fieldSet": [
{
"field": {
"id": 123
},
"value": "<string>"
}
]
}
'import requests
url = "https://openapi.pluuug.com/v1/contract/{contract_id}"
payload = {
"contractNumber": "<string>",
"title": "<string>",
"amount": 1,
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": { "id": 123 },
"client": { "id": 123 },
"categorySet": [{ "id": 123 }],
"fieldSet": [
{
"field": { "id": 123 },
"value": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"X-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'X-API-Key': '<api-key>',
'X-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
contractNumber: '<string>',
title: '<string>',
amount: 1,
startDate: '2023-12-25',
endDate: '2023-12-25',
vatType: 'E',
settlementFrequency: 1,
settlementCycle: 'M',
settlementDay: 1,
inquiry: {id: 123},
client: {id: 123},
categorySet: [{id: 123}],
fieldSet: [{field: {id: 123}, value: '<string>'}]
})
};
fetch('https://openapi.pluuug.com/v1/contract/{contract_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.pluuug.com/v1/contract/{contract_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'contractNumber' => '<string>',
'title' => '<string>',
'amount' => 1,
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'vatType' => 'E',
'settlementFrequency' => 1,
'settlementCycle' => 'M',
'settlementDay' => 1,
'inquiry' => [
'id' => 123
],
'client' => [
'id' => 123
],
'categorySet' => [
[
'id' => 123
]
],
'fieldSet' => [
[
'field' => [
'id' => 123
],
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"X-Signature: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openapi.pluuug.com/v1/contract/{contract_id}"
payload := strings.NewReader("{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("X-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://openapi.pluuug.com/v1/contract/{contract_id}")
.header("X-API-Key", "<api-key>")
.header("X-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.pluuug.com/v1/contract/{contract_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contractNumber\": \"<string>\",\n \"title\": \"<string>\",\n \"amount\": 1,\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"vatType\": \"E\",\n \"settlementFrequency\": 1,\n \"settlementCycle\": \"M\",\n \"settlementDay\": 1,\n \"inquiry\": {\n \"id\": 123\n },\n \"client\": {\n \"id\": 123\n },\n \"categorySet\": [\n {\n \"id\": 123\n }\n ],\n \"fieldSet\": [\n {\n \"field\": {\n \"id\": 123\n },\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"title": "<string>",
"amount": 1,
"created": "2023-11-07T05:31:56Z",
"contractNumber": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"vatType": "E",
"settlementFrequency": 1,
"settlementCycle": "M",
"settlementDay": 1,
"inquiry": {
"id": 123,
"uniqueId": "<string>",
"status": {
"id": 123,
"title": "<string>",
"folder": {
"id": 123,
"name": "<string>"
}
},
"name": "<string>",
"estimate": "<string>",
"inquiryDate": "2023-12-25"
},
"client": {
"id": 123,
"status": {
"id": 123,
"title": "<string>"
},
"companyName": "<string>",
"inCharge": "<string>",
"position": "<string>",
"contact": "<string>",
"email": "jsmith@example.com"
},
"categorySet": [
{
"id": 123,
"title": "<string>"
}
],
"fieldSet": [
{
"field": {
"id": 123,
"name": "<string>",
"optionSet": [
{
"id": "<string>",
"title": "<string>"
}
],
"memberSet": [
{
"id": 123,
"nickname": "<string>",
"email": "<string>",
"isActive": true,
"grade": {
"id": 123,
"title": "<string>"
}
}
]
},
"value": "<string>"
}
]
}{
"nonField": [
"<string>"
],
"contractNumber": [
"<string>"
],
"title": [
"<string>"
],
"amount": [
"<string>"
],
"type": [
"<string>"
],
"startDate": [
"<string>"
],
"endDate": [
"<string>"
],
"vatType": [
"<string>"
],
"settlementFrequency": [
"<string>"
],
"settlementCycle": [
"<string>"
],
"settlementDay": [
"<string>"
],
"inquiry": {
"id": [
"<string>"
]
},
"client": {
"id": [
"<string>"
]
},
"categorySet": [
"<string>"
],
"fieldSet": [
"<string>"
]
}Authorizations
HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다. 서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
계약 번호
Required string length:
1 - 128계약 제목
Required string length:
1 - 128계약 금액
Required range:
x >= 0계약 타입
I- 회차 정산형S- 정기 결제형G- 단건 정산
Available options:
I, S, G 계약 착수일
계약 종료일
부가세 타입
E- 부가세 별도I- 부가세 포함N- 부가세 없음
Available options:
E, I, N 결제 주기 빈도(정기 결제형 계약에서만 사용)
Required range:
x >= 1결제 주기(정기 결제형 계약에서만 사용)
W- 주M- 개월
Available options:
W, M 결제일 (정기 결제형 계약에서만 사용)
주 단위 계약일 경우, 요일에 해당하는 숫자를 입력하세요:
- 일요일:
0 - 월요일:
1 - 화요일:
2 - 수요일:
3 - 목요일:
4 - 금요일:
5 - 토요일:
6
월 단위 계약일 경우, 1일부터 30일 중 원하는 날짜를 숫자로 입력하세요:
- 예: 매월 10일 결제 →
10 - 최소값:
1, 최대값:30
⚠️ * 주의: 월 단위에서 31일은 허용되지 않습니다.*
Required range:
0 <= x <= 30의뢰
Show child attributes
Show child attributes
고객
Show child attributes
Show child attributes
카테고리
Show child attributes
Show child attributes
커스텀 필드
Show child attributes
Show child attributes
Response
계약 제목
Maximum string length:
128계약 금액
Required range:
x >= 0계약 타입
I- 회차 정산형S- 정기 결제형G- 단건 정산
Available options:
I, S, G 계약 상태
P- 계약 준비 중I- 정산 진행 중C- 계약 종료T- 계약 중단
Available options:
P, I, C, T 생성일시
계약 번호
Maximum string length:
128계약 착수일
계약 종료일
부가세 타입
E- 부가세 별도I- 부가세 포함N- 부가세 없음
Available options:
E, I, N 결제 주기 빈도(정기 결제형 계약에서만 사용)
Required range:
x >= 1결제 주기(정기 결제형 계약에서만 사용)
W- 주M- 개월
Available options:
W, M 결제일 (정기 결제형 계약에서만 사용)
주 단위 계약일 경우, 요일에 해당하는 숫자를 입력하세요:
- 일요일:
0 - 월요일:
1 - 화요일:
2 - 수요일:
3 - 목요일:
4 - 금요일:
5 - 토요일:
6
월 단위 계약일 경우, 1일부터 30일 중 원하는 날짜를 숫자로 입력하세요:
- 예: 매월 10일 결제 →
10 - 최소값:
1, 최대값:30
⚠️ * 주의: 월 단위에서 31일은 허용되지 않습니다.*
Required range:
0 <= x <= 30의뢰
Show child attributes
Show child attributes
고객
Show child attributes
Show child attributes
카테고리
Show child attributes
Show child attributes
커스텀 필드
Show child attributes
Show child attributes
⌘I