pixiGetInkassoBookings
Procedure returns all "Inkasso" invoices for the given time frame.
Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ToDate | string | false | End of date range Type: datetime Default value: Example: Available from: AVA Official - Update 23 (8.4.23.27873) |
FromDate | string | false | Start of date range Type: datetime Default value: Example: Available from: AVA Official - Update 23 (8.4.23.27873) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetInkassoBookings>
<FromDate>string</FromDate>
<ToDate>string</ToDate>
</pixiGetInkassoBookings>
</Body>
</Envelope>
Response
1. Customer Account Inkasso bookings details
Name | Type | Description |
---|---|---|
Ort | string | Billing address - City Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
Land | string | Always 001 Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
Name1 | string | Billing address - First and last name Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Name2 | string | Always empty Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
E_Mail | string | Billing address - Email Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Mobile | string | Billing address - Mobile phone number Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Strasse | string | Billing address - Street Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
Telefax | string | Billing address - Fax number Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Telefon | string | Billing address - Phone numberr Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
KundenNr | string | Customer number - 97XXX3 Type: varchar (6) Available from: 25.06 (25.6.0.58802) |
BetragCHF | string | Event currency amount from Customer Account (format: 00.00) Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
Geschlecht | string | Sex - depending on salutation; Herr = m, Frau = w, everything else = f Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
Hausnummer | string | Billing address - House number Type: varchar (12) Available from: 25.06 (25.6.0.58802) |
Mahnkosten | string | Invoice reminder costs (format: 00.00) Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
RecordCode | string | Internal record code - 0 Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
Sprachcode | string | Language code - D or F Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
CompanyType | string | Company type - 99 Type: varchar (2) Available from: 25.06 (25.6.0.58802) |
Geburtsjahr | string | Customer year of birth (format: yyyy) Type: varchar (4) Available from: 25.06 (25.6.0.58802) |
KundenRefNr | string | External customer number Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Adresszusatz | string | Always empty Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
Geburtsdatum | string | Customer birth date (format: dd.mm.yyyy) Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
Postleitzahl | string | Billing address - ZIP Code Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
BetragCHFtotal | string | Invoice gross total (format: 00.00) Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
Rechnungsdatum | string | Date of invoice creation (format: dd.mm.yyyy) Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
Rechnungsgrund | string | Always empty Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
Rechnungsnummer | string | Invoice number Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetInkassoBookingsPost200TextXmlResponse>
<KundenNr>string</KundenNr>
<RecordCode>string</RecordCode>
<KundenRefNr>string</KundenRefNr>
<Name1>string</Name1>
<Name2>string</Name2>
<CompanyType>string</CompanyType>
<Adresszusatz>string</Adresszusatz>
<Strasse>string</Strasse>
<Hausnummer>string</Hausnummer>
<Postleitzahl>string</Postleitzahl>
<Ort>string</Ort>
<Land>string</Land>
<Sprachcode>string</Sprachcode>
<Geschlecht>string</Geschlecht>
<Geburtsdatum>string</Geburtsdatum>
<Geburtsjahr>string</Geburtsjahr>
<Telefon>string</Telefon>
<Telefax>string</Telefax>
<E_Mail>string</E_Mail>
<Mobile>string</Mobile>
<Rechnungsdatum>string</Rechnungsdatum>
<Rechnungsnummer>string</Rechnungsnummer>
<BetragCHF>string</BetragCHF>
<Rechnungsgrund>string</Rechnungsgrund>
<Mahnkosten>string</Mahnkosten>
<BetragCHFtotal>string</BetragCHFtotal>
</PixiGetInkassoBookingsPost200TextXmlResponse>
2. Informational resultset
Name | Type | Description |
---|---|---|
Status | string | Status returned by an API Call Type: varchar (4) Available from: 25.06 (25.6.0.58802) |
Message | string | Additional message returned by an API Call Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetInkassoBookingsPost200TextXmlResponse>
<KundenNr>string</KundenNr>
<RecordCode>string</RecordCode>
<KundenRefNr>string</KundenRefNr>
<Name1>string</Name1>
<Name2>string</Name2>
<CompanyType>string</CompanyType>
<Adresszusatz>string</Adresszusatz>
<Strasse>string</Strasse>
<Hausnummer>string</Hausnummer>
<Postleitzahl>string</Postleitzahl>
<Ort>string</Ort>
<Land>string</Land>
<Sprachcode>string</Sprachcode>
<Geschlecht>string</Geschlecht>
<Geburtsdatum>string</Geburtsdatum>
<Geburtsjahr>string</Geburtsjahr>
<Telefon>string</Telefon>
<Telefax>string</Telefax>
<E_Mail>string</E_Mail>
<Mobile>string</Mobile>
<Rechnungsdatum>string</Rechnungsdatum>
<Rechnungsnummer>string</Rechnungsnummer>
<BetragCHF>string</BetragCHF>
<Rechnungsgrund>string</Rechnungsgrund>
<Mahnkosten>string</Mahnkosten>
<BetragCHFtotal>string</BetragCHFtotal>
</PixiGetInkassoBookingsPost200TextXmlResponse>
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:pixiGetInkassoBookings>
<ToDate xsi:type="xsd:string"></ToDate>
<FromDate xsi:type="xsd:string"></FromDate>
</ns1:pixiGetInkassoBookings>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetInkassoBookings', [
'ToDate' => '', // string
'FromDate' => '', // 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);
}