agency-invoicing

PATCH `/v1/agency-invoicing/tax-rates/{rateId}`

Change a tax rate.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão agency.invoicing.manage; 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 PATCH https://api.zinndigital.com/v1/agency-invoicing/tax-rates/{rateId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⭐ Changing a rate does NOT restate any invoice that already carries it — the percentage and the name are copied onto each line when it is saved. That is what lets you move VAT from 20% to 17.5% next April without rewriting last month. Requires `agency.invoicing.manage`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`rateId (path)`	`Uuid`	Sim	—
`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 é
`name`	`string`	Não	—
`rate_bps`	`integer`	Não	—
`registration_number`	`string`	Não	—
`note`	`string`	Não	—
`is_default`	`boolean`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Sim	What the document calls it. ⛔ Free text, not an enum: the line must read "VAT", "MwSt.", "TVA" or "Sales tax" depending on who is being invoiced.
`rate_bps`	`integer`	Sim	—
`registration_number`	`string`	Não	—
`note`	`string`	Não	—
`is_default`	`boolean`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429