Clientes

Cadastrar cliente

Adicione clientes na plataforma para vincular às suas cobranças. Mantenha um registro centralizado com dados completos de contato e endereço.

Endpoint

POST

/invoices/applications/customers

Content-Type: application/json
Authorization: Basic {token}

Headers

Campos da requisição

Envie no body da requisição um JSON com os campos abaixo. Apenas fullName é obrigatório — todos os outros são opcionais.

Campo	Tipo	Obrigatório	Descrição
fullName	string	Obrigatório	Nome completo do cliente. Mínimo de 3 caracteres.
document	string	Opcional	CPF ou CNPJ do cliente. Aceita 11 dígitos (CPF) ou 14 dígitos (CNPJ).
business	string	Opcional	Razão social ou nome da empresa do cliente.
email	email	Opcional	Endereço de e-mail válido do cliente.
phone	string	Opcional	Telefone do cliente, incluindo DDI e DDD.
observations	string	Opcional	Observações ou notas internas sobre o cliente.
address	object	Opcional	Endereço completo do cliente. Quando preenchido, aceita os campos descritos abaixo.

Campos do endereço

O campo address aceita um objeto com os campos abaixo, todos opcionais:

Campo	Tipo	Obrigatório	Descrição
address	string	Opcional	Logradouro (rua, avenida, etc.).
number	string	Opcional	Número do endereço.
complement	string	Opcional	Complemento (apartamento, sala, bloco, etc.).
neighborhood	string	Opcional	Bairro.
city	string	Opcional	Cidade.
state	string	Opcional	UF do estado (ex: SP, RJ, MG).
zipcode	string	Opcional	CEP do endereço.

Exemplo de requisição

Exemplo completo com todos os campos preenchidos. Substitua $TOKEN pelo seu token Base64 (veja a seção Autenticação):

curl -X POST https://api.az.center/invoices/applications/customers \
  -H "Authorization: Basic $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "Maria da Silva",
    "document": "000.000.000-00",
    "business": "Empresa Exemplo LTDA",
    "email": "[email protected]",
    "phone": "+5521979807478",
    "observations": "Cliente preferencial, vencimento sempre no dia 10",
    "address": {
      "address": "Rua das Flores",
      "number": "123",
      "complement": "Sala 4B",
      "neighborhood": "Centro",
      "city": "Rio de Janeiro",
      "state": "RJ",
      "zipcode": "20000-000"
    }
  }'

cURL

Respostas

200 OK

Cliente criado com sucesso

Retorna o objeto do cliente recém-criado, com os campos enviados acrescidos dos identificadores gerados pelo sistema: id, userId, applicationId, createdAt e deletedAt. O endereço também recebe seu próprio id.

{
  "business": "Empresa Exemplo LTDA",
  "document": "000.000.000-00",
  "email": "[email protected]",
  "fullName": "Maria da Silva",
  "phone": "+5521979807478",
  "observations": "Cliente preferencial, vencimento sempre no dia 10",
  "userId": "00000000-0000-0000-0000-000000000001",
  "applicationId": "00000000-0000-0000-0000-000000000002",
  "address": {
    "address": "Rua das Flores",
    "city": "Rio de Janeiro",
    "complement": "Sala 4B",
    "neighborhood": "Centro",
    "number": "123",
    "state": "RJ",
    "zipcode": "20000-000",
    "id": "00000000-0000-0000-0000-000000000003"
  },
  "id": "00000000-0000-0000-0000-000000000004",
  "createdAt": "2026-05-28T20:00:35.000Z",
  "deletedAt": null
}

JSON

Erro

Formato de resposta de erro

Em caso de erro, a API retorna sempre o mesmo envelope: code com o status HTTP, message com a descrição geral, e errors mapeando cada campo problemático para um array de mensagens — útil para exibir feedback direto embaixo de cada input no seu formulário.

{
  "code": <código HTTP>,
  "message": "<descrição do erro>",
  "errors": {
    "<campo>": ["<mensagem>"]
  }
}

Formato

Autenticação Detalhe do cliente