Pular para o conteúdo principal

CollateralizedCreditSummaryResponse

Resumo consolidado de contratos de crédito com garantia

totalContractsinteger<int32>

Total de contratos no recorte

Exemplo 55
requestedAmountnumber<double>

Valor solicitado total

Exemplo 800000
effectivelyEncumberedAmountnumber<double>aceita valor nulo

Valor efetivamente onerado total

Exemplo 600000
statuses object[]

Totais agrupados por status

  • Lista [
    • statusstring

    Status do contrato

    Valores possíveis: [CREATED, CREATION_PENDING, CREATION_FAILED, DELETION_PENDING, DELETION_FAILED, DELETED]

    Exemplo CREATED
    contractsinteger<int32>

    Quantidade de contratos no status

    Exemplo 20
    requestedAmountnumber<double>

    Valor solicitado

    Exemplo 2400
    effectivelyEncumberedAmountnumber<double>aceita valor nulo

    Valor efetivamente onerado

    Exemplo 2100
  • ]
    • links object[]

    Links de navegação da API

  • Lista [
    • relstring

    Relação do link com o recurso atual

    Exemplo self
    methodstring

    Método HTTP do link

    Exemplo GET
    hrefstring

    Caminho relativo do recurso

    Exemplo /api/v2/companies
    descriptionstring

    Explicação em português do que este link permite fazer

    Exemplo Cadastre a empresa para o cliente
  • ]
    • CollateralizedCreditSummaryResponse
    {
      "totalContracts": 55,
      "requestedAmount": 800000,
      "effectivelyEncumberedAmount": 600000,
      "statuses": [
        {
          "status": "CREATED",
          "contracts": 20,
          "requestedAmount": 2400,
          "effectivelyEncumberedAmount": 2100
        }
      ],
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }