agency-invoicing

GET `/v1/agency-invoicing/clients/{clientId}`

One client, with their whole invoice history.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա agency.invoicing.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է 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

GET /v1/agency-invoicing/clients/{clientId}