agency-invoicing
GET /v1/agency-invoicing/portal/{token}
The invoice, for the person paying it. Unauthenticated.
Autenticação
Este endpoint é público. Ele não requer credenciais nem organização — é o que nosso próprio site de marketing e os mecanismos de resposta de IA leem.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
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/agency-invoicing/portal/{token}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
⛔ **No authentication.** The payer is the agency's client and has no account here; the token in the URL is the whole authorisation and reaches exactly one invoice. A revoked, void or draft link answers `404`, the same as a wrong token — telling them apart would confirm to a stranger that a token is real.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
token (path) | string | Sim | The capability token from the payment link on the invoice. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
number | string | Sim | — |
status | string | Sim | — |
currency | string | Sim | — |
issue_date | string | Não | — |
due_date | string | Não | — |
seller | object | Não | The issuing agency, frozen at issue. |
buyer | object | Não | — |
lines | object[] | Não | — |
tax_groups | object[] | Não | — |
subtotal | string | Não | — |
tax_total | string | Não | — |
total | string | Sim | — |
amount_due | string | Não | — |
amount_due_minor | integer | Sim | — |
labels | object | Não | Every label on the page, already in the client's language. ⛔ Served from the platform's translation catalogue rather than a gettext call: this engine has no `.po` files, so `get… |
direction | string<ltr, rtl> | Não | — |
notes | string | Não | — |
offline | object | Não | How to pay when the agency has connected no gateway — their own written payment instructions and contact address, frozen onto the document. ⭐ A payment page that offered nothing… |
Erros que este endpoint pode retornar
404 · 429