agency-invoicing

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

One client, with their whole invoice history.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს agency.invoicing.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ეს ენდპოინტი იყენებს პარამეტრად org_id. მისი გამოტოვების შემთხვევაში ზარი ფარავს თქვენი იჯარის მთელ ქვეხეს, ხოლო გაგზავნისას ზარი შეიზღუდება მხოლოდ ერთ ორგანიზაციამდე.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
  -H "Authorization: Bearer zdk_live_…"

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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}