reseller

GET /v1/reseller/brand/invoice

How your invoices read.

All reseller endpoints

Authentication

Send an API key as a bearer token. The key must carry the reseller.view permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

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/reseller/brand/invoice \
  -H "Authorization: Bearer zdk_live_…"

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

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.

Parameters

NameTypeRequiredWhat it is
org_id (query)UuidNoThe 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…

Response

NameTypeRequiredWhat it is
configuredbooleanYesFalse when your clients are still invoiced under Zinn Digital®, in which case there is nothing here to set.
legal_entity_namestringYesThe company these invoices are issued by.
footer_textstringYes
payment_termsstringYes
payment_detailsstringYes
support_contactstringYes

Errors this endpoint can return

401 · 403 · 429