v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Operation

Consultar uma operação cadastrada

Esta rota serve para consultar uma operação utilizando o 'operationId' retornado na sua criação.

get/operations/{operationId}

Path parameters

operationIdinteger required

Id da operação

Id da operação

Response

Sucesso

idinteger

Id da operação

companyIdentificationstring

CNPJ/CPF da empresa com quem foi realizada a operação

companyNamestring

Nome da empresa com quem foi realizada a operação

createdAtstring date-time

Data de criação da operação

totalMaturityAmountnumber

Valor de vencimento total da operação

totalDisbursementAmountnumber

Valor de desembolso total da operação

operationStatus'Pending' | 'PartiallyCanceled' | 'Canceled' | 'WaitingContractSignature' | 'PartiallySigned' | 'WaitingSolicitation' | 'InDisbursement' | 'PartiallyDisbursed' | 'PartiallyDisbursedWithSomeCancels' | 'DisbursedWithSomeCancels' | 'Completed' | 'PartiallySettled' | 'PartiallySettledWithSomeCancels' | 'Settled' | 'Unsettled' | 'UnsettledWithSomeCancels'

Status da operação


Definições:

  • Pending - Operação pendente de processamento (status transitório)
  • PartiallyCanceled - Operação parcialmente cancelada (status transitório)
  • Canceled - Operação cancelada
  • WaitingContractSignature - Operação aguardando assinatura do contrato
  • PartiallySigned - Operação parcialmente assinada (status transitório)
  • WaitingSolicitation - Operação em processamento (status transitório)
  • InDisbursement - Operação em desembolso (status transitório)
  • PartiallyDisbursed - Operação parcialmente desembolsada (status transitório)
  • PartiallyDisbursedWithSomeCancels - Operação parcialmente desembolsada com alguns cancelamentos (status transitório)
  • DisbursedWithSomeCancels - Operação desembolsada com alguns cancelamentos
  • Completed - Operação desembolsada
  • PartiallySettled - Operação parcialmente liquidada
  • PartiallySettledWithSomeCancels - Operação parcialmente liquidada com alguns cancelamentos
  • Settled - Operação liquidada
  • Unsettled - Operação com liquidação em atraso
  • UnsettledWithSomeCancels - Operação com liquidação em atraso e alguns cancelamentos

Example response

{
  "operationStatus": "Pending"
}