latestOpenAPI 3.0.12026-08-1032138.8 KB

e3d7945a88fd

Reconciliation reports

Generate a reconciliation report

Initiates the asynchronous generation of a financial reconciliation report for one or more properties within a specified date range.

The report is generated asynchronously. The response returns a request_id that you use to poll the report status endpoint until the status is READY, EMPTY, or ERROR. When ready, a pre-signed download_url and filename are returned for downloading the report. The download_url is valid for approximately 15 minutes (see download_url_expires_at). To obtain a new download URL after expiry, call this endpoint again to generate a new report. If status is EMPTY or ERROR, stop polling; no report is available for download.

Use the report filters endpoint to retrieve the available report_configurations and report_filters values before generating a report.

Connection type: Reservations connection type is required to access this endpoint.

This endpoint is rate-limited to 10 requests per minute.

post/connectivity-payments/recon-reports

Headers

Authorizationstring required

Bearer token for authentication.

accept-versionstring

API version to use.

Request body

from_datestring date required

Start date of the reporting period (inclusive), in YYYY-MM-DD format.

to_datestring date required

End date of the reporting period (inclusive), in YYYY-MM-DD format.

Example request

{
  "properties": [
    {
      "legal_entity_id": "1234567",
      "property_ids": [
        "123456"
      ]
    }
  ],
  "from_date": "2025-04-01",
  "to_date": "2025-08-01",
  "report_configurations": [
    {
      "config_key": "format_type",
      "config_value": "CSV"
    }
  ],
  "report_filters": [
    {
      "filter_key": "bank_accounts",
      "filter_values": [
        "DE123456789"
      ]
    }
  ]
}

Response

Report generation request accepted. Use the returned request_id with the report status endpoint to check progress and retrieve the download URL.

Example response

{
  "meta": {
    "ruid": "string"
  },
  "data": {
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "report_status": "GENERATING"
  }
}