Pular para o conteúdo principal

ListReports

Retorna uma lista de relatórios de monitoramento de pagamentos.

data object[]

Lista de relatórios de monitoramento de pagamentos.

  • Array [
  • idstring

    Identificador único do relatório.

    Example: fund_66ba1effec1df70e48dbd6d1-v1
    tenantstring

    Identificador do locatário (tenant).

    Example: trava-loans-dev_2025-02-07
    statusstring

    Status do relatório.

    Possible values: [PENDING, PROCESSING, COMPLETED, FAILED]

    Example: PROCESSING
    totalItemsWithErrorsinteger

    Quantidade total de itens com erro.

    Example: 5
    hasReportFileGeneratedboolean

    Indica se um arquivo de relatório foi gerado.

    Example: false
    hasNotifiedboolean

    Indica se a notificação foi enviada.

    Example: true
    totalAmountPaidfloat

    Valor total pago.

    Example: 109194.17
    hasPendenceWithoutActionAvailableboolean

    Indica se há pendências sem ações disponíveis.

    Example: false
    reportStatusstring

    Status do arquivo de relatório.

    Possible values: [GENERATED, NOT_GENERATED, ERROR]

    Example: GENERATED
    totalPaymentIntentItemsinteger

    Total de itens de intenção de pagamento.

    Example: 2
    processedPaymentIntentItemsinteger

    Total de itens de intenção de pagamento processados.

    Example: 2
    paymentIntentNonIntegrityItemsinteger

    Total de itens de intenção de pagamento com integridade comprometida.

    Example: 0
    totalInvoiceItemsintegernullable

    Total de faturas.

    Example: 10
    totalInvoiceintegernullable

    Total de faturas.

    Example: 10
    processedInvoiceintegernullable

    Total de faturas processadas.

    Example: 8
    invoiceNonIntegrityItemsintegernullable

    Total de faturas com integridade comprometida.

    Example: 1
    totalTransactionItemsintegernullable

    Total de transações.

    Example: 5001
    processedTransactionItemsintegernullable

    Total de transações processadas.

    Example: 4900
    transactionNonIntegrityItemsintegernullable

    Total de transações com integridade comprometida.

    Example: 10
    totalInstallmentItemsintegernullable

    Total de parcelas.

    Example: 5001
    processedInstallmentItemsintegernullable

    Total de parcelas processadas.

    Example: 5000
    installmentNonIntegrityItemsintegernullable

    Total de parcelas com integridade comprometida.

    Example: 1
    totalLoanItemsintegernullable

    Total de empréstimos.

    Example: 50
    processedLoanItemsintegernullable

    Total de empréstimos processados.

    Example: 48
    loanNonIntegrityItemsintegernullable

    Total de empréstimos com integridade comprometida.

    Example: 2
    totalRedistributionItemsintegernullable

    Total de redistribuições.

    Example: 3
    processedRedistributionItemsintegernullable

    Total de redistribuições processadas.

    Example: 2
    redistributionNonIntegrityItemsintegernullable

    Total de redistribuições com integridade comprometida.

    Example: 1
    createdAtdate-time

    Data de criação do relatório no formato ISO-8601.

    Example: 2025-02-07T11:30:48.924Z
    reportFileGeneratedbooleannullable

    Indica se o arquivo de relatório foi gerado.

    Example: false
    notifiedbooleannullable

    Indica se a notificação foi enviada.

    Example: false
    namestringnullable

    Nome do relatório.

    Example: BV
  • ]
  • ListReports
    {
    "data": [
    {
    "id": "fund_66ba1effec1df70e48dbd6d1-v1",
    "tenant": "trava-loans-dev_2025-02-07",
    "status": "PROCESSING",
    "totalItemsWithErrors": 5,
    "hasReportFileGenerated": false,
    "hasNotified": true,
    "totalAmountPaid": 109194.17,
    "hasPendenceWithoutActionAvailable": false,
    "reportStatus": "GENERATED",
    "totalPaymentIntentItems": 2,
    "processedPaymentIntentItems": 2,
    "paymentIntentNonIntegrityItems": 0,
    "totalInvoiceItems": 10,
    "totalInvoice": 10,
    "processedInvoice": 8,
    "invoiceNonIntegrityItems": 1,
    "totalTransactionItems": 5001,
    "processedTransactionItems": 4900,
    "transactionNonIntegrityItems": 10,
    "totalInstallmentItems": 5001,
    "processedInstallmentItems": 5000,
    "installmentNonIntegrityItems": 1,
    "totalLoanItems": 50,
    "processedLoanItems": 48,
    "loanNonIntegrityItems": 2,
    "totalRedistributionItems": 3,
    "processedRedistributionItems": 2,
    "redistributionNonIntegrityItems": 1,
    "createdAt": "2025-02-07T11:30:48.924Z",
    "reportFileGenerated": false,
    "notified": false,
    "name": "BV"
    }
    ]
    }