Requisição

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

Method: GET


Os argumentos são:

CampoTipoOcorrênciaDescrição
numero
A0-1Número da Conta
digito
A0-1Dígito da Conta
descricao
A0-1Descrição
agencia
A0-1Agência
contaContabil
A0-1Conta Contábil
buscaEspecifica
L1-1Valor lógico que define se a busca será exata ou contendo os filtros informados.
offset
N0-1Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0.
limit
N0-1Nú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/contaBancaria?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
Conta Bancária
metadataO1-1
Metadata


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


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,
            "descricao": "Banco Itaú",
            "numero": "12345",
            "digito": "6",
            "agencia": {
                "id": 1,
                "codigo": "123",
                "descricao": "Agencia Itau",
                "banco": {
                    "id": 54,
                    "nome": "Itaú Unibanco",
                    "codigoFebraban": "341",
                    "sigla": "Itaú",
                    "website": "http://www.itau.com.br"
                }
            }
        },
        {
            "id": 2,
            "descricao": "Bradesco S.A.",
            "numero": "12345",
            "digito": "6",
            "agencia": {
                "id": 2,
                "codigo": "1234",
                "descricao": "Agencia Bradesco",
                "digito": "4",
                "banco": {
                    "id": 52,
                    "nome": "Bradesco",
                    "codigoFebraban": "237",
                    "sigla": "Bradesco",
                    "website": "http://www.bradesco.com.br"
                }
            }
        },
        {
            "id": 3,
            "descricao": "Santander",
            "numero": "120003",
            "digito": "4",
            "agencia": {
                "id": 3,
                "codigo": "112233",
                "descricao": "Santander",
                "banco": {
                    "id": 48,
                    "nome": "Banco Santander",
                    "codigoFebraban": "033",
                    "sigla": "Santander",
                    "website": "http://www.santander.com.br"
                }
            }
        }
    ],
     "metadata": {
        "resultset": {
            "count": 3,
            "offset": 0,
            "limit": 50
        }
    }

}