Páginas filhas
  • NGF - FINA710 - Endpoint CashFlow

Versões comparadas

Chave

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

...

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



Bloco de código
languagejs
themeMidnight
titlebody
Wiki Markup
*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

...

Attribute

Type

Description

date

date

Date of balance

value

numeric

Balance value

Example:

response


Bloco de código
languagejs
themeMidnight
titleresponse
Wiki Markup
\\
*Example:*
\\
*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
            \}
        \]
    \}
\}
\\