Linha Microsiga Protheus - Inglês

Páginas filhas
  • NGF - FINA710 - Endpoint Banks

Versões comparadas

Versão antiga 1

changes.mady.by.user Thayna de Souza Moreira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Thayna de Souza Moreira

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

NGF - FINA710 - Endpoint Banks

  Draft

01. OVERVIEW

Return bank information and their balances

02. ENDPOINT

Method used: POST
Banks: /api/gfin/v1/Banks/Balances

03. REQUEST PARAMETERS

Body parameters:

Attribute

Type

Description

Default

branches

array

system branches to be considered in the query

-

banks

array

(optional) banks to be considered in the search

all

inverted

logical

(optional) defines if the banks to be considered will have an inverted concept. If true, the banks received will be ignored in the search

false

referenceDate

data

(optional) reference date of the bank balance

current date

page

numeric

(optional) page number

1

limit

numeric

(optional) limit of banks per page

all

Example:body

body

body =
{

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="324ae702-5d77-4370-b62d-051d47dd00ef"><ac:plain-text-body><![CDATA[

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

]]></ac:plain-text-body></ac:structured-macro>

04. API RESPONSE

Json Object

Attribute

Type

Description

items

Array

list of banks

hasNext

Logical

true if there is a new page

List of Fields

Attribute

Description

id

A6_COD

agency

A6_AGENCIA

account

A6_NUMCON

name

A6_NOME

balance

E8_SALATUA


Example:response

response

{

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cdd5d7f4-c776-46d0-839f-6b2a306ce620"><ac:plain-text-body><![CDATA[

{
    "hasNext": false,
    "items": [
        {
            "id": "000",
            "agency": "00000",
            "account": "0000000000",
            "name": "BANK 0000000000",
            "balance": -271317.
25        
25
        },
        {
            "id": "001",
            "agency": "00001",
            "account": "0000000001",
            "name": "BANK 0000000001",
            "balance": 123.
45        
45
        },
        {
            "id": "002",
            "agency": "00002",
            "account": "0000000002",
            "name": "BANK 0000000002",
            "balance": 16563.
02        
02
        }
    ]
}]]></ac:plain-text-body></ac:structured-macro>

}