Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.view; 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 GET https://api.zinndigital.com/v1/reseller/brand/invoice \
-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
The footer, payment terms, remittance details and support contact printed on invoices you issue to your clients. Requires `reseller.view`. ⛔ `configured: false` means your clients are still invoiced under Zinn Digital®, so there is nothing to personalise yet.
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… |
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 · 429