PartnerZFinaliseResponse Model

Defines the response packet for a Z Finalise request.

Required
resultCode : ZFinaliseResultCode

The result of the finalise request as per the ZFinaliseResultCode enum.

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 Z Report target information for the specified Z Report.

Nullable
finalisedDateTime : string (ISO 8601 DateTime)

The date and time that this Z report was finalised in outlet local time, or NULL if it is unfinalised.
If finalised, this will be the stored Date and Time that was supplied in the finalise request.

Nullable MaxLength(32)
finalisedUserName : string

The name of the POS User / interface that finalised the Z Report, or NULL if it is unfinalised.
Example: John or External Interface

Example
{
  "resultCode": 1,
  "outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "zReportCounter": 321,
  "zReportTarget": {},
  "finalisedDateTime": "2012-04-03T09:40:59.736Z",
  "finalisedUserName": "string value"
}