> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jusfy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Calcula a correção de FGTS (teses JAM e Depósito)

> Corrige lançamentos de FGTS por uma das duas teses de cálculo:

- **`jam`**: Realiza a correção monetária do JAM. Exige `jam_interests.id` = `3`|`4`|`5`|`6` (correspondentes a 3%–6% a.a.). A resposta agrupa `items[]` mês a mês desde 01/1999 até a data atual, com `_calculation_basis`, `_difference_jam` e `_outstanding_balance_correction` por item, além do `_amount_correction` acumulado no topo.
- **`deposit`**: Tese de Depósito — corrige o valor original com pro rata na primeira e última competência. Cada item traz um `schedule[]` com a evolução mês a mês.

`items` precisa de **pelo menos um** lançamento. O índice (`index.id`) é resolvido no backend para o `bacen_code` correspondente (ex.: `2` → INPC).



## OpenAPI

````yaml /openapi/legado.json post /api/calculadoras/fgts
openapi: 3.0.0
info:
  title: Calculadoras Jusfy API
  description: >-
    Rotas sem versão (`/api/...`). Continuam funcionando, mas a versão atual

    da API é a v1 (`/api/v1`): para integrações novas, use a v1 e siga o [guia
    de
    migração](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado).


    A política de versionamento e depreciação está na [política de
    versionamento](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado#pol%C3%ADtica-de-versionamento).
  version: legacy
  contact: {}
servers:
  - url: https://api.jusfy.dev/calculators
security: []
tags:
  - name: Calculadoras
    description: >-
      Execução das calculadoras jurídicas e consulta dos índices de correção.
      Cada cálculo recebe um payload, retorna o resultado processado e exige API
      key no header `x-api-key`.
  - name: Consultas
    description: >-
      Consultas de dados (veículos, condutores e documentos). Cada consulta
      recebe o documento, retorna os dados encontrados e exige API key no header
      `x-api-key`. A maioria responde na mesma requisição; o **rastreamento
      veicular** e o **buscador processual** são assíncronos — devolvem `202`
      com um protocolo e entregam o resultado por webhook e/ou pelo `GET` do
      protocolo.
  - name: JusScore
    description: >-
      Consulta de processos judiciais por CPF/CNPJ, com score de risco
      consolidado e a lista detalhada dos processos. É assíncrona: o POST inicia
      a consulta e o GET devolve o resultado quando pronto. Exige API key no
      header `x-api-key`.
  - name: Consumo
    description: >-
      Consumo da própria API key: quantas chamadas cada produto recebeu num
      período, separando as cobradas das não cobradas. Não exige escopo; exige
      API key no header `x-api-key`.
  - name: Health
    description: >-
      Verificações de disponibilidade do serviço (liveness e readiness). Rotas
      abertas, sem autenticação.
paths:
  /api/calculadoras/fgts:
    post:
      tags:
        - Calculadoras
      summary: Calcula a correção de FGTS (teses JAM e Depósito)
      description: >-
        Corrige lançamentos de FGTS por uma das duas teses de cálculo:


        - **`jam`**: Realiza a correção monetária do JAM. Exige
        `jam_interests.id` = `3`|`4`|`5`|`6` (correspondentes a 3%–6% a.a.). A
        resposta agrupa `items[]` mês a mês desde 01/1999 até a data atual, com
        `_calculation_basis`, `_difference_jam` e
        `_outstanding_balance_correction` por item, além do `_amount_correction`
        acumulado no topo.

        - **`deposit`**: Tese de Depósito — corrige o valor original com pro
        rata na primeira e última competência. Cada item traz um `schedule[]`
        com a evolução mês a mês.


        `items` precisa de **pelo menos um** lançamento. O índice (`index.id`) é
        resolvido no backend para o `bacen_code` correspondente (ex.: `2` →
        INPC).
      operationId: CalculatorsController_fgts[0]
      parameters: []
      requestBody:
        required: true
        description: Payload da calculadora de FGTS.
        content:
          application/json:
            schema:
              type: object
              description: >-
                Payload da correção de FGTS. Escolha a tese (`jam` ou
                `deposit`), o índice de correção e informe os lançamentos
                (`items`). Para a tese `jam`, também é obrigatório o
                `jam_interests` (rótulo `3`–`6`, correspondentes a 3%–6% a.a.).
                A resposta traz os itens corrigidos e os totais agregados.
              required:
                - end_date
                - thesis
                - index
                - items
              properties:
                name:
                  type: string
                  description: Nome do cálculo. Opcional; não afeta o resultado.
                author:
                  type: string
                  description: Autor do cálculo (ecoado).
                end_date:
                  type: string
                  format: date
                  description: Data final da correção (`YYYY-MM-DD`).
                thesis:
                  type: object
                  description: Tese aplicada ao cálculo.
                  required:
                    - id
                  properties:
                    id:
                      type: string
                      enum:
                        - jam
                        - deposit
                      description: >-
                        `jam` = Realiza a correção monetária do JAM; `deposit` =
                        Tese de Depósito (correção com pro rata na primeira e
                        última competência).
                    name:
                      type: string
                jam_interests:
                  type: object
                  description: >-
                    Configuração dos juros da tese `jam`. Obrigatório quando
                    `thesis.id === "jam"`.
                  required:
                    - id
                  properties:
                    id:
                      type: string
                      enum:
                        - '3'
                        - '4'
                        - '5'
                        - '6'
                      description: >-
                        Rótulo do juros: `3` = 3% a.a., `4` = 4% a.a., `5` = 5%
                        a.a., `6` = 6% a.a.
                    name:
                      type: string
                index:
                  type: object
                  description: Índice de correção monetária.
                  required:
                    - id
                  properties:
                    id:
                      type: number
                      description: ID do índice — o núcleo usa para buscar o `bacen_code`.
                    name:
                      type: string
                    bacen_code:
                      type: string
                items:
                  type: array
                  description: Itens a corrigir. Deve conter **pelo menos um** item.
                  items:
                    type: object
                    description: Um item a corrigir.
                    required:
                      - date
                      - amount
                    properties:
                      date:
                        type: string
                        format: date
                      amount:
                        type: number
                      fine:
                        type: number
                        description: Multa por item. Opcional (não afeta os totais).
                      description:
                        type: string
            examples:
              fgts:
                summary: Tese de Depósito (INPC)
                value:
                  author: Autor Exemplo
                  end_date: '2021-07-09'
                  thesis:
                    id: deposit
                    name: Depósito
                  index:
                    id: 2
                    name: INPC
                    bacen_code: '188'
                  items:
                    - date: '1999-01-10'
                      amount: 100
                      description: Depósito jan/1999
      responses:
        '200':
          description: Resultado da correção, com os itens processados e totais agregados.
          content:
            application/json:
              schema:
                type: object
                example:
                  statusCode: 200
                  message: Cálculo concluído com sucesso
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/calculadoras/fgts
                  result:
                    index: INPC
                    latest_index_update: 04/2026
                    author: Autor Exemplo
                    interests_rate: ''
                    hasInterests: false
                    hasFine: false
                    hasLegalFees: false
                    hasInterestRate: false
                    items:
                      - _key: 1
                        _date: 10/01/1999
                        _amount: 100,00
                        _fine: 0,00
                        _interests: 0,00
                        _subtotal: 415,71
                        _differenceAdjustedAmount: 415,71
                        _outstanding_balance: 415,71
                        date: '1999-01-10'
                        amount: 100
                        description: Depósito jan/1999
                        interests: 0
                        subtotal: 415.71
                        schedule:
                          - date: '1999-01-10'
                            amount: 100
                            correction: 0
                            amount_adjusted: 0
                            interests: 0
                            outstanding_balance: 100
                            _description: Depósito jan/1999
                            _date: 10/01/1999
                            _amount: 100,00
                            _amount_adjusted: ''
                            _correction: ''
                            _interests: ''
                            _outstanding_balance: ''
                          - date: '1999-01-31'
                            amount: 100
                            correction: 0.55
                            amount_adjusted: 100.55
                            interests: 0
                            outstanding_balance: 100.55
                            _description: ''
                            _date: 31/01/1999
                            _amount: 100,00
                            _amount_adjusted: R$ 100,55
                            _correction: 0,55
                            _interests: ''
                            _outstanding_balance: R$ 100,55
                          - date: '2021-07-09'
                            amount: 415.53
                            correction: 0.09
                            amount_adjusted: 415.71
                            interests: 0
                            outstanding_balance: 415.71
                            _description: ''
                            _date: 09/07/2021
                            _amount: 415,53
                            _amount_adjusted: R$ 415,71
                            _correction: 0,09
                            _interests: ''
                            _outstanding_balance: R$ 415,71
                    _end_date: 09/07/2021
                    _total_interests: 0,00
                    _total_outstanding_balance: 415,71
                    _subtotal_amount: 100,00
                    _subtotal: 415,71
                    _subtotal_nofine: 415,71
                    _difference: 315,71
                    _legal_fees: 0,00
                    _total: 415,71
                    _total_fines: R$ 0,00
                    status: true
        '401':
          description: >-
            API key ausente ou que não pertence a nenhum cliente (`code:
            invalid_api_key`). A `message` diz qual dos dois.
          content:
            application/json:
              examples:
                missing:
                  summary: Key ausente
                  value:
                    statusCode: 401
                    message: Missing API key
                    code: invalid_api_key
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/calculadoras/trabalhista
                invalid:
                  summary: Key inválida
                  value:
                    statusCode: 401
                    message: Invalid API key
                    code: invalid_api_key
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/calculadoras/trabalhista
        '403':
          description: >-
            Acesso negado. Dois motivos, distinguidos pelo `code`: o cliente não
            está ativo (`inactive_client`), ou a API key não tem o escopo deste
            produto (`insufficient_scope`, com o escopo na `message`). A
            liberação de produtos é feita pela equipe Jusfy.
          content:
            application/json:
              examples:
                inactive_client:
                  summary: Cliente não ativo
                  value:
                    statusCode: 403
                    message: Client is not active
                    code: inactive_client
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/calculadoras/trabalhista
                insufficient_scope:
                  summary: Sem o escopo do produto
                  value:
                    statusCode: 403
                    message: 'Missing scope: <escopo>'
                    code: insufficient_scope
                    requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                    timestamp: '2026-10-14T18:00:00.000Z'
                    path: /api/calculadoras/trabalhista
        '422':
          description: Payload inválido. `message` indica o campo e o motivo.
          content:
            application/json:
              schema:
                example:
                  statusCode: 422
                  code: payload_rejected
                  message: 'Expected number, received null (property: fine)'
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/calculadoras/fgts
        '429':
          description: >-
            Limite de requisições por minuto do cliente neste produto excedido.
            `Retry-After` diz em quantos segundos a janela vira. Toda resposta
            traz `X-RateLimit-Limit`, `X-RateLimit-Remaining` e
            `X-RateLimit-Reset`.
          content:
            application/json:
              schema:
                example:
                  statusCode: 429
                  code: rate_limit_exceeded
                  message: >-
                    Rate limit exceeded for calculadoras.trabalhista:execute: 60
                    requests per minute. Retry in 42s.
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/calculadoras/trabalhista
        '502':
          description: Erro no motor de cálculo da Jusfy.
          content:
            application/json:
              schema:
                example:
                  statusCode: 502
                  code: upstream_error
                  message: Calculation backend error
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/calculadoras/fgts
        '504':
          description: Tempo limite ao falar com o motor de cálculo.
          content:
            application/json:
              schema:
                example:
                  statusCode: 504
                  code: upstream_timeout
                  message: Calculation backend timed out
                  requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65
                  timestamp: '2026-06-22T18:00:00.000Z'
                  path: /api/calculadoras/fgts
      security:
        - api-key: []
components:
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.