reseller

PUT `/v1/reseller/brand/invoice`

Set how your invoices read.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.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 PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
  -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

Requires `reseller.manage`. ⭐ These are printed on **your** invoices, under your company, your VAT number and your number series — so the payment details are yours. Your clients are charged on your own payment gateway and you are the merchant of record for them. ⛔ **Changing these does not change invoices already issued**, and must not: every value is frozen onto each document when it is raised. Restating where last month's invoice was payable would be a different demand for money under the same number. Refused with 422 when your clients are still invoiced under Zinn Digital®.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`Uuid`	Não	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agen…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`footer_text`	`string`	Não	Small print at the foot of the document — typically your registered company name and number.
`payment_terms`	`string`	Não	When and how you expect to be paid.
`payment_details`	`string`	Não	Remittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them.
`support_contact`	`string`	Não	Where your client asks about this invoice.

Resposta

Nome	Tipo	Obrigatório	O que é
`configured`	`boolean`	Sim	False when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set.
`legal_entity_name`	`string`	Sim	The company these invoices are issued by.
`footer_text`	`string`	Sim	—
`payment_terms`	`string`	Sim	—
`payment_details`	`string`	Sim	—
`support_contact`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 422 · 429