agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění agency.invoicing.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

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/profile \
  -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

Podrobnosti

⛔ `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`.

Parametry

Název	Typ	Požadováno	Co to je
`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
`business_name`	`string`	Ne	—
`address`	`string`	Ne	—
`email`	`string`	Ne	—
`phone`	`string`	Ne	—
`website`	`string`	Ne	—
`tax_number_label`	`string`	Ne	—
`tax_number`	`string`	Ne	—
`payment_instructions`	`string`	Ne	—
`logo_sha256`	`string`	Ne	—
`accent_colour`	`string`	Ne	—
`default_currency`	`string`	Ne	—
`default_payment_terms_days`	`integer`	Ne	—
`default_footer`	`string`	Ne	—
`default_notes`	`string`	Ne	—
`number_prefix`	`string`	Ne	—
`number_padding`	`integer`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`business_name`	`string`	Ne	—
`address`	`string`	Ne	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Ne	—
`phone`	`string`	Ne	—
`website`	`string`	Ne	—
`tax_number_label`	`string`	Ne	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`	Ne	—
`payment_instructions`	`string`	Ne	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`	Ne	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`	Ne	—
`default_currency`	`string`	Ano	—
`default_payment_terms_days`	`integer`	Ne	—
`default_footer`	`string`	Ne	—
`default_notes`	`string`	Ne	—
`number_prefix`	`string`	Ano	—
`number_padding`	`integer`	Ne	—
`next_number`	`integer`	Ano	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`	Ne	What the next invoice will be called, e.g. `INV-0042`.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429