pixiGetRemindersCA

Returns list of Reminders including Customer account data for given parameters - Reminder level, Payment type, Shop, Reminder days, Dates and some financial parameters.

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Customers data is taken from Billing Address


Request

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

Request body

Name Type Required Description
ShopID string false

Allows to filter results by Shop.

Type: char

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

InvoiceTo string false

Invoice date to. If not set, current date minus reminder days is used.

Type: datetime

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

InvoiceFrom string false

Invoice date from.

Type: datetime

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

PaymentType string false

Allows to filter results by Invoice Payment type.

Type: char

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

ReminderDays integer false

Allows to filter results by Invoice age (in days).

Type: int

Default value: 1

Example:

Available from: LOU Official (6.3.0.4452)

OnlyUnmatched boolean false

Show only Invoices that are not completely paid.

Type: bit

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)

ReminderLevel integer false

Allows to filter results by Reminder level.

Type: int

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

OnlyWhenCAUnbalanced boolean false

Show only Invoices from not balanced Customer accounts.

Type: bit

Default value: 0

Example:

Available from: LOU Official (6.3.0.4452)


Response

1. Returns list of Reminders with Customer account data

Name Type Description
ZIP string

ZIP from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

fax string

Fax number from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

City string

City from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

Email string

Email address from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

Phone string

Phone number from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

State string

State from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

ShopID string

pixi Shop Id

Type: VARCHAR

Available from: / (25.7.0.59144)

Street string

Street from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

AddrKey integer

Billing address Id - internal

Type: INT

Available from: / (25.7.0.59144)

Company string

Company of customer - optional

Type: VARCHAR

Available from: / (25.7.0.59144)

Country string

Country code from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

CustKey integer

Customer Id - internal

Type: INT

Available from: / (25.7.0.59144)

HouseNr string

House number from address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

FullName string

Full name of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

LastName string

Last name of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

CAMatched boolean

Flag if Customer account is matched for Customer

Type: BIT

Available from: / (25.7.0.59144)

FirstName string

First name of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

InvoiceNr string

Invoice number

Type: VARCHAR

Available from: / (25.7.0.59144)

InvoiceKey integer

Invoice Id - internal

Type: INT

Available from: / (25.7.0.59144)

AddressLine string

Full street address of customer

Type: VARCHAR

Available from: / (25.7.0.59144)

InvoiceDate string

Invoice creation date

Type: DATETIME

Available from: / (25.7.0.59144)

LastOrderNr integer

Last pixi Order number for Invoice

Type: INT

Available from: / (25.7.0.59144)

InvoiceTotal number

Invoice total amount

Type: MONEY

Available from: / (25.7.0.59144)

ReminderDate1 string

Date of Reminder level 1 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

ReminderDate2 string

Date of Reminder level 2 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

ReminderDate3 string

Date of Reminder level 3 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

ReminderDate4 string

Date of Reminder level 4 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

ReminderDate5 string

Date of Reminder level 5 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

ReminderDate6 string

Date of Reminder level 6 for the Invoice

Type: DATETIME

Available from: / (25.7.0.59144)

AllReminderCosts number

Costs of all reminders for the Invoice

Type: MONEY

Available from: / (25.7.0.59144)

LastReminderCosts number

Costs of last reminder for the Invoice

Type: MONEY

Available from: / (25.7.0.59144)

OpenInvoiceAmount number

Open amount for the Invoice

Type: MONEY

Available from: / (25.7.0.59144)

CAFinancialBalance number

Customer account financial balance

Type: MONEY

Available from: / (25.7.0.59144)

CustomerNrExternal string

External Customer number

Type: VARCHAR

Available from: / (25.7.0.59144)

LastOrderNrExternal string

Last external (shop) Order number for Invoice

Type: VARCHAR

Available from: / (25.7.0.59144)

CurrentReminderLevel integer

Maximum reminder level for Invoice

Type: INT

Available from: / (25.7.0.59144)