Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetPosInvoiceLines

Pixi-Docs
Old Pixi-Docs

Returns all invoice lines of the corresponding POS invoice, meaning all sold items for further reporting

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Invoices

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetPosInvoiceLines

Request body

Name Type Required Description
InvoiceNr string true

POS Invoice number

Type: varchar(20)

Default value:

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
ResultCode string false

Result Code - output

Type: char

Default value: (empty)

Example: ABC

Available from: LOU Official - Update 46 (6.9.46.27927)
ResultText string false

Result Text - output

Type: varchar(1024)

Default value: (empty)

Example: ABC

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetPosInvoiceLines>
      <InvoiceNr>string</InvoiceNr>
      <ResultCode>string</ResultCode>
      <ResultText>string</ResultText>
    </pixiGetPosInvoiceLines>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
EANUPC string

item EAN

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvDate string

invoice date

Type: datetime

Available from: 25.06 (25.6.0.58802)
ItemQty integer

item quantity

Type: int

Available from: 25.06 (25.6.0.58802)
Discount number

discount per item, can be empty

Type: numeric

Available from: 25.06 (25.6.0.58802)
ItemName string

item name

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

ID of corresponding POS invoice

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemNrInt string

internal item number to identify the item (ItemNrInt = ID used to match to the shops items)

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemPrice_Netto number

item price excluding VAT

Type: money

Available from: 25.06 (25.6.0.58802)
ItemPrice_Total number

item price including VAT and discount, i.e. price for which item has been sold

Type: money

Available from: 25.06 (25.6.0.58802)
ItemPrice_Brutto number

item price including VAT

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetPosInvoiceLinesPost200TextXmlResponse>
  <ItemNrInt>string</ItemNrInt>
  <EANUPC>string</EANUPC>
  <ItemName>string</ItemName>
  <ItemQty>0</ItemQty>
  <InvDate>string</InvDate>
  <InvoiceNr>string</InvoiceNr>
  <ItemPrice_Brutto>0</ItemPrice_Brutto>
  <ItemPrice_Netto>0</ItemPrice_Netto>
  <Discount>0</Discount>
  <ItemPrice_Total>0</ItemPrice_Total>
</PixiGetPosInvoiceLinesPost200TextXmlResponse>

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:pixiGetPosInvoiceLines>
            <InvoiceNr xsi:type="xsd:string">abcdef</InvoiceNr> <!-- required -->
            <ResultCode xsi:type="xsd:string">ABC</ResultCode>
            <ResultText xsi:type="xsd:string">ABC</ResultText>
        </ns1:pixiGetPosInvoiceLines>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetPosInvoiceLines', [
    'InvoiceNr' => 'abcdef', // string (required)
    'ResultCode' => 'ABC', // string
    'ResultText' => 'ABC', // 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);
}