Requisição
URL: https://api.erpeasy.compels.net/negociante
Method: GET
Os argumentos são:
| Nome | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| buscaEspecifica | L | 1-1 | Valor lógico que define se a busca será exata ou contendo os filtros informados. | |
| codigo | A | 0-1 | Código do negociante. | |
| nome | A | 0-1 | Nome do negociante. | |
| cpfCnpj | A | 0-1 | CPF/CNPJ do negociante. | |
| cep | A | 0-1 | CEP do negociante. | |
| municipio | A | 0-1 | Município do negociante. | |
| uf | A | 0-1 | UF do negociante. | |
| pais | A | 0-1 | Pais do negociante. | |
| dataCadastroAlteracao | D | 0-1 | Data do Cadastro/Última Alteração no formato AAAA-MM-DD | |
| lastInsertedID | N | 0-1 | Ultimo Identificador (ID). Se informado a busca irá retornar apenas os registro com o ID maior que o valor informado. | |
| offset | N | 0-1 | Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0. | |
| limit | N | 0-1 | Número que identifica a quantidade de registros a consulta retornará, caso não informado o padrão será 50 (valor máximo). | |
Exemplo de endpoint com argumentos:
https://api.erpeasy.compels.net/negociante?offset=0&limit=50
Resposta
A resposta será dada através de um texto no formato JSON cujos atributos são:
RESPONSE
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| results | O | 0-N | Negociante | |
| metadata | O | 1-1 | Metadata | |
NEGOCIANTE
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| nome | A | 1-1 | Nome | |
| nomeFantasia | A | 0-1 | Nome fantasia | |
| tipoNegociante | N | 1-1 | Tipo: 0 - Física 1 - Jurídica 2 - Exterior 3 - Outros | |
| cpfCnpj | A | 0-1 | CPF/CNPJ | |
| rg | A | 0-1 | RG | |
| suframa | A | 0-1 | Suframa | |
| tipoRegimeTributacao | N | 1-1 | Regime de Tributação: 0 - Simples Nacional 1 - Lucro Prezumido 2 - Lucro Real 3 - Outros | |
| inscricaoEstadual | A | 0-1 | Inscrição Estadual | |
| inscricaoMunicipal | A | 0-1 | Inscrição Municipal | |
| contribuinteIcms | L | 1-1 | Contribuinte ICMS true - Sim false - Não | |
| A | 0-1 | |||
| homePage | A | 0-1 | Home Page | |
| observacao | A | 1-1 | Observação | |
| status | O | 1-N | Status | |
| telefones | O | 0-N | Telefone | |
| enderecos | O | 0-3 | Endereço | |
| contatos | O | 0-N | Contato | |
| contaContabilCliente | O | 0-1 | Conta Contábil Cliente | |
| contaContabilFornecedor | O | 0-1 | Conta Contábil Fornecedor | |
| contaContabilAdiantamentoRec | O | 0-1 | Conta Contábil Adiantamento de Recebimento | |
| contaContabilAdiantamentoCpg | O | 0-1 | Conta Contábil Adiantamento de Pagamento | |
| dataCadastro | D | 1-1 | Data do cadastro YYYY-MM-DD | |
| responsavelCadastro | A | 1-1 | Responsável pelo cadastro | |
| dataUltimaAlteracao | D | 0-1 | Data ultima alteração YYYY-MM-DD | |
| responsavelAlteracao | A | 0-1 | Responsável pela ultima alteração | |
| inativo | L | 1-1 | Valor lógico para identificar se negociante inativo | |
STATUS
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Identificador único externo | |
| descricao | A | 1-1 | Descrição | |
| tipoStatus | N | 1-1 | Tipo do Status 0 - Cliente 1 - Fornecedor 2 - Fornecedor Universal 3 - Fabricante 4 - Transportadora 5 - Banco 6 - Vendedor 7 - Espelho Nota 8 - Estoque de Terceiros 9 - Outros 10 - Comprador 11 - Administrado de Cartão 12 - Lead | |
TELEFONE
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| telefone | A | 1-1 | Número do telefone | |
| tipoNumero | N | 1-1 | Tipo do número 0 - Telefone 1 - Celular 3 - Fax | |
ENDEREÇO
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| tipoEndereco | N | 1-1 | Tipo do Endereço 0 - Principal 1 - Cobrança 2 - Entrega | |
| endereco | A | 1-1 | Logradouro | |
| numero | A | 1-1 | Número | |
| complemento | A | 0-1 | Complemento | |
| bairro | A | 1-1 | Bairro | |
| cep | O | 1-1 | CEP 99999-999 - EXTERIOR | |
| municipio | O | 1-1 | Município | |
CEP
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Código | |
| logradouro | A | 0-1 | Logradouro | |
| bairro | A | 0-1 | Bairro | |
| municipio | O | 0-1 | Município | |
MUNICÍPIO
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigoMunicipal | A | 1-1 | Código Municipal | |
| nome | A | 1-1 | Nome do Negociante | |
| uf | O | 1-1 | UF | |
| pais | O | 1-1 | Pais | |
UF
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| sigla | A | 1-1 | Sigla | |
| descricao | A | 1-1 | Descrição | |
| codigoIbge | A | 1-1 | Código IBGE | |
PAIS
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| sigla | A | 1-1 | Sigla | |
| descricao | A | 1-1 | Descrição | |
| codigoBacen | A | 1-1 | Código Bacen | |
CONTATO
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| nome | A | 1-1 | Nome | |
| telefone | A | 0-1 | Telefone | |
| celular | A | 0-1 | Celular | |
| A | 0-1 | |||
| enviaXML | L | 1-1 | Valor lógico para informar se envia XML | |
| aniversario | D | 0-1 | Data de Nascimento no formato YYYY-DD-MM | |
| cargo | O | 0-1 | Cargo | |
CARGO
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | N | 1-1 | Código | |
| descricao | A | 1-1 | Descrição | |
CONTA CONTÁBIL
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| id | N | 1-1 | Identificador único interno | |
| codigo | A | 1-1 | Número da Conta | |
| descricao | A | 1-1 | Descrição | |
| natureza | A | 1-1 | Natureza ATIVO PASSIVO RESULTADO | |
| sinonimo | A | 0-1 | Sinônimo | |
| contaReferencial | A | 0-1 | Conta de Referência | |
| dataInclusaoAlteracao | D | 1-1 | Data de Inclusão/Alteração | |
| inativo | L | 1-1 | Valor lógico para identificar se a conta esta inativo | |
METADATA
| Campo | Tipo | Ocorrência | Descrição | |
|---|---|---|---|---|
| count | N | 1-1 | Total de registros | |
| offset | N | 1-1 | Número que identifica em qual registro a consulta iniciada | |
| limit | N | 1-1 | Número que identifica o limite de registros na consulta | |
Exemplo de resposta
{
"results": [
{
"id": 1,
"codigo": "1",
"nome": "Negociante 1",
"dataCadastro": "2018-10-30",
"responsavelCadastro": "Compels",
"tipoNegociante": 2,
"cpfCnpj": "N/A",
"contribuinteIcms": false,
"tipoRegimeTributacao": 3,
"aliquotaIcmsSimplesNacional": 0,
"enderecos": [
{
"id": 1,
"endereco": "R 7 Todd Court",
"numero": "7",
"bairro": "Estados Unidos",
"tipoEndereco": 0,
"cep": {
"id": 105,
"codigo": "99999-999",
"logradouro": "N/A",
"bairro": "N/A",
"municipio": {
"id": 230,
"nome": "Estados Unidos",
"codigoMunicipal": "9999999",
"uf": {
"id": 28,
"descricao": "EXTERIOR",
"sigla": "EX",
"codigoIbge": "0"
},
"pais": {
"id": 71,
"descricao": "ESTADOS UNIDOS",
"sigla": "USA",
"codigoBacen": "2496"
}
}
},
"municipio": {
"id": 230,
"nome": "Estados Unidos",
"codigoMunicipal": "9999999",
"uf": {
"id": 28,
"descricao": "EXTERIOR",
"sigla": "EX",
"codigoIbge": "0"
},
"pais": {
"id": 71,
"descricao": "ESTADOS UNIDOS",
"sigla": "USA",
"codigoBacen": "2496"
}
}
}
],
"nomeFantasia": "Empresa 1",
"inativo": false
},
{
"id": 2,
"codigo": "2",
"nome": "Empresa 2",
"dataCadastro": "2018-10-29",
"responsavelCadastro": "Compels",
"tipoNegociante": 1,
"cpfCnpj": "22.777.000/0001-99",
"inscricaoEstadual": "288044455110",
"contribuinteIcms": true,
"tipoRegimeTributacao": 0,
"aliquotaIcmsSimplesNacional": 0,
"enderecos": [
{
"id": 3126,
"endereco": "Rua Nossa sra da Pompeia",
"numero": "416",
"bairro": "Portao",
"tipoEndereco": 0,
"cep": {
"id": 874,
"codigo": "07411-395",
"logradouro": "RUA 1",
"bairro": "CIDADE NOVA",
"municipio": {
"id": 7,
"nome": "ARUJÁ",
"codigoMunicipal": "3503901",
"uf": {
"id": 20,
"descricao": "São Paulo",
"sigla": "SP",
"codigoIbge": "35"
},
"pais": {
"id": 30,
"descricao": "BRASIL",
"sigla": "BRA",
"codigoBacen": "1058"
}
}
},
"municipio": {
"id": 7,
"nome": "ARUJÁ",
"codigoMunicipal": "3503901",
"uf": {
"id": 20,
"descricao": "São Paulo",
"sigla": "SP",
"codigoIbge": "35"
},
"pais": {
"id": 30,
"descricao": "BRASIL",
"sigla": "BRA",
"codigoBacen": "1058"
}
}
}
],
"nomeFantasia": "Negociante 2",
"inativo": false
}
],
"metadata": {
"resultset": {
"count": 2,
"offset": 0,
"limit": 50
}
}
}