agency-invoicing
GET /v1/agency-invoicing/clients/{clientId}
One client, with their whole invoice history.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie agency.invoicing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
⭐ 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`.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
clientId (path) | Uuid | Tak | — |
org_id (query) | Uuid | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Tak | — |
contact_name | string | Nie | — |
email | string | Nie | — |
phone | string | Nie | — |
address | string | Nie | — |
tax_number_label | string | Nie | — |
tax_number | string | Nie | — |
currency | string | Tak | — |
locale | string | Nie | 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 | Nie | — |
archived | boolean | Nie | — |
created_at | string | Nie | — |
invoices | AgencyInvoice[] | Nie | — |
outstanding_minor | integer | Nie | What this client still owes, in minor units. |
invoiced_total_minor | integer | Nie | Everything ever billed to them, void invoices excluded. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429