Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetReminderLevel

Pixi-Docs
Old Pixi-Docs

Procedure sets reminder level for the given Invoice.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Additional_Notes_Examples

Invoices

Request

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

Request body

Name Type Required Description
InvoiceNR string true

Invoice Number

Type: varchar(20)

Default value:

Example: ABC123

Available from: LOU Official (6.3.0.4452)
ReminderLevel integer true

Reminde rLevel

Type: int

Default value:

Example: 1

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetReminderLevel>
      <ReminderLevel>0</ReminderLevel>
      <InvoiceNR>string</InvoiceNR>
    </pixiSetReminderLevel>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiSetReminderLevelPost200TextXmlResponse />

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:pixiSetReminderLevel>
            <InvoiceNR xsi:type="xsd:string">ABC123</InvoiceNR> <!-- required -->
            <ReminderLevel xsi:type="xsd:integer">1</ReminderLevel> <!-- required -->
        </ns1:pixiSetReminderLevel>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetReminderLevel', [
    'InvoiceNR' => 'ABC123', // string (required)
    'ReminderLevel' => '1', // integer (required)
]);

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