Unofficial Pixi-API-Documentation

by koempf24.de

pixiReadInvoices

Pixi-Docs
Old Pixi-Docs

API Call to retrieve all relevant invoice data

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

General

Request

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

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)
InvoiceNr string false

Invoice number

Type: varchar(20)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
InvoiceKey integer false

Invoice ID

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="">
    <pixiReadInvoices>
      <InvoiceKey>0</InvoiceKey>
      <InvoiceNr>string</InvoiceNr>
      <CreateDateFrom>string</CreateDateFrom>
      <CreateDateTo>string</CreateDateTo>
      <UpdateDateFrom>string</UpdateDateFrom>
      <UpdateDateTo>string</UpdateDateTo>
      <CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
      <CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
      <RowCount>0</RowCount>
    </pixiReadInvoices>
  </Body>
</Envelope>

Response

1. Retrieve invoice data

Name Type Description
1SS boolean

One scan shipping flag

Type: bit

Available from: 25.06 (25.6.0.58802)
BLZ string

Bank code

Type: varchar

Available from: 25.06 (25.6.0.58802)
LSNr integer

LS number

Type: int

Available from: 25.06 (25.6.0.58802)
Note string

Note

Type: varchar

Available from: 25.06 (25.6.0.58802)
BoxNr integer

Box number

Type: int

Available from: 25.06 (25.6.0.58802)
Payed string

Payed

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATNo string

VAT number

Type: varchar

Available from: 25.06 (25.6.0.58802)
total number

Total amount

Type: money

Available from: 25.06 (25.6.0.58802)
LSDate string

LS date

Type: datetime

Available from: 25.06 (25.6.0.58802)
PLHref integer

Picklist number

Type: int

Available from: 25.06 (25.6.0.58802)
PayDay string

Pay day

Type: datetime

Available from: 25.06 (25.6.0.58802)
SUGKTO string

SUGKTO

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATLow number

VAT low

Type: money

Available from: 25.06 (25.6.0.58802)
AccName string

Account name

Type: varchar

Available from: 25.06 (25.6.0.58802)
Account string

Account

Type: varchar

Available from: 25.06 (25.6.0.58802)
AddrRef integer

Addres reference

Type: int

Available from: 25.06 (25.6.0.58802)
CustRef integer

ID of customer

Type: int

Available from: 25.06 (25.6.0.58802)
DueDate string

Due date

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvDate string

Invoice date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Payment string

Payment

Type: varchar

Available from: 25.06 (25.6.0.58802)
Printed string

Printed

Type: varchar

Available from: 25.06 (25.6.0.58802)
RLSCost number

RLS cost

Type: money

Available from: 25.06 (25.6.0.58802)
RLSDate string

RLS date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Summary number

Summary

Type: money

Available from: 25.06 (25.6.0.58802)
VATHigh number

VAT high

Type: money

Available from: 25.06 (25.6.0.58802)
VATType string

VAT type

Type: varchar

Available from: 25.06 (25.6.0.58802)
AuszugNr string

Auszug Nr

Type: varchar

Available from: 25.06 (25.6.0.58802)
Packages integer

Packages

Type: int

Available from: 25.06 (25.6.0.58802)
PayedSum number

Payed sum

Type: money

Available from: 25.06 (25.6.0.58802)
ShipCode string

Ship code

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATHText string

Text representation of high VAT

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATLText string

Text representation of low VAT

Type: varchar

Available from: 25.06 (25.6.0.58802)
ccpPayID string

ID of credit card payment

Type: varchar

Available from: 25.06 (25.6.0.58802)
BuchuText string

Buchu text

Type: varchar

Available from: 25.06 (25.6.0.58802)
ChargeVAT string

The flag that marks if the VAT should be charged

Type: char

Available from: 25.06 (25.6.0.58802)
CreateEmp string

Creator of the recodr (pixi user)

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvShopID string

Invoice shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

Invoice number

Type: varchar

Available from: 25.06 (25.6.0.58802)
PrintDate string

Print date

Type: datetime

Available from: 25.06 (25.6.0.58802)
StockNote string

Stock note

Type: varchar

Available from: 25.06 (25.6.0.58802)
UpdateEmp string

User who last updated the record

Type: varchar

Available from: 25.06 (25.6.0.58802)
VoucherID string

ID of the voucher

Type: varchar

Available from: 25.06 (25.6.0.58802)
CreateDate string

Create date

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvoiceKey integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShipAdrRef integer

Shipping address ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShipVendor string

Shipping vendor code

Type: varchar

Available from: 25.06 (25.6.0.58802)
UpdateDate string

Last update date of the record

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATBaseLow number

VAT base low

Type: money

Available from: 25.06 (25.6.0.58802)
VATLowPerc number

VAT low percent

Type: numeric

Available from: 25.06 (25.6.0.58802)
ccpTransID string

CCP transaction ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
retTrackID string

Return track ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCPAuthCode string

CCP authorization code

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCPReCharge string

CCP re charge

Type: varchar

Available from: 25.06 (25.6.0.58802)
CreateDTAUS boolean

Create DTAUS

Type: bit

