pixiGetInkassoBookings
Liefert die im Zeitraum an das Inkasso übergebenen Rechnungen mit Kundenadresse und Beträgen; nur in den Datenbanken pixi_GCH unterstützt.
Dieser Aufruf ist kundenspezifisch und funktioniert nur, wenn die Pixi-Datenbank pixi_GCH oder pixi_GCH_test heißt. In allen anderen Datenbanken wird eine Statuszeile mit Status = Info und dem Hinweis geliefert, dass der Aufruf nicht mehr unterstützt wird.
In den unterstützten Datenbanken wird die interne Prozedur Pixi_CA_GetInkassoBookings ausgeführt und deren Zeilen werden zurückgegeben:
- Die Buchungs-Event-ID für manuelle Inkasso-Buchungen wird aus der Einstellung
CA_Inkasso_ManualBookingIDgelesen (StandardINU). - Alle Kundenkonto-Buchungen (
CustomerAccount) mit dieser Event-ID und einemEventDatezwischenFromDateundToDate(jeweils einschließlich) werden ermittelt. - Über
CustomerAccountMatchwerden die zugeordneten Buchungen in beide Richtungen gesucht und die Rechnungen bestimmt, auf die diese Buchungen verweisen. - Pro Rechnung wird eine Zeile mit Kunde (
Customers) und Kundenadresse (Addresses) geliefert, aufsteigend sortiert nach Rechnungsdatum (InvDate).
Das Zeilenformat ist ein festes Exportformat für ein Inkassobüro:
- Feste Werte:
KundenNr=975503,RecordCode=0,CompanyType=99,Land=001,AdresszusatzundRechnungsgrundleer. SprachcodeistD, wenn die Adresse zum ShopGCHgehört, sonstF.Geschlechtistmbei AnredeHerr,wbeiFrau, sonstf.- Datumswerte (
Geburtsdatum,Rechnungsdatum) haben das Formatdd.mm.yyyy. - Beträge (
BetragCHF,Mahnkosten,BetragCHFtotal) werden als Text mit Punkt als Dezimaltrennzeichen geliefert.BetragCHFist der Betrag der zugeordneten Inkasso-Buchung,BetragCHFtotalder Rechnungsbetrag,Mahnkostendie Mahngebühren (0, wenn keine vorhanden).
Hinweise
- Außerhalb der Datenbanken
pixi_GCH/pixi_GCH_testist der Aufruf faktisch stillgelegt: Es wird immer dieInfo-Zeile geliefert, ohne Daten abzufragen. - Vor dem Export wird die Hilfsprozedur
util.TableDropfür die Alt-Tabelletmp.pipiGetInkassoBookings_Outputaufgerufen; die Daten selbst werden in einer temporären Tabelle gesammelt, die am Ende gelöscht wird. Die Hilfsprozeduren liegen nicht vor. - Die Event-ID hängt von der Einstellung
CA_Inkasso_ManualBookingIDab, die zur Laufzeit überdbo.SettingGetgelesen wird. - Die Kundenkonto-Tabellen werden
WITH (NOLOCK)gelesen; nicht festgeschriebene Buchungen können daher enthalten sein. EventDate BETWEEN FromDate AND ToDatewird aufdatetimeverglichen: EinToDateohne Uhrzeit (Mitternacht) schließt spätere Buchungen dieses Tages aus.Geburtsjahrist0, wenn kein Geburtsdatum hinterlegt ist;Geburtsdatumist dann leer.BetragCHFkann leer (NULL) sein, wenn kein passender Inkasso-Buchungsbetrag gefunden wird. Die Betragsermittlung verwendet skalare Unterabfragen; hat eine Rechnung mehrere Kundenkonto-Einträge, kann SQL Server den Fehler 'Unterabfrage hat mehr als einen Wert zurückgegeben' auslösen.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
FromDate
Pflicht
|
datetime dateTime |
– |
Beginn des Zeitraums (einschließlich) für das Beispiel: |
ToDate
Pflicht
|
datetime dateTime |
– |
Ende des Zeitraums (einschließlich) für das Beispiel: |
Antwort
Result-Set 1 · Wenn die Datenbank pixi_GCH oder pixi_GCH_test ist
Eine Zeile pro im Zeitraum an das Inkasso übergebener Rechnung, sortiert nach Rechnungsdatum.
| Spalte | Typ | Beschreibung |
|---|---|---|
KundenNr
|
varchar(6) string |
Feste Kundennummer beim Inkassobüro, immer |
RecordCode
|
varchar(1) string |
Fester Satzcode, immer |
KundenRefNr
Kann leer sein |
varchar(60) string |
Externe Kundennummer ( |
Name1
Kann leer sein |
varchar(60) string |
Name der Kundenadresse. |
Name2
|
varchar(60) string |
Zweite Namenszeile, leer wenn nicht gesetzt. |
CompanyType
|
varchar(2) string |
Fester Wert |
Adresszusatz
|
varchar(1) string |
Immer leer. |
Strasse
Kann leer sein |
varchar(100) string |
Straße. |
Hausnummer
Kann leer sein |
varchar(12) string |
Hausnummer. |
Postleitzahl
Kann leer sein |
varchar(10) string |
Postleitzahl. |
Ort
Kann leer sein |
varchar(50) string |
Ort. |
Land
|
varchar(3) string |
Fester Ländercode |
Sprachcode
|
varchar(1) string |
|
Geschlecht
|
varchar(1) string |
|
Geburtsdatum
|
varchar(30) string |
Geburtsdatum im Format |
Geburtsjahr
|
int |
Geburtsjahr, |
Telefon
Kann leer sein |
varchar(60) string |
Telefonnummer. |
Telefax
|
varchar(60) string |
Faxnummer, leer wenn nicht gesetzt. |
E_Mail
Kann leer sein |
varchar(60) string |
E-Mail-Adresse. |
Mobile
|
varchar(60) string |
Zweite Telefonnummer ( |
Rechnungsdatum
Kann leer sein |
varchar(30) string |
Rechnungsdatum im Format |
Rechnungsnummer
|
varchar(20) string |
Rechnungsnummer. |
BetragCHF
Kann leer sein |
varchar(8000) string |
Betrag der zugeordneten Inkasso-Buchung als Text mit Punkt als Dezimaltrennzeichen; leer, wenn keine gefunden wird. |
Rechnungsgrund
|
varchar(1) string |
Immer leer. |
Mahnkosten
Kann leer sein |
varchar(8000) string |
Mahngebühren der Rechnung als Text mit Punkt als Dezimaltrennzeichen, |
BetragCHFtotal
Kann leer sein |
varchar(8000) string |
Rechnungsbetrag als Text mit Punkt als Dezimaltrennzeichen. |
Result-Set 2 · Wenn die Datenbank nicht pixi_GCH oder pixi_GCH_test ist
Einzelne Statuszeile mit dem Hinweis, dass der Aufruf nicht mehr unterstützt wird.
| Spalte | Typ | Beschreibung |
|---|---|---|
Status
|
varchar(4) string |
Immer |
Message
|
varchar(56) string |
Hinweis, dass der Aufruf nicht mehr unterstützt wird. |
Beispielantwort
<SqlRowSet1>
<row>
<KundenNr>975503</KundenNr>
<RecordCode>0</RecordCode>
<KundenRefNr>K-104522</KundenRefNr>
<Name1>Muster</Name1>
<Name2>Hans</Name2>
<CompanyType>99</CompanyType>
<Adresszusatz/>
<Strasse>Bahnhofstrasse</Strasse>
<Hausnummer>12</Hausnummer>
<Postleitzahl>8001</Postleitzahl>
<Ort>Zürich</Ort>
<Land>001</Land>
<Sprachcode>D</Sprachcode>
<Geschlecht>m</Geschlecht>
<Geburtsdatum>14.03.1978</Geburtsdatum>
<Geburtsjahr>1978</Geburtsjahr>
<Telefon>044 123 45 67</Telefon>
<Telefax/>
<E_Mail>hans.muster@example.ch</E_Mail>
<Mobile>079 123 45 67</Mobile>
<Rechnungsdatum>05.10.2023</Rechnungsdatum>
<Rechnungsnummer>RE2023104411</Rechnungsnummer>
<BetragCHF>149.90</BetragCHF>
<Rechnungsgrund/>
<Mahnkosten>20.00</Mahnkosten>
<BetragCHFtotal>149.90</BetragCHFtotal>
</row>
</SqlRowSet1>
Fehlermeldungen
| Status | Meldung | Ursache |
|---|---|---|
| Info | API Call: pixiGetInkassoBookings is no longer supported. | Wird in jeder Datenbank außer `pixi_GCH` und `pixi_GCH_test` geliefert. Der Aufruf ist dort stillgelegt und lässt sich nicht über Parameter aktivieren. |
Beispiele
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)
<?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/">
<SOAP-ENV:Body>
<ns1:pixiGetInkassoBookings>
<FromDate>2024-01-01T00:00:00</FromDate>
<ToDate>2024-01-31T23:59:59</ToDate>
</ns1:pixiGetInkassoBookings>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
--user 'USERNAME:PASSWORD' \
--header 'Content-Type: text/xml; charset=utf-8' \
--data-binary @- <<'XML'
<?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/">
<SOAP-ENV:Body>
<ns1:pixiGetInkassoBookings>
<FromDate>2024-01-01T00:00:00</FromDate>
<ToDate>2024-01-31T23:59:59</ToDate>
</ns1:pixiGetInkassoBookings>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
<?php
$soapClient = new SoapClient(null, [
'login' => 'USERNAME',
'password' => 'PASSWORD',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);
$arguments = [
'FromDate' => '2024-01-01T00:00:00',
'ToDate' => '2024-01-31T23:59:59',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetInkassoBookings', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetInkassoBookings