pixiInvoiceSetInfo · Pixi API documentation

Updates the Note field of exactly one invoice in the Invoices table.

The invoice is looked up with the condition InvoiceNr = @InvoiceNr OR InvoiceKey = @InvoiceKey.
If this condition matches no invoice, or more than one invoice, the call returns a status row with ErrorNr = 404 and changes nothing. This happens if:
- neither InvoiceNr nor InvoiceKey is passed,
- the given number or key does not exist,
- InvoiceNr and InvoiceKey point to two different invoices.
If exactly one invoice matches, its Note is overwritten with @Note, and a status row with ErrorNr = 200 and an empty ErrorMessage is returned.
If the update fails, a status row with ErrorNr = 500 is returned.

Passing both parameters is allowed if they refer to the same invoice.

Notes

The existing note is replaced, not appended. If Note is omitted, it defaults to NULL and the note of the invoice is cleared.
The existence check reads Invoices with NOLOCK; check and update are not wrapped in a transaction.
The 500 status row does not contain the original SQL error text.
ErrorNr is returned as a string ('200', '404', '500'), not as a number.
@Note is declared as varchar(255); longer texts may be truncated.

Tables used

Invoices · Write

Parameter	Type	Default	Description
`InvoiceNr`	varchar(20) string	NULL	Invoice number of the invoice to update. Either this or `InvoiceKey` must identify exactly one invoice. Example: `RE2024001234`
`InvoiceKey`	int	NULL	Internal key of the invoice to update. Alternative to `InvoiceNr`; if both are given, they must refer to the same invoice. Example: `58213`
`Note`	varchar(255) string	NULL	New note text for the invoice. Replaces the existing note; `NULL` (or omitting the parameter) clears it. Example: `Zahlung per Vorkasse eingegangen`

Result set 1 · Always; exactly one status row.

Status of the operation.

Column	Type	Description
`ErrorNr`	varchar(3) string	Status code: `200` success, `404` invoice not found or ambiguous, `500` update failed.
`ErrorMessage`	varchar(75) string	Error text; empty on success.

Response example

<SqlRowSet1>
  <row>
    <ErrorNr>200</ErrorNr>
    <ErrorMessage/>
  </row>
</SqlRowSet1>

Status	Message	Cause
404	Invoice does not exist or two different invoice parameters were specified.	No invoice matches `InvoiceNr`/`InvoiceKey`, neither parameter was passed, or the two parameters point to different invoices. Pass a valid number or key of a single invoice.
500	Technical problems during update of the Invoice information	The update of `Invoices` raised an SQL error (e.g. locking or constraint problems). The original error is not returned; retry or check the database.

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiInvoiceSetInfo>
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
      <!-- <InvoiceKey>58213</InvoiceKey> -->
      <!-- <Note>Zahlung per Vorkasse eingegangen</Note> -->
    </ns1:pixiInvoiceSetInfo>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiInvoiceSetInfo>
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
      <!-- <InvoiceKey>58213</InvoiceKey> -->
      <!-- <Note>Zahlung per Vorkasse eingegangen</Note> -->
    </ns1:pixiInvoiceSetInfo>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'InvoiceNr' => 'RE2024001234',
    // 'InvoiceKey' => '58213',
    // 'Note' => 'Zahlung per Vorkasse eingegangen',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiInvoiceSetInfo', $soapArguments);