Skip to main content
GET
/
v1
/
contract
/
{contract_id}
계약 상세
curl --request GET \
  --url https://openapi.pluuug.com/v1/contract/{contract_id}
{
  "id": 123,
  "contractNumber": "<string>",
  "title": "<string>",
  "amount": 123,
  "type": "I",
  "status": "P",
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "vatType": "E",
  "settlementFrequency": 1,
  "settlementCycle": "M",
  "settlementDay": 1,
  "inquiry": {
    "id": 123,
    "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>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Path Parameters

contract_id
integer
required

Response

200 - application/json
id
integer
required
contractNumber
string | null
required

계약 번호

Maximum length: 128
title
string
required

계약 제목

Maximum length: 128
amount
integer
required

계약 금액

type
enum<string>
required

계약 타입

  • I - 회차 정산형
  • S - 정기 결제형
  • G - 단건 정산
Available options:
I,
S,
G
status
enum<string>
required

계약 상태

  • P - 계약 준비 중
  • I - 정산 진행 중
  • C - 계약 종료
  • T - 계약 중단
Available options:
P,
I,
C,
T
startDate
string<date> | null
required

계약 착수일

endDate
string<date> | null
required

계약 종료일

inquiry
object
required

의뢰

client
object
required

고객

categorySet
object[] | null
required

카테고리

vatType
enum<string>
default:E

부가세 타입

  • E - 부가세 별도
  • I - 부가세 포함
  • N - 부가세 없음
Available options:
E,
I,
N
settlementFrequency
integer
default:1

결제 주기 빈도(정기 결제형 계약에서만 사용)

Required range: x >= 1
settlementCycle
enum<string>
default:M

결제 주기(정기 결제형 계약에서만 사용)

  • W - 주
  • M - 개월
Available options:
W,
M
settlementDay
integer
default:1

결제일 (정기 결제형 계약에서만 사용)

주 단위 계약일 경우, 요일에 해당하는 숫자를 입력하세요:

  • 일요일: 0
  • 월요일: 1
  • 화요일: 2
  • 수요일: 3
  • 목요일: 4
  • 금요일: 5
  • 토요일: 6

월 단위 계약일 경우, 1일부터 30일 중 원하는 날짜를 숫자로 입력하세요:

  • 예: 매월 10일 결제 → 10
  • 최소값: 1, 최대값: 30

⚠️ * 주의: 월 단위에서 31일은 허용되지 않습니다.*

Required range: 0 <= x <= 30
I