Skip to main content
POST
/
v1
/
settlement
정산 생성
curl --request POST \
  --url https://openapi.pluuug.com/v1/settlement \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "amount": 1,
  "additionalAmount": 1,
  "vat": 1,
  "settlementRound": 2,
  "dueDate": "2023-12-25",
  "settledDate": "2023-12-25",
  "isTaxInvoiceIssued": false,
  "isTaxInvoiceNeeded": false,
  "taxInvoiceIssuedDate": "2023-12-25",
  "taxInvoiceIssueDueDate": "2023-12-25",
  "contract": {
    "id": 123
  },
  "type": {
    "id": 123
  },
  "inChargeSet": [
    {
      "id": 123
    }
  ]
}'
{
  "id": 123,
  "title": "<string>",
  "status": "C",
  "amount": 1,
  "additionalAmount": 1,
  "vat": 1,
  "dueDate": "2023-12-25",
  "settledDate": "2023-12-25",
  "typeAlias": "<string>",
  "contract": {
    "id": 123,
    "title": "<string>",
    "amount": 123,
    "type": "I",
    "status": "P",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  }
}

🚫 제한사항

  1. 계약
  • 계약은 시작일과 종료일이 모두 지정되어 있어야 합니다.
  • 중단된 계약에 대해서는 정산을 생성할 수 없습니다.
  1. 정산 형태
  • 다차수 생성을 허용하지 않는 정산 형태는 같은 형태로 여러개 생성할 수 없습니다. (추가 정산, 미수 정산 제외)

Authorizations

X-API-Key
string
header
required

Body

title
string
required

정산 제목

Required string length: 1 - 128
amount
integer
required

정산 금액

Required range: x >= 0
additionalAmount
integer
required

추가 금액

Required range: x >= 0
vat
integer
required

부가세

Required range: x >= 0
contract
object
required

계약

type
object
required

정산 형태

settlementRound
integer

정산 차수

Required range: x >= 1
dueDate
string<date> | null

지급 예정일

settledDate
string<date> | null

지급 완료일

isTaxInvoiceIssued
boolean
default:false

세금 계산서 발행 여부

isTaxInvoiceNeeded
boolean
default:false

세금 계산서 발행 필요 여부

taxInvoiceIssuedDate
string<date> | null

세금 계산서 발행 날짜

taxInvoiceIssueDueDate
string<date> | null

세금 계산서 발행 예정 날짜

inChargeSet
object[] | null

담당자

Response

id
integer
required
title
string
required

정산 제목

Maximum length: 128
status
enum<string>
required

정산 상태

  • C - 정산 예정
  • D - 정산 지연
  • S - 정산 완료
  • P - 정산 중단
Available options:
C,
D,
S,
P
amount
integer
required

정산 금액

Required range: x >= 0
additionalAmount
integer
required

추가 금액

Required range: x >= 0
vat
integer
required

부가세

Required range: x >= 0
typeAlias
string
required

정산 형태

contract
object
required

계약

dueDate
string<date> | null

지급 예정일

settledDate
string<date> | null

지급 완료일

I