Description
Returns previously identified duplicate customer addresses from the pixi duplicate detection system. Each row presents a side-by-side comparison of two matching customers including their address data, order information, invoice counts, last delivery date, external customer number, and Datev account number.
Use this API call to retrieve pending duplicate address pairs for manual review or as input to a deduplication workflow. By default only unprocessed (unused) pairs are returned. Pass ShowUsed = 1 to include all pairs regardless of processed status.
Results are paginated using StartCustRef (start from a given customer reference) and RowCount (maximum number of rows). The NrOfRecords field in every row reports the total count of unprocessed duplicate pairs across the entire system, independent of pagination.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
|---|---|---|---|---|---|
1 |
StartCustRef |
int |
0 |
0 |
Pagination offset: return only pairs where CustRef1 is greater than this value. Set to 0 or omit to start from the beginning. |
2 |
ShowUsed |
bit |
0 |
0 |
Filter for processed pairs. 0 = return only unprocessed (pending) duplicate pairs (default). 1 = return all pairs including already processed ones. |
3 |
RowCount |
int |
0 |
100 |
Maximum number of rows to return per request. Default is 100. |
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:pixiAddressesDisplayDuplicates>
<dem:StartCustRef>0</dem:StartCustRef>
<dem:ShowUsed>0</dem:ShowUsed>
<dem:RowCount>100</dem:RowCount>
</dem:pixiAddressesDisplayDuplicates>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Duplicate address pairs
# |
Name |
Type |
Description |
1 |
matchlevel |
int |
Numeric level indicating the strength of the duplicate match. Higher values indicate a closer match. |
2 |
matchtext |
varchar(100) |
Human-readable description of what matched between the two address records. |
3 |
CustRef1 |
int |
Customer reference number (CustKey) of the first customer in the duplicate pair. |
4 |
AddrKey1 |
int |
Address key of the first customer's address record. |
5 |
FirstName1 |
varchar(60) |
First name of the first customer. |
6 |
LastName1 |
varchar(60) |
Last name of the first customer. |
7 |
Company1 |
varchar(60) |
Company name or care-of recipient of the first customer. |
8 |
Street1 |
varchar(100) |
Street name of the first customer's address. |
9 |
HouseNr1 |
varchar(12) |
House number of the first customer's address. |
10 |
City1 |
varchar(50) |
City of the first customer's address. |
11 |
ZIP1 |
varchar(10) |
Postal code of the first customer's address. |
12 |
Country1 |
varchar(3) |
ISO 3-letter country code of the first customer's address. |
13 |
CustRef2 |
int |
Customer reference number (CustKey) of the second customer in the duplicate pair. |
14 |
AddrKey2 |
int |
Address key of the second customer's address record. |
15 |
FirstName2 |
varchar(60) |
First name of the second customer. |
16 |
LastName2 |
varchar(60) |
Last name of the second customer. |
17 |
Company2 |
varchar(60) |
Company name or care-of recipient of the second customer. |
18 |
Street2 |
varchar(100) |
Street name of the second customer's address. |
19 |
HouseNr2 |
varchar(12) |
House number of the second customer's address. |
20 |
City2 |
varchar(50) |
City of the second customer's address. |
21 |
ZIP2 |
varchar(10) |
Postal code of the second customer's address. |
22 |
Country2 |
varchar(3) |
ISO 3-letter country code of the second customer's address. |
23 |
NrOfInvoices1 |
int |
Total number of invoices associated with the first customer. |
24 |
NrOfInvoices2 |
int |
Total number of invoices associated with the second customer. |
25 |
LastDelivery1 |
datetime |
Date of the most recent invoice for the first customer. Useful to determine which customer record is more active. |
26 |
LastDelivery2 |
datetime |
Date of the most recent invoice for the second customer. Useful to determine which customer record is more active. |
27 |
CustomerNrExternal1 |
varchar(60) |
External customer number of the first customer, as set in the Customers table. |
28 |
CustomerNrExternal2 |
varchar(60) |
External customer number of the second customer, as set in the Customers table. |
29 |
NrOfRecords |
int |
Total count of unprocessed duplicate pairs in the entire system (independent of StartCustRef pagination). Use this to calculate total pages. |
30 |
CustKeyMatchedTo |
int |
When ShowUsed = 1, returns the CustKey the record was matched to. Always NULL when ShowUsed = 0. |
31 |
OrderNr1 |
int |
Order number associated with the first customer's address. |
32 |
OrderStatus1 |
varchar(10) |
Status of the order associated with the first customer's address. |
33 |
OrderNr2 |
int |
Order number associated with the second customer's address. |
34 |
OrderStatus2 |
varchar(10) |
Status of the order associated with the second customer's address. |
35 |
DatevUserAccount1 |
varchar(10) |
Datev accounting account number of the first customer. |
36 |
DatevUserAccount2 |
varchar(10) |
Datev accounting account number of the second customer. |
Additional Notes
Results are ordered by CustRef1 ascending.
Pagination: use StartCustRef to page through results. Set StartCustRef to the last CustRef1 value received to fetch the next page. Use RowCount to control page size (default: 100).
ShowUsed = 0 (default): returns only unprocessed duplicate pairs (UsedFlag = 0 or NULL).
ShowUsed = 1: returns all duplicate pairs including already processed ones.
CustKeyMatchedTo: returns a value only when ShowUsed = 1. When ShowUsed = 0, this column is always NULL.
NrOfRecords: reports the total count of unprocessed (UsedFlag = 0) duplicate pairs across the entire system, independent of the StartCustRef pagination filter.
Address records that have no associated order in the OrderHeader table are excluded from results.