Defines an entry in the Z Reports table
Required
outletID :
string (GUID)
The OutletID that the Z Report is associated with.
Required
zReportID :
string (GUID)
The globally unique identifier for the Z Report
Required
zReportCounter :
number (int)
The Z Report Counter allocated to the Z Report. This is automatically generated by the system when a new Z Report is created for an integration.
Required
zReportTarget :
PartnerZReportTarget
Contains the parameters of the Z Report batch allocation for the Z Report.
Required
isFinalised :
bool
Has this Z Report been finalised?
Nullable
finalisedDateTime :
string (ISO 8601 DateTime)
The date and time that this Z report was finalised in outlet local time. If finalised by a 3rd Party integrations, this will be the Date and Time they supplied in the finalise request.
For unfinalised (ie currently open) Z periods, this will be NULL
Nullable
MaxLength(32)
finalisedUserName :
string
The name of the POS User / interface that finalised the Z Report.
For unfinalised (ie currently open) Z periods, this will be NULL
Example: John or External Interface
Example
{
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportCounter": 321,
"zReportTarget": {},
"isFinalised": true,
"finalisedDateTime": "2012-04-03T09:40:59.736Z",
"finalisedUserName": "string value"
}