Payments Lesen

pixiGetPaymenttypes

Liefert die in Pixi angelegten Zahlungsarten, optional gefiltert nach Code, Zahlungstext, initialem Auftragsstatus oder XML-Tag.

Liest die Zahlungsarten aus der Tabelle Payments und liefert für jede Zahlungsart Code, PaymentText, IniOrderStatus und XMLTag.

Parameter, die als Leerstring übergeben werden, gelten als nicht gesetzt (NULL).
Ist kein Parameter gesetzt, werden alle Zahlungsarten geliefert.
Sind ein oder mehrere Parameter gesetzt, wird eine Zahlungsart geliefert, wenn sie mindestens einem der übergebenen Werte entspricht:
- Code gleich Code
- PaymentText gleich PaymentText
- IniOrderStatus gleich IniOrderStatus
- XMLTag gleich TagXML

Alle Vergleiche sind exakte Übereinstimmungen; eine Platzhaltersuche gibt es nicht. Eine Sortierung wird nicht vorgenommen.

Hinweise

Die Filter werden mit ODER verknüpft, nicht mit UND. Werden z. B. Code und IniOrderStatus übergeben, werden Zahlungsarten geliefert, die einem der beiden Werte entsprechen, nicht nur solche, die beiden entsprechen.
Die Tabelle wird WITH (NOLOCK) gelesen; nicht festgeschriebene Änderungen können sichtbar sein.
Der Parameter für das XML-Tag heißt TagXML, die zurückgegebene Spalte dagegen XMLTag.
Da SQL Server nachfolgende Leerzeichen beim Stringvergleich ignoriert, gilt auch ein Wert aus reinen Leerzeichen als nicht gesetzt.
Die Spaltentypen des Ergebnisses sind im Code nicht sichtbar; die angegebenen Typen entsprechen den Parametertypen, die für die Vergleiche verwendet werden.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`Code`	varchar(1) string	–	Einstelliger Code der Zahlungsart. Leer bedeutet kein Filter auf den Code. Beispiel: `V`
`PaymentText`	varchar(32) string	–	Exakter Text (Bezeichnung) der Zahlungsart. Leer bedeutet kein Filter auf den Text. Beispiel: `Vorkasse`
`IniOrderStatus`	varchar(3) string	–	Initialer Auftragsstatus, den Aufträge mit dieser Zahlungsart erhalten. Leer bedeutet kein Filter auf den Status. Beispiel: `VK`
`TagXML`	varchar(32) string	–	XML-Tag der Zahlungsart, verglichen mit der Spalte `XMLTag`. Leer bedeutet kein Filter auf das Tag. Beispiel: `PREPAYMENT`

Antwort

Result-Set 1 · Immer; alle Zahlungsarten, wenn kein Parameter gesetzt ist, sonst diejenigen, die mindestens einem übergebenen Wert entsprechen.

Eine Zeile pro Zahlungsart.

Spalte	Typ	Beschreibung
`Code` Kann leer sein	varchar(1) string	Einstelliger Code der Zahlungsart.
`PaymentText` Kann leer sein	varchar(32) string	Text (Bezeichnung) der Zahlungsart.
`IniOrderStatus` Kann leer sein	varchar(3) string	Initialer Auftragsstatus für Aufträge mit dieser Zahlungsart.
`XMLTag` Kann leer sein	varchar(32) string	XML-Tag dieser Zahlungsart, z. B. beim Auftragsimport.

Beispielantwort

<SqlRowSet1>
  <row>
    <Code>V</Code>
    <PaymentText>Vorkasse</PaymentText>
    <IniOrderStatus>VK</IniOrderStatus>
    <XMLTag>PREPAYMENT</XMLTag>
  </row>
  <row>
    <Code>R</Code>
    <PaymentText>Rechnung</PaymentText>
    <IniOrderStatus>AU</IniOrderStatus>
    <XMLTag>INVOICE</XMLTag>
  </row>
</SqlRowSet1>

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:pixiGetPaymenttypes>
      <!-- <Code>V</Code> -->
      <!-- <PaymentText>Vorkasse</PaymentText> -->
      <!-- <IniOrderStatus>VK</IniOrderStatus> -->
      <!-- <TagXML>PREPAYMENT</TagXML> -->
    </ns1:pixiGetPaymenttypes>
  </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:pixiGetPaymenttypes>
      <!-- <Code>V</Code> -->
      <!-- <PaymentText>Vorkasse</PaymentText> -->
      <!-- <IniOrderStatus>VK</IniOrderStatus> -->
      <!-- <TagXML>PREPAYMENT</TagXML> -->
    </ns1:pixiGetPaymenttypes>
  </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 = [
    // 'Code' => 'V',
    // 'PaymentText' => 'Vorkasse',
    // 'IniOrderStatus' => 'VK',
    // 'TagXML' => 'PREPAYMENT',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetPaymenttypes', $soapArguments);

Verwendete Tabellen

Payments · Lesen

SQL-Objekt:: dbo.pipiGetPaymenttypes