agency-invoicing
PATCH /v1/agency-invoicing/clients/{clientId}
Change a client's details.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/clients/{clientId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
clientId (path) | Uuid | Ano | — |
org_id (query) | Uuid | Ne | 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… |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
name | string | Ne | — |
contact_name | string | Ne | — |
email | string | Ne | — |
phone | string | Ne | — |
address | string | Ne | — |
tax_number_label | string | Ne | — |
tax_number | string | Ne | — |
currency | string | Ne | — |
locale | string | Ne | — |
notes | string | Ne | — |
archived | boolean | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ano | — |
contact_name | string | Ne | — |
email | string | Ne | — |
phone | string | Ne | — |
address | string | Ne | — |
tax_number_label | string | Ne | — |
tax_number | string | Ne | — |
currency | string | Ano | — |
locale | string | Ne | 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 | Ne | — |
archived | boolean | Ne | — |
created_at | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429