The function returns all POS events within given period of time, for a given location and a given cash register. (Both these parameters can be empty meaning "all"). Return dataset is equivalent to the report "POS Journal" available in pixi* Reports.

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


Request

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

Request body

Name Type Required Description
LocID string false

Location Id

Type: varchar(3)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

ToDate string false

End date of the event range.

Type: datetime

Default value: When its not specified then end of the today is taken.

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

FromDate string false

Start date of the event range.

Type: datetime

Default value: When its not specified then start of the today is taken.

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

RegisterID string false

POS Register Id

Type: varchar(30)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

ResultCode string false

Type: char

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

ResultText string false

Type: varchar(1024)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. POS events

Name Type Description
VatLow number

Vat Low

Type: money

Available from: 25.06 (25.6.0.58802)

VatHigh number

Vat High

Type: money

Available from: 25.06 (25.6.0.58802)

AmountIn number

Amount In

Type: money

Available from: 25.06 (25.6.0.58802)

AmountOut number

Amount Out

Type: money

Available from: 25.06 (25.6.0.58802)

CreatedBy string

Created By

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

EventTime string

Event Time

Type: datetime

Available from: 25.06 (25.6.0.58802)

EventType string

Event Type

Type: char (1)

Available from: 25.06 (25.6.0.58802)

InvoiceNr string

Invoice Nr

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)

UpdatedBy string

Updated By

Type: varchar (50)

Available from: 25.06 (25.6.0.58802)

RegisterID string

POS Register Id

Type: varchar (30)

Available from: 25.06 (25.6.0.58802)

EventComment string

Event Comment

Type: varchar (max)

Available from: 25.06 (25.6.0.58802)

InvoiceAmount number

Invoice Amount

Type: money

Available from: 25.06 (25.6.0.58802)

RegisterValue number

Register Value

Type: money

Available from: 25.06 (25.6.0.58802)

EventDescription string

Event Description

Type: varchar (100)

Available from: 25.06 (25.6.0.58802)