Function: getPaymentsExport()

getPaymentsExport<ThrowOnError>(options?): RequestResult<GetPaymentsExportResponses, GetPaymentsExportErrors, ThrowOnError>

Defined in: app/api/sdk.gen.ts:749

Exports all payment transactions within a specified date range to a CSV file. The ExportPaymentsToCsv endpoint is a powerful administrative tool for financial reporting and external auditing. It gathers all relevant transaction data between the start and end dates, formats it into a structured CSV file, and provides it as a download, enabling deep-dive analysis in spreadsheet software.

Type Parameters

ThrowOnError

ThrowOnError *extends* boolean = false

Parameters

options?

Options<GetPaymentsExportData, ThrowOnError>

Returns

RequestResult<GetPaymentsExportResponses, GetPaymentsExportErrors, ThrowOnError>