ReadMe_CollectionSummaryResponse

Resumo consolidado de contratos de cobrança

totalContractsinteger<int32>

Total de contratos no recorte

Exemplo 55

requestedAmountnumber<double>

Valor solicitado total

Exemplo 800000

statuses object[]

Totais agrupados por status

Lista [

statusstring

Status do contrato

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

Exemplo CREATED

contractsinteger<int32>

Quantidade de contratos no status

Exemplo 20

requestedAmountnumber<double>

Valor solicitado

Exemplo 2400

]

strategies object[]

Totais agrupados por estratégia de cobrança

Lista [

strategystringaceita valor nulo

Estratégia de cobrança. Pode ser nula para contratos sem estratégia registrada.

Valores possíveis: [TURBO, SELECTIVE, SELECTIVE_WITH_DEBIT, SNIPER, DYNAMIC]

Exemplo TURBO

contractsinteger<int32>

Quantidade de contratos na estratégia

Exemplo 20

requestedAmountnumber<double>

Valor solicitado

Exemplo 2400

]

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

]

ReadMe_CollectionSummaryResponse

{
  "totalContracts": 55,
  "requestedAmount": 800000,
  "statuses": [
    {
      "status": "CREATED",
      "contracts": 20,
      "requestedAmount": 2400
    }
  ],
  "strategies": [
    {
      "strategy": "TURBO",
      "contracts": 20,
      "requestedAmount": 2400
    }
  ],
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}