Criar Simulação

Cria uma nova simulação de empréstimo para um vínculo empregatício do trabalhador. O sistema calcula parcelas, juros, IOF, CET e valor líquido com base nos parâmetros informados.

Dados necessários

Campo	Tipo	Obrigatório	Descrição
employmentRelationshipId	integer	Sim	ID do vínculo empregatício do trabalhador
loanAmount	decimal	Sim	Valor do empréstimo solicitado
installmentCount	integer	Sim	Número de parcelas
monthlyInterestRate	decimal	Sim	Taxa de juros mensal (%)
loanDate	string	Sim	Data do empréstimo (YYYY-MM-DD)
firstDueDate	string	Não	Data do primeiro vencimento (dia 25, null para cálculo automático)
feesAmount	decimal	Sim	Valor de taxas adicionais (pode ser 0)

Regra de vencimento automático

Quando firstDueDate é null, o sistema calcula automaticamente:

• loanDate até dia 20 → primeiro vencimento = dia 25 do mês + 2

• loanDate a partir do dia 21 → primeiro vencimento = dia 25 do mês + 3

Próximo passo

Com a simulação criada, prossiga para Criar Proposta utilizando o simulationId retornado.

Criar Simulação

post

https://consignado.staging.giro.techhttps://consignado.giro.tech

/api/v1/originator/employees/{publicId}/simulations

Cria uma nova simulação de empréstimo para um vínculo empregatício do trabalhador. O primeiro vencimento segue o calendário Dataprev (sempre dia 25): até dia 20 do loanDate → +2 meses; dia 21 em diante → +3 meses. Se firstDueDate for enviado como null, o sistema aplica automaticamente essa regra. Se informado, deve respeitar o calendário e o dia 25.

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

publicIdstringObrigatório

Public ID do employee

Corpo

application/json

employmentRelationshipIdinteger · int64Obrigatório

Identificador do vínculo empregatício usado como base da simulação.

loanAmountnumber · decimal · mín: 0.01Obrigatório

Valor líquido solicitado em reais (decimal com 2 casas decimais). Ex. 5000.00

installmentCountinteger · mín: 1Obrigatório

Quantidade de parcelas desejada para pagamento do empréstimo.

monthlyInterestRatenumber · decimal · mín: 0.01Obrigatório

Taxa de juros mensal nominal em percentual (decimal com 4 casas decimais). Ex. 4.0

loanDatestring · dateObrigatório

Data base de contratação considerada para cálculo da operação.

firstDueDatestring · date · nuloOpcional

Data do primeiro vencimento (sempre dia 25).

• Se informado, deve seguir o calendário Dataprev: data mínima conforme competência (dia do loanDate até 20 → +2 meses; dia 21 em diante → +3 meses).
• Se null (ou omitido), o sistema aplica automaticamente o primeiro vencimento no dia 25 conforme o calendário Dataprev.

feesAmountnumber · decimalObrigatório

Valor total de tarifas em reais (decimal com 2 casas decimais). Ex. 0 ou 122.22

Respostas

201

Simulação criada com sucesso

application/json

400

Dados inválidos

401

Não autenticado

403

Permissão insuficiente

post

/api/v1/originator/employees/{publicId}/simulations

HTTPcURLJavaScriptPython

POST /api/v1/originator/employees/{publicId}/simulations HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "employmentRelationshipId": 1,
  "loanAmount": 5750,
  "installmentCount": 12,
  "monthlyInterestRate": 1.97,
  "loanDate": "2024-02-01",
  "firstDueDate": null,
  "feesAmount": 122.22
}

{
  "id": 42,
  "employeeId": 15,
  "employmentRelationshipId": 7,
  "requestedAmount": 5000,
  "installmentCount": 12,
  "monthlyInterestRate": 4,
  "termMonths": 12,
  "installmentAmount": 593.78,
  "totalAmount": 7125.36,
  "monthlyEffectiveCost": 2.43,
  "annualEffectiveCost": 33.18,
  "iofAmount": 63.42,
  "feesAmount": 0,
  "status": "EPHEMERAL",
  "expiresAt": "2025-01-16T10:00:00Z",
  "source": "ORIGINATOR",
  "createdDate": "2025-01-15T10:00:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech