Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetPaidInvoices

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 (6.3.0.4452) Additional notes:

Invoices

Request

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

Request body

Name Type Required Description
To string true

To date

Type: datetime

Default value:

Example: 31.12.2022

Available from: LOU Official (6.3.0.4452)
From string true

From date

Type: datetime

Default value:

Example: 31.12.2022

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetPaidInvoices>
      <From>string</From>
      <To>string</To>
    </pixiGetPaidInvoices>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
ShopID string

ShopID

Type: varchar

Available from: 25.06 (25.6.0.58802)
DatePaid string

DatePaid

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

InvoiceNr

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceKey integer

InvoiceKey

Type: int

Available from: 25.06 (25.6.0.58802)
OrderNRExternal string

OrderNRExternal

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetPaidInvoicesPost200TextXmlResponse>
  <InvoiceKey>0</InvoiceKey>
  <InvoiceNr>string</InvoiceNr>
  <DatePaid>string</DatePaid>
  <ShopID>string</ShopID>
  <OrderNRExternal>string</OrderNRExternal>
</PixiGetPaidInvoicesPost200TextXmlResponse>

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:pixiGetPaidInvoices>
            <To xsi:type="xsd:string">31.12.2022</To> <!-- required -->
            <From xsi:type="xsd:string">31.12.2022</From> <!-- required -->
        </ns1:pixiGetPaidInvoices>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetPaidInvoices', [
    'To' => '31.12.2022', // string (required)
    'From' => '31.12.2022', // string (required)
]);

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);
}