Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetUpdatedInvoices

Pixi-Docs
Old Pixi-Docs

API call that returns updated Invoices

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Invoices

Request

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

Request body

Name Type Required Description
Rows integer false

Define maximum rows that will be returned

Type: int

Default value: 0 (all records shown)

Example: 100

Available from: LOU Official (6.3.0.4452)
Since string false

Filter: Get invoices that were updated after specified date

Type: datetime

Default value: Start of current day

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)
OffSet integer false

Start with next invoice ID specified in Offset parameter

Type: int

Default value: -1

Example: 15

Available from: AVA 17.07 (8.4.31.30601)
PaymentType string false

Filter: Only return invoices with specified PaymentType

Type: varchar(1)

Default value: Empty (all records shown)

Example: C

Available from: AVA 17.07 (8.4.31.30601)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetUpdatedInvoices>
      <Since>string</Since>
      <Rows>0</Rows>
      <PaymentType>string</PaymentType>
      <OffSet>0</OffSet>
    </pixiGetUpdatedInvoices>
  </Body>
</Envelope>

Response

1. Updated invoices since specified date

Name Type Description
ShopID string

Shop code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

Invoice number

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
InvoiceKey integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
UpdateDate string

Last update date connected to the invoice

Type: datetime

Available from: 25.06 (25.6.0.58802)
PaymentCode string

Payment code connected to the invoice

Type: varchar (1)

Available from: 25.06 (25.6.0.58802)
PaymentText string

Payment text / description

Type: varchar (120)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetUpdatedInvoicesPost200TextXmlResponse>
  <InvoiceKey>0</InvoiceKey>
  <InvoiceNr>string</InvoiceNr>
  <UpdateDate>string</UpdateDate>
  <ShopID>string</ShopID>
  <PaymentCode>string</PaymentCode>
  <PaymentText>string</PaymentText>
</PixiGetUpdatedInvoicesPost200TextXmlResponse>

2. Error response

Name Type Description
Status string

Status of the responce

Type: varchar(50)

Available from: 25.06 (25.6.0.58802)
Message string

Description of the error response

Type: varchar(4000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetUpdatedInvoicesPost400TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiGetUpdatedInvoicesPost400TextXmlResponse>

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:pixiGetUpdatedInvoices>
            <Rows xsi:type="xsd:integer">100</Rows>
            <Since xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</Since>
            <OffSet xsi:type="xsd:integer">15</OffSet>
            <PaymentType xsi:type="xsd:string">C</PaymentType>
        </ns1:pixiGetUpdatedInvoices>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetUpdatedInvoices', [
    'Rows' => '100', // integer
    'Since' => 'YYYY-MM-DD hh:mm:ss', // string
    'OffSet' => '15', // integer
    'PaymentType' => 'C', // 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);
}