Linha Microsiga Protheus - Espanhol

Atalhos

Árvore de páginas

01. VISIÓN GENERAL

Devolver información de bancos y sus saldos bancarios

02. ENDPOINT

Método utilizado:POST

Bancos : /api/gfin/v1/Banks/Balances

03. PARÁMETROS DE LA SOLICITUD

Parámetros del body:

Atributo

Tipo

Descripción

Estándar

branchesarray

sucursales del sistema para considerar en la consulta

-
banksarray

(opcional) bancos que se considerarán en la búsqueda

todos
invertedlogical

(opcional) define si los bancos que se considerarán tendrán un concepto invertido, si fuera true los bancos recibidos no se considerarán en la búsqueda

false
referenceDatedata

(opcional) fecha de referencia del saldo bancario

facha actual
pagenumeric

(opcional) número de la página

1
limitnumeric

(opcional) límite de bancos por página

todos

Ejemplo:
body

body =
{
    "referenceDate": "2019-10-01",
    "banks": [
        {
            "id": "000",
            "agency": "00000",
            "account": "0000000000"
        },
        {
            "id": "001",
            "agency": "00001",
            "account": "0000000001"
        },
        {
            "id": "002",
            "agency": "00002",
            "account": "0000000002"
        }
    ]
}

04. RESPUESTA DE LA API

Objeto Json

Atributo

Tipo

Descripción

itemsArraylista de Bancos
hasNextLogicaltrue si existiera nueva página

Lista de campos

Atributo

Descripción

idA6_COD
agencyA6_AGENCIA
accountA6_NUMCON
nameA6_NOME
balanceE8_SALATUA


Ejemplo:
response

{
    "hasNext": false,
    "items": [
        {
            "id": "000",
            "agency": "00000",
            "account": "0000000000",
            "name": "BANCO 0000000000",
            "balance": -271317.25
        },
        {
            "id": "001",
            "agency": "00001",
            "account": "0000000001",
            "name": "BANCO 0000000001",
            "balance": 123.45
        },
        {
            "id": "002",
            "agency": "00002",
            "account": "0000000002",
            "name": "BANCO 0000000002",
            "balance": 16563.02
        }
    ]
}

  • Sem rótulos