---
title: "Get the list of all reports"
method: GET
path: "/reports"
tags: ["Reports"]
---

# Get the list of all reports

`GET /reports`

By passing in the appropriate options, you can search for reports in the system.

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `orderBy` string
- `orderCriteria` string
- `search` string

## Response `200`

search results matching criteria

- ReportsResponse
  - `totals` integer — Total number of reports. The total number of reports matching the search criteria, which can be larger than the number of elements in the array "reports" (which is upper bound by the "pageSize" parameter from the query request).
  - `reports` ReportRecord[]
    - `reportType` 'ABS_SETTLEMENT_RESPONSE_REPORT' | 'BBX_PARTNER_COMMISSION_REPORT' | 'DAILY_TRANSACTION_REPORT' | 'CUSTOM_PDSP_REPORT' | 'INTERCARD_COMMISSION_REPORT' | 'INTERCARD_INVOICE' | 'MERCHANT_SETTLEMENT_REPORT', required — The type of the report. |Value|Description| |--------|-----------| |ABS_SETTLEMENT_RESPONSE_REPORT|ABS settlement report (generated and returned by ABS during settlement as a ready-made file report)| |BBX_PARTNER_COMMISSION_REPORT|BBX commission report (generated by BBX as a ready-made file report)| |INTERCARD_COMMISSION_REPORT|InterCard commission report (generated by InterCard as a ready-made file report)| |DAILY_TRANSACTION_REPORT|The daily transactions report is generated for each payout to the clearing entity (which e.g. can be either a store, a merchant or even a franchisee level). The content therefore depends on the particular setup. <br/>Please see https://verifone.cloud/docs/in-store-payments/merchant-payout-reports#daily-transactions-report| |INTERCARD_INVOICE|InterCard invoice (generated by InterCard as a ready-made file report)| |MERCHANT_SETTLEMENT_REPORT|The merchant settlement report contains a total summary (TS) and summary (S) records for all payment types which contributed to a single payout to the merchant. <br/>Please see https://verifone.cloud/docs/in-store-payments/merchant-payout-reports#merchant-settlement-report|
    - `reportParameter` ReportParameters — List of parameters which were basis for the generation of this report.
      - `batchUUID` string, uuid — The unique identifier of the settlement batch this report is related to. Mapped to PDSP's `transaction.context.paymentContext.batchUUID`.
      - `settlementBatchFileNumber` string — The identifier of the settlement batch file this report is related to. Mapped to PDSP's `transaction.settlementContext.settlementBatchFileNumber`.
      - `correlationId` string, uuid — Correlation ID.
      - `clearingEntityUid` string, uuid — Clearing Entity UUID.
      - `clearingAccountUid` string, uuid — Clearing Account UUID.
      - `clearingDate` string, date-time — Date & Time.
      - `clearingMerchantName` string — Clearing merchant name.
      - `clearingUid` string, uuid — The clearing UUID.
      - `clearingBankAccount` string — The clearing bank account.
      - `bankingPartner` 'DESJARDINS' | 'IBC' | 'INTERCARD' — The name of the banking partners.
      - `clearingBankCode` string — The clearing bank code.
      - `clearingMerchantId` string — The clearing merchant ID.
      - `clearingReference` string — The clearing reference.
      - `generatedOn` string, date-time — The timestamp when the original report was created.
      - `invoicePeriodFrom` string, date — The start date of the invoicing period.
      - `invoicePeriodTo` string, date — The end date of the invoicing period.
      - `invoiceNumber` string — Invoice number.
      - `reportDescription` string — Description of the report.
      - `reportableDay` string, date — The date the report was generated for.
    - `mimeType` 'application/pdf' | 'text/csv' | 'text/plain', required — The MIME type of this report.
    - `reportEntityUid` string, uuid, required — The internally assigned identifier for the entity for which the report was generated.
    - `fileName` string, required — The filename of the report including extenstion (e.g. myfile.txt). Please note that the file extenstion is validated based on the mimeType indicated in the request and that the reportUid is concatenated to the filename (format: filename_reportUid.ext, e.g. myfile_cb941e2d-f446-413a-8c2b-28e26eb048fc.txt)
    - `reportUid` string, uuid — The unique identifier of that specific report.
    - `createdOn` string, date-time — The date and time the report was created.
    - `modifiedOn` string, date-time — The date and time the report was last modified.
    - `status` 'INITIATED' | 'INVALID_INPUT_PARAMETERS' | 'PROCESSING_STARTED' | 'FAILED' | 'SUCCESSFUL' — The status of the report will be in one of the following states.

## Other responses

- `400` — Bad Request. Unable to interpret the request.
- `401` — Unauthorized. Unable to authenticate client to allow request.
- `403` — Forbidden. This Feature is not enabled. This feature has not been authorised for the client.
- `404` — Not found. The requested resource does not exist.
- `429` — Too many requests. Too many requests from the client hit the API.
- `500` — Internal error. There was an error processing the request; try again later.
- `503` — Service Unavailable. Unable process requests at this time, please try again later.
- `504` — Service Unavailable. Unable process requests at this time, please try again later.

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)