Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 3.2 KB

VoucherTransactionsFilters.md

File metadata and controls

44 lines (28 loc) · 3.2 KB

VoucherTransactionsFilters

List of available fields and filters that can be exported with gift card or loyalty card transactions along with the sorting order of the returned data.

Properties

Name Type Description Notes
order OrderEnum How the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order. [optional]
fields List<FieldsEnum> Array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: Field
filters VoucherTransactionsExportFilterConditions

Enum: OrderEnum

Name Value
_CREATED_AT "-created_at"
CREATED_AT "created_at"

Enum: List<FieldsEnum>

Name Value
ID "id"
TYPE "type"
SOURCE_ID "source_id"
REASON "reason"
BALANCE "balance"
AMOUNT "amount"
CREATED_AT "created_at"
VOUCHER_ID "voucher_id"
CAMPAIGN_ID "campaign_id"
SOURCE "source"
DETAILS "details"
RELATED_TRANSACTION_ID "related_transaction_id"