CHcheckout
Reports

Get all reports

Returns the list of reports and their details.

get/reports

Request

Query parameters

created_afterstring date-time
Example:2025-02-17T00:00:00.0000000+00:00

Filters reports to those created on or after the specified timestamp, in UTC. <br/>Format – ISO 8601 code

created_beforestring date-time
Example:2025-02-19T00:00:00.0000000+00:00

Filters reports to those created before the specified timestamp, in UTC. <br/>Format – ISO 8601 code

entity_idstring
Example:ent_znj4ih5kn4fuxiaquoudv5mvwy

Filters reports to those created for the specified entity. <br/>Sub-entity IDs are not supported.

limitinteger
Example:5

The number of results you want to include per page. </br> For example, if there are 50 results and you set limit=10, you receive 5 pages each containing 10 results.

pagination_tokenstring

A token used to paginate multiple pages of results.

Response

Reports retrieved successfully

countinteger

The total number of reports on the current page.

limitinteger

The maximum number of results included per page.

Example response

{
  "count": 1,
  "limit": 5,
  "data": [
    {
      "id": "rpt_lmmldzousk7etoqijqundqexa4",
      "created_on": "2022-02-18T13:00:12.3570000+00:00",
      "last_modified_on": "2022-02-18T13:16:12.3570000+00:00",
      "description": "Reconciliation Report for X.",
      "account": {
        "client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
        "entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
      },
      "tags": [
        "payout_id:pay_123456789"
      ],
      "from": "2022-02-17T12:00:00.0000000+00:00",
      "to": "2022-02-18T12:00:00.0000000+00:00",
      "files": [
        {
          "id": "file_7ysmgfkj4ipunduud22uf73iey",
          "filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20220218_000000001drl_1.csv",
          "format": "CSV"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.