NGF - Customer Panel - Endpoint Balances

01. OVERVIEW

Returns pending balances, overdue balances, and balances that are due in the next 7 days.

02. ENDPOINT

Method used: POST
Balances: /api/tfc/v1/CustomerFinancialTransactions/Balances

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	-

Example:

body

body = {
            customerId: "TFC001",
            storeId: "01",
            branchId: ["D MG 01 ", "D MG 02 "],
            date: "20200824"
        }

04. API RESPONSE

Json Object

Attribute	Type	Description
overdueBalance	Numeric	total overdue
weekBalance	Numeric	balance due in the next 7 days
totalBalance	Numeric	total pending