Requisição 

URL: https://api.erpeasy.compels.net/negociante

Method: GET


Os argumentos são:

Nome
TipoOcorrênciaDescrição
buscaEspecificaL1-1Valor lógico que define se a busca será exata ou contendo os filtros informados.
codigoA0-1Código do negociante.
nomeA0-1Nome do negociante.
cpfCnpjA0-1CPF/CNPJ do negociante.
cepA0-1CEP do negociante.
municipioA0-1Município do negociante.
ufA0-1UF do negociante.
paisA0-1Pais do negociante.
dataCadastroAlteracaoD0-1Data 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

CampoTipoOcorrênciaDescrição
resultsO0-NNegociante
metadataO1-1Metadata


NEGOCIANTE

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoA1-1Identificador único externo 
nomeA1-1Nome
nomeFantasiaA0-1Nome fantasia
tipoNegocianteN1-1Tipo:
0 - Física
1 - Jurídica
2 - Exterior
3 - Outros
cpfCnpjA0-1CPF/CNPJ
rgA0-1RG
suframaA0-1Suframa
tipoRegimeTributacaoN1-1Regime de Tributação:
0 - Simples Nacional
1 - Lucro Prezumido
2 - Lucro Real
3 - Outros
inscricaoEstadualA0-1Inscrição Estadual
inscricaoMunicipalA0-1Inscrição Municipal
contribuinteIcmsL1-1Contribuinte ICMS
true - Sim
false - Não
emailA0-1E-mail
homePageA0-1Home Page
observacaoA1-1Observação
statusO1-NStatus
telefonesO0-NTelefone
enderecosO0-3Endereço
contatosO0-NContato
contaContabilClienteO0-1Conta Contábil Cliente
contaContabilFornecedorO0-1Conta Contábil Fornecedor
contaContabilAdiantamentoRecO0-1Conta Contábil Adiantamento de Recebimento
contaContabilAdiantamentoCpgO0-1Conta Contábil Adiantamento de Pagamento
dataCadastroD1-1Data do cadastro YYYY-MM-DD
responsavelCadastroA1-1Responsável pelo cadastro
dataUltimaAlteracaoD0-1Data ultima alteração YYYY-MM-DD
responsavelAlteracaoA0-1Responsável pela ultima alteração
inativoL1-1Valor lógico para identificar se negociante inativo


STATUS

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoA1-1Identificador único externo
descricaoA1-1Descrição
tipoStatusN1-1Tipo 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

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
telefoneA1-1Número do telefone
tipoNumeroN1-1Tipo do número
0 - Telefone
1 - Celular
3 - Fax


ENDEREÇO

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
tipoEnderecoN1-1Tipo do Endereço
0 - Principal
1 - Cobrança
2 - Entrega
enderecoA1-1Logradouro
numeroA1-1Número
complementoA0-1Complemento
bairroA1-1Bairro
cepO1-1CEP
99999-999 - EXTERIOR
municipioO1-1Município


CEP

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoA1-1Código
logradouroA0-1Logradouro
bairroA0-1Bairro
municipioO0-1Município


MUNICÍPIO

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoMunicipalA1-1Código Municipal
nomeA1-1Nome do Negociante
ufO1-1UF
paisO1-1Pais


UF

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
siglaA1-1Sigla
descricaoA1-1Descrição
codigoIbgeA1-1Código IBGE


PAIS

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
siglaA1-1Sigla
descricaoA1-1Descrição
codigoBacenA1-1Código Bacen


CONTATO

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
nomeA1-1Nome
telefoneA0-1Telefone
celularA0-1Celular
emailA0-1E-mail
enviaXMLL1-1Valor lógico para informar se envia XML
aniversarioD0-1Data de Nascimento no formato YYYY-DD-MM
cargoO0-1Cargo


CARGO

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoN1-1Código
descricaoA1-1Descrição


CONTA CONTÁBIL

CampoTipoOcorrênciaDescrição
idN1-1Identificador único interno
codigoA1-1Número da Conta
descricaoA1-1Descrição
naturezaA1-1Natureza
ATIVO
PASSIVO
RESULTADO
sinonimoA0-1Sinônimo
contaReferencialA0-1Conta de Referência
dataInclusaoAlteracaoD1-1Data de Inclusão/Alteração
inativoL1-1Valor lógico para identificar se a conta esta inativo


METADATA

CampoTipoOcorrênciaDescrição
countN1-1Total de registros
offsetN1-1Número que identifica em qual registro a consulta iniciada
limitN1-1Nú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
}
    }

}