pixiGetDatevExportInvoices
Enabled but undocumented
Return lists of customers (optional also suppliers) with invoices or orders for given date period
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The API call can only be used when DATEV API Calls (BookExportDatevActive) setting are enabled.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTo | string | true | Invoice date or Customer account event date to Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
ShopId | string | false | pixi Shop Id Type: varchar(3) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Country | string | false | Country code of Customer Type: varchar(3) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
DateFrom | string | true | Invoice date or Customer account event date from Type: datetime Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
InvoiceNr | string | false | Allows to filter the export by Invoice number Type: varchar(20) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CostCenter | string | false | Allows to filter the export by CostCenter (Kostenstelle) Type: varchar(8) Default value: Example: Available from: AVA Official - Update 23 (8.4.23.27873) |
ShowOnlySums | boolean | true | Show detailed data or summary only Type: bit Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNrExternal | string | false | Allows to filter the export by Order number external Type: varchar(50) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
BookKeepingAccount | string | false | Allows to filter the export by Bookkeeping account Type: varchar(255) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetDatevExportInvoices>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
<ShopId>string</ShopId>
<ShowOnlySums>true</ShowOnlySums>
<Country>string</Country>
<InvoiceNr>string</InvoiceNr>
<OrderNrExternal>string</OrderNrExternal>
<BookKeepingAccount>string</BookKeepingAccount>
<CostCenter>string</CostCenter>
</pixiGetDatevExportInvoices>
</Body>
</Envelope>
Response
1. Returns data for invoices and customer account
Name | Type | Description |
---|---|---|
IsEU | boolean | Country Flag: 1- EU Country, 0 non EU country Type: BIT Available from: 25.06 (25.6.0.58802) |
Sign | string | Sign of amount, positive or negative Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Price | number | Absolute amount Type: MONEY Available from: 25.06 (25.6.0.58802) |
VatID | string | VAT Id from billing address Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
Empty1 | string | not used Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Empty2 | string | not used Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
Empty3 | string | not used Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
Empty4 | string | not used Type: VARCHAR(1) Available from: 25.06 (25.6.0.58802) |
Skonto | integer | not used Type: INT Available from: 25.06 (25.6.0.58802) |
Source | string | Short for source - invoices, vouchers, shipping costs, customer account events Type: VARCHAR(5) Available from: 25.06 (25.6.0.58802) |
Country | string | Country code from shipping address Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
InvDate | string | Invoice create date Type: DATETIME Available from: 25.06 (25.6.0.58802) |
InvText | string | Invoice note Type: VARCHAR(60) Available from: 25.06 (25.6.0.58802) |
VatCode | integer | Bookkeeping account for VAT Type: INT Available from: 25.06 (25.6.0.58802) |
ExchRate | string | Currency exchange rate (if used on invoice) Type: DECIMAL (19,6) Available from: 25.06 (25.6.0.58802) |
Lastname | string | Customers last name Type: VARCHAR(60) Available from: 25.06 (25.6.0.58802) |
MwstSatz | integer | Item VAT rate code: 1 - High VAT, 2 - Low VAT, 3 - No VAT Type: INT Available from: 25.06 (25.6.0.58802) |
Firstname | string | Customers first name Type: VARCHAR(60) Available from: 25.06 (25.6.0.58802) |
InvoiceNr | string | Invoice number Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
CostCenter | string | Cost center Nr for Shop Type: VARCHAR(8) Available from: 25.06 (25.6.0.58802) |
CustomerNr | string | Internal customer number Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
Gegenkonto | string | Account nr for Shop Type: VARCHAR(50) Available from: 25.06 (25.6.0.58802) |
CntCodeISO2 | string | ISO2 Country code Type: CHAR(2) Available from: 25.06 (25.6.0.58802) |
InvoiceDate | string | Invoice creation date Type: DATETIME Available from: 25.06 (25.6.0.58802) |
CustomerName | string | Customer name Type: VARCHAR(60) Available from: 25.06 (25.6.0.58802) |
PriceInCents | string | Absolute amount in cents Type: BIGINT Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order currency code Type: VARCHAR(3) Available from: 25.06 (25.6.0.58802) |
AccountNrItems | string | Bookkeeping account number for items Type: VARCHAR(20) Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Shop order number Type: VARCHAR(12) Available from: 25.06 (25.6.0.58802) |
BookKeepingAccount | string | Bookkeeping account number Type: VARCHAR(255) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetDatevExportInvoicesPost200TextXmlResponse>
<Source>string</Source>
<OrderCurrency>string</OrderCurrency>
<InvDate>string</InvDate>
<Country>string</Country>
<MwstSatz>0</MwstSatz>
<Sign>string</Sign>
<Price>0</Price>
<PriceInCents>string</PriceInCents>
<VatCode>0</VatCode>
<BookKeepingAccount>string</BookKeepingAccount>
<AccountNrItems>string</AccountNrItems>
<InvoiceNr>string</InvoiceNr>
<Empty1>string</Empty1>
<InvoiceDate>string</InvoiceDate>
<CustomerNr>string</CustomerNr>
<Empty2>string</Empty2>
<Empty3>string</Empty3>
<Empty4>string</Empty4>
<Skonto>0</Skonto>
<InvText>string</InvText>
<OrderNrExternal>string</OrderNrExternal>
<CustomerName>string</CustomerName>
<Firstname>string</Firstname>
<Lastname>string</Lastname>
<VatID>string</VatID>
<Gegenkonto>string</Gegenkonto>
<IsEU>true</IsEU>
<CntCodeISO2>string</CntCodeISO2>
<ExchRate>string</ExchRate>
<CostCenter>string</CostCenter>
</PixiGetDatevExportInvoicesPost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetDatevExportInvoices>
<DateTo xsi:type="xsd:string"></DateTo> <!-- required -->
<ShopId xsi:type="xsd:string"></ShopId>
<Country xsi:type="xsd:string"></Country>
<DateFrom xsi:type="xsd:string"></DateFrom> <!-- required -->
<InvoiceNr xsi:type="xsd:string"></InvoiceNr>
<CostCenter xsi:type="xsd:string"></CostCenter>
<ShowOnlySums xsi:type="xsd:boolean"></ShowOnlySums> <!-- required -->
<OrderNrExternal xsi:type="xsd:string"></OrderNrExternal>
<BookKeepingAccount xsi:type="xsd:string"></BookKeepingAccount>
</ns1:pixiGetDatevExportInvoices>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetDatevExportInvoices', [
'DateTo' => '', // string (required)
'ShopId' => '', // string
'Country' => '', // string
'DateFrom' => '', // string (required)
'InvoiceNr' => '', // string
'CostCenter' => '', // string
'ShowOnlySums' => '', // boolean (required)
'OrderNrExternal' => '', // string
'BookKeepingAccount' => '', // string
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}