billing

PUT `/v1/billing/profile`

Replace the organization's billing profile.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.invoice.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X PUT https://api.zinndigital.com/v1/billing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "billing_address": <BillingAddress> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

A full replace (PUT) of the editable "Bill to" fields; an omitted field resets to blank. billing_address (with its required country, needed for tax) is the one mandatory member. Editing changes only invoices issued afterwards — a past invoice snapshotted the buyer block at issue time and is never rewritten (docs/34 §1.1). vat_status is engine-owned (the validate-not-trust flow, §2.3) and is not accepted here; changing vat_number resets it to unvalidated. Requires billing.invoice.manage in the target organization.

Paraméterek

Név	Típus	Kötelező	Mi ez
`org_id (query)`	`Uuid`	Nem	The organization whose profile to replace; defaults to the caller's own.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`legal_name`	`string`	Nem	—
`company_name`	`string`	Nem	—
`billing_address`	`BillingAddress`	Igen	A billing address. Everything is optional except `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server.
`vat_number`	`string`	Nem	—
`tax_id`	`LabelValue`	Nem	—
`custom_invoice_fields`	`LabelValue[]`	Nem	—
`billing_email`	`string`	Nem	—
`invoice_locale`	`string`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`org_id`	`string`	Igen	—
`legal_name`	`string`	Igen	—
`company_name`	`string`	Igen	—
`billing_address`	`BillingAddress`	Igen	A billing address. Everything is optional except `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server.
`vat_number`	`string`	Igen	—
`vat_status`	`string<unvalidated, pending, valid, invalid>`	Igen	State of the validate-not-trust check on `vat_number` (docs/34 §2.3). Read-only; a change to `vat_number` resets it to `unvalidated`.
`tax_id`	`LabelValue`	Nem	A free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
`custom_invoice_fields`	`LabelValue[]`	Igen	Up to five customer-defined `{label, value}` lines, rendered verbatim.
`billing_email`	`string`	Igen	Where invoices are delivered; blank means the account email.
`invoice_locale`	`string`	Igen	Preferred invoice language; blank means the account language.
`updated_at`	`string`	Nem	When the profile was last saved. Null if it has never been saved.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429