pixiCreateInkassoBookings

The call checks the name of the current database.

Database pixi_GCH or pixi_GCH_test: the internal procedure Pixi_CA_CreateinkassoManualBookings is executed with the three parameters. It creates manual booking events on the customer account so that the affected invoices are no longer open. No result set is returned in this case.
Any other database: nothing is booked. The call returns a single row with Status = Info and a message saying that the call is no longer supported.

The internal procedure works as follows:

It reads the booking event ID from the setting CA_Inkasso_ManualBookingID. If the setting is empty or 0, INU is used.
It only continues if a customer account event with this ID exists in CustomerAccountEvents and has OriginalAmountMultiply = -1 (negative event).
It selects invoices with Total > 0 and an open amount (Total - PayedSum) > 0. The customer must be matched according to fPixi_CA_IsMatched. The customer must also have at least one open invoice that meets all of these conditions:
- reminder level between MinimumReminderLevel and MaxReminderLevel;
- invoice date older than MinimumAgeInDays days.
For each selected invoice it writes a log entry to LogTable. It then calls Pixi_CA_InsertManualBookingEvent with the negated open amount, the text Manual booking, the user pixi* Automatic, the customer account key of the invoice and its currency.

All open invoices of a qualifying customer are booked, not only the invoices that meet the age and reminder criteria.

Notes

Deprecated: outside the databases pixi_GCH and pixi_GCH_test the call does nothing except return the Info row. The message text contains the typo suported.
No feedback: in the supported databases no result set is returned. Success can only be checked via LogTable or the customer account.
Not documented here: the definitions of Pixi_CA_InsertManualBookingEvent, fPixi_CA_IsMatched and fPixi_GetSetting are not attached. Their exact behaviour is therefore not documented.
Dynamic SQL, no transaction: bookings and log entries are built as dynamic SQL and executed without an explicit transaction. The log entries are written before the bookings, so a failing booking can leave log entries without matching bookings.
Dirty reads: reads use NOLOCK.
No duplicate protection: repeated calls can create further bookings while invoices still appear open.

Tables used

Invoices · Read Customers · Read Addresses · Read CustomerAccountEvents · Read CustomerAccount · Read LogTable · Write

Parameter	Type	Default	Description
`MinimumAgeInDays` Required	int	–	Minimum age of a reminded invoice in days (invoice date older than today minus this value) for its customer to qualify. Example: `10`
`MinimumReminderLevel` Required	smallint int	–	Lowest reminder level (inclusive) of the qualifying invoice. NULL reminder levels count as 0. Example: `1`
`MaxReminderLevel` Required	int	–	Highest reminder level (inclusive) of the qualifying invoice. Example: `3`

Result set 1 · Only if the database is not `pixi_GCH` or `pixi_GCH_test`

Info row stating that the call is no longer supported.

Column	Type	Description
`Status`	varchar(4) string	Always `Info`.
`Message`	varchar(58) string	Fixed text saying that the call is no longer supported.

Response example

<SqlRowSet1>
  <row>
    <Status>Info</Status>
    <Message>API Call: pixiCreateInkassoBookings is no longer suported.</Message>
  </row>
</SqlRowSet1>

Status	Message	Cause
Info	API Call: pixiCreateInkassoBookings is no longer suported.	The call was executed in a database other than `pixi_GCH` or `pixi_GCH_test`. No bookings are created. The call cannot be used in other databases.

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiCreateInkassoBookings>
      <MinimumAgeInDays>10</MinimumAgeInDays>
      <MinimumReminderLevel>1</MinimumReminderLevel>
      <MaxReminderLevel>3</MaxReminderLevel>
    </ns1:pixiCreateInkassoBookings>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiCreateInkassoBookings>
      <MinimumAgeInDays>10</MinimumAgeInDays>
      <MinimumReminderLevel>1</MinimumReminderLevel>
      <MaxReminderLevel>3</MaxReminderLevel>
    </ns1:pixiCreateInkassoBookings>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'MinimumAgeInDays' => '10',
    'MinimumReminderLevel' => '1',
    'MaxReminderLevel' => '3',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiCreateInkassoBookings', $soapArguments);

Notes

Tables used

Result set 1 · Only if the database is not pixi_GCH or pixi_GCH_test

Response example

Result set 1 · Only if the database is not `pixi_GCH` or `pixi_GCH_test`