StockOrderNote Model

Defines the model for submitting stock invoices to the EPOS system

Required
stockOrderNoteID : 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 information, otherwise just set this to 0.

Required
contextType : StockOrderNoteContextTypes

The ContextType indicates what type of stock order note this is, and therefore what the ContextID represents.
As per the StockOrderNoteContextTypes enum.

Required
dateTimeCreated : object

The date and time the Stock Invoice was created.

Required MaxLength(32)
createdBy_UserName : string

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

Nullable
contextID : string (GUID)

The optional ContextID associated with this stock order note based on the specified ContextType.

Nullable
dateTimeDeleted : object

The date and time the Purchase Order was Deleted.

Nullable
createdBy_EmployeeID : string (GUID)

The unique employee record ID of the employee / staff member who created the order.
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 order.
This may be NULL for 3rd party integrations

Nullable
deletedBy_EmployeeID : string (GUID)

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

Nullable
deletedBy_UserID : string (GUID)

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

Nullable MaxLength(32)
deletedBy_UserName : string

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

Nullable MaxLength(1024)
note : string

The optional user note for this stock invoice.

Example
{
  "stockOrderNoteID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "active_RevisionID": 321,
  "contextType": 1,
  "dateTimeCreated": {},
  "createdBy_UserName": "string value",
  "contextID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "dateTimeDeleted": {},
  "createdBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "createdBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "deletedBy_EmployeeID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "deletedBy_UserID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "deletedBy_UserName": "string value",
  "note": "string value"
}