Description
Returns payment (wire transfer) data for a given date range in DATEV-compatible format for accounting export. Supports filtering by shop, country, bank account number, amount range, and cost center. This API call requires the DATEV API Calls system setting (BookExportDatevActive) to be enabled. If the setting is disabled, an error result is returned instead of payment data.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
DateFrom |
datetime |
1 |
2024-01-01 00:00:00 |
Payment date range start (inclusive). |
2 |
DateTo |
datetime |
1 |
2024-01-31 23:59:59 |
Payment date range end (inclusive). |
3 |
ShopId |
string |
0 |
WEB |
Filter results to a specific pixi shop ID. If NULL, all shops are included. |
4 |
Country |
string |
0 |
DEU |
Filter results to customers from a specific country code. If NULL, all countries are included. |
5 |
BankAccountNr |
string |
0 |
1800 |
Filter results to a specific bank booking account number. If NULL, all accounts are included. |
6 |
AmoutFrom |
money |
0 |
10.00 |
Filter results to payments with an amount greater than or equal to this value. If NULL, no lower limit is applied. |
7 |
AmoutTo |
money |
0 |
500.00 |
Filter results to payments with an amount less than or equal to this value. If NULL, no upper limit is applied. |
8 |
CostCenter |
string |
0 |
KST01 |
Filter results by cost center (Kostenstelle). If NULL, all cost centers are included. |
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:pixiGetDatevExportWires>
<dem:DateFrom>2024-01-01 00:00:00</dem:DateFrom>
<dem:DateTo>2024-01-31 23:59:59</dem:DateTo>
<dem:ShopId>WEB</dem:ShopId>
<dem:Country>DEU</dem:Country>
<dem:BankAccountNr>1800</dem:BankAccountNr>
<dem:AmoutFrom>10.00</dem:AmoutFrom>
<dem:AmoutTo>500.00</dem:AmoutTo>
<dem:CostCenter>KST01</dem:CostCenter>
</dem:pixiGetDatevExportWires>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Payment Data
Returned when the BookExportDatevActive setting is enabled. One row per payment entry.
# |
Name |
Type |
Description |
1 |
Currency |
string |
Currency code of the payment. |
2 |
Sign |
string |
Sign of the amount: positive or negative. |
3 |
Amount |
money |
Absolute payment amount. |
4 |
Empty1 |
string |
Not used. Reserved for DATEV format compatibility. |
5 |
CustomerNr |
string |
Internal pixi customer number. |
6 |
Empty2 |
string |
Not used. Reserved for DATEV format compatibility. |
7 |
BankDate |
datetime |
Bank event date from the pixi customer account. |
8 |
BankAccountNr |
string |
Booking account number for the payment. |
9 |
Empty3 |
string |
Not used. Reserved for DATEV format compatibility. |
10 |
Empty4 |
string |
Not used. Reserved for DATEV format compatibility. |
11 |
Empty5 |
string |
Not used. Reserved for DATEV format compatibility. |
12 |
Empty6 |
string |
Not used. Reserved for DATEV format compatibility. |
13 |
WireText |
string |
Payment description text. |
14 |
ExchRate |
decimal |
Currency exchange rate applied to the payment. Empty if home currency was used. |
15 |
CostCenter |
string |
Cost center number for the shop. |
16 |
OrderNrExternal |
string |
External order number associated with the payment. |
Body 2: Error Information
Returned instead of Body 1 when the BookExportDatevActive setting is disabled.
# |
Name |
Type |
Description |
1 |
Status |
string |
Always "ERROR" when the DATEV setting is not enabled. |
2 |
StatusMessage |
string |
Always: "Setting "DATEV API Calls" (BookExportDatevActive) is not enabled." |
Additional Notes
This API call requires the system setting BookExportDatevActive to be enabled.
If disabled, Body 2 is returned and no payment data is exported.
AmoutFrom and AmoutTo parameter names contain a known typo (missing 'n').
Use exactly AmoutFrom and AmoutTo when constructing the SOAP request.
Empty1 through Empty6 fields are always empty.
They are included to maintain DATEV file format column positions.
AmoutFrom and AmoutTo filter on the absolute payment amount regardless of sign.