pixi Developer & Integration Documentation

pixiGetDatevExportAddresses

Description

Returns customer (and optionally supplier) address data for a given invoice date range in DATEV-compatible format, for use in accounting exports. Customer data is sourced from billing addresses. 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 address data.


Request Parameters

#

Name

Type

Required

Example

Description

1

DateFrom

datetime

1

2024-01-01 00:00:00

Invoice date range start (inclusive).

2

DateTo

datetime

1

2024-01-31 23:59:59

Invoice 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

Email

string

0

customer@example.com

Filter results to a specific customer email address. If NULL, all customers are included.

6

DatevUserAccount

string

0

10001

Filter results to a specific DATEV account number. If NULL, all accounts are included.

7

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:pixiGetDatevExportAddresses>
<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:Email>customer@example.com</dem:Email>
<dem:DatevUserAccount>10001</dem:DatevUserAccount>
<dem:CostCenter>KST01</dem:CostCenter>
</dem:pixiGetDatevExportAddresses>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Customer and Supplier Address Data

Returned when the BookExportDatevActive setting is enabled. One row per customer or supplier.

#

Name

Type

Description

1

CustomerNr

string

DATEV account number of the customer, or customer number of the supplier.

2

Name

string

Name of the customer or supplier.

3

Name2

string

Second name line of the customer or supplier.

4

FirstName

string

First name of the customer. Empty for suppliers.

5

LastName

string

Last name of the customer. Empty for suppliers.

6

Company

string

Company name of the customer. Empty for suppliers.

7

VatId

string

VAT ID of the customer. Empty for suppliers.

8

Street

string

Street from the billing address of the customer or supplier.

9

ZipOld

string

Country code and ZIP code combined (legacy format) from the address.

10

Zip

string

ZIP code from the billing address of the customer or supplier.

11

Country

string

Country code from the billing address.

12

CountryISO3

string

ISO 3166-1 alpha-3 country code from the billing address.

13

CountryISO2

string

ISO 3166-1 alpha-2 country code from the billing address.

14

CountryKFZ

string

Country name (Easylog format) from the billing address.

15

City

string

City from the billing address of the customer or supplier.

16

Phone

string

Phone number of the customer or supplier.

17

Fax

string

Fax number of the customer or supplier.

18

eMail

string

Email address of the customer or supplier.

19

CostCenter

string

Cost center from the shop assignment. Empty if no cost center is assigned.


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 address data is exported.

Customer data is sourced from billing addresses.

Supplier data is included when the system setting BookExportDatevKreditorenActive is also enabled.
When disabled, only customer rows are returned.