pixiReport_InvoicesList
The call returns a list of all invoices.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTo | string | true | Date to. Type: datetime Default value: Example: Available from: LOU Official (6.3.0.4452) |
ShopID | string | false | Return only records for this shop. Type: char Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Payment | string | false | Return only records for this payment type. Type: char Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
DateFrom | string | true | Date from. Type: datetime Default value: Example: Available from: LOU Official (6.3.0.4452) |
ShipCountry | string | false | Return only records for this ship country. Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
DocumentType | string | false | Return only records for this document type: R - invoice, G - credit. Type: char Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReport_InvoicesList>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
<ShopID>string</ShopID>
<Payment>string</Payment>
<ShipCountry>string</ShipCountry>
<DocumentType>string</DocumentType>
</pixiReport_InvoicesList>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Fax | string | Fax Type: varchar Available from: 25.06 (25.6.0.58802) |
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar Available from: 25.06 (25.6.0.58802) |
Name | string | Name Type: varchar Available from: 25.06 (25.6.0.58802) |
Name2 | string | Name2 Type: varchar Available from: 25.06 (25.6.0.58802) |
Payed | string | Paid date Type: datetime Available from: 25.06 (25.6.0.58802) |
Phone | string | Phone Type: varchar Available from: 25.06 (25.6.0.58802) |
Total | number | Total Type: money Available from: 25.06 (25.6.0.58802) |
Anrede | string | Anrede Type: varchar Available from: 25.06 (25.6.0.58802) |
VATLow | number | VATLow Type: money Available from: 25.06 (25.6.0.58802) |
usStID | string | usStID Type: varchar Available from: 25.06 (25.6.0.58802) |
Address | string | Address Type: varchar Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar Available from: 25.06 (25.6.0.58802) |
InvDate | string | InvDate Type: datetime Available from: 25.06 (25.6.0.58802) |
VATHigh | number | VATHigh Type: money Available from: 25.06 (25.6.0.58802) |
LastName | string | Name Type: varchar Available from: 25.06 (25.6.0.58802) |
AccountNR | string | AccountNR Type: varchar Available from: 25.06 (25.6.0.58802) |
FirstName | string | Name Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceNR | string | InvoiceNR Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrShopID | string | AddrShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceKey | integer | InvoiceKey Type: int Available from: 25.06 (25.6.0.58802) |
SumEKItems | number | SumEKItems Type: money Available from: 25.06 (25.6.0.58802) |
VATLowPerc | number | VATHigh Type: numeric Available from: 25.06 (25.6.0.58802) |
par_DateTo | string | par_DateTo Type: datetime Available from: 25.06 (25.6.0.58802) |
par_ShopID | string | par_ShopID Type: CHAR Available from: 25.06 (25.6.0.58802) |
CountryName | string | CountryName Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentText | string | PaymentText Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCountry | string | ShipCountry Type: varchar Available from: 25.06 (25.6.0.58802) |
SumQtyItems | integer | SumQtyItems Type: int Available from: 25.06 (25.6.0.58802) |
Total_NoVAT | number | Total_NoVAT Type: money Available from: 25.06 (25.6.0.58802) |
VATHighPerc | number | VATHigh Type: numeric Available from: 25.06 (25.6.0.58802) |
par_Payment | string | par_Payment Type: CHAR Available from: 25.06 (25.6.0.58802) |
RefInvoiceNR | string | RefInvoiceNR Type: varchar Available from: 25.06 (25.6.0.58802) |
par_DateFrom | string | par_DateFrom Type: datetime Available from: 25.06 (25.6.0.58802) |
ShipCost_NoVAT | number | ShipCost_NoVAT Type: money Available from: 25.06 (25.6.0.58802) |
Total_ShipCost | number | Total_ShipCost Type: money Available from: 25.06 (25.6.0.58802) |
Order_Nr_Extern | string | Order_Nr_Extern Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCountryName | string | ShipCountryName Type: varchar Available from: 25.06 (25.6.0.58802) |
par_ShipCountry | string | par_ShipCountry Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
Par_DocumentType | string | Par_DocumentType Type: CHAR Available from: 25.06 (25.6.0.58802) |
Total_Items_NoVAT | number | Total_Items_NoVAT Type: money Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_InvoicesListPost200TextXmlResponse>
<InvoiceKey>0</InvoiceKey>
<RefInvoiceNR>string</RefInvoiceNR>
<Payed>string</Payed>
<InvDate>string</InvDate>
<InvoiceNR>string</InvoiceNR>
<Total>0</Total>
<Total_NoVAT>0</Total_NoVAT>
<Total_Items_NoVAT>0</Total_Items_NoVAT>
<ShipCost_NoVAT>0</ShipCost_NoVAT>
<Total_ShipCost>0</Total_ShipCost>
<VATHigh>0</VATHigh>
<VATLow>0</VATLow>
<VATHighPerc>0</VATHighPerc>
<VATLowPerc>0</VATLowPerc>
<SumQtyItems>0</SumQtyItems>
<SumEKItems>0</SumEKItems>
<Order_Nr_Extern>string</Order_Nr_Extern>
<AccountNR>string</AccountNR>
<Anrede>string</Anrede>
<Name>string</Name>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Name2>string</Name2>
<Address>string</Address>
<ZIP>string</ZIP>
<City>string</City>
<Country>string</Country>
<CountryName>string</CountryName>
<Phone>string</Phone>
<Fax>string</Fax>
<ShipCountry>string</ShipCountry>
<ShipCountryName>string</ShipCountryName>
<AddrShopID>string</AddrShopID>
<PaymentText>string</PaymentText>
<usStID>string</usStID>
<par_DateFrom>string</par_DateFrom>
<par_DateTo>string</par_DateTo>
<par_ShopID>string</par_ShopID>
<par_Payment>string</par_Payment>
<par_ShipCountry>string</par_ShipCountry>
<Par_DocumentType>string</Par_DocumentType>
</PixiReport_InvoicesListPost200TextXmlResponse>
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:pixiReport_InvoicesList>
<DateTo xsi:type="xsd:string"></DateTo> <!-- required -->
<ShopID xsi:type="xsd:string"></ShopID>
<Payment xsi:type="xsd:string"></Payment>
<DateFrom xsi:type="xsd:string"></DateFrom> <!-- required -->
<ShipCountry xsi:type="xsd:string"></ShipCountry>
<DocumentType xsi:type="xsd:string"></DocumentType>
</ns1:pixiReport_InvoicesList>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReport_InvoicesList', [
'DateTo' => '', // string (required)
'ShopID' => '', // string
'Payment' => '', // string
'DateFrom' => '', // string (required)
'ShipCountry' => '', // string
'DocumentType' => '', // 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);
}