Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetDatevExportWires

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

Return lists of Payments (wires) for given date period

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The API call can only be used when DATEV API Calls (BookExportDatevActive) setting are enabled.

Invoices

Request

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

Request body

Name Type Required Description
DateTo string true

Invoice date or Customer account event date to

Type: datetime

Default value:

Example:

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

pixi Shop Id

Type: varchar(3)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
AmoutTo number false

Allows to filter the export by Amount - to

Type: money

Default value:

Example:

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

Country code of Customer

Type: varchar(3)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
DateFrom string true

Invoice date or Customer account event date from

Type: datetime

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
AmoutFrom number false

Allows to filter the export by Amount - from

Type: money

Default value:

Example:

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

Allows to filter the export by CostCenter (Kostenstelle)

Type: varchar(8)

Default value:

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)
BankAccountNr string false

Allows to filter the export by Bank Account number

Type: varchar(10)

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="">
    <pixiGetDatevExportWires>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
      <ShopId>string</ShopId>
      <Country>string</Country>
      <BankAccountNr>string</BankAccountNr>
      <AmoutFrom>0</AmoutFrom>
      <AmoutTo>0</AmoutTo>
      <CostCenter>string</CostCenter>
    </pixiGetDatevExportWires>
  </Body>
</Envelope>

Response

1. Returns data for payments (wires)

Name Type Description
Sign string

Sign of amount, positive or negative

Type: CHAR(1)

Available from: / (25.7.0.59144)
Amount number

Absolute amount

Type: MONEY

Available from: / (25.7.0.59144)
Empty1 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
Empty2 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
Empty3 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
Empty4 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
Empty5 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
Empty6 string

not used

Type: VARCHAR(1)

Available from: / (25.7.0.59144)
BankDate string

Bank event date from pixi Customer Account

Type: DATETIME

Available from: / (25.7.0.59144)
Currency string

Currency code

Type: VARCHAR(3)

Available from: / (25.7.0.59144)
ExchRate string

Currency exchange rate (if used on invoice)

Type: DECIMAL (19,6)

Available from: / (25.7.0.59144)
WireText string

Invoice text

Type: VARCHAR(60)

Available from: / (25.7.0.59144)
CostCenter string

Cost center Nr for Shop

Type: VARCHAR(8)

Available from: / (25.7.0.59144)
CustomerNr string

Internal customer number

Type: VARCHAR(20)

Available from: / (25.7.0.59144)
BankAccountNr string

Booking Account number

Type: VARCHAR(20)

Available from: / (25.7.0.59144)
OrderNrExternal string

Order number external

Type: VARCHAR(50)

Available from: / (25.7.0.59144)

Response Example

<PixiGetDatevExportWiresPost200TextXmlResponse>
  <Currency>string</Currency>
  <Sign>string</Sign>
  <Amount>0</Amount>
  <Empty1>string</Empty1>
  <CustomerNr>string</CustomerNr>
  <Empty2>string</Empty2>
  <BankDate>string</BankDate>
  <BankAccountNr>string</BankAccountNr>
  <Empty3>string</Empty3>
  <Empty4>string</Empty4>
  <Empty5>string</Empty5>
  <Empty6>string</Empty6>
  <WireText>string</WireText>
  <ExchRate>string</ExchRate>
  <CostCenter>string</CostCenter>
  <OrderNrExternal>string</OrderNrExternal>
</PixiGetDatevExportWiresPost200TextXmlResponse>

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:pixiGetDatevExportWires>
            <DateTo xsi:type="xsd:string"></DateTo> <!-- required -->
            <ShopId xsi:type="xsd:string"></ShopId>
            <AmoutTo xsi:type="xsd:number"></AmoutTo>
            <Country xsi:type="xsd:string"></Country>
            <DateFrom xsi:type="xsd:string"></DateFrom> <!-- required -->
            <AmoutFrom xsi:type="xsd:number"></AmoutFrom>
            <CostCenter xsi:type="xsd:string"></CostCenter>
            <BankAccountNr xsi:type="xsd:string"></BankAccountNr>
        </ns1:pixiGetDatevExportWires>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetDatevExportWires', [
    'DateTo' => '', // string (required)
    'ShopId' => '', // string
    'AmoutTo' => '', // number
    'Country' => '', // string
    'DateFrom' => '', // string (required)
    'AmoutFrom' => '', // number
    'CostCenter' => '', // string
    'BankAccountNr' => '', // 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);
}