NGF - FINA710 - Endpoint CashFlow

01. OVERVIEW

Returns the balances for the cash flow grouped by portfolio and date. The dateRef attribute will be considered for the calculation of the accessory value registered in the bill and currency conversion.

Bills marked as cash flow (E1_FLUXO/E2_FLUXO) = YES are considered.

Orders that have an open delivery quantity are considered.

02. ENDPOINT

Method used: POST
Cash flow: /api/gfin/v1/CashFlow
Cash Flow - Receivables: /api/gfin/v1/CashFlow/Receivables
Cash Flow - Payables: /api/gfin/v1/CashFlow/Payables
Cash flow - purchase orders: /api/gfin/v1/CashFlow/Purchases
Cash flow - sales orders: /api/gfin/v1/CashFlow/Sales

03. REQUEST PARAMETERS

Body parameters:

Attribute	Type	Description	Default
branches	array	system branches to be considered in the query	-
dateRef	character	(optional) reference date for future balances yyyy-MM-dd	dDatabase
dateFrom	character	(optional) from due date	-
dateTo	character	(optional) to due date	-

Example:

body

body =
{
    branches: ["D MG 01"],
    dateRef: "2020-10-26",
    dateFrom: "2020-10-26",
    dateTo: "2021-10-26"
}

04. API RESPONSE

Json Object

Attribute	Type	Description
documents	object	payables and receivables
orders	object	Sales and Purchase Orders

Documents object

Attribute	Type	Description
receivables	object	Receivables
payables	object	Payables

Orders object

Attribute	Type	Description
sales	object	Sales orders
purchases	object	Purchase Orders

Data object

Attribute	Type	Description
date	date	Date of balance
value	numeric	Balance value