Create a Report
Create an asynchronous report generation task. The report is not returned immediately; use the returned id to poll Query a Report until the status becomes SUCCESS, then download the file by sending a GET request directly to the returned downloadUrl.
Request Parameters
requestIdstring
required
Idempotency key. Use a unique value (e.g., UUID) for each creation.
reportTypestring
required
Type of report to generate.
Valid Values:
ACCOUNT_STATEMENTS_REPORT — Account statement report for reconciliation, audit, and third-party verification.
fileFormatstring
required
Output file format.
Valid Values:
CSV — Comma-separated values format.
XLSX — Microsoft Excel (XLSX) format.
PDF — PDF format; supports needEsign and pdfFields.
languagestring
Report language. Defaults to en_US when omitted.
Valid Values:
en_US — English.
zh_CN — Simplified Chinese.
fromDatestring
Start date of the report data range (inclusive), following the ISO 8601 standard. See Data Types. Provide fromDate and toDate together or omit both; toDate must be greater than or equal to fromDate.
toDatestring
End date of the report data range (inclusive), following the ISO 8601 standard. See Data Types. Provide fromDate and toDate together or omit both.
currenciesarray
Filter the report to specific currencies, following the ISO 4217 standard. See Data Types. Up to 10 currencies. Omit to include all currencies.
transactionTypesarray
Filter the report to specific transaction types. Omit to include all transaction types. See TransactionType.
balanceTypesarray
Filter the report to specific balance types. Omit to include all balance types. See BalanceType.
budgetAccountIdsarray
Filter by budget account IDs. When provided, the BUDGET_BALANCE balance type is added automatically.
needEsignboolean
Whether the report requires an electronic signature. Defaults to false. Effective only when fileFormat is PDF.
pdfFieldsarray
Extra display columns for the PDF report. Effective only when fileFormat is PDF. Omit to use the default columns.
Valid Values:
accountingType — Include the accounting type column.
description — Include the description column.
fileNamestring
Custom file name. A name is generated automatically when omitted.
Response Parameters
resultResult
See Result.
idstring
Unique report task identifier. Use this ID to poll Query a Report. Once status is SUCCESS, download the file from the returned downloadUrl.
statusstring
Report task status. A newly created task starts as PROCESSING.
Valid Values:
PROCESSING — The report is being generated.
SUCCESS — The report is ready for download.
FAILED — Report generation failed.
createdAtdatetime
Creation time, following the ISO 8601 standard. See Data Types.
Error Codes
Definition
POST /api/open/v1/reports/createRequest
{
"requestId": "f18d0117-095a-4782-a9f1-eeb16c3b0808",
"reportType": "ACCOUNT_STATEMENTS_REPORT",
"fileFormat": "CSV",
"fromDate": "2026-08-01T00:00:00+08:00",
"toDate": "2026-08-08T23:59:59+08:00"
}Response
{
"result": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"id": "RPT202608080000****",
"status": "PROCESSING",
"createdAt": "2026-08-08T12:08:56+08:00"
}