Unofficial Pixi-API-Documentation

by koempf24.de

pixiCAGetInvoiceMatch

Pixi-Docs
Old Pixi-Docs

API call returns customer account events for a selected invoice

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

Customers

Request

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

Request body

Name Type Required Description
InvoiceNr string false

Filter: Invoice Number

Type: varchar(20)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
InvoiceKey integer false

Filter: Invoice ID

Type: int

Default value: NULL

Example: 123

Available from: LOU Official (6.3.0.4452)

Request Example

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

Response

1. Customer account events

Name Type Description
Amount number

Event total amount

Type: money

Available from: / (25.7.0.59144)
EventID string

Event ID

Type: varchar (3)

Available from: / (25.7.0.59144)
Matched number

Event matched amount

Type: money

Available from: / (25.7.0.59144)
EventDate string

Date of the event

Type: smalldatetime

Available from: / (25.7.0.59144)
InvoiceNr string

pixi* invoice number

Type: varchar (20)

Available from: / (25.7.0.59144)
Reference string

Reference text

Type: varchar (512)

Available from: / (25.7.0.59144)
CreateDate string

Record create date

Type: datetime

Available from: / (25.7.0.59144)
InvoiceKey integer

Invoice ID

Type: int

Available from: / (25.7.0.59144)
OrderCurrency string

curreency of the order/invoice

Type: varchar (3)

Available from: / (25.7.0.59144)

Response Example

<PixiCAGetInvoiceMatchPost200TextXmlResponse>
  <InvoiceKey>0</InvoiceKey>
  <InvoiceNr>string</InvoiceNr>
  <EventID>string</EventID>
  <EventDate>string</EventDate>
  <Reference>string</Reference>
  <Amount>0</Amount>
  <Matched>0</Matched>
  <OrderCurrency>string</OrderCurrency>
  <CreateDate>string</CreateDate>
</PixiCAGetInvoiceMatchPost200TextXmlResponse>

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

PHP Example

<?php

getPixiSoapClientResponse('pixiCAGetInvoiceMatch', [
    'InvoiceNr' => 'abcdefg', // 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);
}