> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/simulacoes/criar-simulacao-por-parcela.md).

# Criar Simulação por Parcela

Simulação reversa: você informa a parcela desejada (`targetInstallmentAmount`) e recebe o valor máximo de empréstimo para o vínculo.

{% hint style="warning" %}
**`feesAmount` está deprecated** e será removido: use `tacAmount` + `insuranceAmount`. Até lá, a requisição aceita os novos campos ou só `feesAmount`, e a resposta traz os três.
{% endhint %}

## Request

`POST /api/v1/originator/employees/{publicId}/simulations/by-installment`

Autenticação: `Authorization: Bearer {originatorToken}`.

### Parâmetros

| Parâmetro  | Local | Tipo     | Obrigatório | Descrição                         |
| ---------- | ----- | -------- | ----------- | --------------------------------- |
| `publicId` | path  | `string` | Sim         | Identificador público do employee |

### Corpo

Igual ao da [simulação padrão](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/simulacoes/criar-simulacao.md), com `targetInstallmentAmount` no lugar de `loanAmount`.

| Campo                            | Tipo            | Obrigatório | Descrição                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| -------------------------------- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `employmentRelationshipPublicId` | `string (uuid)` | Sim         | ID do vínculo empregatício do trabalhador                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `targetInstallmentAmount`        | `decimal`       | Sim         | Valor de parcela desejado em reais (>= 0.01)                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `installmentCount`               | `integer`       | Sim         | Número de parcelas (1–99)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `monthlyInterestRate`            | `decimal`       | Sim         | Taxa de juros mensal em percentual (>= 0.01)                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `loanDate`                       | `string` (date) | Sim         | Data do empréstimo (`YYYY-MM-DD`). Não pode ser no passado.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `firstDueDate`                   | `string` (date) | Não         | Data do primeiro vencimento, sempre no dia 28. `null` para cálculo automático (ver regra abaixo). Não pode ser no passado.                                                                                                                                                                                                                                                                                                                                                                                  |
| `tacAmount`                      | `decimal`       | Não         | Taxa de Abertura de Crédito. Deve ser `0` (padrão quando omitido); valor positivo dá `400` (`TAC_NOT_ALLOWED`).                                                                                                                                                                                                                                                                                                                                                                                             |
| `insuranceAmount`                | `decimal`       | Não         | Seguro prestamista (>= 0). Omitido ou `null`: usa a configuração do originador, ou zero.                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `feesAmount`                     | `decimal`       | Não         | **Deprecated — use `tacAmount` + `insuranceAmount`.** Quando enviado isoladamente, é tratado como `insuranceAmount` (com `tacAmount = 0`).                                                                                                                                                                                                                                                                                                                                                                  |
| `iofFinanced`                    | `boolean`       | Não         | IOF financiado. Omitido: configuração do originador.                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `feesFinanced`                   | `boolean`       | Não         | Tarifas (TAC + seguro) financiadas. Omitido: configuração do originador.                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `maxEffectiveCostSpread`         | `decimal`       | Não         | Teto de CET relativo à taxa contratada, **em pontos percentuais** — mesma forma do `monthlyInterestRate` (`1.0` = CET mensal máxima de taxa + 1 p.p.; faixa 0.01–100). O campo é **aceito** na simulação por parcela, mas o teto **não é aplicado nem verificado**: a plataforma não isenta dias de juros de carência por causa dele. O único efeito observável de enviá-lo é a resposta vir com `effectiveCostWithinLimit` = `null` (explícito no JSON). Omitido, `effectiveCostWithinLimit` volta `true`. |

