Versões comparadas

Chave

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

Índice

01. VISÃO GERAL

Retornar os valores mensais dos títulos em aberto.
Será considerado os próximos 12 meses da data de referências para a consulta, retornando os valores aglutinados por mês.

02. ENDPOINT

O método utilizado: POST

Movimentos : /api/tfc/v1/CustomerFinancialTransactions/Movements

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-
periodsNumericquantidade de meses para a consulta, considerando o mês corrente-

Exemplo:
body

body = {
        customerId: "000001",
        storeId: "01",
        date: "20200805",
        branchId: ["D MG 01 ", "D MG 02 "],
        periods: 5
        }

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

periodCharacterperíodo YYYYMM
valueNumericsoma de valores

Exemplo:
response

items:[
    {
        period: "202008",
        value: 4720.8
    },
    {
        period: "202009",
        value: 250.4
    },
    {
        period: "202011",
        value: 8734.85
    },
    {
        period: "202012",
        value: 218765.4
    }
]