Pular para o conteúdo principal

CollectionReceivablesV2Response

Lista paginada dos recebíveis vinculados a uma cobrança.

collectionIdstring<uuid>obrigatório

Identificador da cobrança.

Exemplo 11111111-1111-4111-8111-111111111111
receivables object[]obrigatório

Recebíveis materializados para a cobrança.

  • Lista [
  • receivableIdstringobrigatório

    Chave única do recebível dentro da cobrança.

    Exemplo 43151964000143|12345678000190|VCD|2036-04-23
    acquirerTaxIdstring

    CNPJ da adquirente.

    Exemplo 12345678000190
    paymentSchemestring

    Código do arranjo de pagamento.

    Exemplo VCD
    settlementDatestring<date>

    Data de liquidação do recebível.

    Exemplo 2036-04-23
    amountnumber<double>obrigatório

    Valor corrente considerado na cobrança.

    Exemplo 1500
    statusstringobrigatório

    Situação do recebível dentro da cobrança.

    Valores possíveis: [COMMITTED, INACTIVE]

    Exemplo COMMITTED
  • ]
  • pagination objectobrigatório

    Paginação por posição usada nas consultas de cobrança.

    currentIteminteger<int32>obrigatório

    Posição inicial da página atual.

    Exemplo 0
    limitinteger<int32>obrigatório

    Quantidade máxima de itens por página.

    Exemplo 30
    nextIteminteger<int32>

    Posição inicial da próxima página.

    Exemplo 30
    totalItemsinteger<int32>obrigatório

    Total de recebíveis vinculados à cobrança.

    Exemplo 1
    CollectionReceivablesV2Response
    {
    "collectionId": "11111111-1111-4111-8111-111111111111",
    "receivables": [
    {
    "receivableId": "43151964000143|12345678000190|VCD|2036-04-23",
    "acquirerTaxId": "12345678000190",
    "paymentScheme": "VCD",
    "settlementDate": "2036-04-23",
    "amount": 1500,
    "status": "COMMITTED"
    }
    ],
    "pagination": {
    "currentItem": 0,
    "limit": 30,
    "nextItem": 30,
    "totalItems": 1
    }
    }