O vencimento automático segue a mesma [regra da simulação padrão](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/simulacoes/criar-simulacao.md#regra-de-vencimento-automatico).

## Response

Mesmo formato da [simulação padrão](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/simulacoes/criar-simulacao.md#response). A diferença: `requestedAmount` é o valor máximo de empréstimo encontrado para a parcela alvo.

`201 Created`.

## Exemplo

```http
POST /api/v1/originator/employees/Kj8mP2xQ9nR4sT6v/simulations/by-installment HTTP/1.1
Host: api.giro.tech
Authorization: Bearer {originatorToken}
Content-Type: application/json

{
  "employmentRelationshipPublicId": "0198f2a1-7c3e-7b2d-9f14-3a5c8e6d1b02",
  "targetInstallmentAmount": 250.00,
  "installmentCount": 12,
  "monthlyInterestRate": 1.99,
  "loanDate": "2027-01-04",
  "firstDueDate": "2027-03-28",
  "tacAmount": 0,
  "insuranceAmount": 50.00,
  "iofFinanced": true,
  "feesFinanced": true
}
```

A resposta completa, com os valores calculados, está no exemplo do bloco de referência no fim da página.

## Próximo passo

[Criar Proposta](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/propostas/criar-proposta.md) com o `publicId` retornado como `simulationPublicId`. Sem simulação, o `firstDueDate` vira o `dueDate` da proposta.

## Erros

| Código        | `errorCode`                         | Situação                                                                                                                                                      |
| ------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400           | —                                   | Payload inválido (`properties.errors`): campo ausente/inválido, data no passado. Informe exatamente um identificador de vínculo                               |
| 400           | —                                   | JSON malformado, data ou UUID inválidos (`type: about:blank`)                                                                                                 |
| 400           | `TAC_NOT_ALLOWED`                   | `tacAmount` diferente de 0 (positivo ou negativo)                                                                                                             |
| 400           | —                                   | `Vínculo empregatício não encontrado: <id>` — vínculo inexistente ou de outro employee                                                                        |
| 400           | —                                   | `Simulação reversa não convergiu para o valor de parcela informado.` — ajuste a parcela ou o prazo                                                            |
| 400           | —                                   | Primeiro vencimento fora do dia 28 ou antes do mínimo do calendário Dataprev; financiado abaixo do piso de Valor Presente; margem do vínculo não consultada   |
| 400           | —                                   | Parcela acima da margem: `title: Elegibility Violation`, `properties.violations[].code` = `MARGIN_EXCEEDED`                                                   |
| 404           | —                                   | Employee não encontrado ou de outro originador                                                                                                                |
| 429           | —                                   | Mais de 100 requisições por segundo                                                                                                                           |
| 4xx repassado | `LOAN_SIMULATOR_ERROR`              | O simulador de crédito recusou o cálculo, com o status devolvido por ele (`502` se o status não for reconhecido; `500` se a resposta vier vazia)              |
| 503           | `SERVICE_UNAVAILABLE_LOANSIMULATOR` | Simulador de crédito indisponível. Reenvie com uma **nova** `Idempotency-Key`: com a mesma chave, a resposta guardada (este mesmo erro) é repetida por 7 dias |

Erros comuns a todos os endpoints — `401`, `403` de token, `409` de `Idempotency-Key` em processamento, `500` e `503` — e o formato `ProblemDetail` estão em [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.md).

## Criar Simulação por Parcela (Reversa)

> Cria uma simulação reversa: dado um valor de parcela desejado (\`targetInstallmentAmount\`),\
> o sistema encontra o valor máximo de empréstimo que o trabalhador pode obter.\
> Utiliza convergência numérica iterativa. O primeiro vencimento segue a mesma regra\
> do calendário Dataprev descrita em "Criar Simulação".<br>

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Simulations","description":"Simulações de empréstimo"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/employees/{publicId}/simulations/by-installment":{"post":{"summary":"Criar Simulação por Parcela (Reversa)","description":"Cria uma simulação reversa: dado um valor de parcela desejado (`targetInstallmentAmount`),\no sistema encontra o valor máximo de empréstimo que o trabalhador pode obter.\nUtiliza convergência numérica iterativa. O primeiro vencimento segue a mesma regra\ndo calendário Dataprev descrita em \"Criar Simulação\".\n","tags":["Simulations"],"parameters":[{"name":"publicId","in":"path","required":true,"description":"Identificador público do employee (16 caracteres)","schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255},"description":"Chave de idempotência para evitar duplicação em retentativas.\nSe fornecida, o servidor retornará a mesma resposta para chamadas\ncom a mesma chave do mesmo originador.\nA chave é retida por 7 dias. Depois desse prazo ela é expurgada e uma\nrequisição com a mesma chave é tratada como nova, sendo reprocessada.\n"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["targetInstallmentAmount","installmentCount","monthlyInterestRate","loanDate"],"properties":{"employmentRelationshipPublicId":{"type":"string","format":"uuid","description":"Identificador público opaco do vínculo empregatício."},"targetInstallmentAmount":{"type":"number","format":"decimal","minimum":0.01,"description":"Valor de parcela desejado em reais (decimal com 2 casas decimais). O sistema encontra o valor máximo de empréstimo que produz essa parcela."},"installmentCount":{"type":"integer","minimum":1,"description":"Quantidade de parcelas desejada para pagamento do empréstimo."},"monthlyInterestRate":{"type":"number","format":"decimal","minimum":0.01,"description":"Taxa de juros mensal nominal em percentual (decimal com 4 casas decimais). Ex. 4.0"},"loanDate":{"type":"string","format":"date","description":"Data base de contratação considerada para cálculo da operação. Não pode ser no passado."},"firstDueDate":{"type":"string","format":"date","nullable":true,"description":"Data do primeiro vencimento (sempre dia 28). Não pode ser no passado.\n- Se informado, deve seguir o calendário Dataprev.\n- Se `null` (ou omitido), o sistema aplica automaticamente o primeiro vencimento no dia 28 conforme o calendário Dataprev.\n"},"tacAmount":{"type":"number","format":"decimal","minimum":0,"nullable":true,"description":"Valor de TAC (Taxa de Abertura de Crédito) em reais. Para consignado privado deve ser sempre `0` ou omitido — o backend rejeita requisições com `tacAmount > 0` retornando `400` com `errorCode = TAC_NOT_ALLOWED`.\n"},"insuranceAmount":{"type":"number","format":"decimal","minimum":0,"nullable":true,"description":"Valor do seguro prestamista em reais. Quando omitido, o backend usa o `defaultInsuranceAmount` configurado no originador.\n"},"feesAmount":{"type":"number","format":"decimal","minimum":0,"nullable":true,"deprecated":true,"description":"**DEPRECATED** — use `tacAmount` + `insuranceAmount` separadamente. Mantido por 1 release para compatibilidade.\nQuando `tacAmount`/`insuranceAmount` não vêm e apenas `feesAmount` vem, o backend trata como `insuranceAmount=feesAmount, tacAmount=0`.\n"},"iofFinanced":{"type":"boolean","nullable":true,"default":true,"description":"Define se o IOF é financiado (embutido no valor financiado e diluído nas parcelas).\n- `true` (default): IOF financiado.\n- `false`: IOF não financiado. IOF descontado do desembolso.\n"},"feesFinanced":{"type":"boolean","nullable":true,"description":"Define se as tarifas (TAC + Seguro) é financiado (embutido no valor financiado e diluído nas parcelas).\n- `null` ou `true` (default): TAC financiado.\n- `false`: TAC não financiado. O custo das tarifas é descontado do desembolso.\nSobrepõe a configuração do originator se enviado explicitamente.\n"},"maxEffectiveCostSpread":{"type":"number","format":"decimal","minimum":0.01,"maximum":100,"nullable":true,"description":"Teto de CET relativo à taxa contratada, **em pontos percentuais** — mesma forma do `monthlyInterestRate`\n(ex.: `1.0` = CET mensal máxima de taxa + 1 p.p.). O campo é **aceito** na reversa, mas o teto\n**não é aplicado nem verificado** nesta operação: o simulador não isenta dias de juros de carência\npor causa dele.\nO único efeito observável de enviá-lo é a resposta vir com `effectiveCostWithinLimit` = `null`\n(teto não verificado). Quando omitido, `effectiveCostWithinLimit` volta `true`.\n"}}}}}},"responses":{"201":{"description":"Simulação reversa criada com sucesso","content":{"application/json":{"schema":{"type":"object","description":"Simulação criada para o vínculo do trabalhador.\n\nOs valores do exemplo são ilustrativos: mostram a forma e as relações entre os campos, não o resultado exato do cálculo. Correspondem ao request de exemplo (R$ 5.000,00 em 12x a 1,97% a.m., `loanDate` 2027-01-04, 1º vencimento 2027-03-28, IOF financiado, sem tarifas): `disbursementAmount` = `requestedAmount`, `financedAmount` = `requestedAmount` + `iofAmount`, `debitAmount` = soma das parcelas e `totalInterestAmount` = `debitAmount` − `financedAmount`. O array `installments` do exemplo mostra só a 1ª, a 2ª e a última parcela.\n","properties":{"publicId":{"type":"string","format":"uuid","nullable":true,"description":"Identificador público opaco da simulação. É este o valor a enviar em `simulationPublicId` na criação de proposta. Pode vir ausente em simulações antigas."},"employeePublicId":{"type":"string","description":"Identificador público do trabalhador (16 caracteres Base64 URL-safe)."},"employmentRelationshipPublicId":{"type":"string","format":"uuid","description":"Identificador público opaco do vínculo."},"requestedAmount":{"type":"number","format":"decimal","description":"Valor solicitado em reais (decimal com 2 casas decimais). Na simulação por parcela (reversa), é o\nvalor de empréstimo que o cálculo encontrou para a parcela pedida.\n"},"installmentCount":{"type":"integer","description":"Quantidade de parcelas calculada para a proposta simulada."},"monthlyInterestRate":{"type":"number","format":"decimal","description":"Taxa de juros mensal em percentual (decimal com 4 casas decimais)."},"termMonths":{"type":"integer","description":"Prazo total da operação em meses."},"installmentAmount":{"type":"number","format":"decimal","description":"Parcela mensal em reais (decimal com 2 casas decimais)."},"totalAmount":{"type":"number","format":"decimal","description":"(DEPRECATED) Valor total da operação em reais. Use `financedAmount` e demais campos detalhados.\n","deprecated":true},"disbursementAmount":{"type":"number","format":"decimal","description":"Valor desembolsado em reais (decimal com 2 casas decimais)."},"financedAmount":{"type":"number","format":"decimal","description":"Valor financiado em reais (decimal com 2 casas decimais)."},"outstandingBalance":{"type":"number","format":"decimal","description":"Saldo devedor em reais (decimal com 2 casas decimais)."},"totalInterestAmount":{"type":"number","format":"decimal","description":"Juros totais em reais (decimal com 2 casas decimais)."},"debitAmount":{"type":"number","format":"decimal","minimum":0,"description":"Total a pagar em reais (soma das parcelas, decimal com 2 casas decimais). A última parcela pode diferir das demais por arredondamento."},"firstDueDate":{"type":"string","format":"date","description":"Data do primeiro vencimento."},"lastDueDate":{"type":"string","format":"date","description":"Data do último vencimento."},"installments":{"type":"array","description":"Lista de parcelas da simulação com detalhamento por parcela.","items":{"type":"object","description":"Detalhamento de uma parcela da simulação.","properties":{"installmentNumber":{"type":"integer","description":"Número da parcela (1-based)."},"dueDate":{"type":"string","format":"date","description":"Data de vencimento da parcela."},"installmentAmount":{"type":"number","format":"decimal","description":"Valor total da parcela em reais."},"amortizationAmount":{"type":"number","format":"decimal","description":"Capital amortizado na parcela em reais."},"interestAmount":{"type":"number","format":"decimal","description":"Valor dos juros na parcela em reais."},"iofAmount":{"type":"number","format":"decimal","description":"IOF da parcela em reais."},"feesAmount":{"type":"number","format":"decimal","description":"Tarifas da parcela em reais."},"outstandingBalance":{"type":"number","format":"decimal","description":"Saldo devedor após a parcela em reais."},"daysToCompensate":{"type":"integer","description":"Dias a compensar para a parcela."}}}},"monthlyEffectiveCost":{"type":"number","format":"decimal","description":"CET mensal em percentual (decimal com 4 casas decimais)."},"annualEffectiveCost":{"type":"number","format":"decimal","description":"CET anual em percentual (decimal com 4 casas decimais)."},"iofAmount":{"type":"number","format":"decimal","description":"IOF estimado em reais (decimal com 2 casas decimais)."},"tacAmount":{"type":"number","format":"decimal","description":"TAC (Taxa de Abertura de Crédito) em reais. Para consignado privado, sempre `0`."},"insuranceAmount":{"type":"number","format":"decimal","description":"Seguro prestamista em reais. Snapshot do valor usado no cálculo da simulação."},"feesAmount":{"type":"number","format":"decimal","deprecated":true,"description":"**DEPRECATED** — soma computada de `tacAmount + insuranceAmount`. Use os campos separados.\nMantido por 1 release para compatibilidade com clients legados.\n"},"status":{"type":"string","enum":["EPHEMERAL","CONVERTED_TO_PROPOSAL","EXPIRED"],"description":"Situação da simulação no ciclo de originação.\n| Valor | Significado |\n|-------|-------------|\n| EPHEMERAL | Simulação ativa, ainda não convertida em proposta |\n| CONVERTED_TO_PROPOSAL | Simulação já convertida em proposta |\n| EXPIRED | Simulação expirada (prazo de validade ultrapassado) |\n"},"expiresAt":{"type":"string","format":"date-time","description":"Data e hora limite de validade da simulação (UTC)."},"source":{"type":"string","description":"Origem da simulação no sistema (por exemplo, ORIGINATOR)."},"iofFinanced":{"type":"boolean","description":"Indica se o IOF foi financiado na simulação."},"createdDate":{"type":"string","format":"date-time","description":"Data e hora de criação da simulação (UTC)."},"graceDaysCharged":{"type":"integer","format":"int64","nullable":true,"description":"Dias de juros de carência efetivamente cobrados pelo simulador."},"graceDaysWaived":{"type":"integer","format":"int64","nullable":true,"description":"Dias de juros de carência isentados pela convergência do teto de CET (0 sem teto)."},"effectiveCostWithinLimit":{"type":"boolean","nullable":true,"description":"Na simulação direta: `true` quando a CET mensal ficou dentro do teto solicitado (ou nenhum teto foi informado);\n`false` quando nem isentando toda a carência o teto foi atingido (best-effort).\nNa reversa (por parcela): o teto não é verificado. Vem `true` quando a requisição não trouxe `maxEffectiveCostSpread`;\nvem `null` quando trouxe — o campo é serializado como `null` **explícito** no JSON (não omitido).\n"}}}}}},"400":{"description":"Dados inválidos, corpo ilegível, regra de negócio ou parcela acima da margem.","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Employee não encontrado ou de outro originador.","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"409":{"description":"Mesma `Idempotency-Key` ainda em processamento; tente de novo depois","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"429":{"description":"Mais de 100 requisições por segundo. Aguarde o header `Retry-After` e reenvie com **nova** `Idempotency-Key` — com a mesma chave, o `429` gravado é repetido.","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"502":{"description":"Status não reconhecido do motor de cálculo (`errorCode` LOAN_SIMULATOR_ERROR)","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"503":{"description":"Simulador de crédito indisponível. Reenvie com **nova** `Idempotency-Key`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"4XX":{"description":"Recusada pelo motor de cálculo, com o status dele (`errorCode` LOAN_SIMULATOR_ERROR)","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