Available from: 25.06 (25.6.0.58802)
Fulfillment boolean

Fulfillment

Type: bit

Available from: 25.06 (25.6.0.58802)
InvShipLock string

Invoice ship lock

Type: varchar

Available from: 25.06 (25.6.0.58802)
ScanOutDate string

Invoice ship out date

Type: datetime

Available from: 25.06 (25.6.0.58802)
VATBaseHigh number

VAT base high

Type: money

Available from: 25.06 (25.6.0.58802)
VATHighPerc number

The VAT percent of high VAT

Type: numeric

Available from: 25.06 (25.6.0.58802)
ReturnClosed string

Return closed

Type: char

Available from: 25.06 (25.6.0.58802)
ReturnReason string

Return reason

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCPNumOfTries integer

CCP number of tries

Type: int

Available from: 25.06 (25.6.0.58802)
DiscountTotal number

Discount total

Type: money

Available from: 25.06 (25.6.0.58802)
InvLocationID string

Invoice location ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
IsPackageLost string

Is package lost

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderCurrency string

Order currency

Type: varchar

Available from: 25.06 (25.6.0.58802)
Reminder1Date string

Reminder1 date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Reminder2Date string

Reminder2 date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Reminder3Date string

Reminder3 date

Type: datetime

Available from: 25.06 (25.6.0.58802)
ReminderCosts number

Reminder costs

Type: money

Available from: 25.06 (25.6.0.58802)
ReminderLevel integer

Reminder level

Type: int

Available from: 25.06 (25.6.0.58802)
VATinShipCost string

VAT in ship cost

Type: varchar

Available from: 25.06 (25.6.0.58802)
CCPPaymentDone string

CCP payment done

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvTrackNumber string

Invoice track number

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaidAtCreation number

Paid at creation

Type: money

Available from: 25.06 (25.6.0.58802)
PaidByCustomer number

Paid by customer

Type: money

Available from: 25.06 (25.6.0.58802)
RefToInvoiceNr string

Reference to the original invoice number in case of returns

Type: varchar

Available from: 25.06 (25.6.0.58802)
ReminderReason string

Reminder reason

Type: varchar

Available from: 25.06 (25.6.0.58802)
ReturnSupplier string

Return supplier

Type: varchar

Available from: 25.06 (25.6.0.58802)
Total_ShipCost number

The total of ship costs

Type: money

Available from: 25.06 (25.6.0.58802)
TrackingIDsent string

Tracking ID sent

Type: datetime

Available from: 25.06 (25.6.0.58802)
retTrackIDhist string

Return track ID history

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvCreationMode string

Invoice creation mode

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceMailSent boolean

Invoice mail sent

Type: bit

Available from: 25.06 (25.6.0.58802)
RefToInvoiceKey integer

Reference to the original invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShippedByVendor boolean

Shipped by vendor

Type: bit

Available from: 25.06 (25.6.0.58802)
Total_OrderCurr number

Total order currency

Type: money

Available from: 25.06 (25.6.0.58802)
PackageNetWeight number

Package net weight

Type: decimal

Available from: 25.06 (25.6.0.58802)
TextIfNoInvlines string

Text if no Invlines

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATLow_OrderCurr number

VAT low order currency

Type: money

Available from: 25.06 (25.6.0.58802)
ReminderProcessed string

Reminder processed

Type: char

Available from: 25.06 (25.6.0.58802)
VATHigh_OrderCurr number

VAT high order currency

Type: money

Available from: 25.06 (25.6.0.58802)
PackageGrossWeight number

Package gross weight

Type: decimal

Available from: 25.06 (25.6.0.58802)
ShipmentTrackingID string

Shipment tracking ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
VATBaseLow_ShipCost number

VAT base low ship cost

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseHigh_ShipCost number

VAT base high ship cost

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseLow_OrderCurr number

VAT base low order currency

Type: money

Available from: 25.06 (25.6.0.58802)
VoucherSum_OrderCurr number

Voucher Sum amount (Net value in case of B2B Invoice)

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseHigh_OrderCurr number

VAT base high order currency

Type: money

Available from: 25.06 (25.6.0.58802)
Total_ShipCost_OrderCurr number

Total ship cost order currency

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseLow_ShipCost_OrderCurr number

VAT base low ship cost order currency

Type: money

Available from: 25.06 (25.6.0.58802)
VATBaseHigh_ShipCost_OrderCurr number

