pixiGetInvoicesForCustomer
Returns Invoices for customer in Order currency for defined customer key, customer number external or invoice number. Only one parameter must be set.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
CustKey | integer | false | Customer Key. Type: int Default value: Example: Available from: LOU Official (6.3.0.4452) |
InvoiceNr | string | false | Invoice Number. Type: varchar(20) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CustomerNrExternal | string | false | Customer number external (shop customer number). Type: varchar(60) Default value: Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetInvoicesForCustomer>
<CustKey>0</CustKey>
<CustomerNrExternal>string</CustomerNrExternal>
<InvoiceNr>string</InvoiceNr>
</pixiGetInvoicesForCustomer>
</Body>
</Envelope>
Response
1. Invoices information
Name | Type | Description |
---|---|---|
Blz | string | Bank identification related to LS payment type Type: varchar Available from: 25.06 (25.6.0.58802) |
Paid | boolean | Invoice is paid Type: bit Available from: 25.06 (25.6.0.58802) |
total | number | Invoice total amount Type: money Available from: 25.06 (25.6.0.58802) |
Account | string | Account information related to LS payment type Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number (internal) Type: int Available from: 25.06 (25.6.0.58802) |
PaidSum | number | Invoice paid amount Type: money Available from: 25.06 (25.6.0.58802) |
BankName | string | Bank name related to LS payment type Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardNr | string | CC Name Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipDate | string | Invoice ship date Type: datetime Available from: 25.06 (25.6.0.58802) |
CcCardExp | string | CC Expiry Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceNr | integer | Invoice Number Type: int Available from: 25.06 (25.6.0.58802) |
CcCardName | string | CC Number Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardType | string | CC Type Type: varchar Available from: 25.06 (25.6.0.58802) |
TotalToPay | number | Invoice total amount to be paid Type: money Available from: 25.06 (25.6.0.58802) |
TrackingID | string | Tracking ID of the order Type: varchar Available from: 25.06 (25.6.0.58802) |
AccountName | string | Name on the account related to LS payment type Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceDate | string | Invoice date Type: datetime Available from: 25.06 (25.6.0.58802) |
PaymentCode | string | Invoice payment type Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentDate | string | Invoice payment date Type: datetime Available from: 25.06 (25.6.0.58802) |
PaymentText | string | Invoice payment text Type: varchar Available from: 25.06 (25.6.0.58802) |
ReminderLevel | integer | Invoice Reminder level Type: int Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Order number (shop) Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentAddressId | integer | Id of Billing Address Type: int Available from: 25.06 (25.6.0.58802) |
OrderCurrencyCode | string | Order Currency Code Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipmentAddressId | integer | Id of Shipping Address Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetInvoicesForCustomerPost200TextXmlResponse>
<InvoiceNr>0</InvoiceNr>
<InvoiceDate>string</InvoiceDate>
<PaymentAddressId>0</PaymentAddressId>
<ShipmentAddressId>0</ShipmentAddressId>
<total>0</total>
<PaymentCode>string</PaymentCode>
<PaymentText>string</PaymentText>
<PaymentDate>string</PaymentDate>
<Paid>true</Paid>
<TotalToPay>0</TotalToPay>
<PaidSum>0</PaidSum>
<CcCardType>string</CcCardType>
<CcCardNr>string</CcCardNr>
<CcCardName>string</CcCardName>
<CcCardExp>string</CcCardExp>
<Account>string</Account>
<Blz>string</Blz>
<BankName>string</BankName>
<AccountName>string</AccountName>
<TrackingID>string</TrackingID>
<ShipDate>string</ShipDate>
<ReminderLevel>0</ReminderLevel>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<OrderCurrencyCode>string</OrderCurrencyCode>
</PixiGetInvoicesForCustomerPost200TextXmlResponse>
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:pixiGetInvoicesForCustomer>
<CustKey xsi:type="xsd:integer"></CustKey>
<InvoiceNr xsi:type="xsd:string"></InvoiceNr>
<CustomerNrExternal xsi:type="xsd:string"></CustomerNrExternal>
</ns1:pixiGetInvoicesForCustomer>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetInvoicesForCustomer', [
'CustKey' => '', // integer
'InvoiceNr' => '', // string
'CustomerNrExternal' => '', // 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);
}