Request model for submitting a request to allocate a Z Report for a trading period
Required
outletID :
string (GUID)
The OutletID that the Z Report is associated with. This must be a valid Outlet ID configured within the POS system.
3rd party integrations can be provided with a valid Outlet ID for order submission depending on the customer's requirements.
Nullable
zReportID :
string (GUID)
(SPECIAL) This is the ID of the Z period record that we want to retrieve.
When NOT provided (ie NULL), the ZReportTarget property must be populated.
Rule: You must supply either a ZReportID or ZReportTarget.
Nullable
zReportTarget :
PartnerZReportTarget
(SPECIAL) This defines the parameters of the batch allocation when a specific Z Report ID has NOT been specified.
When provided, a Z will automatically be allocated based on the ZReportTarget settings for the batch.
Note: Auto generated Z's from the ZReportTarget will be created in an unfinalised state and will remain so until a separate api call is made to finalise the Z.
Rule: You must supply either a ZReportID or ZReportTarget.
Example
{
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportTarget": {}
}