agency-invoicing

POST `/v1/agency-invoicing/preview`

Total a set of lines without saving anything.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão agency.invoicing.view; uma chave sem ela é recusada com 403, e não 404.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`Uuid`	Não	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…

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`lines`	`AgencyInvoiceLineWrite[]`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`line_totals_minor`	`integer[]`	Não	—
`subtotal_minor`	`integer`	Sim	—
`discount_minor`	`integer`	Não	—
`tax_minor`	`integer`	Sim	—
`total_minor`	`integer`	Sim	—
`tax_groups`	`AgencyInvoiceTaxGroup[]`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429