get
https://api.operand.app/beta/entity/clients/
Retorna um Cliente passado como parâmetro
| Field | Type | Field Name corresponding | Description |
|---|---|---|---|
| actualSituation | Enum | Situação | Retorna a situação do cadastro. |
| address | String | Logradouro | Retorna o logradouro do cadastro. |
| addressComplement | String | Complemento | Retorna o complemento de endereço do cadastro. |
| addressNumber | String | Número do logradouro | Retorno o número do logradouro do cadastro. |
| briefing | String | Resumo | Retorna o resumo do cadastro |
| cep | String | CEP | Retorna o CEP. |
| city | String | Cidade | Retorna a cidade. |
| cityState | String | Cidade e UF | Retorna o nome da cidade e a UF |
| company | Tinyint | Validação PJ | Retorna se o cadastro é de do tipo PJ. |
| contacts | Json | Informações de contato | "Retorna as informações de iContact, sContact, sEmail, sPhone." |
| iContact | Integer | ID do contato | Retorna o ID do contato. |
| sContact | String | Nome do contato | Retorna o nome do contato. |
| sEmail | String | Retorna o e-mail do contato | |
| sPhone | String | Telefone 1 | Retorna o primeiro número do telefone do cadastro. |
| district | String | Bairro | Retorna o bairro. |
| String | Retorna o e-mail. | ||
| firstContact | String | Nome do primeiro contato | Retorna o nome do primeiro contato. |
| idClient | Integer | ID do cliente | Retorna o ID do cliente. |
| lateJobs | Integer | Jobs em atraso | Retorna a quantidade de jobs em atraso para o cliente |
| locality | Json | Informações do endereço | "Retorna um json com as informações: sCep, sAddress, sAddressNumber, sAddressComplement, sDistrict, sState, iState, sCity, iCity, iIBGE, sCountry." |
| sCep | String | CEP | Retorna o CEP. |
| sAddress | String | Logradouro | Retorna o logradouro do cadastro. |
| sAddressNumber | String | Número do logradouro | Retorno o número do logradouro do cadastro. |
| sAddressComplement | String | Complemento | Retorna o complemento de endereço do cadastro. |
| sDistrict | String | Bairro | Retorna o bairro. |
| sState | String | UF | Retorna a Unidade Federativa (UF). |
| iState | String | UF | Retorna a Unidade Federativa (UF). |
| sCity | String | Cidade (Estado) | Retorna a cidade e a Unidade Federativa (UF). |
| iCity | Integer | Código da cidade | Retorna o código da cidade |
| iIBGE | Integer | Código da cidade no IBGE | Retorno o código da cidade no cadastro do IBGE |
| sCountry | String | País | Retorna o país. |
| nationalDocument | String | CPF ou CNPJ | Retorna o valor do campo CPF ou CNPJ |
| person | String | Nome Fantasia | Retorna o nome fantasia do cadastro. |
| phone | String | Telefone 1 | Retorna o número do telefone do cadastro. |
| phone2 | String | Telefone 2 | Retorna o número do telefone do cadastro. |
| state | String | UF | Retorna a Unidade Federativa (UF). |
| totalJobs | Integer | Total de jobs do cliente | Retorna a quantidade de jobs cadastrados para o cliente. |
| typeNationalDocument | String | Tipo de documento | Retorna se o documento é um CPF ou um CNPJ. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…