ZReport Model

Defines an entry in the Z Reports table

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
IsTraining : bool

Is this a training mode z report (ie not part of official reporting figures)

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
RequiresPrinting : bool

Does this Z report require printing? Typically this is set when a Z report is finalised, but not yet printed. This flag is cleared once the Z has been physically printed.
3rd party integrations would normally set this to false unless there was a requirement for the user to print this Z from the POS system manually.

Required
IsOfflineLocalZ : bool

Was this Z report performed in an offline capacity (ie during a period of disconnection from the server).
3rd party integrations should always set this to false.

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).
3rd party integrations should always set this to false.

Required
WasPrinted : bool

Has this Z report been printed on the POS?

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.
3rd party integrations can use an existing configuration based outlet ID, or can allocate their own outlet ID if the Z Report does not belong to a standard POS outlet.

Required MaxLength(64) Truncates
OutletGroupCommonName : string

The name of the Outlet group that this Z Report belongs to (at the time of creation).
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: Australian Outlets

Required MaxLength(64) Truncates
OutletGroupLocalizedName : string

The localised name of the outlet group that this zreport belongs to (at the time of creation).
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: Australian Outlets

Required MaxLength(64) Truncates
OutletCommonName : string

The name of the Outlet that this Z Report belongs to.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: Little Johns Pizza

Required MaxLength(64) Truncates
OutletLocalizedName : string

The localised name of the Z Report that this transaction belongs to.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: Little Johns Pizza

Required MaxLength(256)
Report_DeviceIdentifier : string

This is an identifier for the device which created the Z Report. PowerEPOS uses a combination of MAC Address, Hostname and OS.
3rd Party integrators can leave this blank, or set this to something meaningful if a need arises to track Z Reports created by a certain device.

Required MaxLength(64) Truncates
Report_TerminalCommonName : string

The name of the terminal (typically the POS terminal) that created the Z Report.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
3rd Party integrations should specify a meaningful name (possibly the integration name) to group the source of the Z Reports, as Terminal is main filter that can be used by the Reporting system.
Example: "POS 1" or "Bar POS" or "Online Orders"

Required MaxLength(64) Truncates
Report_TerminalLocalizedName : string

The localised name of the terminal (typically the POS terminal) that created the Z Report.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
3rd Party integrations should specify a meaningful name (possibly the integration name) to group the source of the Z Reports, as Terminal is main filter that can be used by the Reporting system.
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.
3rd Party integrations can leave this blank or come up with their own short name for the terminal.
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) Truncates
CurrencyCommonName : string

The name of the currency that all values in this Z Report represent.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"

Required MaxLength(64) Truncates
CurrencyLocalizedName : string

The localised name of the currency that all values in this Z Report represent.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"

Required MaxLength(128)
ClientName : string

The name of the software application that has created the Z Report.
3rd Party integrations should enter their application or integration name here.
Example: "My POS App" or "My Website App"

Required MaxLength(128)
ClientVersion : string

The version of the software application that has created the Z Report.
3rd Party integrations should enter their application version name here.
Example: "1.0.0.0" or "1" or "2.5a" etc

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.
3rd party integrations should 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.
3rd party integrations should set this to 0.

Nullable MaxLength(512) Truncates
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 MaxLength(8)
POSServerInstanceID : string

Specifies the ID of the POSServer instance that handled this Z report.
3rd Party integrations should set this to blank (empty string).

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.
3rd Party integrations would normally set this to be NULL

Nullable
FinalisedBy_EmployeeID : string (GUID)

The unique employee record ID of the employee / staff member who finalised/closed the Z Report.
This may be NULL for 3rd party integrations or where no Employee (Time Clocking / HR) integration exists.

Nullable
FinalisedBy_UserID : string (GUID)

This unique UserID from the POS_Users (configuration) table representing the POS user who finalised/closed the Z Report.
This may be NULL for 3rd party integrations

Nullable MaxLength(32) Truncates
FinalisedBy_UserName : string

The name of the POS User / person who finalised/closed the Z Report.
3rd Party integrations should specify a user name (where applicable), or use the integration name as a fallback.
Example: John

Nullable MaxLength(256)
Finalised_DeviceIdentifier : string

This is an identifier for the device which finalised the Z Report. PowerEPOS uses a combination of MAC Address, Hostname and OS.
3rd Party integrators can leave this blank, or set this to something meaningful if a need arises to track Z Report's created by a certain device.

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.
3rd Party integrations would normally set this to be NULL

Nullable MaxLength(64) Truncates
Finalised_TerminalCommonName : string

The name of the terminal (typically the POS terminal) that finalised the Z Report.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
3rd Party integrations should specify a meaningful name (possibly the integration name) to group the source of the Z Reports, as Terminal is main filter that can be used by the Reporting system.
Example: "POS 1" or "Bar POS" or "Online Orders"

Nullable MaxLength(64) Truncates
Finalised_TerminalLocalizedName : string

The localised name of the terminal (typically the POS terminal) that finalised the Z Report.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
3rd Party integrations should specify a meaningful name (possibly the integration name) to group the source of the Z Reports, as Terminal is main filter that can be used by the Reporting system.
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.
3rd Party integrations can leave this blank or come up with their own short name for the terminal.
Example: P1 or TRM1 or INTG

Nullable
ZReportAuditLines : ZReportAuditLine []

A list of Z Report Audit Lines for this Z Report.

Nullable
ZReportInterfaceItems : ZReportInterfaceItem []

A list of Z Report Interface Items for this Z Report.

Example
{
  "ZReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "TradingDate": "2012-04-03T09:40:59.736Z",
  "IsTraining": true,
  "ZReportCounter": 321,
  "DateTimeFrom": "2012-04-03T09:40:59.736Z",
  "AmountFloat": 1.23,
  "RequiresPrinting": true,
  "IsOfflineLocalZ": true,
  "IsOutOfPeriodZ": true,
  "WasPrinted": true,
  "WasFinalisedAsConsolidated": true,
  "OutletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "OutletGroupCommonName": "string value",
  "OutletGroupLocalizedName": "string value",
  "OutletCommonName": "string value",
  "OutletLocalizedName": "string value",
  "Report_DeviceIdentifier": "string value",
  "Report_TerminalCommonName": "string value",
  "Report_TerminalLocalizedName": "string value",
  "Report_TerminalDisplayID": "string value",
  "CurrencyCode": "string value",
  "CurrencySymbol": "string value",
  "CurrencyCommonName": "string value",
  "CurrencyLocalizedName": "string value",
  "ClientName": "string value",
  "ClientVersion": "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,
  "POSServerInstanceID": "string value",
  "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_DeviceIdentifier": "string value",
  "Finalised_TerminalID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "Finalised_TerminalCommonName": "string value",
  "Finalised_TerminalLocalizedName": "string value",
  "Finalised_TerminalDisplayID": "string value",
  "ZReportAuditLines": [],
  "ZReportInterfaceItems": []
}