agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) agency.invoicing.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 PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⛔ `next_number` is deliberately NOT settable. Rewinding a sequence would mint a duplicate number for a document already in a client's hands; advancing it leaves a gap a tax authority will ask about. Requires `agency.invoicing.manage`.

Paraméterek

Név	Típus	Kötelező	Mi ez
`org_id (query)`	`Uuid`	Nem	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…

Kérés törzse

Név	Típus	Kötelező	Mi ez
`business_name`	`string`	Nem	—
`address`	`string`	Nem	—
`email`	`string`	Nem	—
`phone`	`string`	Nem	—
`website`	`string`	Nem	—
`tax_number_label`	`string`	Nem	—
`tax_number`	`string`	Nem	—
`payment_instructions`	`string`	Nem	—
`logo_sha256`	`string`	Nem	—
`accent_colour`	`string`	Nem	—
`default_currency`	`string`	Nem	—
`default_payment_terms_days`	`integer`	Nem	—
`default_footer`	`string`	Nem	—
`default_notes`	`string`	Nem	—
`number_prefix`	`string`	Nem	—
`number_padding`	`integer`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`business_name`	`string`	Nem	—
`address`	`string`	Nem	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Nem	—
`phone`	`string`	Nem	—
`website`	`string`	Nem	—
`tax_number_label`	`string`	Nem	What the agency calls its tax registration — "VAT number", "ABN", "GSTIN", "EIN". ⛔ Printed only when the number is set too: a label with no number is an empty row, and a number…
`tax_number`	`string`	Nem	—
`payment_instructions`	`string`	Nem	Bank details or a "PayPal me at …" line, printed on the document verbatim and shown on the payment page. ⭐ Never translated — translating a payment instruction is not a safe act.
`logo_sha256`	`string`	Nem	A digest into the content-addressed logo store, never a URL. That is what lets the PDF inline the mark with no network call at render time.
`accent_colour`	`string`	Nem	—
`default_currency`	`string`	Igen	—
`default_payment_terms_days`	`integer`	Nem	—
`default_footer`	`string`	Nem	—
`default_notes`	`string`	Nem	—
`number_prefix`	`string`	Igen	—
`number_padding`	`integer`	Nem	—
`next_number`	`integer`	Igen	The next sequence number. ⛔ Read-only. Rewinding it would mint a duplicate number for a document already in a client's hands.
`next_number_preview`	`string`	Nem	What the next invoice will be called, e.g. `INV-0042`.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429