Buscar Proposta

Retorna os detalhes completos de uma proposta específica, incluindo todos os dados financeiros, status e referência à simulação original.

Parâmetros

Parâmetro	Local	Tipo	Descrição
id	path	integer	ID da proposta

Buscar Proposta

get

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

/api/v1/originator/proposals/{id}

Busca uma proposta por ID

Autorizações

BearerAuth

AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota

idinteger · int64Obrigatório

ID da proposta

Respostas

200

Proposta retornada com sucesso

application/json

idinteger · int64OpcionalExample: 23

publicIdstringOpcional

Identificador público (16 caracteres Base64 URL-safe). Ex. Kj8mP2xQ9nR4sT6v

Example: Kj8mP2xQ9nR4sT6v

employeeIdinteger · int64OpcionalExample: 15

simulationIdinteger · int64OpcionalExample: 42

loanAmountnumber · decimalOpcional

Valor do empréstimo em reais (decimal com 2 casas decimais).

Example: 5750

financedAmountnumber · decimalOpcional

Valor financiado em reais (decimal com 2 casas decimais).

Example: 5935.64

totalInterestAmountnumber · decimalOpcional

Juros totais em reais (decimal com 2 casas decimais).

Example: 1189.72

monthlyInterestRatenumber · decimalOpcional

Taxa mensal em percentual (decimal com 4 casas decimais).

Example: 1.97

monthlyEffectiveCostnumber · decimalOpcional

CET mensal em percentual (decimal com 4 casas decimais).

Example: 2.43

annualEffectiveCostnumber · decimalOpcional

CET anual em percentual (decimal com 4 casas decimais).

Example: 33.18

disbursementAmountnumber · decimalOpcional

Valor a desembolsar em reais (decimal com 2 casas decimais).

Example: 5627.78

insuranceAmountnumber · decimalOpcional

Seguro em reais (decimal com 2 casas decimais).

Example: 87.3

iofAmountnumber · decimalOpcional

IOF em reais (decimal com 2 casas decimais).

Example: 63.42

tacAmountnumber · decimalOpcional

TAC em reais (decimal com 2 casas decimais).

Example: 34.92

outstandingBalancenumber · decimalOpcional

Saldo devedor em reais (decimal com 2 casas decimais).

Example: 7125.36

installmentCountintegerOpcionalExample: 12

dueDatestring · dateOpcionalExample: 2024-04-25

statusstring · enumOpcional

Status da proposta.

Valor	Significado
PENDING	Aguardando aceite do trabalhador
ACCEPTED	Aceita pelo trabalhador
REJECTED	Rejeitada pelo trabalhador
EXPIRED	Expirada (prazo de aceite)
CONVERTED_TO_CONTRACT	Convertida em contrato

Example: PENDINGValores possíveis:

expiresAtstring · date-timeOpcionalExample: 2024-02-08T10:00:00Z

acceptedAtstring · date-timeOpcional

createdDatestring · date-timeOpcionalExample: 2024-02-01T10:00:00Z

401

Não autenticado

403

Permissão insuficiente

404

Proposta não encontrada

get

/api/v1/originator/proposals/{id}

HTTPcURLJavaScriptPython

GET /api/v1/originator/proposals/{id} HTTP/1.1
Host: consignado.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 23,
  "publicId": "Kj8mP2xQ9nR4sT6v",
  "employeeId": 15,
  "simulationId": 42,
  "loanAmount": 5750,
  "financedAmount": 5935.64,
  "totalInterestAmount": 1189.72,
  "monthlyInterestRate": 1.97,
  "monthlyEffectiveCost": 2.43,
  "annualEffectiveCost": 33.18,
  "disbursementAmount": 5627.78,
  "insuranceAmount": 87.3,
  "iofAmount": 63.42,
  "tacAmount": 34.92,
  "outstandingBalance": 7125.36,
  "installmentCount": 12,
  "dueDate": "2024-04-25",
  "status": "PENDING",
  "expiresAt": "2024-02-08T10:00:00Z",
  "installments": [
    {
      "number": 1,
      "amount": 593.78,
      "dueDate": "2024-04-25"
    }
  ],
  "createdDate": "2024-02-01T10:00:00Z"
}

Central de Atendimento | Giro.TechGiro.Tech