Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportGetUnpaidInvoices

Pixi-Docs
Old Pixi-Docs

Returns list of open invoices and their not paid amounts

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

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
Date string false

Filter: Date till invoice was created

Type: datetime

Default value: NULL

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

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

Filter: Shop Id

Type: varchar(3)

Default value: NULL

Example: abc

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

Filter: Payment Code

Type: char

Default value: NULL

Example: Single character : "C"

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportGetUnpaidInvoices>
      <Date>string</Date>
      <ShopID>string</ShopID>
      <PaymentCode>string</PaymentCode>
    </pixiReportGetUnpaidInvoices>
  </Body>
</Envelope>

Response

1. Open invoices

Name Type Description
ShopID string

Shop ID

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
Vorname string

Customer first name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)
Nachname string

Customer last name

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)
CountryCode string

Country code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
CurrencyCode string

Currency code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
Kundennummer string

Customer number external

Type: varchar (60)

Available from: 25.06 (25.6.0.58802)
Rechnungsdatum string

Invoice date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Rechnungsbetrag number

Invoice total

Type: money

Available from: 25.06 (25.6.0.58802)
Rechnungsnummer string

Invoice number

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
DatevUserAccount string

Customer DATEV account number

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
OffenerRechnungsbetrag number

Open amount

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportGetUnpaidInvoicesPost200TextXmlResponse>
  <Rechnungsnummer>string</Rechnungsnummer>
  <Rechnungsdatum>string</Rechnungsdatum>
  <Rechnungsbetrag>0</Rechnungsbetrag>
  <OffenerRechnungsbetrag>0</OffenerRechnungsbetrag>
  <Kundennummer>string</Kundennummer>
  <DatevUserAccount>string</DatevUserAccount>
  <Nachname>string</Nachname>
  <Vorname>string</Vorname>
  <ShopID>string</ShopID>
  <CountryCode>string</CountryCode>
  <CurrencyCode>string</CurrencyCode>
</PixiReportGetUnpaidInvoicesPost200TextXmlResponse>

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:pixiReportGetUnpaidInvoices>
            <Date xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</Date>
            <ShopID xsi:type="xsd:string">abc</ShopID>
            <PaymentCode xsi:type="xsd:string">Single character : "C"</PaymentCode>
        </ns1:pixiReportGetUnpaidInvoices>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportGetUnpaidInvoices', [
    'Date' => 'YYYY-MM-DD hh:mm:ss', // string
    'ShopID' => 'abc', // string
    'PaymentCode' => 'Single character : "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);
}