pixi Developer & Integration Documentation

pixiShowSpecialCommentCustomers

Description

Returns customer account records that have a special comment (history note) set on the customer. When an invoice number is provided, returns the matching account record for that specific invoice regardless of whether a special comment exists. When no invoice number is provided, returns all customers with a non-empty special comment, ordered by invoice date descending.

Use this API call to retrieve customers flagged with a history note for follow-up workflows, or to look up account details for a known invoice number.


Request Parameters

#

Name

Type

Required

Example

Description

1

Rows

int

0

300

Maximum number of rows to return. Default is 300. Passing NULL or omitting uses the default.

2

InvoiceNr

varchar(64)

0

TOTAY1

Invoice number to look up. When provided, returns the account record for that specific invoice. When omitted or empty, returns all customers with a special comment ordered by invoice date descending.


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:pixiShowSpecialCommentCustomers>
<dem:Rows>300</dem:Rows>
<dem:InvoiceNr>TOTAY1</dem:InvoiceNr>
</dem:pixiShowSpecialCommentCustomers>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Customer account data

#

Name

Type

Description

1

SName

varchar(60)

Invoice/shipping name of the customer.

2

SCareOf

varchar(60)

Care-of name associated with the customer's invoice address.

3

SZIP

varchar(10)

Postal code of the customer's invoice address.

4

SCity

varchar(60)

City of the customer's invoice address.

5

CHisNote

varchar(1000)

Special comment or history note set on the customer account. This is the field used to filter when no InvoiceNr is provided.

6

InvoiceNr

varchar(20)

Invoice number of the associated invoice.

7

total

varchar(20)

Total amount of the invoice.

8

InvDate

datetime

Date of the invoice. Results are ordered by this field descending when no InvoiceNr is specified.

9

DATEVAccountNr

varchar(10)

Datev accounting account number of the customer.

10

CurrencyCode

varchar(3)

ISO currency code of the invoice (e.g. EUR, USD).


Additional Notes

When InvoiceNr is provided: returns the account record matching that invoice, regardless of whether a special comment exists on the customer.
When InvoiceNr is omitted or empty: returns all customers where CHisNote is not empty and InvoiceNr is not empty, ordered by InvDate descending.

An empty string passed for InvoiceNr is treated the same as omitting the parameter (returns all commented customers).

Results are limited by the Rows parameter (default: 300).