Clientes

Detalhe do cliente

Recupere os dados completos de um cliente específico pelo ID, incluindo o endereço cadastrado.

Endpoint

GET

/invoices/applications/customers/:id

Authorization: Basic {token}
Headers

Parâmetros de path

Substitua :id na URL pelo identificador único do cliente:

CampoTipoObrigatórioDescrição

id

UUID
Obrigatório

Identificador único do cliente a ser consultado. Retornado no campo id da resposta de cadastro do cliente.

Exemplo de requisição

Exemplo de chamada para buscar um cliente. Substitua $TOKEN pelo seu token Base64 e {{customerId}} pelo id real do cliente:

curl -X GET https://api.az.center/invoices/applications/customers/{{customerId}} \
  -H "Authorization: Basic $TOKEN"
cURL

Respostas

200 OK

Cliente encontrado

Retorna o objeto completo do cliente. O endereço aparece tanto como referência (campo addressId) quanto como objeto aninhado completo (campo address) — não precisa fazer uma segunda chamada pra buscar o endereço.

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

Formato de resposta de erro

Em caso de erro (cliente não encontrado, token inválido, etc.), a API retorna um envelope com code (status HTTP) e message (descrição do erro).

{
  "code": <código HTTP>,
  "message": "<descrição do erro>"
}
Formato
Cadastrar clienteCadastrar cobrança