agency-invoicing

PATCH `/v1/agency-invoicing/profile`

Change your invoicing identity or defaults.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão agency.invoicing.manage; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X PATCH https://api.zinndigital.com/v1/agency-invoicing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`Uuid`	Não	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…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`business_name`	`string`	Não	—
`address`	`string`	Não	—
`email`	`string`	Não	—
`phone`	`string`	Não	—
`website`	`string`	Não	—
`tax_number_label`	`string`	Não	—
`tax_number`	`string`	Não	—
`payment_instructions`	`string`	Não	—
`logo_sha256`	`string`	Não	—
`accent_colour`	`string`	Não	—
`default_currency`	`string`	Não	—
`default_payment_terms_days`	`integer`	Não	—
`default_footer`	`string`	Não	—
`default_notes`	`string`	Não	—
`number_prefix`	`string`	Não	—
`number_padding`	`integer`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`business_name`	`string`	Não	—
`address`	`string`	Não	The registered address, one line per newline. Free-form because address shape is a property of a country, not of our schema.
`email`	`string`	Não	—
`phone`	`string`	Não	—
`website`	`string`	Não	—
`tax_number_label`	`string`	Não	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`	Não	—
`payment_instructions`	`string`	Não	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`	Não	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`	Não	—
`default_currency`	`string`	Sim	—
`default_payment_terms_days`	`integer`	Não	—
`default_footer`	`string`	Não	—
`default_notes`	`string`	Não	—
`number_prefix`	`string`	Sim	—
`number_padding`	`integer`	Não	—
`next_number`	`integer`	Sim	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`	Não	What the next invoice will be called, e.g. `INV-0042`.

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429