Requisição
URL: https://api.erpeasy.compels.net/recebimento
Method: GET
Os argumentos são:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dataInicial | D | Sim | Data inicio para a consulta no formato AAAA-MM-DD |
| dataFinal | D | Sim | Data final para a consulta no formato AAAA-MM-DD |
| tipo | N | Não | Valor que identifica se a busca será feita somente nos recebimentos ou pagamentos 1 - Recebimento 2 - Pagamento |
| offset | N | Não | Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0. |
| limit | N | Não | 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:
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 | Recebimento/Pagamento |
| metadata | O | 1-1 | Metadata |
RECEBIMENTO/PAGAMENTO
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do Recebimento/Pagamento |
| dataRecebimento | D | 1-1 | Data do recebimento/pagamento no formato AAAA-MM-DD |
| dataCredito | D | 1-1 | Data do cŕedito em conta no formato AAAA-MM-DD |
| valorRecebimento | N | 1-1 | Valor recebimento/pagamento |
| valorDesconto | N | 1-1 | Valor de Desconto |
| valorJuros | N | 1-1 | Valor de Juros |
| valorTaxa | N | 1-1 | Valor de Taxa |
| valorTarifa | N | 1-1 | Valor de Tarifa Bancária |
| valorIr | N | 1-1 | Valor de IR |
| valorCsll | N | 1-1 | Valor de CSLL |
| valorPis | N | 1-1 | Valor de Pis |
| valorCofins | N | 1-1 | Valor de COFINS |
| valorInss | N | 1-1 | Valor de INSS |
| valorIss | N | 1-1 | Valor de ISS |
| valorVariacaoAtiva | N | 1-1 | Valor de Variação Ativa |
| valorVariacaoPassiva | N | 1-1 | Valor de Variação Passiva |
| complementoRecebimento | A | 0-1 | Complemento do Recebimento/Pagamento |
| empresa | O | 1-1 | Empresa |
| movimento | O | 0-1 | Movimento Bancário |
| compensacao | O | 0-1 | Compensação |
| duplicata | O | 1-1 | Duplicata |
EMPRESA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico da empresa |
MOVIMENTO
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do movimento |
COMPENSAÇÃO
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico da compensação |
DUPLICATA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | Identificador único numérico da Duplicata | |
| empresa | - | 1-1 | Empresa |
| documento | N | 1-1 | Número do documento |
| negociante | O | 1-1 | Negociante |
| emissao | D | 1-1 | Data de emissão |
| vencimento | D | 1-1 | Data de vencimento |
| valor | N | 1-1 | Valor |
| contaInterna | O | 1-1 | Conta Interna |
| contaBancaria | O | 1-1 | Conta Bancaria |
| tipoCobranca | O | 0-1 | Tipo de Cobrança |
| centroCusto | O | 0-1 | Centro de Custo |
| complemento | A | 0-1 | Complemento |
NEGOCIANTE
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do Negociante |
| codigo | A | 1-1 | Código do Negociante |
| nome | A | 1-1 | Nome do Negociante |
| cpfCnpj | A | 0-1 | CPF/CNPJ do Negociante |
CONTA INTERNA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico da Conta Interna |
| codigo | A | 1-1 | Identificador único alfanumérico da Conta Interna |
| descricao | A | 1-1 | Descrição |
| creditoDebito | A | 1-1 | Determina o Tipo da Conta Interna C - Cŕedito D - Débito |
| ativa | B | 1-1 | Valor lógico para verificar se a conta interna está ativa ou não |
CONTA BANCÁRIA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico da Conta |
| numero | A | 1-1 | Número da Conta |
| digito | A | 1-1 | Dígito da Conta |
| descricao | A | 1-1 | Descrição da Conta |
| agencia | O | 0-1 | Agência |
AGÊNCIA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | Identificador único numérico da Agência | |
| codigo | A | 1-1 | Código da Agência |
| digito | A | 0-1 | Dígito da Agência |
| descricao | A | 1-1 | Descrição da Agência |
| banco | O | 1-1 | Banco |
BANCO
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do Banco |
| codigoFebraban | N | 1-1 | Código Febraban do Banco |
| sigla | A | 1-1 | Sigla do Banco |
| nome | A | 1-1 | Nome do Banco |
| website | A | 0-1 | Website do Banco |
TIPO DE COBRANÇA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do Tipo de Cobrança |
| codigo | A | 1-1 | Identificador único alfanumérico do Tipo de Cobrança |
| descricao | A | 1-1 | Descrição do Tipo de Cobrança |
CENTRO DE CUSTO
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único numérico do Centro de Custo |
| codigo | A | 1-1 | Identificador único alfanumérico do Centro de Custo |
| descricao | A | 1-1 | Descrição do Centro de Custo |
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,
"dataRecebimento": "2018-01-02",
"dataCredito": "2018-01-02",
"valorRecebimento": 11166,
"valorIr": 0,
"valorCsll": 0,
"valorPis": 0,
"valorCofins": 0,
"valorInss": 0,
"valorIss": 0,
"valorVariacaoAtiva": 0,
"valorVariacaoPassiva": 0,
"movimento": {
"id": 1
},
"duplicata": {
"id": 1,
"empresa": {
"id": 1
},
"documento": "TESTE-1",
"negociante": {
"id": 1,
"codigo": "1",
"nome": "COMPELS",
"cpfCnpj": "11.111.111/0001-11"
},
"emissao": "2017-11-01",
"vencimento": "2017-12-31",
"valor": 11166,
"desconto": 0,
"saldo": 0,
"contaInterna": {
"id": 1,
"codigo": "101",
"descricao": "Venda",
"creditoDebito": "C",
"ativa": true
},
"contaBancaria": {
"id": 1
"descricao": "Bradesco S.A.",
"numero": "1234",
"digito": "5",
"agencia": {
"id": 1,
"codigo": "123",
"descricao": "Agencia Bradesco",
"digito": "4",
"banco": {
"id": 52,
"nome": "Bradesco",
"codigoFebraban": "237",
"sigla": "Bradesco",
"website": "http://www.bradesco.com.br"
}
}
},
"complemento": "Original da Nota de Serviço No.: TESTE-1"
},
"valorDesconto": 0,
"valorJuros": 0,
"valorTaxa": 0,
"valorTarifa": 0,
"complementoRecebimento": "Compels - (TESTE-1*1)"
},
{
"id": 2,
"dataRecebimento": "2018-01-02",
"dataCredito": "2018-01-02",
"valorRecebimento": 4506,
"valorIr": 0,
"valorCsll": 0,
"valorPis": 0,
"valorCofins": 0,
"valorInss": 0,
"valorIss": 0,
"valorVariacaoAtiva": 0,
"valorVariacaoPassiva": 0,
"movimento": {
"id": 2
},
"duplicata": {
"id": 2,
"empresa": {
"id": 1
},
"documento": "TESTE-2",
"negociante": {
"id": 1,
"codigo": "1",
"nome": "Compels",
"cpfCnpj": "11.111.111/0001-11"
},
"emissao": "2017-11-16",
"vencimento": "2017-12-16",
"valor": 4506,
"desconto": 0,
"saldo": 0,
"contaInterna": {
"id": 1,
"codigo": "101",
"descricao": "Venda",
"creditoDebito": "C",
"ativa": true
},
"contaBancaria": {
"id": 2,
"descricao": "Bradesco S.A.",
"numero": "2345",
"digito": "5",
"agencia": {
"id": 2,
"codigo": "321",
"descricao": "Agencia Bradesco",
"digito": "1",
"banco": {
"id": 52,
"nome": "Bradesco",
"codigoFebraban": "237",
"sigla": "Bradesco",
"website": "http://www.bradesco.com.br"
}
}
},
"complemento": "Original da Nota de Serviço No.: TESTE-2"
},
"valorDesconto": 0,
"valorJuros": 0,
"valorTaxa": 0,
"valorTarifa": 0,
"complementoRecebimento": "Compels - (TESTE-2*1)"
}
],
"metadata": {
"resultset": {
"count": 3,
"offset": 0,
"limit": 50
}
}
}