agency-invoicing

PATCH `/v1/agency-invoicing/clients/{clientId}`

Change a client's details.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

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/clients/{clientId} \
  -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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`clientId (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	—
`contact_name`	`string`	Não	—
`email`	`string`	Não	—
`phone`	`string`	Não	—
`address`	`string`	Não	—
`tax_number_label`	`string`	Não	—
`tax_number`	`string`	Não	—
`currency`	`string`	Não	—
`locale`	`string`	Não	—
`notes`	`string`	Não	—
`archived`	`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	—
`contact_name`	`string`	Não	—
`email`	`string`	Não	—
`phone`	`string`	Não	—
`address`	`string`	Não	—
`tax_number_label`	`string`	Não	—
`tax_number`	`string`	Não	—
`currency`	`string`	Sim	—
`locale`	`string`	Não	Which language this client's invoices and payment page render in. An agency in Berlin invoicing a French client sends a French invoice.
`notes`	`string`	Não	—
`archived`	`boolean`	Não	—
`created_at`	`string`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429