Description

Returns customer account match records. Each record links two customer account entries (CAref1 and CAref2) that were matched against each other, for example a payment and an invoice, together with the matched amount and who created and last updated the match.

Results are returned in pages, sorted by CustomerAccountMatchKey in ascending order. You can filter by create date, update date, or create-or-update date, and narrow the results to one customer (CustRef) or one customer account entry (CustomerAccountKey). All parameters are optional. If no record matches, an empty result is returned; the call does not return an error result set.

Request Parameters

#	Name	Type	Required	Example	Description
1	CustomerAccountMatchKey	integer	0	0	Paging cursor. Returns records with a CustomerAccountMatchKey greater than this value; the record with this key itself is not returned. Default: 0 (start from the first record). See Additional Notes.
2	CreateDateFrom	datetime	0	2026-09-01 00:00:00	Filter: create date from (inclusive).
3	CreateDateTo	datetime	0	2026-10-01 00:00:00	Filter: create date to (exclusive).
4	UpdateDateFrom	datetime	0	2026-09-01 00:00:00	Filter: update date from (inclusive).
5	UpdateDateTo	datetime	0	2026-10-01 00:00:00	Filter: update date to (exclusive).
6	CreateAndUpdateDateFrom	datetime	0	2026-09-01 00:00:00	Filter: create or update date from (inclusive). See Additional Notes.
7	CreateAndUpdateDateTo	datetime	0	2026-10-01 00:00:00	Filter: create or update date to (exclusive). See Additional Notes.
8	RowCount	integer	0	1000	Maximum number of records returned per call (page size). Default: 1000.
9	CustRef	integer	0	12345	Filter: customer ID (CustKey). Returns only matches where CAref1 or CAref2 belongs to this customer. Can be combined with all other filters.
10	CustomerAccountKey	integer	0	67890	Filter: customer account entry ID. Returns only matches where CAref1 or CAref2 equals this value. Can be combined with all other filters.

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:pixiReadCustomerAccountMatch>
         <dem:CustomerAccountMatchKey>0</dem:CustomerAccountMatchKey>
         <dem:CreateDateFrom>2026-09-01 00:00:00</dem:CreateDateFrom>
         <dem:CreateDateTo>2026-10-01 00:00:00</dem:CreateDateTo>
         <dem:RowCount>1000</dem:RowCount>
         <dem:CustRef>12345</dem:CustRef>
      </dem:pixiReadCustomerAccountMatch>
   </soapenv:Body>
</soapenv:Envelope>

This example returns the first 1000 matches of customer 12345 created in September 2026. Omit parameters you do not use instead of sending them empty.

Response

Body 1: Customer account match information

#	Name	Type	Description
1	CustomerAccountMatchKey	integer	Customer account match ID. Use the last value of a page as CustomerAccountMatchKey to request the next page.
2	CAref1	integer	Customer account entry ID of the first side of the match.
3	CAref2	integer	Customer account entry ID of the second side of the match.
4	AbsoluteMatchAmount	number	Matched amount (absolute value).
5	CreateEmp	string	pixi user who created the match.
6	CreateDate	datetime	Date and time the match was created.
7	UpdateEmp	string	pixi user who last updated the match.
8	UpdateDate	datetime	Date and time the match was last updated.

Additional Notes

Paging:
- Results are sorted by CustomerAccountMatchKey (ascending), max. RowCount records per call (default 1000).
- First call: omit CustomerAccountMatchKey (or send 0).
- Next call: send the last CustomerAccountMatchKey you received. Repeat until fewer than RowCount records are returned.
- The record with the key you send is not returned again. To read a single record, send its key minus 1 with RowCount = 1.

Date filters:
- "From" dates are inclusive, "To" dates are exclusive. Each date can be used alone.
- Only one pair of date filters is applied per call, in this order of priority:
  1. CreateAndUpdateDateFrom / CreateAndUpdateDateTo
  2. CreateDateFrom / CreateDateTo
  3. UpdateDateFrom / UpdateDateTo
  If you send more than one pair, the lower-priority pairs are ignored.

CreateAndUpdateDateFrom / CreateAndUpdateDateTo:
- A record is returned when its create date OR its update date is on or after CreateAndUpdateDateFrom,
  AND its create date OR its update date is before CreateAndUpdateDateTo.
- The two conditions are checked separately and can be met by different dates. A record created before
  the range and updated after it can therefore also be returned. To get records changed within an exact
  period, use CreateDateFrom/To or UpdateDateFrom/To instead.

Customer filters:
- CustRef and CustomerAccountKey can be combined with each other, with the date filters, and with paging.
- If both are sent, a record must match both filters.

Empty results:
- If no record matches, Body 1 is returned without rows. No error result set is returned.