NGF - FINA710 - Endpoint CashFlow

01. VISIÓN GENERAL

Devuelve los saldos al flujo de caja agrupados por cartera y fecha.
Se considerará atributo dateFef para el cálculo del valor accesorio registrado en el título y la conversión de monedas.

Se consideran los títulos marcados como flujo de caja (E1_FLUXO/E2_FLUXO) = SÍ.

Se consideran los pedidos que tengan cantidad pendiente de entrega.

02. ENDPOINT

Método utilizado: POST

Flujo de caja : /api/gfin/v1/CashFlow

Flujo de caja - Cobrables: /api/gfin/v1/CashFlow/Receivables

Flujo de caja - pagables: /api/gfin/v1/CashFlow/Payables

Flujo de caja - pedidos de compra: /api/gfin/v1/CashFlow/Purchases

Flujo de caja - pedidos de venta: /api/gfin/v1/CashFlow/Sales

03. PARÁMETROS DE LA SOLICITUD

Parámetros del body:

Atributo	Tipo	Descripción	Estándar
branches	array	sucursales del sistema para considerar en la consulta	-
dateRef	character	(opcional) fecha de referencia para los saldos futuros aaaa-MM-dd	dDatabase
dateFrom	character	(opcional) de vencimiento	-
dateTo	character	(opcional) a vencimiento	-

Ejemplo:

Body

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

04. RESPUESTA DE LA API

Objeto Json

Atributo	Tipo	Descripción
documents	object	Cobrables y pagables
orders	object	Pedidos de compra y venta

Objeto documents

Atributo	Tipo	Descripción
receivables	object	Cobrables
payables	object	Pagables

Objeto orders

Atributo	Tipo	Descripción
sales	object	Pedidos de venta
purchases	object	Pedidos de compra

Objeto data

Atributo	Tipo	Descripción
date	date	Fecha del saldo
value	numeric	Valor del saldo

Ejemplo:

response

{
    "documents": {
        "receivables": [
            {
                "date": "2014-05-12",
                "value": 8000
            },
            {
                "date": "2015-02-16",
                "value": 2000
            }
        ],
        "payables": [
            {
                "date": "2012-01-02",
                "value": 2000
            },
            {
                "date": "2014-02-10",
                "value": 345
            }
        ]
    },
    "orders": {
        "sales": [
            {
                "date": "2021-03-02",
                "value": 35764598.25
            },
            {
                "date": "2021-03-31",
                "value": 265993.49
            }
        ],
        "purchases": [
            {
                "date": "2021-03-02",
                "value": 6563394.69
            },
            {
                "date": "2021-03-11",
                "value": 1750
            }
        ]
    }
}

Atalhos

Árvore de páginas

01. VISIÓN GENERAL

02. ENDPOINT

03. PARÁMETROS DE LA SOLICITUD

04. RESPUESTA DE LA API