Requisição
URL: https://api.erpeasy.compels.net/contaBancaria
Method: GET
Os argumentos são:
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| numero | A | 0-1 | Número da Conta |
| digito | A | 0-1 | Dígito da Conta |
| descricao | A | 0-1 | Descrição |
| agencia | A | 0-1 | Agência |
| contaContabil | A | 0-1 | Conta Contábil |
| buscaEspecifica | L | 1-1 | Valor lógico que define se a busca será exata ou contendo os filtros informados. |
| 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/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 |
|---|---|---|---|
| results | O | 0-N | Conta Bancária |
| metadata | O | 1-1 | Metadata |
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 |
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,
"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
}
}
}