VAT base high ship cost order currency

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReadInvoicesPost200TextXmlResponse>
  <InvoiceKey>0</InvoiceKey>
  <InvoiceNr>string</InvoiceNr>
  <InvDate>string</InvDate>
  <CustRef>0</CustRef>
  <AddrRef>0</AddrRef>
  <Summary>0</Summary>
  <VATBaseHigh>0</VATBaseHigh>
  <VATBaseLow>0</VATBaseLow>
  <VATType>string</VATType>
  <VATNo>string</VATNo>
  <total>0</total>
  <Payment>string</Payment>
  <Printed>string</Printed>
  <PrintDate>string</PrintDate>
  <PayDay>string</PayDay>
  <Payed>string</Payed>
  <PayedSum>0</PayedSum>
  <SUGKTO>string</SUGKTO>
  <BuchuText>string</BuchuText>
  <AuszugNr>string</AuszugNr>
  <Account>string</Account>
  <BLZ>string</BLZ>
  <AccName>string</AccName>
  <LSDate>string</LSDate>
  <LSNr>0</LSNr>
  <RLSDate>string</RLSDate>
  <RLSCost>0</RLSCost>
  <Reminder1Date>string</Reminder1Date>
  <Reminder2Date>string</Reminder2Date>
  <Reminder3Date>string</Reminder3Date>
  <Note>string</Note>
  <ShipCode>string</ShipCode>
  <CreateDate>string</CreateDate>
  <CreateEmp>string</CreateEmp>
  <UpdateDate>string</UpdateDate>
  <UpdateEmp>string</UpdateEmp>
  <BoxNr>0</BoxNr>
  <Total_OrderCurr>0</Total_OrderCurr>
  <Total_ShipCost>0</Total_ShipCost>
  <Total_ShipCost_OrderCurr>0</Total_ShipCost_OrderCurr>
  <ScanOutDate>string</ScanOutDate>
  <OrderCurrency>string</OrderCurrency>
  <VATBaseHigh_OrderCurr>0</VATBaseHigh_OrderCurr>
  <VATBaseLow_OrderCurr>0</VATBaseLow_OrderCurr>
  <VATHighPerc>0</VATHighPerc>
  <VATLowPerc>0</VATLowPerc>
  <VATHigh>0</VATHigh>
  <VATLow>0</VATLow>
  <VATHigh_OrderCurr>0</VATHigh_OrderCurr>
  <VATLow_OrderCurr>0</VATLow_OrderCurr>
  <VATHText>string</VATHText>
  <VATLText>string</VATLText>
  <RefToInvoiceNr>string</RefToInvoiceNr>
  <RefToInvoiceKey>0</RefToInvoiceKey>
  <ChargeVAT>string</ChargeVAT>
  <ShipVendor>string</ShipVendor>
  <CCPPaymentDone>string</CCPPaymentDone>
  <CCPAuthCode>string</CCPAuthCode>
  <CCPNumOfTries>0</CCPNumOfTries>
  <CCPReCharge>string</CCPReCharge>
  <ShipAdrRef>0</ShipAdrRef>
  <InvLocationID>string</InvLocationID>
  <InvShopID>string</InvShopID>
  <PackageNetWeight>0</PackageNetWeight>
  <PackageGrossWeight>0</PackageGrossWeight>
  <IsPackageLost>string</IsPackageLost>
  <InvShipLock>string</InvShipLock>
  <InvTrackNumber>string</InvTrackNumber>
  <VoucherSum_OrderCurr>0</VoucherSum_OrderCurr>
  <VoucherID>string</VoucherID>
  <VATinShipCost>string</VATinShipCost>
  <ShippedByVendor>true</ShippedByVendor>
  <VATBaseLow_ShipCost>0</VATBaseLow_ShipCost>
  <VATBaseHigh_ShipCost>0</VATBaseHigh_ShipCost>
  <ccpPayID>string</ccpPayID>
  <ccpTransID>string</ccpTransID>
  <ReminderLevel>0</ReminderLevel>
  <ReminderProcessed>string</ReminderProcessed>
  <ReminderCosts>0</ReminderCosts>
  <ReminderReason>string</ReminderReason>
  <ShipmentTrackingID>string</ShipmentTrackingID>
  <ReturnReason>string</ReturnReason>
  <StockNote>string</StockNote>
  <ReturnSupplier>string</ReturnSupplier>
  <ReturnClosed>string</ReturnClosed>
  <Fulfillment>true</Fulfillment>
  <InvoiceMailSent>true</InvoiceMailSent>
  <TrackingIDsent>string</TrackingIDsent>
  <PaidByCustomer>0</PaidByCustomer>
  <PLHref>0</PLHref>
  <Packages>0</Packages>
  <DiscountTotal>0</DiscountTotal>
  <PaidAtCreation>0</PaidAtCreation>
  <TextIfNoInvlines>string</TextIfNoInvlines>
  <retTrackID>string</retTrackID>
  <retTrackIDhist>string</retTrackIDhist>
  <_x0031_SS>true</_x0031_SS>
  <DueDate>string</DueDate>
  <CreateDTAUS>true</CreateDTAUS>
  <InvCreationMode>string</InvCreationMode>
  <VATBaseHigh_ShipCost_OrderCurr>0</VATBaseHigh_ShipCost_OrderCurr>
  <VATBaseLow_ShipCost_OrderCurr>0</VATBaseLow_ShipCost_OrderCurr>
</PixiReadInvoicesPost200TextXmlResponse>

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:pixiReadInvoices>
            <RowCount xsi:type="xsd:integer"></RowCount>
            <InvoiceNr xsi:type="xsd:string"></InvoiceNr>
            <InvoiceKey xsi:type="xsd:integer"></InvoiceKey>
            <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:pixiReadInvoices>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReadInvoices', [
    'RowCount' => '', // integer
    'InvoiceNr' => '', // string
    'InvoiceKey' => '', // 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);
}