Description
Sets or updates the note field on an existing invoice. The invoice is identified by either its invoice number or its internal invoice ID. On success, returns status code 200. On failure, returns an error code and description.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
InvoiceNr |
varchar(20) |
0 |
INV00000001 |
Invoice number. Either InvoiceNr or InvoiceKey must be provided to identify the invoice. |
2 |
InvoiceKey |
int |
0 |
123 |
Internal invoice ID. Either InvoiceNr or InvoiceKey must be provided to identify the invoice. |
3 |
Note |
varchar(255) |
0 |
abcdef |
The note text to set on the invoice. Maximum 255 characters. If not provided, the note is cleared (set to NULL). |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pipiInvoiceSetInfo>
<dem:InvoiceNr>INV00000001</dem:InvoiceNr>
<dem:InvoiceKey></dem:InvoiceKey>
<dem:Note>abcdef</dem:Note>
</dem:pipiInvoiceSetInfo>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result set
# |
Name |
Type |
Description |
1 |
ErrorNr |
varchar |
Status code of the operation. 200 = success; 404 = invoice not found or conflicting parameters; 500 = error during update. |
2 |
ErrorMessage |
varchar |
Empty on success. Descriptive error message on failure. |
Additional Notes
At least one of InvoiceNr or InvoiceKey must be provided. If neither is given, the invoice cannot be identified and a 404 is returned.
If both InvoiceNr and InvoiceKey are provided and they reference different invoices, the count check will return more than one result and a 404 error is returned.
If Note is not provided (or sent as empty), the invoice note is set to NULL, effectively clearing any existing note.
ErrorNr values:
200 — note updated successfully; ErrorMessage is empty
404 — invoice not found, or InvoiceNr and InvoiceKey reference different invoices
500 — a technical error occurred during the database update