Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetInvoicesUnpaid

Pixi-Docs
Old Pixi-Docs

This call returns relevant data for a file with open invoices and was created for a special customer. It's faster than using pixiGetInvoice and pixiGetAddress for every invoice, that's why there is an extra call.

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

General

Request

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

Request body

Name Type Required Description
PaidInvoices boolean false

If this is set to 1, all invoices that are paid already are exported (for an initial export with all already paid invoices). It should not be used often though, it takes quite some resources

Type: bit

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetInvoicesUnpaid>
      <PaidInvoices>true</PaidInvoices>
    </pixiGetInvoicesUnpaid>
  </Body>
</Envelope>

Response

1. Invoice details

Name Type Description
Blz string

Bank Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
Note string

Invoice note

Type: varchar

Available from: 25.06 (25.6.0.58802)
Paid boolean

Flag if the invoice was paid already

Type: bit

Available from: 25.06 (25.6.0.58802)
total number

Invoice total

Type: money

Available from: 25.06 (25.6.0.58802)
InvZIP string

Postal code

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
Account string

Account number

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustKey integer

Customer ID

Type: int

Available from: 25.06 (25.6.0.58802)
DueDate string

Invoice due date

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvCity string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvName string

First and last name

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaidSum number

Actual paid amount

Type: money

Available from: 25.06 (25.6.0.58802)
BankName string

Name of the Bank

Type: varchar

Available from: 25.06 (25.6.0.58802)
CcCardNr string

Number of the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)
Currency string

Order Currency Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvName2 string

2nd name

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipDate string

Ship this order at this date only! Not before

Type: datetime

Available from: 25.06 (25.6.0.58802)
CcCardExp string

Expiry date of the credit card

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvStreet string

Street

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

pixi* invoice number

Type: varchar

Available from: 25.06 (25.6.0.58802)
CcCardName string

Name of the credit institute

Type: varchar

Available from: 25.06 (25.6.0.58802)
CcCardType string

Type of credit card

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvCompany string

Company name

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvHouseNr string

House Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceKey integer

Invoice Key (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)
TotalToPay number

Total amount to pay

Type: money

Available from: 25.06 (25.6.0.58802)
TrackingID string

Tracking ID of the shipment. Applies to the orders that have been shipped

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)
AccountName string

Name of the owner of this bank account

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvLastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceDate string

Date of the invoice

Type: datetime

Available from: 25.06 (25.6.0.58802)
PaymentCode string

Payment code

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaymentDate string

Date of the payment

Type: datetime

Available from: 25.06 (25.6.0.58802)
PaymentText string

Payment text / description

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvFirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
ReturnReason string

Return Reason

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderCurrency string

Order Currency Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
ReminderLevel integer

Reminder level

Type: int

Available from: 25.06 (25.6.0.58802)
RefToInvoiceNr string

Reference to Invoice Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
RefToInvoiceKey integer

Reference to Invoice Key (Id)

Type: int

Available from: 25.06 (25.6.0.58802)
DatevUserAccount string

DATEV Account Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaymentAddressId integer

Billing address ID

Type: int

Available from: 25.06 (25.6.0.58802)
ShipmentAddressId integer

Shipping address ID

Type: int

Available from: 25.06 (25.6.0.58802)
CustomerNrExternal string

External Reference to the Customer (imported from Shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvCountryCodeISO3 string

ISO3 Country Code

Type: char

Available from: 25.06 (25.6.0.58802)
TotalToPay_OrderCurr number

Invoice total

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoicesUnpaidPost200TextXmlResponse>
  <InvoiceNr>string</InvoiceNr>
  <InvoiceDate>string</InvoiceDate>
  <ShopID>string</ShopID>
  <PaymentAddressId>0</PaymentAddressId>
  <ShipmentAddressId>0</ShipmentAddressId>
  <CustKey>0</CustKey>
  <total>0</total>
  <PaymentCode>string</PaymentCode>
  <PaymentText>string</PaymentText>
  <PaymentDate>string</PaymentDate>
  <Paid>true</Paid>
  <TotalToPay>0</TotalToPay>
  <PaidSum>0</PaidSum>
  <CcCardType>string</CcCardType>
  <CcCardNr>string</CcCardNr>
  <CcCardName>string</CcCardName>
  <CcCardExp>string</CcCardExp>
  <Account>string</Account>
  <Blz>string</Blz>
  <BankName>string</BankName>
  <AccountName>string</AccountName>
  <TrackingID>string</TrackingID>
  <ShipDate>string</ShipDate>
  <UpdateDate>string</UpdateDate>
  <ReminderLevel>0</ReminderLevel>
  <Note>string</Note>
  <ShipVendor>string</ShipVendor>
  <Currency>string</Currency>
  <OrderCurrency>string</OrderCurrency>
  <TotalToPay_OrderCurr>0</TotalToPay_OrderCurr>
  <ReturnReason>string</ReturnReason>
  <InvoiceKey>0</InvoiceKey>
  <RefToInvoiceNr>string</RefToInvoiceNr>
  <RefToInvoiceKey>0</RefToInvoiceKey>
  <CustomerNrExternal>string</CustomerNrExternal>
  <InvZIP>string</InvZIP>
  <InvCity>string</InvCity>
  <InvCountryCodeISO3>string</InvCountryCodeISO3>
  <InvName>string</InvName>
  <InvName2>string</InvName2>
  <InvFirstName>string</InvFirstName>
  <InvLastName>string</InvLastName>
  <InvCompany>string</InvCompany>
  <InvStreet>string</InvStreet>
  <InvHouseNr>string</InvHouseNr>
  <DueDate>string</DueDate>
  <DatevUserAccount>string</DatevUserAccount>
</PixiGetInvoicesUnpaidPost200TextXmlResponse>

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:pixiGetInvoicesUnpaid>
            <PaidInvoices xsi:type="xsd:boolean"></PaidInvoices>
        </ns1:pixiGetInvoicesUnpaid>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetInvoicesUnpaid', [
    'PaidInvoices' => '', // boolean
]);

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