Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateInkassoBookings

Pixi-Docs
Old Pixi-Docs

Creates Manual Bookings in Customer Account for Inkasso Invoices so they are not open anymore.

Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes:

Manual Bookings are created with the event ID which is set in pixi Control Center setting Inkassso ID (CA_Inkasso_ManualBookingID). If nothing is set, then the default event ID INU is used. Invoices are considered depending on the specified parameter values. Additional requirements:

  • Invoice total has to be positive
  • Invoice has to be matched
  • Invoice is not totally paid
Payments

Request

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

Request body

Name Type Required Description
MaxReminderLevel integer false

Maximum reminder level that should be considered

Type: int

Default value:

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)
MinimumAgeInDays integer false

The minimum age of an invoice (in days)

Type: int

Default value:

Example:

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

Minimum reminder level that should be considered

Type: smallint

Default value:

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateInkassoBookings>
      <MinimumAgeInDays>0</MinimumAgeInDays>
      <MinimumReminderLevel>string</MinimumReminderLevel>
      <MaxReminderLevel>0</MaxReminderLevel>
    </pixiCreateInkassoBookings>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiCreateInkassoBookingsPost200TextXmlResponse />

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:pixiCreateInkassoBookings>
            <MaxReminderLevel xsi:type="xsd:integer"></MaxReminderLevel>
            <MinimumAgeInDays xsi:type="xsd:integer"></MinimumAgeInDays>
            <MinimumReminderLevel xsi:type="xsd:string"></MinimumReminderLevel>
        </ns1:pixiCreateInkassoBookings>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateInkassoBookings', [
    'MaxReminderLevel' => '', // integer
    'MinimumAgeInDays' => '', // integer
    'MinimumReminderLevel' => '', // 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);
}