Histórico da Página
NGF - Customer Panel - Endpoint Balances
Draft
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
|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="35df2e8a-7c7e-4d8b-b9a7-fdfc50b9a6f6"><ac:plain-text-body><![CDATA[
|
|
|
|
]]></ac:plain-text-body></ac:structured-macro>
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 |
Example:
response
{ |
|
|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas