Versões comparadas

Chave

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

Índice

01. VISÃO GERAL

Retorna os saldos em aberto, atrasados e vencendo nos próximos 7 dias.

02. ENDPOINT

O método utilizado: POST

Balances: /api/tfc/v1/CustomerFinancialTransactions/Balances

03. PARÂMETROS DA REQUISIÇÃO

Parâmetros do body:

Atributo

Tipo

Descrição

Padrão

customerIdCharactercódigo do cliente-
storeIdCharacter

loja do cliente

-
dateCharacterdata de referência no formato YYYYMMDD -
branchIdArrayfiliais do sistema para considerar na consulta-

Exemplo:
body

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

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

overdueBalanceNumerictotal em atraso
weekBalanceNumericsaldo a vencer nos próximos 7 dias
totalBalanceNumerictotal em aberto

Exemplo:
response

{
    overdueBalance: 2500.0,
    weekBalance: 500.0,
    totalBalance: 7500.0
}