reseller

PUT /v1/reseller/brand/invoice

Set how your invoices read.

All reseller endpoints

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage 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 PUT https://api.zinndigital.com/v1/reseller/brand/invoice \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Requires `reseller.manage`. ⭐ These are printed on **your** invoices, under your company, your VAT number and your number series — so the payment details are yours. Your clients are charged on your own payment gateway and you are the merchant of record for them. ⛔ **Changing these does not change invoices already issued**, and must not: every value is frozen onto each document when it is raised. Restating where last month's invoice was payable would be a different demand for money under the same number. Refused with 422 when your clients are still invoiced under Zinn Digital®.

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…

Request body

NameTypeRequiredWhat it is
footer_textstringNoSmall print at the foot of the document — typically your registered company name and number.
payment_termsstringNoWhen and how you expect to be paid.
payment_detailsstringNoRemittance details — account name, IBAN, BIC, a payment link. Line breaks are preserved exactly as you type them.
support_contactstringNoWhere your client asks about this invoice.

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 · 422 · 429