Unofficial Pixi-API-Documentation

by koempf24.de

pixiInvoiceSetInfo

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

API Call to set the Invoice Note

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

Invoices

Request

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

Request body

Name Type Required Description
Note string false

Invoice Note

Type: varchar(255)

Default value: NULL

Example: abcdef

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

Invoice number

Type: varchar(20)

Default value: NULL

Example: abcdef

Available from: LOU Official - Update 46 (6.9.46.27927)
InvoiceKey integer false

Invoice Id

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiInvoiceSetInfo>
      <InvoiceNr>string</InvoiceNr>
      <InvoiceKey>0</InvoiceKey>
      <Note>string</Note>
    </pixiInvoiceSetInfo>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
ErrorNr string

200 = OK 404 = Invoice not found 500 = Error during Update of the invoice

Type: varchar

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

displays an error message (or empty if successful)

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiInvoiceSetInfoPost200TextXmlResponse>
  <ErrorNr>string</ErrorNr>
  <ErrorMessage>string</ErrorMessage>
</PixiInvoiceSetInfoPost200TextXmlResponse>

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:pixiInvoiceSetInfo>
            <Note xsi:type="xsd:string">abcdef</Note>
            <InvoiceNr xsi:type="xsd:string">abcdef</InvoiceNr>
            <InvoiceKey xsi:type="xsd:integer">123</InvoiceKey>
        </ns1:pixiInvoiceSetInfo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiInvoiceSetInfo', [
    'Note' => 'abcdef', // string
    'InvoiceNr' => 'abcdef', // string
    'InvoiceKey' => '123', // integer
]);

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