pixiReadInvlines
API Call to retrieve all relevant invoice lines
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RowCount | integer | false | Number of rows returned maximum Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
InvlineKey | integer | false | pixi* Invoice line Key Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReadInvlines>
<InvlineKey>0</InvlineKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadInvlines>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
ItemNr | string | ItemNr Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrRef | integer | AddrRef Type: int Available from: 25.06 (25.6.0.58802) |
CustRef | integer | CustRef Type: int Available from: 25.06 (25.6.0.58802) |
ItemQty | integer | ItemQty Type: int Available from: 25.06 (25.6.0.58802) |
ItemRef | integer | ItemRef Type: int Available from: 25.06 (25.6.0.58802) |
ItemVAT | string | ItemVAT Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemText | string | ItemText Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderQty | integer | OrderQty Type: int Available from: 25.06 (25.6.0.58802) |
SerialNr | string | SerialNr Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCost | string | ShipCost Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | CreateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
FullPrice | string | FullPrice Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemPrice | string | ItemPrice Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | UpdateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | CreateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
InvLineKey | integer | InvLineKey Type: int Available from: 25.06 (25.6.0.58802) |
InvoiceRef | integer | InvoiceRef Type: int Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | UpdateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
CCPChargedYN | string | CCPChargedYN Type: varchar Available from: 25.06 (25.6.0.58802) |
DiscountPerc | string | DiscountPerc Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemDiscount | integer | ItemDiscount Type: int Available from: 25.06 (25.6.0.58802) |
OrderLineRef | integer | OrderLineRef Type: int Available from: 25.06 (25.6.0.58802) |
DiscountValue | string | DiscountValue Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | OrderCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCostPerItem | string | ShipCostPerItem Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCost_OrderCurr | string | ShipCost_OrderCurr Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemPrice_OrderCurr | string | ItemPrice_OrderCurr Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadInvlinesPost200TextXmlResponse>
<InvLineKey>0</InvLineKey>
<InvoiceRef>0</InvoiceRef>
<OrderLineRef>0</OrderLineRef>
<CustRef>0</CustRef>
<AddrRef>0</AddrRef>
<ItemNr>string</ItemNr>
<ItemQty>0</ItemQty>
<OrderQty>0</OrderQty>
<ItemText>string</ItemText>
<ItemPrice>string</ItemPrice>
<ItemDiscount>0</ItemDiscount>
<ItemVAT>string</ItemVAT>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<ItemPrice_OrderCurr>string</ItemPrice_OrderCurr>
<ShipCost>string</ShipCost>
<ShipCostPerItem>string</ShipCostPerItem>
<OrderCurrency>string</OrderCurrency>
<ShipCost_OrderCurr>string</ShipCost_OrderCurr>
<ItemRef>0</ItemRef>
<CCPChargedYN>string</CCPChargedYN>
<SerialNr>string</SerialNr>
<FullPrice>string</FullPrice>
<DiscountValue>string</DiscountValue>
<DiscountPerc>string</DiscountPerc>
</PixiReadInvlinesPost200TextXmlResponse>
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:pixiReadInvlines>
<RowCount xsi:type="xsd:integer"></RowCount>
<InvlineKey xsi:type="xsd:integer"></InvlineKey>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<CreateAndUpdateDateTo xsi:type="xsd:string"></CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string"></CreateAndUpdateDateFrom>
</ns1:pixiReadInvlines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadInvlines', [
'RowCount' => '', // integer
'InvlineKey' => '', // integer
'CreateDateTo' => '', // string
'UpdateDateTo' => '', // string
'CreateDateFrom' => '', // string
'UpdateDateFrom' => '', // string
'CreateAndUpdateDateTo' => '', // string
'CreateAndUpdateDateFrom' => '', // 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);
}