Requisição

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

Method: GET


Os argumentos são:

Nome
TipoObrigatórioDescrição
dataInicial
DSimData inicio para a consulta no formato AAAA-MM-DD
dataFinal
DSimData final para a consulta no formato AAAA-MM-DD
tipo
NNão
Valor que identifica se a busca será feita somente nos recebimentos ou pagamentos
1 - Recebimento
2 - Pagamento
offsetNNão
Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0.
limitNNãoNú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/recebimento?dataInicial=2018-01-01&dataFinal=2018-01-31&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
resultsO0-N
Recebimento/Pagamento
metadataO1-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
empresaO1-1Empresa
movimento
O0-1
Movimento Bancário
compensacao
O0-1
Compensação
duplicata
O1-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
documentoN
1-1
Número do documento
negociante
O1-1
Negociante
emissao
D1-1Data de emissão
vencimentoD1-1Data de vencimento
valor
N1-1Valor
contaInterna
O1-1Conta Interna
contaBancaria
O1-1Conta Bancaria
tipoCobranca
O0-1Tipo de Cobrança
centroCusto
O0-1Centro de Custo
complemento
A0-1Complemento


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
idN1-1Identificador único numérico da Conta Interna
codigo
A1-1Identificador único  alfanumérico da Conta Interna
descricaoA1-1Descrição
creditoDebito
A1-1Determina o Tipo da Conta Interna
C - Cŕedito
D - Débito
ativaB1-1Valor 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
numeroA
1-1
Número da Conta
digitoA
1-1
Dígito da Conta
descricaoA
1-1
Descrição da Conta
agenciaO0-1Agência


AGÊNCIA

Campo
Tipo
Ocorrência
Descrição
idN
Identificador único numérico da Agência
codigoA1-1Código da Agência
digitoA0-1Dígito da Agência
descricaoA1-1Descrição da Agência
bancoO1-1Banco


BANCO

Campo
Tipo
Ocorrência
Descrição
idN1-1Identificador único numérico do Banco
codigoFebrabanN1-1Código Febraban do Banco
siglaA1-1Sigla do Banco
nomeA1-1Nome do Banco
websiteA0-1Website do Banco


TIPO DE COBRANÇA

Campo
Tipo
Ocorrência
Descrição
idN1-1Identificador único numérico do Tipo de Cobrança
codigo
A1-1Identificador único  alfanumérico do Tipo de Cobrança
descricao
A1-1Descrição do Tipo de Cobrança


CENTRO DE CUSTO

Campo
Tipo
Ocorrência
Descrição
idN1-1Identificador único numérico do Centro de Custo
codigo
A1-1Identificador único  alfanumérico do Centro de Custo
descricao
A1-1Descrição do Centro de Custo


METADATA

Campo
Tipo
Ocorrência
Descrição
countN1-1
Total de registros
offsetN1-1
Nú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,
            "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
        }
    }

}