SalesTransactionTag Model

This record defines Order Tags and their user specified values associated with a transaction

Required
SalesTransactionTagID : string (GUID)

The Unique identifier for this record

Required
Active_RevisionID : number (int)

This represents the revision of the configuration data that was being used when this record was generated. This is primarily for use by the PowerEPOS software, however 3rd party integrators can set this too if they
are using our configuration data as a basis for sale information, otherwise just set this to 0.

Required MaxLength(32) Truncates
CreatedBy_UserName : string

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

Required MaxLength(64) Truncates
OrderTagCommonName : string

The name of the Order Tag as per the configuration record it was created from.
3rd Party integrations can make up their own names, or they can base them on the existing Order Tag configuration if available.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "Pagers", "Customer Name"

Required MaxLength(64) Truncates
OrderTagLocalizedName : string

The localised name of the Order Tag as per the configuration record it was created from.
3rd Party integrations can make up their own names, or they can base them on the existing Order Tag configuration if available.
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: "Pagers", "Customer Name"

Required MaxLength(8) Truncates
OrderTagCommonReceiptPrefix : string

The prefix of the Order Tag as per the configuration record it was created from. Prefix is added to the front of the Order Tag Value when displayed on receipts.
3rd Party integrations can make up their own prefixes, or they can base them on the existing Order Tag configuration if available. Set to blank (empty string) if no prefix is required.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "NAME", "PAGER"

Required MaxLength(8) Truncates
OrderTagLocalizedReceiptPrefix : string

The localised prefix of the Order Tag as per the configuration record it was created from. Prefix is added to the front of the Order Tag Value when displayed on receipts.
3rd Party integrations can make up their own prefixes, or they can base them on the existing Order Tag configuration if available. Set to blank (empty string) if no prefix is required.
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: "NAME", "PAGER"

Required MaxLength(64) Truncates
Value : string

The preset value or user specified value for the tag. This relates to the type of tag and whether it prompts the user for a custom value.
Example: "15" (for Order Tag "Pager Number")
Example: "Jones Party" (for Order Tag "Customer Name")

Nullable
DateTime : string (ISO 8601 DateTime)

The date/time the tag was added to the order in outlet local time

IsTagCancelled : bool

Has this tag been cancelled/removed

Nullable
CreatedBy_EmployeeID : string (GUID)

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

Nullable
CreatedBy_UserID : string (GUID)

This unique UserID from the POS_Users (configuration) table representing the POS user that created the record.
This may be NULL for 3rd party integrations

Nullable
OrderTagID : string (GUID)

The unique ID of the POS_OrderTags (configuration) record matching the Order Tag the record was created from
This may be NULL for 3rd party integrations

Nullable
StatusFlags : number (int)

The status flags for the tag as per the POSCorePublic.Enums.Sales.TagStatusFlags enum

Example
{
  "SalesTransactionTagID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "Active_RevisionID": 321,
  "CreatedBy_UserName": "string value",
  "OrderTagCommonName": "string value",
  "OrderTagLocalizedName": "string value",
  "OrderTagCommonReceiptPrefix": "string value",
  "OrderTagLocalizedReceiptPrefix": "string value",
  "Value": "string value",
  "DateTime": "2012-04-03T09:40:59.736Z",
  "IsTagCancelled": true,
  "CreatedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "CreatedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "OrderTagID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "StatusFlags": 321
}