agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 agency.invoicing.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
⭐ Every invoice you have raised against them, what they still owe and what they have been billed in total — the "all client history" screen in one request rather than a filtered list. Requires `agency.invoicing.view`.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
clientId (path) | Uuid | 예 | — |
org_id (query) | Uuid | 아니요 | Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded… |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
id | Uuid | 예 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | 예 | — |
contact_name | string | 아니요 | — |
email | string | 아니요 | — |
phone | string | 아니요 | — |
address | string | 아니요 | — |
tax_number_label | string | 아니요 | — |
tax_number | string | 아니요 | — |
currency | string | 예 | — |
locale | string | 아니요 | Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice. |
notes | string | 아니요 | — |
archived | boolean | 아니요 | — |
created_at | string | 아니요 | — |
invoices | AgencyInvoice[] | 아니요 | — |
outstanding_minor | integer | 아니요 | What this client still owes, in minor units. |
invoiced_total_minor | integer | 아니요 | Everything ever billed to them, void invoices excluded. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404 · 429