> ## 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 o plano de pagamento no superendividamento

> Monta um plano de pagamento das dívidas do devedor conforme a Lei do Superendividamento, respeitando o mínimo existencial. Informe as dívidas (`debts`), o prazo e a carência do plano, o sistema de amortização (`price` ou `sac`), a taxa de juros e o mínimo existencial (`minimum_living_income`). A resposta traz o resumo do plano (`summary`), o rateio das parcelas por credor (`installments_by_creditor`) e o cronograma consolidado (`amortization_schedule`).



## OpenAPI

````yaml /openapi/legado.json post /api/calculadoras/superendividamento
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/superendividamento:
    post:
      tags:
        - Calculadoras
      summary: Calcula o plano de pagamento no superendividamento
      description: >-
        Monta um plano de pagamento das dívidas do devedor conforme a Lei do
        Superendividamento, respeitando o mínimo existencial. Informe as dívidas
        (`debts`), o prazo e a carência do plano, o sistema de amortização
        (`price` ou `sac`), a taxa de juros e o mínimo existencial
        (`minimum_living_income`). A resposta traz o resumo do plano
        (`summary`), o rateio das parcelas por credor
        (`installments_by_creditor`) e o cronograma consolidado
        (`amortization_schedule`).
      operationId: CalculatorsController_superendividamento[0]
      parameters: []
      requestBody:
        required: true
        description: Payload da calculadora de superendividamento.
        content:
          application/json:
            schema:
              type: object
              description: >-
                Payload do cálculo de superendividamento. Informe as dívidas a
                renegociar, os parâmetros do plano (prazo, carência, juros e
                sistema de amortização) e o mínimo existencial; a resposta traz
                o resumo do plano, o rateio das parcelas por credor e o
                cronograma consolidado de amortização.
              required:
                - planning_start_date
                - number_of_months
                - grace_period
                - debts
                - amortization_type
                - interest_rate
                - minimum_living_income
              properties:
                name:
                  type: string
                  description: Nome do cálculo. Opcional; não afeta o resultado.
                planning_start_date:
                  type: string
                  format: date
                  description: Data de início do planejamento (`YYYY-MM-DD`).
                number_of_months:
                  type: number
                  description: Quantidade de meses do plano (inteiro positivo).
                grace_period:
                  type: number
                  description: Período de carência, em dias (`0..180`).
                debts:
                  type: array
                  description: Dívidas a renegociar. Deve conter **pelo menos um** item.
                  items:
                    type: object
                    description: Dívida a renegociar no plano.
                    required:
                      - item_id
                      - creditor
                      - amount
                    properties:
                      item_id:
                        type: number
                        description: Identificador da dívida (inteiro `>= 0`).
                      creditor:
                        type: string
                        description: Nome do credor (mínimo 1 caractere).
                      description:
                        type: string
                        description: Descrição da dívida. Opcional.
                      amount:
                        type: number
                        description: Valor total da dívida (positivo).
                      amount_installment:
                        type: number
                        description: >-
                          Valor da parcela atual da dívida, se houver. Opcional
                          (`>= 0`).
                amortization_type:
                  type: string
                  enum:
                    - price
                    - sac
                  description: Sistema de amortização aplicado ao plano.
                interest_rate:
                  type: number
                  description: Juros mensal (%) aplicado ao plano (`>= 0`).
                minimum_living_income:
                  type: object
                  description: >-
                    Parâmetros do mínimo existencial usados para limitar o valor
                    da parcela.
                  required:
                    - total_income
                    - percentage_minimum_living
                  properties:
                    total_income:
                      type: number
                      description: Renda total do devedor (positivo).
                    percentage_minimum_living:
                      type: number
                      description: >-
                        Percentual da renda reservado ao mínimo existencial
                        (positivo).
                    total_installment_value:
                      type: number
                      description: >-
                        Valor total já comprometido com parcelas. Opcional (`>=
                        0`).
                    percentage_installment_value:
                      type: number
                      description: >-
                        Percentual da renda já comprometido com parcelas.
                        Opcional (`>= 0`).
            examples:
              superendividamento:
                summary: Plano de pagamento (tabela Price)
                value:
                  name: Plano de superendividamento - exemplo
                  planning_start_date: '2024-09-20'
                  number_of_months: 10
                  grace_period: 0
                  amortization_type: price
                  interest_rate: 10
                  debts:
                    - item_id: 1
                      creditor: Credor A
                      description: Cartão de crédito
                      amount: 3000
                    - item_id: 2
                      creditor: Credor B
                      description: Empréstimo pessoal
                      amount: 2000
                  minimum_living_income:
                    total_income: 5000
                    percentage_minimum_living: 50
      responses:
        '200':
          description: Resultado do plano, com resumo, rateio por credor e cronograma.
          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/superendividamento
                  result:
                    summary:
                      outstanding_balance: 5000
                      total_interest_paid: 3137.29
                      total_paid: 8137.3
                      grace_period: 0
                      interest_rate: 10
                      number_of_months: 10
                      installment_fixed_value: 813.73
                      outstanding_balance_remaining: 0
                      plan_status: possible
                    installments_by_creditor:
                      - name: Credor A
                        description: Cartão de crédito
                        payment_amount: 488.24
                        outstanding_balance: 3000
                        total_interest_paid: 1882.38
                        total_paid: 4882.4
                        outstanding_balance_remaining: 0
                        installments:
                          - number: 0
                            due_date: '2024-08-20'
                            amortization: 0
                            interest: 0
                            payment_amount: 0
                            outstanding_balance: 3000
                            monthly_interest_rate: 0.1
                          - number: 1
                            due_date: '2024-09-20'
                            amortization: 188.24
                            interest: 300
                            payment_amount: 488.24
                            outstanding_balance: 2811.76
                            monthly_interest_rate: 0.1
                          - number: 2
                            due_date: '2024-10-20'
                            amortization: 207.06
                            interest: 281.18
                            payment_amount: 488.24
                            outstanding_balance: 2604.7
                            monthly_interest_rate: 0.1
                          - number: 3
                            due_date: '2024-11-20'
                            amortization: 227.77
                            interest: 260.47
                            payment_amount: 488.24
                            outstanding_balance: 2376.94
                            monthly_interest_rate: 0.1
                          - number: 4
                            due_date: '2024-12-20'
                            amortization: 250.54
                            interest: 237.7
                            payment_amount: 488.24
                            outstanding_balance: 2126.39
                            monthly_interest_rate: 0.1
                          - number: 5
                            due_date: '2025-01-20'
                            amortization: 275.6
                            interest: 212.64
                            payment_amount: 488.24
                            outstanding_balance: 1850.8
                            monthly_interest_rate: 0.1
                          - number: 6
                            due_date: '2025-02-20'
                            amortization: 303.16
                            interest: 185.08
                            payment_amount: 488.24
                            outstanding_balance: 1547.65
                            monthly_interest_rate: 0.1
                          - number: 7
                            due_date: '2025-03-20'
                            amortization: 333.47
                            interest: 154.76
                            payment_amount: 488.24
                            outstanding_balance: 1214.17
                            monthly_interest_rate: 0.1
                          - number: 8
                            due_date: '2025-04-20'
                            amortization: 366.82
                            interest: 121.42
                            payment_amount: 488.24
                            outstanding_balance: 847.35
                            monthly_interest_rate: 0.1
                          - number: 9
                            due_date: '2025-05-20'
                            amortization: 403.5
                            interest: 84.74
                            payment_amount: 488.24
                            outstanding_balance: 443.85
                            monthly_interest_rate: 0.1
                          - number: 10
                            due_date: '2025-06-20'
                            amortization: 443.85
                            interest: 44.39
                            payment_amount: 488.24
                            outstanding_balance: 0
                            monthly_interest_rate: 0.1
                      - name: Credor B
                        description: Empréstimo pessoal
                        payment_amount: 325.49
                        outstanding_balance: 2000
                        total_interest_paid: 1254.91
                        total_paid: 3254.9
                        outstanding_balance_remaining: 0
                        installments:
                          - number: 0
                            due_date: '2024-08-20'
                            amortization: 0
                            interest: 0
                            payment_amount: 0
                            outstanding_balance: 2000
                            monthly_interest_rate: 0.1
                          - number: 1
                            due_date: '2024-09-20'
                            amortization: 125.49
                            interest: 200
                            payment_amount: 325.49
                            outstanding_balance: 1874.51
                            monthly_interest_rate: 0.1
                          - number: 2
                            due_date: '2024-10-20'
                            amortization: 138.04
                            interest: 187.45
                            payment_amount: 325.49
                            outstanding_balance: 1736.47
                            monthly_interest_rate: 0.1
                          - number: 3
                            due_date: '2024-11-20'
                            amortization: 151.84
                            interest: 173.65
                            payment_amount: 325.49
                            outstanding_balance: 1584.62
                            monthly_interest_rate: 0.1
                          - number: 4
                            due_date: '2024-12-20'
                            amortization: 167.03
                            interest: 158.46
                            payment_amount: 325.49
                            outstanding_balance: 1417.6
                            monthly_interest_rate: 0.1
                          - number: 5
                            due_date: '2025-01-20'
                            amortization: 183.73
                            interest: 141.76
                            payment_amount: 325.49
                            outstanding_balance: 1233.87
                            monthly_interest_rate: 0.1
                          - number: 6
                            due_date: '2025-02-20'
                            amortization: 202.1
                            interest: 123.39
                            payment_amount: 325.49
                            outstanding_balance: 1031.76
                            monthly_interest_rate: 0.1
                          - number: 7
                            due_date: '2025-03-20'
                            amortization: 222.32
                            interest: 103.18
                            payment_amount: 325.49
                            outstanding_balance: 809.45
                            monthly_interest_rate: 0.1
                          - number: 8
                            due_date: '2025-04-20'
                            amortization: 244.55
                            interest: 80.94
                            payment_amount: 325.49
                            outstanding_balance: 564.9
                            monthly_interest_rate: 0.1
                          - number: 9
                            due_date: '2025-05-20'
                            amortization: 269
                            interest: 56.49
                            payment_amount: 325.49
                            outstanding_balance: 295.9
                            monthly_interest_rate: 0.1
                          - number: 10
                            due_date: '2025-06-20'
                            amortization: 295.9
                            interest: 29.59
                            payment_amount: 325.49
                            outstanding_balance: 0
                            monthly_interest_rate: 0.1
                    amortization_schedule:
                      total_interest_paid: 3137.29
                      total_paid: 8137.3
                      installments:
                        - number: 0
                          due_date: '2024-08-20'
                          payment_amount: 0
                          interest: 0
                          amortization: 0
                          outstanding_balance: 5000
                          monthly_interest_rate: 0.1
                        - number: 1
                          due_date: '2024-09-20'
                          payment_amount: 813.73
                          interest: 500
                          amortization: 313.73
                          outstanding_balance: 4686.27
                          monthly_interest_rate: 0.1
                        - number: 2
                          due_date: '2024-10-20'
                          payment_amount: 813.73
                          interest: 468.63
                          amortization: 345.1
                          outstanding_balance: 4341.17
                          monthly_interest_rate: 0.1
                        - number: 3
                          due_date: '2024-11-20'
                          payment_amount: 813.73
                          interest: 434.12
                          amortization: 379.61
                          outstanding_balance: 3961.56
                          monthly_interest_rate: 0.1
                        - number: 4
                          due_date: '2024-12-20'
                          payment_amount: 813.73
                          interest: 396.16
                          amortization: 417.57
                          outstanding_balance: 3543.99
                          monthly_interest_rate: 0.1
                        - number: 5
                          due_date: '2025-01-20'
                          payment_amount: 813.73
                          interest: 354.4
                          amortization: 459.33
                          outstanding_balance: 3084.67
                          monthly_interest_rate: 0.1
                        - number: 6
                          due_date: '2025-02-20'
                          payment_amount: 813.73
                          interest: 308.47
                          amortization: 505.26
                          outstanding_balance: 2579.41
                          monthly_interest_rate: 0.1
                        - number: 7
                          due_date: '2025-03-20'
                          payment_amount: 813.73
                          interest: 257.94
                          amortization: 555.79
                          outstanding_balance: 2023.62
                          monthly_interest_rate: 0.1
                        - number: 8
                          due_date: '2025-04-20'
                          payment_amount: 813.73
                          interest: 202.36
                          amortization: 611.37
                          outstanding_balance: 1412.25
                          monthly_interest_rate: 0.1
                        - number: 9
                          due_date: '2025-05-20'
                          payment_amount: 813.73
                          interest: 141.23
                          amortization: 672.5
                          outstanding_balance: 739.75
                          monthly_interest_rate: 0.1
                        - number: 10
                          due_date: '2025-06-20'
                          payment_amount: 813.73
                          interest: 73.98
                          amortization: 739.75
                          outstanding_balance: 0
                          monthly_interest_rate: 0.1
        '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/superendividamento
        '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/superendividamento
        '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/superendividamento
      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.