agency-invoicing

POST `/v1/agency-invoicing/preview`

Total a set of lines without saving anything.

Authentication

Send an API key as a bearer token. The key must carry the agency.invoicing.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 POST https://api.zinndigital.com/v1/agency-invoicing/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "lines": <AgencyInvoiceLineWrite[]> }'

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

Backs the live preview in the invoice builder. ⭐ It calls the SAME arithmetic the save path uses — a preview computed by a second implementation is one that can disagree with the invoice, and you would find out after you had sent it. Requires `agency.invoicing.view`.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`Uuid`	No	Which of your organizations is invoicing. Required only when you belong to more than one — otherwise it is inferred from your DIRECT membership, never from the subtree-expanded…

Request body

Name	Type	Required	What it is
`lines`	`AgencyInvoiceLineWrite[]`	Yes	—

Response

Name	Type	Required	What it is
`line_totals_minor`	`integer[]`	No	—
`subtotal_minor`	`integer`	Yes	—
`discount_minor`	`integer`	No	—
`tax_minor`	`integer`	Yes	—
`total_minor`	`integer`	Yes	—
`tax_groups`	`AgencyInvoiceTaxGroup[]`	No	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429