Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateBankline

Pixi-Docs
Old Pixi-Docs

Insert a new bankline.

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

Invoices

Request

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

Request body

Name Type Required Description
BIC string false

BIC

Type: varchar(50)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
BLZ string true

BLZ

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
IBAN string false

IBAN

Type: varchar(150)

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
BankDate string true

Bank Date

Type: datetime

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
AccountNr string true

AccountNr

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
BankAmount number true

Bank Amount

Type: money

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
BankText01 string true

Bank Text 01

Type: varchar(1024)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
BankText02 string true

Bank Text 02

Type: varchar(1024)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
BankText03 string true

Bank Text 03

Type: varchar(1024)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
CurrencyId string false

Order CurrencyId: in case when will be NULL, we take database currency default.

Type: smallint

Default value: NULL

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SourceType string false

Source Type

Type: varchar(3)

Default value: API

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
BankFileName string true

Bank File Name

Type: varchar(1024)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
CustomerName string true

CustomerName

Type: varchar(60)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
AccountingBankAccount string false

Accounting Bank Account

Type: varchar(250)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateBankline>
      <BankFileName>string</BankFileName>
      <BankDate>string</BankDate>
      <BankAmount>0</BankAmount>
      <BankText01>string</BankText01>
      <BankText02>string</BankText02>
      <BankText03>string</BankText03>
      <BLZ>string</BLZ>
      <AccountNr>string</AccountNr>
      <CustomerName>string</CustomerName>
      <BIC>string</BIC>
      <IBAN>string</IBAN>
      <AccountingBankAccount>string</AccountingBankAccount>
      <SourceType>string</SourceType>
      <CurrencyId>string</CurrencyId>
    </pixiCreateBankline>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
BanklineKey integer

Bankline Id

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreateBanklinePost200TextXmlResponse>
  <BanklineKey>0</BanklineKey>
</PixiCreateBanklinePost200TextXmlResponse>

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:pixiCreateBankline>
            <BIC xsi:type="xsd:string"></BIC>
            <BLZ xsi:type="xsd:string"></BLZ> <!-- required -->
            <IBAN xsi:type="xsd:string"></IBAN>
            <BankDate xsi:type="xsd:string"></BankDate> <!-- required -->
            <AccountNr xsi:type="xsd:string"></AccountNr> <!-- required -->
            <BankAmount xsi:type="xsd:number"></BankAmount> <!-- required -->
            <BankText01 xsi:type="xsd:string"></BankText01> <!-- required -->
            <BankText02 xsi:type="xsd:string"></BankText02> <!-- required -->
            <BankText03 xsi:type="xsd:string"></BankText03> <!-- required -->
            <CurrencyId xsi:type="xsd:string"></CurrencyId>
            <SourceType xsi:type="xsd:string"></SourceType>
            <BankFileName xsi:type="xsd:string"></BankFileName> <!-- required -->
            <CustomerName xsi:type="xsd:string"></CustomerName> <!-- required -->
            <AccountingBankAccount xsi:type="xsd:string"></AccountingBankAccount>
        </ns1:pixiCreateBankline>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateBankline', [
    'BIC' => '', // string
    'BLZ' => '', // string (required)
    'IBAN' => '', // string
    'BankDate' => '', // string (required)
    'AccountNr' => '', // string (required)
    'BankAmount' => '', // number (required)
    'BankText01' => '', // string (required)
    'BankText02' => '', // string (required)
    'BankText03' => '', // string (required)
    'CurrencyId' => '', // string
    'SourceType' => '', // string
    'BankFileName' => '', // string (required)
    'CustomerName' => '', // string (required)
    'AccountingBankAccount' => '', // 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);
}