Guide

Simulação FGTS

Para efetuar a simulação do saldo disponivel para o cliente será necessario efetuar uma request HTTP para o endpoint

POST fgts/simulations

deve-se enviar as sequintes informação para que possa obter o resultado da simulação

key

value

“simulationFeesId”

"3fa85f64-5717-4562-b3fc-2c963f66afa6",

“targetAmount”

0,

“desiredInstallments“

[{"totalAmount": 500,00, "dueDate": "2024-02-02"}]

“isInsured”

valor booleano para seguro.

“provider“

StringEnum(["qi", "cartos"])

ATENÇÂO:

  1. O campo “targetAmount“ caso não seja informado nenhum valor enviar como 0;

  2. “desiredInstallments“ deve ser enviar no minimo 2 periodos;

  3. “simulationFeesId” utilizar o o valor de "id_simulation_fees" do endpoint anterior.

exemplo:

Request body required
{
  "simulationFeesId": "f6d779ed-52bf-42f2-9dbc-3125fe6491ba",
  "targetAmount": 0,
  "documentNumber": "2115",
  "isInsured": false,
  "desiredInstallments": [
    {
      "totalAmount": 33.64,
      "dueDate": "2025-02-01"
    },
    {
      "totalAmount": 31.95,
      "dueDate": "2026-02-01"
    },
    {
      "totalAmount": 60.71,
      "dueDate": "2027-02-01"
    },
    {
      "totalAmount": 81.95,
      "dueDate": "2028-02-01"
    },
    {
      "totalAmount": 69.66,
      "dueDate": "2029-02-01"
    },
    {
      "totalAmount": 78.95,
      "dueDate": "2030-02-01"
    },
    {
      "totalAmount": 63.16,
      "dueDate": "2031-02-01"
    },
    {
      "totalAmount": 75.79,
      "dueDate": "2032-02-01"
    },
    {
      "totalAmount": 53.05,
      "dueDate": "2033-02-01"
    },
    {
      "totalAmount": 37.14,
      "dueDate": "2034-02-01"
    }
  ],
  "provider": "cartos"
}

200 Response body
{
  "cet": 0.04,
  "annualCet": 0.54,
  "availableBalance": 486.17,
  "emissionAmount": 539.93,
  "iof": 10.56,
  "tax": 1.8,
  "tc": 7.4,
  "totalBalance": 606.99,
  "totalInstallments": 2,
  "id": "74e22e17-37cf-4a28-9182-3abd462b3168"
}

  1. “availableBalance” é o valor disponível para o cliente;

  2. “emissionAmount” é o valor de custos da operação, onde incide todas as taxas;

  3. “totalBalance” este é o valor bloqueado na conta FGTS do cliente.