agency-invoicing
POST /v1/agency-invoicing/logo
Upload the logo your invoices carry.
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 POST https://api.zinndigital.com/v1/agency-invoicing/logo \
-H "Authorization: Bearer zdk_live_…"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
⛔ Its own door, and `POST /v1/branding/logo` cannot serve it: that one stores the mark for a white-labelled **panel**, demands `reseller.manage`, and refuses unless white-label is on the plan — with the message *"a logo here would appear nowhere"*. On a panel that is right. On an invoice it is false: the document is your own paper and carries your mark whatever your plan says. ⭐ The image is vetted and stored content-addressed; the digest returned is what the PDF inlines as a `data:` URI, which is what keeps the render offline. 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
logo_sha256 | string | Sim | The content digest. ⛔ Not a URL — the invoice renderer inlines the bytes as a `data:` URI and follows no external reference at render time. |
width | integer | Não | — |
height | integer | Não | — |
byte_size | integer | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429