agency-invoicing

POST `/v1/agency-invoicing/preview`

Total a set of lines without saving anything.

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение agency.invoicing.view; ключ без него отклоняется с кодом 403, а не 404.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/agency-invoicing/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "lines": <AgencyInvoiceLineWrite[]> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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`.

Параметры

Имя	Тип	Обязательно	Что это
`org_id (query)`	`Uuid`	Нет	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…

Тело запроса

Имя	Тип	Обязательно	Что это
`lines`	`AgencyInvoiceLineWrite[]`	Да	—

Ответ

Имя	Тип	Обязательно	Что это
`line_totals_minor`	`integer[]`	Нет	—
`subtotal_minor`	`integer`	Да	—
`discount_minor`	`integer`	Нет	—
`tax_minor`	`integer`	Да	—
`total_minor`	`integer`	Да	—
`tax_groups`	`AgencyInvoiceTaxGroup[]`	Нет	—

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429

POST /v1/agency-invoicing/preview