This API call returns various customer events, depending on the given parameters. Be aware, that all parameters are combined with an AND condition. Although the event date and the create date a very similar there can be a difference up to a few seconds.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:


Request

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

Request body

Name Type Required Description
CustRef integer false

Show only events that are related to a specific customer

Type: int

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

EventID string false

Returns one specific event by the given ID

Type: varchar(3)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

MaxAmount number false

Show only events with the given maximum amount

Type: money

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

MinAmount number false

Show only events with the given minimum amount

Type: money

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

InvoiceRef integer false

Show only events that are related to a certain invoice

Type: int

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

DoNotRefund boolean false

Filters events that should not be refund

Type: bit

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

EventDateTo string false

[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date.

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

PaymentCode string false

Show only events that have a specific payment code

Type: char

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

ShowDeleted boolean false

Show also deleted events

Type: bit

Default value: 0

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateDateTo string false

[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateTo string false

[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

EventDateFrom string false

EventDateFrom

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

CreateDateFrom string false

[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateFrom string false

[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

MaxMatchedAmount number false

Show only events with the given maximum amount that has been matched

Type: money

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

MinMatchedAmount number false

Show only events with the given minimum amount that has been matched

Type: money

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Result set

Name Type Description
Amount number

Amount

Type: money

Available from: / (25.7.0.59144)

Comment string

DoNotRefund

Type: varchar

Available from: / (25.7.0.59144)

CustRef integer

CustKey from table dbo.Customers.

Type: int

Available from: / (25.7.0.59144)

EventID string

Event ID

Type: varchar

Available from: / (25.7.0.59144)

Matched number

Matched

Type: money

Available from: / (25.7.0.59144)

CreateEmp string

User who created Customer Account

Type: varchar

Available from: / (25.7.0.59144)

EventDate string

Event Date

Type: datetime

Available from: / (25.7.0.59144)

IsDeleted boolean

IsDeleted

Type: bit

Available from: / (25.7.0.59144)

Reference string

Reference

Type: varchar

Available from: / (25.7.0.59144)

UpdateEmp string

User who updated Customer Account

Type: varchar

Available from: / (25.7.0.59144)

CreateDate string

Record create date

Type: datetime

Available from: / (25.7.0.59144)

InvoiceRef integer

Reference to Invoice

Type: int

Available from: / (25.7.0.59144)

UpdateDate string

Record updated date

Type: datetime

Available from: / (25.7.0.59144)

DoNotRefund boolean

Do Not Refund

Type: bit

Available from: / (25.7.0.59144)

OrderCurrency string

OrderCurrency

Type: varchar

Available from: / (25.7.0.59144)

ManualBookingRef integer

Reference to Manual Booking

Type: int

Available from: / (25.7.0.59144)

CustomerAccountKey integer

Customer Account ID.

Type: int

Available from: / (25.7.0.59144)