GenericZReport Model

Required
zReportID : string (GUID)

The globally unique identifier for the Z Report

Required
tradingDate : string (ISO 8601 DateTime)

This is the Trading Date that the Z Report belongs to. There may be multiple Z reports in a single trading date.
This should be just the trading date itself, with no time component. eg 2020-01-01 00:00:00
Related Fields: ZReportID, ZReportCounter

Required
zReportCounter : number (int)

This is the Z Counter for the Z Report itself. This should be an incrementing numeric value for each Z report by outlet/terminal.
Example: 1 (first z report for this terminal), 2 (second z report for this terminal), etc
Related Fields: ZReportID, TradingDate

Required
dateTimeFrom : string (ISO 8601 DateTime)

The starting date and time that this Z report encapsulates in outlet local time.

Required decimal(18, 2)
amountFloat : number (decimal)

The amount of cash that was in the draw as the float amount during this Z period.

Required
isOfflineLocalZ : bool

Was this Z report performed in an offline capacity (ie during a period of disconnection from the server).

Required
isOutOfPeriodZ : bool

Was this Z report performed in an out of period capacity (ie has the POS system date been set backwards resulting in this being out of sequence).

Required
wasFinalisedAsConsolidated : bool

Was this Z report finalised as part of a batch with other Z reports?

Required
outletID : string (GUID)

The unique OutletID for the outlet the Z Report belongs to based on the POS_Outlets (configuration) table.

Required MaxLength(64)
outletGroupName : string

The name of the Outlet group that this Z Report belongs to (at the time of creation).
Example: Australian Outlets

Required MaxLength(64)
outletName : string

The name of the Outlet that this Z Report belongs to.
Example: Little Johns Pizza

Required MaxLength(64)
report_TerminalName : string

The name of the terminal (typically the POS terminal) that created the Z Report.
Example: "POS 1" or "Bar POS" or "Online Orders"

Required MaxLength(4)
report_TerminalDisplayID : string

A short ID for the terminal that created the Z Report, typically matching the ID from the POS_Terminals (configuration) record.
Example: P1 or TRM1 or INTG

Required MaxLength(4)
currencyCode : string

An ISO 4217 currency code indicating the currency that all values in this Z Report represent. This MUST be a valid currency code.
Example: "GBP" or "AUD" or "USD" or "EUR"

Required MaxLength(8)
currencySymbol : string

The currency symbol displayed for values in this currency
Example: "$" or "£" or "€"

Required MaxLength(64)
currencyName : string

The name of the currency that all values in this Z Report represent.
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"

Nullable
dbGen : number (int)

This represents an identifier for a unique database operation that last updated/created this entity. The value is not unique as it can be shared across multiple entities if they were all inserted/updated
from within a single operation. These values are always incrementing so all entities with DBGen > X can be assumed that they were edited/inserted since the operation X occured.

Expect a 64 bit integer.

This is a readonly property. Setting it will have no effect. It will be assigned internally and made visible when querying for this model

Nullable
dateTimeTo : string (ISO 8601 DateTime)

The ending date and time that this Z report encapsulates in outlet local time (when finalised).
For unfinalised (ie currently open) Z periods, this should be NULL

Nullable
dateTimeActivityFrom : string (ISO 8601 DateTime)

Specifies the Date and Time (in outlet local time) of the first record (transaction or non-sale activity) that was included in this Z report.
This may be NULL if unknown, or while the Z report is in an unfinalised state.

Nullable
dateTimeActivityTo : string (ISO 8601 DateTime)

Specifies the Date and Time (in outlet local time) of the last record (transaction or non-sale activity) that was included in this Z report.
This may be NULL if unknown, or while the Z report is in an unfinalised state.

Nullable MaxLength(36)
closedOrderNumberFrom : string

Specifies the ClosedOrderNumber from the first SalesTransaction record that was included in this Z report.
This may be NULL if unknown, or while the Z report is in an unfinalised state.

Nullable MaxLength(36)
closedOrderNumberTo : string

Specifies the ClosedOrderNumber from the last SalesTransaction record that was included in this Z report.
This may be NULL if unknown, or while the Z report is in an unfinalised state.

Nullable
openOrderCount : number (int)

Specifies the number of unfinalised (ie open) orders currently in the system at the time the Z report was finalised.
For unfinalised z reports, set this to 0.

Nullable decimal(18, 2)
openOrderAmount : number (decimal)

Specifies the value of all unfinalised (ie open) orders currently in the system at the time the Z report was finalised.
For unfinalised z reports, set this to 0.

Nullable MaxLength(512)
notes : string

Optional notes associated with the Z report. Leave blank (empty string) if no notes are required.

Nullable
statusFlags : number (int)

This is the numeric representation of the POSCorePublic.Enums.Sales.ZReportStatusFlags applicable to this z report.

Nullable
report_TerminalID : string (GUID)

This is the unique TerminalID of a record from the POS_Terminals (configuration) table representing the Terminal which created the Z Report.

Nullable
finalisedBy_EmployeeID : string (GUID)

The unique employee record ID of the employee / staff member who finalised/closed the Z Report.

Nullable
finalisedBy_UserID : string (GUID)

This unique UserID from the POS_Users (configuration) table representing the POS user who finalised/closed the Z Report.

Nullable MaxLength(32)
finalisedBy_UserName : string

The name of the POS User / person who finalised/closed the Z Report.
Example: John

Nullable
finalised_TerminalID : string (GUID)

This is the unique TerminalID of a record from the POS_Terminals (configuration) table representing the Terminal which finalised the Z Report.

Nullable MaxLength(64)
finalised_TerminalName : string

The name of the terminal (typically the POS terminal) that finalised the Z Report.
Example: "POS 1" or "Bar POS" or "Online Orders"

Nullable MaxLength(4)
finalised_TerminalDisplayID : string

A short ID for the terminal that finalise the Z Report, typically matching the ID from the POS_Terminals (configuration) record.
Example: P1 or TRM1 or INTG

Example
{
  "zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "tradingDate": "2012-04-03T09:40:59.736Z",
  "zReportCounter": 321,
  "dateTimeFrom": "2012-04-03T09:40:59.736Z",
  "amountFloat": 1.23,
  "isOfflineLocalZ": true,
  "isOutOfPeriodZ": true,
  "wasFinalisedAsConsolidated": true,
  "outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "outletGroupName": "string value",
  "outletName": "string value",
  "report_TerminalName": "string value",
  "report_TerminalDisplayID": "string value",
  "currencyCode": "string value",
  "currencySymbol": "string value",
  "currencyName": "string value",
  "dbGen": 321,
  "dateTimeTo": "2012-04-03T09:40:59.736Z",
  "dateTimeActivityFrom": "2012-04-03T09:40:59.736Z",
  "dateTimeActivityTo": "2012-04-03T09:40:59.736Z",
  "closedOrderNumberFrom": "string value",
  "closedOrderNumberTo": "string value",
  "openOrderCount": 321,
  "openOrderAmount": 1.23,
  "notes": "string value",
  "statusFlags": 321,
  "report_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "finalisedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "finalisedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "finalisedBy_UserName": "string value",
  "finalised_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "finalised_TerminalName": "string value",
  "finalised_TerminalDisplayID": "string value"
}