agency-invoicing
GET /v1/agency-invoicing/portal/{token}
The invoice, for the person paying it. Unauthenticated.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency-invoicing/portal/{token}Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ **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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
token (path) | string | Yes | The capability token from the payment link on the invoice. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
number | string | Yes | — |
status | string | Yes | — |
currency | string | Yes | — |
issue_date | string | No | — |
due_date | string | No | — |
seller | object | No | The issuing agency, frozen at issue. |
buyer | object | No | — |
lines | object[] | No | — |
tax_groups | object[] | No | — |
subtotal | string | No | — |
tax_total | string | No | — |
total | string | Yes | — |
amount_due | string | No | — |
amount_due_minor | integer | Yes | — |
labels | object | No | 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> | No | — |
notes | string | No | — |
offline | object | No | 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… |
Errors this endpoint can return
404 · 429