Skip to navigation

Detalhar cliente

Consulta o cadastro, os contatos e o resumo comercial de um cliente.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID do cliente.

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data:

CampoTipoDescrição
idintegerID do cliente.
namestringNome.
emailstringE-mail.
phonestringTelefone.
national_idstringDocumento.
sponsorstringContato principal.
addressobjectEndereço.
statusstringSituação do cadastro.
metadataobject ou arrayValores personalizados, conforme configuração.
contactsarray<object>Contatos do cliente.
contacts[].idintegerID para usar em contactId.
contacts[].namestringNome.
contacts[].emailstringE-mail.
contacts[].phonestringTelefone.
contacts[].positionstringCargo.
contacts[].maininteger1 indica contato principal.
contacts[].activeinteger1 indica contato ativo.
{
"data": {
"id": 101,
"name": "Empresa Exemplo",
"sponsor": "Ana Silva",
"email": "contato@example.com",
"phone": "+5511999990000",
"national_id": "11222333000181",
"contacts": [
{
"id": 201,
"name": "Ana Silva",
"email": "ana@example.com",
"phone": "+5511999990000",
"position": "Compras",
"main": 1,
"active": 1
}
],
"budget_count": 1,
"budget_value_total": 1500,
"activity_count": 1
}
}

Erros específicos

HTTPCódigoSituação
404CLIENT_NOT_FOUNDClient not found.

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID do cliente.

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

404
Not Found Error