Linha Microsiga Protheus - Inglês

Páginas filhas
  • NGF - Customer Panel - Endpoint Movements

Versões comparadas

Versão antiga 1

changes.mady.by.user Usuário desconhecido (thayna.souza)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Usuário desconhecido (thayna.souza)

Gravado em

Chave

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

NGF - Customer Panel - Endpoint Movements

  Draft

01. OVERVIEW

Return the monthly values of the pending bills. The next 12 months of the reference date will be considered for the query, returning the values agglutinated by month.

02. ENDPOINT

Method used: POST
Transactions: /api/tfc/v1/CustomerFinancialTransactions/Movements

03. REQUEST PARAMETERS

Body parameters:

Attribute

Type

Description

Default

customerId

Character

Customer code

-

storeId

Character

Customer store

-

date

Character

reference date in the format YYYYMMDD 

-

branchId

Array

system branches to be considered in the query

-

periods

Numeric

the number of months for the query, considering the current month

-

Example:body

body

body = {

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="425872a8-2c15-49ab-9830-b9ff41099733"><ac:plain-text-body><![CDATA[

body = {
        customerId: "000001",
        storeId: "01",
        date: "20200805",
        branchId: ["D MG 01 ", "D MG 02 "],
        periods:
5        }]]></ac:plain-text-body></ac:structured-macro>
 5
        }

04. API RESPONSE

Json Object

Attribute

Type

Description

period

Character

period YYYYMM

value

Numeric

sum of values

Example:response

response

items:[

    {

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7647ca19-5308-45fa-81d7-a3d7b38c2ccf"><ac:plain-text-body><![CDATA[

items:[    {
        period: "202008",

        value: 4720.
8    
8

    },

    {

        period: "202009",

        value: 250.
4    
4

    },

    {
        period: "202011",
        value: 8734.
85    
85
    },
    {
        period: "202012",
        value: 218765.
4    
4
    }
]

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