Endpoint
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| formato | string | obrigatório | Formato do retorno. Use json |
Retorno
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Elemento raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Código de status do processamento |
| retorno.status | string | - | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Código do erro conforme tabela da API (1) |
| retorno.erros | array | - | condicional | Lista de erros ocorridos (1) |
| retorno.conta | object | - | condicional | Informações da conta (2) |
| conta.razao_social | string | 80 | obrigatório | Razão social da empresa |
| conta.cnpj_cpf | string | 20 | obrigatório | CNPJ ou CPF |
| conta.fantasia | string | 60 | opcional | Nome fantasia |
| conta.endereco | string | 60 | opcional | Endereço |
| conta.numero | string | 10 | opcional | Número |
| conta.bairro | string | 30 | opcional | Bairro |
| conta.complemento | string | 60 | opcional | Complemento |
| conta.cidade | string | 30 | opcional | Cidade |
| conta.estado | string | 2 | opcional | UF do estado |
| conta.cep | string | 10 | opcional | CEP |
| conta.fone | string | 40 | opcional | Telefone |
| conta.email | string | 50 | opcional | |
| conta.inscricao_estadual | string | 18 | opcional | Inscrição estadual |
| conta.regime_tributario | string | 56 | opcional | Regime tributário |
(1) Retornado quando status = “Erro” (2) Retornado quando status = “OK”
