Returns list of Invoices (Reminder candidates) for given parameters - Reminder level, Payment type, Shop and Reminder days.

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/pixiGetReminders

Request body

Name Type Required Description
ShopID string true

Allows to filter results by Shop.

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

PaymentType string true

Allows to filter results by Invoice Payment type.

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

ReminderDays integer false

Allows to filter results by Invoice age (in days). If not set, DB setting or default values are used.

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

ReminderLevel integer true

Allows to filter results by Reminder level. Value should be 1 or higher.

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)


Response

1. Returns list of Reminders

Name Type Description
zip string

ZIP from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

city string

City from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

name string

Name of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

email string

Email address from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

name2 string

Name of customer (2nd part) - optional

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

phone string

Phone number from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

state string

State from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

total number

Invoice total amount

Type: MONEY

Available from: 25.06 (25.6.0.58802)

careof string

Company of customer - optional

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

street string

Street from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

country string

Country code from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

housenr string

House number from address of customer

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

invdate string

Invoice creation date

Type: DATETIME

Available from: 25.06 (25.6.0.58802)

payment string

Invoice payment type

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

CuseMail string

Shop email address

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

ShopName string

Shop name

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

invoicenr string

Invoice number

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)

shipmenttrackingid string

Shipment tracking Id. Can contain multiple values, separated by delimiter (semicolon by default)

Type: VARCHAR

Available from: 25.06 (25.6.0.58802)