Description

Returns customer account events with full details including event type, amounts, open balance to match, deletion permission, and related references (invoice, bank line, DTAUS, or manual booking). Use this API call to retrieve the account transaction history for a customer or to look up events by type and date range.

All parameters are optional. When no filters are provided, all customer account events are returned. Results are not paginated.

Request Parameters

#	Name	Type	Required	Example	Description
1	CustKey	int	0	29447	Customer ID to filter events for a specific customer. When omitted, events for all customers are returned.
2	EventID	varchar(3)	0	PAP	Event type code to filter results to a specific event type. When omitted, all event types are returned.
3	DateFrom	datetime	0	2024-01-01	Start of the event date range. Only events on or after this date are returned. When omitted, no start date filter is applied.
4	DateTo	datetime	0	2024-12-31	End of the event date range. Only events on or before this date are returned. When omitted, no end date filter is applied.

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiGetCustomerEvents>
         <dem:CustKey>29447</dem:CustKey>
         <dem:EventID>PAP</dem:EventID>
         <dem:DateFrom>2024-01-01</dem:DateFrom>
         <dem:DateTo>2024-12-31</dem:DateTo>
      </dem:pixiGetCustomerEvents>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Customer account events

#	Name	Type	Description
1	CustomerAccountKey	int	Unique identifier of the customer account transaction record.
2	CustRef	int	Customer ID the event belongs to.
3	EventDate	datetime	Date and time the event was recorded.
4	EventID	varchar(3)	Short code identifying the event type (e.g. PAP, REC, MAN).
5	EventName	varchar(200)	Translated display name of the event type. For DTAUS-related events, the DTAUS state is appended in square brackets (e.g. "Direct Debit [Returned]").
6	Number	varchar(1024)	Related reference number derived from the first matching reference: invoice number (if InvoiceRef is set), bank text (if BankLineRef is set), DTAUS account number (if DTAUSref is set), or manual booking reference (if ManualBookingRef is set). Empty string if none apply.
7	Reference	varchar(512)	Free-text reference associated with the customer account event.
8	Amount	varchar(512)	Amount of the event transaction.
9	OpenTOMatch	varchar(512)	Open amount remaining to be matched for this event (Amount minus already matched amount).
10	DoNotRefund	bit	Flag indicating the event should not be refunded. 1 = do not refund, 0 = refund allowed.
11	InvoiceRef	int	Reference to the associated invoice record. NULL if no invoice is linked.
12	BanklineRef	int	Reference to the associated bank line record. NULL if no bank line is linked.
13	DTAUSref	int	Reference to the associated DTAUS direct debit record. NULL if no DTAUS entry is linked.
14	ManualBookingRef	int	Reference to the associated manual booking record. NULL if no manual booking is linked.
15	AllowToDelete	int	Indicates whether this event may be deleted. 1 = deletion allowed, 0 = deletion not permitted. Based on matching status, invoice payment status, and event type configuration.
16	IsDeleted	bit	Always returns 0. Reserved for future use.
17	CCPTranLogKey	int	Reference to the credit card payment transaction log entry. NULL if no credit card payment is associated.
18	OrderCurrency	varchar(3)	ISO currency code of the event amount (from the currency associated with the customer account entry).

Additional Notes

CaEnabled setting: the Customer Account module must be enabled in pixi system settings (CaEnabled = 1) for customer account events to be recorded. If the module is disabled, no events will exist.

Number field derivation: the Number field is populated from the first available reference in this priority order:
1. InvoiceRef is set: returns the invoice number from the Invoices table
2. BankLineRef is set: returns the bank transaction text (BankText01) from BankLines
3. DTAUSref is set: returns the DTAUS account number from the DTAUS table
4. ManualBookingRef is set: returns the manual booking reference (CA_Reference)
5. None set: returns an empty string

EventName and DTAUS state: when an event has a DTAUSref, the translated DTAUS state text is appended to the event name in square brackets, e.g. "Direct Debit [Returned]". The state text is translated using the pixi translation function.

AllowToDelete logic: an event is deletable (AllowToDelete = 1) only when all of the following conditions are met:
- The event is not currently matched (no CustomerAccountMatch entries for this event)
- The event type allows deletion (IsDeleteAllowed = 1 on the event type)
- If a DTAUS entry is linked, the DTAUS state also allows deletion
- OR: the event has an unpaid, non-CCP-paid invoice with no active invoice reminder lines

IsDeleted: always returns 0 in this call. Reserved for future use.