PartnerZReportTarget Model

Request model for automatically allocating a Z Report to a batch request.

Required MaxLength(10)
tradingDate : string

This is the Trading Date that this batch's sales figures should be included in.
Format: This should be just the trading date itself (ie yyyy-MM-dd), with no time component. eg 2020-01-01
Info: A Trading date encompasses a 24 hour period in which sales are allocated. Businesses that operate over midnight for example would typically encompass a time range of 6am to 6am. Using this as an example,
the trading date of 2021-01-10 would actually compass all orders that occurred between 2021-01-10 6:00am and 2021-01-11 6:00am

Required MaxLength(64)
terminalName : string

The name of the terminal or 3rd party component that created the batch.
3rd Party integrations should specify a meaningful name (possibly the integration name) to group the source of the transactions, as Terminal is a main filter that can be used by the Reporting system.
Example: "MyIntegration"

Required MaxLength(128)
clientName : string

The name of the software application that has created the batch.
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 batch.
3rd Party integrations should enter their application version name here.
Example: "1.0.0.0" or "1" or "2.5a" etc

Nullable
isTraining : bool

(Optional) Is this a training/test order (ie not part of official sales figures)
Default: false

Nullable MaxLength(4)
currencyCode : string

(Optional) An ISO 4217 currency code indicating the currency that all values in this batch represent. This MUST be a valid currency code. If supplied, CurrencySymbol and CurrencyName must also be populated.
Default: Will use the default currency code from the outlet that this batch is being submitted to
Example: "GBP" or "AUD" or "USD" or "EUR"
Related Fields: CurrencySymbol, CurrencyName

Nullable MaxLength(8)
currencySymbol : string

(Optional) The currency symbol displayed for values in this currency. If supplied, CurrencyCode and CurrencyName must also be populated.
Default: Will use the default currency symbol from the outlet that this batch is being submitted to
Example: "$" or "£" or "€"
Related Fields: CurrencyCode, CurrencyName

Nullable MaxLength(64)
currencyName : string

(Optional) The name of the currency that all values in this batch represent. If supplied, CurrencyCode and CurrencySymbol must also be populated.
Default: Will use the default currency name from the outlet that this batch is being submitted to
Example: "Euro" or "Pound Stirling" or "Australian Dollar" or "US Dollar"
Related Fields: CurrencyCode, CurrencySymbol

Example
{
  "tradingDate": "string value",
  "terminalName": "string value",
  "clientName": "string value",
  "clientVersion": "string value",
  "isTraining": true,
  "currencyCode": "string value",
  "currencySymbol": "string value",
  "currencyName": "string value"
}