Unofficial Pixi-API-Documentation

by koempf24.de

pixiManualCreditCreate

Pixi-Docs
Old Pixi-Docs

Create Manual Credit out of Invoice data.

Since pixi version: 21.10 (21.10.0.61843) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
Amount number false

Credit Amount - Netto or Bruto - depends on Invoice/Order type

Type: money

Default value:

Example: 23.45

Available from: 21.10 (21.10.0.61843)
VATRate string false

VatRate: H = High, L = Low, N = None

Type: varchar(1)

Default value:

Example: H

Available from: 21.10 (21.10.0.61843)
UserName string false

User - default: API Manual Credit

Type: varchar(50)

Default value:

Example: UserName

Available from: 21.10 (21.10.0.61843)
InvoiceNr string false

InvoiceNr from dbo.Invoices

Type: varchar(20)

Default value:

Example: INV00001

Available from: 21.10 (21.10.0.61843)
InvoiceKey integer false

Id from dbo.Invoices

Type: int

Default value:

Example: 2

Available from: 21.10 (21.10.0.61843)
LanguageId string false

Language: 1 = Eng, 2= Ger (default)

Type: tinyint

Default value:

Example: 2

Available from: 21.10 (21.10.0.61843)
PositionText string false

Details for Credit

Type: varchar(120)

Default value:

Example: Free text describing operation

Available from: 21.10 (21.10.0.61843)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiManualCreditCreate>
      <InvoiceKey>0</InvoiceKey>
      <InvoiceNr>string</InvoiceNr>
      <PositionText>string</PositionText>
      <LanguageId>string</LanguageId>
      <VATRate>string</VATRate>
      <Amount>0</Amount>
      <UserName>string</UserName>
    </pixiManualCreditCreate>
  </Body>
</Envelope>

Response

1. Error response

Name Type Description
Status string

Status of the responce

Type: varchar(50)

Available from: 25.06 (25.6.0.58802)
Message string

Description of the error response

Type: varchar(4000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiManualCreditCreatePost400TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiManualCreditCreatePost400TextXmlResponse>

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:pixiManualCreditCreate>
            <Amount xsi:type="xsd:number">23.45</Amount>
            <VATRate xsi:type="xsd:string">H</VATRate>
            <UserName xsi:type="xsd:string">UserName</UserName>
            <InvoiceNr xsi:type="xsd:string">INV00001</InvoiceNr>
            <InvoiceKey xsi:type="xsd:integer">2</InvoiceKey>
            <LanguageId xsi:type="xsd:string">2</LanguageId>
            <PositionText xsi:type="xsd:string">Free text describing operation</PositionText>
        </ns1:pixiManualCreditCreate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiManualCreditCreate', [
    'Amount' => '23.45', // number
    'VATRate' => 'H', // string
    'UserName' => 'UserName', // string
    'InvoiceNr' => 'INV00001', // string
    'InvoiceKey' => '2', // integer
    'LanguageId' => '2', // string
    'PositionText' => 'Free text describing operation', // 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);
}