Skip to main content
GET
/
v1
/
settlement
/
{settlement_id}
정산 상세
curl --request GET \
  --url https://openapi.pluuug.com/v1/settlement/{settlement_id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Signature: <api-key>'
{
  "id": 123,
  "title": "<string>",
  "status": "C",
  "amount": 1,
  "additionalAmount": 1,
  "vat": 1,
  "settlementRound": 123,
  "isTaxInvoiceIssued": true,
  "isTaxInvoiceNeeded": true,
  "typeAlias": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "contract": {
    "id": 123,
    "title": "<string>",
    "amount": 123,
    "type": "I",
    "status": "P",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "type": {
    "id": 123,
    "baseType": "INI",
    "category": "I",
    "title": "<string>",
    "allowsMultipleRounds": true
  },
  "dueDate": "2023-12-25",
  "settledDate": "2023-12-25",
  "taxInvoiceIssuedDate": "2023-12-25",
  "taxInvoiceIssueDueDate": "2023-12-25",
  "inChargeSet": [
    {
      "id": 123,
      "nickname": "<string>",
      "email": "<string>",
      "isActive": true,
      "grade": {
        "id": 123,
        "title": "<string>"
      }
    }
  ]
}

Authorizations

X-API-Key
string
header
required
X-Signature
string
header
required

HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다. 서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.

Path Parameters

settlement_id
integer
required

Response

200 - application/json
id
integer
required
title
string
required

정산 제목

Maximum string 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
settlementRound
integer
required

정산 차수

isTaxInvoiceIssued
boolean
required

세금 계산서 발행 여부

isTaxInvoiceNeeded
boolean
required

세금 계산서 발행 필요 여부

typeAlias
string
required

정산 형태

created
string<date-time>
required

생성일시

contract
object
required

계약

type
object
required

정산 형태

dueDate
string<date> | null

지급 예정일

settledDate
string<date> | null

지급 완료일

taxInvoiceIssuedDate
string<date> | null

세금 계산서 발행 날짜

taxInvoiceIssueDueDate
string<date> | null

세금 계산서 발행 예정 날짜

inChargeSet
object[] | null

담당자