Jumpmind Commerce Data Model
Devices Microservice
DEV_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_DEVICE_AUTH (DeviceAuthModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| AUTH_TOKEN |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_DEVICE (DeviceModel)
A device used to transaction commerce for a Business Unit
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
A unique identifier for this Device |
| PARENT_DEVICE_ID |
|
VARCHAR |
128 |
|
| TIMEZONE_OFFSET |
|
VARCHAR |
128 |
The timezone offset under which this Device currently operates |
| DESCRIPTION |
|
VARCHAR |
255 |
A user defined name for the Device |
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_DEVICE_PERSONALIZATION (DevicePersonalizationModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_NAME |
X |
VARCHAR |
128 |
|
| SERVER_URL |
|
VARCHAR |
128 |
|
| DEVICE_ID |
|
VARCHAR |
128 |
|
| APP_ID |
|
VARCHAR |
128 |
|
| PARENT_DEVICE_ID |
|
VARCHAR |
128 |
|
| PARENT_APP_ID |
|
VARCHAR |
128 |
|
| FAILOVER_SERVER_URL1 |
|
VARCHAR |
128 |
|
| FAILOVER_SERVER_URL2 |
|
VARCHAR |
128 |
|
| FAILOVER_SERVER_URL3 |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DEV_DEVICE_STATUS (DeviceStatusModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| DEVICE_STATUS |
|
VARCHAR |
128 |
|
| ACTIVE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Context Microservice
CTX_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_ALERT (AlertModel)
| Column Name |
PK |
Type |
Size |
Description |
| ALERT_ID |
X |
BIGINT |
|
|
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ALERT_TYPE |
|
VARCHAR |
128 |
|
| ALERT_MESSAGE |
|
VARCHAR |
128 |
|
| STACK_TRACE |
|
OTHER |
|
|
| PAYLOAD_TYPE |
|
VARCHAR |
128 |
|
| PAYLOAD |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_AREA_CODE (AreaCodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| AREA_CODE |
X |
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_ADDRESS_I18N (BusinessUnitAddressI18NModel)
Business unit address i18n values
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| LOCALE |
X |
VARCHAR |
128 |
The locale of the address field values in this record. |
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_ADDRESS (BusinessUnitAddressModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_ATTR_I18N (BusinessUnitAttributeI18NModel)
Business unit attribute i18n values
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The unique identifier for the Business Unit. See ctx_business_unit.business_unit_id. |
| ATTR_KEY |
X |
VARCHAR |
128 |
The attribute name or id of the attribute. E.g., fiscal.corpName, salesAudit.buId. |
| LOCALE |
X |
VARCHAR |
128 |
The locale of the business unit field values in this record. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
The localized name for the attribute to display on a user interface. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_ATTR (BusinessUnitAttributeModel)
Contains one or more attributes for a business unit, which are not already present in the BusinessUnitModel and can vary as required by an implementation.
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The unique identifier for the Business Unit. |
| ATTR_KEY |
X |
VARCHAR |
128 |
The attribute name or id of the attribute. E.g., fiscal.corpName, salesAudit.buId. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
The name for the attribute to display on a user interface. |
| ATTR_VALUE |
|
VARCHAR |
128 |
The value of the attribute. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_BRAND (BusinessUnitBrandModel)
Assigns brands to business units
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| BRAND_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_GRP_LNK (BusinessUnitGroupLinkModel)
The link between a business unit and its group
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_GROUP_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| GROUP_TYPE |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_GRP (BusinessUnitGroupModel)
A grouping of business units
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_GROUP_ID |
X |
VARCHAR |
128 |
|
| GROUP_TYPE |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_GROUP_NAME |
|
VARCHAR |
128 |
|
| DELETED |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT_I18N (BusinessUnitI18NModel)
Business unit i18n values
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The unique identifier for the Business Unit. See ctx_business_unit.business_unit_id. |
| LOCALE |
X |
VARCHAR |
128 |
The locale of the business unit field values in this record. |
| BUSINESS_UNIT_NAME |
|
VARCHAR |
128 |
The translated name for the business unit for this locale. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_BUSINESS_UNIT (BusinessUnitModel)
An operating entity which provides commerce capabilities for a company and Brand. A business unit can be a store, a kiosk, a web site, etc.
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
A unique identifier for the Business Unit. |
| PARENT_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
Used for establishing a relationship between this business unit and another one defined in the same table. For example, to relate a RETAIL_LOCATION row back to its parent CORP row. |
| TYPE_CODE |
|
VARCHAR |
128 |
The type of the business unit. |
| GEO_CODE |
|
VARCHAR |
128 |
The geographic code in which this Business Unit transacts its business. Used for calculating tax. |
| BUSINESS_UNIT_NAME |
|
VARCHAR |
128 |
A name for the Business Unit. |
| GOVERNMENT_ID |
|
VARCHAR |
128 |
An identifier issued to this business unit by a governing authority |
| TAX_ID |
|
VARCHAR |
128 |
The tax identifier for the business unit. |
| VAT_ID |
|
VARCHAR |
128 |
For EU business units, this is the Value Added Tax identifier. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_PHONE (BusinessUnitPhoneModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| PHONE_NUMBER |
|
VARCHAR |
128 |
|
| PRIMARY_NUMBER |
|
OTHER |
|
|
| PHONE_NUMBER_TYPE |
|
VARCHAR |
128 |
The CodeModel associated with this phone, e.g. HOME, CELL, MAIN |
| PHONE_NUMBER_LABEL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
An action (Button) that is available on the user interface
| Column Name |
PK |
Type |
Size |
Description |
| BUTTON_GROUP_ID |
X |
VARCHAR |
128 |
The group to which this Button belongs. Button groups are used to group Buttons on the JumpMind Commerce user interface |
| BUTTON_ID |
X |
VARCHAR |
128 |
A unique identifier for this Button |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| PARENT_BUTTON_ID |
|
VARCHAR |
128 |
The parent Button Id of this Button. Used for hierarchical Buttons on the Nu-Commerce user interface |
| DISPLAY_ORDER |
|
INTEGER |
|
The order in which this Button should be displayed in context to other Buttons |
| BUTTON_NAME |
|
VARCHAR |
128 |
The name of the Button to be displayed in the user interface |
| BUTTON_TYPE |
|
VARCHAR |
128 |
The type of action this Button will invoke. Either ACTION, EMBEDDED_WEB_URL, NEW_PAGE_WEB_URL, SERVER_SCRIPT or CLIENT_SCRIPT |
| BUTTON_VALUE |
|
OTHER |
|
The action the Button should invoke when selected. I.E. for NEW_PAGE_WEB_URL, the Button Value might be 'http://mycompany/mypage.html' |
| BUTTON_VARIANT |
|
VARCHAR |
128 |
The variant for the button. IE primary, secondary, tertiary, neutral |
| DEFAULT_PAYLOAD |
|
VARCHAR |
128 |
Optional default payload for action to be sent back to the server |
| ENABLED |
|
OTHER |
|
Whether the Button is enabled by default |
| VISIBLE |
|
OTHER |
|
Whether the Button is visible by default |
| ICON_TYPE |
|
VARCHAR |
1024 |
The icon type for the Button |
| PERMISSION_ID |
|
VARCHAR |
128 |
The id of the permission required to run the action associated with the button |
| ADDITIONAL_STYLE |
|
VARCHAR |
128 |
Additional style to apply to the button |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| ENABLE_IN_TRAINING_MODE |
|
OTHER |
|
Enable button when in training mode. |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CODE (CodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| CODE_GROUP_ID |
X |
VARCHAR |
128 |
The parent grouping value that identifies which codeId values are related to each other. |
| CODE_ID |
X |
VARCHAR |
128 |
A unique value associated with the codeGroupId. |
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| DISPLAY_DEFAULT_FLAG |
|
OTHER |
|
A flag identifying whether this record is the default value for the group. |
| ENABLED_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CONFIG_FOUNDATION (ConfigFoundationModel)
A configuration option that can be applied to affect application functionality. This version of configuration is meant to be base configuration
| Column Name |
PK |
Type |
Size |
Description |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| CONFIG_NAME |
X |
VARCHAR |
128 |
The configuration name of tag |
| CONFIG_VALUE |
|
OTHER |
|
The config value formatted in yaml or property format |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CONFIG (ConfigModel)
A configuration option that can be applied to affect application functionality
| Column Name |
PK |
Type |
Size |
Description |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| CONFIG_NAME |
X |
VARCHAR |
128 |
The configuration name of tag |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| CONFIG_VALUE |
|
OTHER |
|
The config value formatted in yaml or property format |
| ENABLED |
|
OTHER |
|
Whether the Config is enabled |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| EDIT_GROUP_ID |
|
VARCHAR |
128 |
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_COUNTRY_I18N (CountryI18NModel)
| Column Name |
PK |
Type |
Size |
Description |
| COUNTRY_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
The locale of the country field values in this record. |
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_COUNTRY (CountryModel)
| Column Name |
PK |
Type |
Size |
Description |
| COUNTRY_ID |
X |
VARCHAR |
128 |
|
| ALT_COUNTRY_ID |
|
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CURRENCY_DENOMINATION (CurrencyDenominationModel)
Represents the possible denominations available to a currency.
| Column Name |
PK |
Type |
Size |
Description |
| ISO_CURRENCY_CODE |
X |
VARCHAR |
3 |
The alphabetic ISO 4217 currency code. |
| DENOMINATION_TYPE |
X |
VARCHAR |
128 |
The type of physical currency, coin or bill. |
| AMOUNT |
X |
DECIMAL |
12,3 |
The amount money this denomination represents. |
| DESCRIPTION |
|
VARCHAR |
128 |
A description of the denomination of money. |
| AVAILABLE_AS_CHANGE |
|
OTHER |
|
Denotes whether this denomination of money is kept on hand and is available to give as change by the business unit. |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CURRENCY (CurrencyModel)
Represents the possible currencies available to tender.
| Column Name |
PK |
Type |
Size |
Description |
| ALPHABETIC_CODE |
X |
VARCHAR |
3 |
The 3-character currency code. Under ISO 4217, the first two letters represent the two-letter country identifier and the third letter corresponds to the first letter of the currency name. |
This is based on the ISO 4217 specification, but could be extended to support non-spec currencies too, such as virtual fake money currency like Bitcoin (BTC) and Ethereum (ETH). |
| NUMERIC_CODE | | VARCHAR | 3 | A three-digit numeric code that is used in countries that do not use Latin scripts for their computerized systems. Where possible, the numeric code is the same as the numeric country code. |
| CURRENCY_NAME | | VARCHAR | 128 | The name of the currency. |
| ROUNDING_STRATEGY | | VARCHAR | 128 | The rounding strategy that is used for this currency. |
| DECIMAL_PRECISION | | INTEGER | | The number of decimal places of precision the currency supports. The ISO standard states this can be any number from 0-3, for example USD = 2 and JPY = 0. |
| ROUNDING_AMOUNT | | DECIMAL | 12,3 | Amount used for when performing rounding |
| TENDER_AMOUNT_REGEX | | VARCHAR | 128 | Allows setting currency minimum unit |
| CREATE_TIME | | TIMESTAMP | | Timestamp when this entry was created. |
| CREATE_BY | | VARCHAR | 50 | The user who last updated this entry. |
| LAST_UPDATE_TIME | | TIMESTAMP | | Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY | | VARCHAR | 50 | The user who last updated this entry. |
CTX_DISPOSITION_CODE (DispositionCodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| DISPOSITION_GROUP_ID |
X |
VARCHAR |
128 |
|
| DISPOSITION_CODE_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| DISPLAY_DEFAULT |
|
OTHER |
|
|
| SELLABLE |
|
OTHER |
|
Whether the disposition indicates the item is sellable. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Defines field for a form used in the application
| Column Name |
PK |
Type |
Size |
Description |
| FORM_ID |
X |
VARCHAR |
128 |
|
| FORM_FIELD_ID |
X |
VARCHAR |
128 |
A unique identifier for this form field |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| DISPLAY_ORDER |
|
INTEGER |
|
The order in which this form field should be displayed in context to other form fields |
| FIELD_TYPE |
|
VARCHAR |
128 |
The type of form field that will be created. Either ALPHA, ALPHANUMERIC, NUMERIC, COMBO, PHONE, EMAIL |
| ADDITIONAL_STYLE |
|
VARCHAR |
128 |
Additional style to apply to the form field |
| DEFAULT_VALUE |
|
OTHER |
|
|
| ENABLED |
|
OTHER |
|
Whether the form field is enabled by default |
| USE_TO_SEARCH |
|
OTHER |
|
If this column is set it will be used to search for existing records prior to saving |
| ICON_TYPE |
|
VARCHAR |
128 |
The icon type for the form field |
| REQUIRED |
|
OTHER |
|
|
| READ_ONLY |
|
OTHER |
|
|
| MIN_LENGTH |
|
INTEGER |
|
The minimum length of the field used for validation |
| MAX_LENGTH |
|
INTEGER |
|
The maximum length of the field used for validation |
| PATTERN |
|
VARCHAR |
1024 |
The regular expression used to validate the field |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| REQUIRED_OVERRIDABLE |
|
OTHER |
|
If set, a required field will be able to be overridden and marked as unable to be filled |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Defines options for a field for a form used in the application
| Column Name |
PK |
Type |
Size |
Description |
| FORM_ID |
X |
VARCHAR |
128 |
|
| FORM_FIELD_ID |
X |
VARCHAR |
128 |
A unique identifier for form field this option belongs to |
| OPTION_ID |
X |
VARCHAR |
128 |
A unique identifier for this option |
| OPTION_VALUE |
|
OTHER |
|
A value that will be shown in a list |
| DISPLAY_ORDER |
|
INTEGER |
|
The order in which this option should be displayed in context to other options |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| FORM_ID |
X |
VARCHAR |
128 |
|
| FORM_GROUP_ID |
|
VARCHAR |
128 |
A way to group forms together. Might be used when a different form exists on different tabs |
| ICON_TYPE |
|
VARCHAR |
128 |
The icon type for the form |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_GENDER (GenderModel)
| Column Name |
PK |
Type |
Size |
Description |
| GENDER_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_JOB_LOG (JobLogModel)
| Column Name |
PK |
Type |
Size |
Description |
| JOB_LOG_ID |
X |
BIGINT |
|
|
| JOB_NAME |
|
VARCHAR |
128 |
|
| LOG_LEVEL |
|
VARCHAR |
128 |
|
| MESSAGE |
|
VARCHAR |
128 |
|
| STACK_TRACE |
|
OTHER |
|
|
| PAYLOAD_TYPE |
|
VARCHAR |
128 |
|
| PAYLOAD |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_LANGUAGE (LanguageModel)
| Column Name |
PK |
Type |
Size |
Description |
| LANGUAGE_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_LOCK (LockModel)
| Column Name |
PK |
Type |
Size |
Description |
| LOCK_NAME |
X |
VARCHAR |
128 |
|
| LOCKING_ID |
|
VARCHAR |
128 |
|
| LOCK_TIME |
|
TIMESTAMP |
|
|
| LAST_LOCK_TIME |
|
TIMESTAMP |
|
|
| LAST_LOCKING_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_PROMPT (PromptModel)
| Column Name |
PK |
Type |
Size |
Description |
| PROMPT_ID |
X |
VARCHAR |
128 |
|
| PROMPT_TYPE |
|
VARCHAR |
128 |
the type of prompt. ie MESSAGE, etc |
| PROMPT_ON |
|
VARCHAR |
128 |
where to show the prompt |
| PROMPT_TIME |
|
VARCHAR |
128 |
the time in which the prompt should be shown. ie during ITEM_SCANNED, CONTINUE_TO_TENDER, etc |
| PROMPT_TITLE_KEY |
|
VARCHAR |
128 |
|
| PROMPT_MESSAGE_KEY |
|
VARCHAR |
128 |
|
| ADDITIONAL_STYLE |
|
VARCHAR |
128 |
|
| PROMPT_SOUND |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_PUSH_NOTIFICATION (PushNotificationModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| CLIENT_REGISTRATION_ID |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_REASON_CODE (ReasonCodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| REASON_CODE_GROUP_ID |
X |
VARCHAR |
128 |
|
| REASON_CODE_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| DISPLAY_DEFAULT |
|
OTHER |
|
|
| DISPOSITION_GROUP_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_SEQUENCE (SequenceModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NAME |
X |
VARCHAR |
128 |
|
| SALT_VALUE |
|
VARCHAR |
128 |
|
| CURRENT_VALUE |
|
BIGINT |
|
|
| INCREMENT_BY |
|
INTEGER |
|
|
| MAX_VALUE |
|
BIGINT |
|
|
| MIN_VALUE |
|
BIGINT |
|
|
| CYCLE_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_STATE_I18N (StateI18NModel)
| Column Name |
PK |
Type |
Size |
Description |
| STATE_ID |
X |
VARCHAR |
128 |
|
| COUNTRY_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
The locale of the state field values in this record. |
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_STATE (StateModel)
| Column Name |
PK |
Type |
Size |
Description |
| STATE_ID |
X |
VARCHAR |
128 |
|
| COUNTRY_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_LOCATION_TRAFFIC (TrafficModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
Business Unit Id of the traffic data represented |
| BUSINESS_DATE |
X |
VARCHAR |
128 |
Business Date of the traffic data represented |
| ORBIT |
X |
VARCHAR |
128 |
The orbit on which the traffic data was captured |
| RECORDED_TIME |
X |
VARCHAR |
128 |
The recorded time for the traffic data that was captured |
| HOUR_PERIOD |
|
VARCHAR |
128 |
The hour of dat for the traffic data that was captured |
| COUNT_IN |
|
VARCHAR |
128 |
The number of individuals counted in during the recordedTime period |
| COUNT_OUT |
|
VARCHAR |
128 |
The count of individuals counted out during the recordedTime period |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_USAGE_STAT (UsageStatModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| STAT_COLLECTOR_ID |
X |
VARCHAR |
128 |
|
| INTERVAL_START_TIMESTAMP |
X |
TIMESTAMP |
|
|
| INTERVAL_END_TIMESTAMP |
|
TIMESTAMP |
|
|
| SAMPLE_COUNT |
|
INTEGER |
|
|
| MINIMUM_DURATION_MS |
|
BIGINT |
|
|
| MAXIMUM_DURATION_MS |
|
BIGINT |
|
|
| AVERAGE_DURATION_MS |
|
BIGINT |
|
|
| TOTAL_DURATION_MS |
|
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_VERSIONS (VersionModel)
| Column Name |
PK |
Type |
Size |
Description |
| COMPONENT_NAME |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| BUILD_NUMBER |
|
VARCHAR |
128 |
|
| BUILD_NAME |
|
VARCHAR |
128 |
|
| GIT_HASH |
|
VARCHAR |
128 |
|
| GIT_BRANCH |
|
VARCHAR |
128 |
|
| VERSION |
|
VARCHAR |
128 |
|
| BUILD_TIME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_WEBHOOK_SUBSCRIBER (WebHookSubscriberModel)
| Column Name |
PK |
Type |
Size |
Description |
| SUBSCRIBER_ID |
X |
VARCHAR |
128 |
|
| EVENT_TYPE_CODE |
|
VARCHAR |
128 |
|
| WEB_HOOK_URL |
|
VARCHAR |
1024 |
|
| ENABLED |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CTX_CURRENCY_EXCHANGE_RATE (CurrencyExchangeRateModel)
| Column Name |
PK |
Type |
Size |
Description |
| FROM_CURRENCY_CODE |
X |
VARCHAR |
3 |
The ISO 4217 alphabetic currency code to convert from. |
| TO_CURRENCY_CODE |
X |
VARCHAR |
3 |
The ISO 4217 alphabetic currency code to convert to. |
| RATE |
|
DECIMAL |
14,9 |
The rate of exchange. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
User Microservice
USR_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_PASSWORD_HISTORY (PasswordHistoryModel)
| Column Name |
PK |
Type |
Size |
Description |
| USERNAME |
X |
VARCHAR |
128 |
|
| PASSWORD_SEQUENCE |
X |
INTEGER |
|
|
| HASHED_PASSWORD |
|
VARCHAR |
254 |
|
| SALT |
|
VARCHAR |
16 |
|
| ENCRYPTION_METHOD |
|
VARCHAR |
128 |
|
| HASH_ITERATIONS |
|
INTEGER |
|
|
| KEY_LENGTH |
|
INTEGER |
|
|
| PBKDF2_ENABLED |
|
OTHER |
|
|
| EXPIRATION_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_PERMISSION (PermissionModel)
A table that associates workgroups with resources and specifies their access level.
| Column Name |
PK |
Type |
Size |
Description |
| PERMISSION_ID |
X |
VARCHAR |
128 |
e.g. sell.apply.discount OR sell.* |
| ALLOWS_OVERRIDE |
|
OTHER |
|
Allow an operation such as a manager override. |
| REQUIRES_LOGIN |
|
OTHER |
|
A flag that indicates that the permission requires a user login |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_SECURITY_QUESTION (SecurityQuestionModel)
A question that is put ot the Customer or Operator when they have forgotten their Password and the system is trying to verify their identity.
| Column Name |
PK |
Type |
Size |
Description |
| SECURITY_QUESTION_ID |
X |
VARCHAR |
128 |
|
| QUESTION_TEXT |
|
VARCHAR |
255 |
A question that is put to a Customer or Operator when they have forgotten their Password and the system is trying to verify their identity and allow a new Password to be set. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_USER_JOB_CODE (UserJobCodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| USERNAME |
X |
VARCHAR |
128 |
|
| JOB_CODE |
X |
VARCHAR |
128 |
|
| PRIMARY_JOB_CODE |
|
OTHER |
|
|
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_USER_LOCATION (UserLocationModel)
| Column Name |
PK |
Type |
Size |
Description |
| USERNAME |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| PRIMARY_LOCATION_FLAG |
|
OTHER |
|
|
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_USER (UserModel)
Security Identifier granting and denying access to the systems of the retail enterprise, and recorded upon the transaction originating from those systems.
| Column Name |
PK |
Type |
Size |
Description |
| USERNAME |
X |
VARCHAR |
128 |
|
| LAST_NAME |
|
VARCHAR |
128 |
|
| FIRST_NAME |
|
VARCHAR |
128 |
|
| NICKNAME |
|
VARCHAR |
128 |
|
| LAST_LOGIN |
|
TIMESTAMP |
|
|
| LOCKED_OUT_FLAG |
|
OTHER |
|
|
| ALTERNATE_ID |
|
VARCHAR |
128 |
|
| PASSWORD_EXPIRED_FLAG |
|
OTHER |
|
|
| PASSWORD_FAILED_ATTEMPTS |
|
INTEGER |
|
|
| LAST_PASSWORD_ATTEMPT |
|
TIMESTAMP |
|
|
| LOCALE |
|
VARCHAR |
128 |
|
| WORKGROUP_ID |
|
VARCHAR |
128 |
|
| USER_ACTIVE_FLAG |
|
OTHER |
|
|
| BIOMETRIC_DATA |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_OPERATOR_SECURITY_QUESTION (UserSecurityQuestionModel)
A record of the Operator's answer to a security question that is put to the Operator when they have forgotten their Password and the system is trying to verify their identity and allow a new Password to be set.
| Column Name |
PK |
Type |
Size |
Description |
| SECURITY_QUESTION_ROW_ID |
X |
VARCHAR |
16 |
The corresponding SecurityQuestion id. |
| ANSWER_TEXT |
|
VARCHAR |
255 |
A record of the Operator's answer to the indicated SecurityQuestion. |
| EFFECTIVE_TIME |
|
TIMESTAMP |
|
The date and time at which this OperatorSecurityQuestion was chosen by the Operator. |
| EXPIRATION_TIME |
|
TIMESTAMP |
|
The date and time at which this OperatorSecurityQuestion ceases to be valie because a new SecurityHint has been chosen. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_USER_WORKGROUP (UserWorkgroupModel)
| Column Name |
PK |
Type |
Size |
Description |
| USERNAME |
X |
VARCHAR |
128 |
|
| WORKGROUP_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_WORKGROUP_MAPPING (WorkgroupMappingModel)
Provides a mapping between a retailer's internal job codes to commerce workgroups
| Column Name |
PK |
Type |
Size |
Description |
| JOB_CODE |
X |
VARCHAR |
128 |
Job code from an external system that is being mapped to commerce work groups |
| WORKGROUP_ID |
|
VARCHAR |
128 |
The commerce work group id that this job code is being mapped to |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_WORKGROUP (WorkgroupModel)
A group within a workforce that normally works together and has similar access control permissions.
| Column Name |
PK |
Type |
Size |
Description |
| WORKGROUP_ID |
X |
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Workgroup. |
| IGNORE_LOCATION_ASSIGNMENT |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
USR_WORKGROUP_PERMISSION (WorkgroupPermissionModel)
| Column Name |
PK |
Type |
Size |
Description |
| WORKGROUP_ID |
X |
VARCHAR |
128 |
|
| PERMISSION_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| EXCLUDED_FLAG |
|
OTHER |
|
Is this permission to be excluded from a more broad permission (e.g. exclude sell.item.special from sell.item.*) |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Item Microservice
ITM_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ASSIGNED_ITEM (AssignedItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_COUPON_RULE (CouponRuleModel)
Rules associated with coupons on the item
| Column Name |
PK |
Type |
Size |
Description |
| RULE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| COUPON_ID |
|
VARCHAR |
128 |
The coupon that this rule applies to |
| RULE_TYPE |
|
VARCHAR |
128 |
EXCLUDE_ITEM, etc. |
| RULE_VALUE |
|
VARCHAR |
128 |
the value of the rule, usually an itemId that the rule applies to. |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_GROUP_MEMBER (GroupMemberModel)
A set of products that reside within a product grouping.
| Column Name |
PK |
Type |
Size |
Description |
| GROUP_MEMBER_ID |
X |
VARCHAR |
128 |
A unique id of the row. |
| GROUP_ID |
X |
VARCHAR |
128 |
The ID of the group that this member maps to. |
| CATEGORY_TYPE |
X |
VARCHAR |
128 |
The type of category that is apart of the specified group. |
| PRODUCT_ID |
|
VARCHAR |
128 |
The ID of the product that is apart of the specified group. |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_COPY_SECTION_I18N (ItemCopySectionI18NModel)
Supported item copy i18n values
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_COPY_ID |
X |
VARCHAR |
128 |
|
| SECTION_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| SECTION_TITLE |
|
VARCHAR |
128 |
|
| MARKDOWN_TEXT |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_COPY_SECTION (ItemCopySectionModel)
An item copy section within the commerce platform
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_COPY_ID |
X |
VARCHAR |
128 |
|
| SECTION_ID |
X |
VARCHAR |
128 |
|
| SECTION_TITLE |
|
VARCHAR |
128 |
|
| MARKDOWN_TEXT |
|
OTHER |
|
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_DEFAULTS (ItemDefaultsModel)
Default values to use when selling an item
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
Identifier to apply the defaults to. |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| PROPERTY_NAME |
|
VARCHAR |
128 |
The line item property to put the default value |
| DEFAULT_VALUE |
|
VARCHAR |
128 |
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_GROUP_MEMBER (ItemGroupMemberModel)
The set of Items that reside within an Item Group
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
The Item that belongs to this Item Group |
| ITEM_GROUP_ID |
X |
VARCHAR |
128 |
The Item Group to which this Item belongs |
| CATEGORY_TYPE |
X |
VARCHAR |
128 |
The type of category that is apart of the specified group. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_GROUP (ItemGroupModel)
Logical groupings of Items in any hierarchical order
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY_TYPE |
X |
VARCHAR |
128 |
The type of Item Group |
| ITEM_GROUP_ID |
X |
VARCHAR |
128 |
A unique identifier for the Item Group |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
The local date and time when this Item Group becomes effective. If left null, the current date and time will be used |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The local date and time when this Item Group is no longer effective. If left null, the Item Group will continue to be effective after it has been effective |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Item Group |
| PARENT_GROUP_ID |
|
VARCHAR |
128 |
The parent Item Group for this Item Group |
| USE_AS_CLASSIFIER |
|
OTHER |
|
An indicator as to whether this item group should be used as an item classifier |
| LEVEL_ID |
|
VARCHAR |
128 |
An indicator as to the level of this group in the hierarchy (i.e. dept, class, style, color, size, etc. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_GROUP_REASON_CODE (ItemGroupReasonCodeModel)
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_GROUP_ID |
X |
VARCHAR |
128 |
|
| REASON_CODE_GROUP_ID |
X |
VARCHAR |
128 |
|
| REASON_CODE_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_I18N (ItemI18NModel)
Supported product i18n values
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
Item being described by the record |
| LOCALE |
X |
VARCHAR |
128 |
The language that is used as part of the selection of what record to show |
| ITEM_NAME |
|
VARCHAR |
128 |
A name for the Item |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Item |
| LONG_DESCRIPTION |
|
VARCHAR |
1024 |
A long description for the Item |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_ID (ItemIdModel)
Describes scannable/keyable codes for an Item
| Column Name |
PK |
Type |
Size |
Description |
| POS_ITEM_ID |
X |
VARCHAR |
128 |
The scannable/keyable code for the Item |
| ITEM_ID |
|
VARCHAR |
128 |
The unique identifier for the Item |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM_IMAGE (ItemImageModel)
ties an image to a specific itemId
| Column Name |
PK |
Type |
Size |
Description |
| IMAGE_ID |
X |
VARCHAR |
128 |
The unique identifier for an item image. |
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| ITEM_ID |
|
VARCHAR |
128 |
A unique identifier for an item |
| PRODUCT_ID |
|
VARCHAR |
128 |
The product group to which this image belongs |
| IMAGE_URL |
|
VARCHAR |
1024 |
The image url for the Item |
| DEFAULT_IMAGE |
|
OTHER |
|
Whether this imageUrl is the default starting image |
| ENABLED |
|
OTHER |
|
Whether the image is enabled |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_ITEM (ItemModel)
An item that can be transacted in the commerce platform
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
A unique identifier for the Item. Typically the unique Id associated with the item when the item is setup in the merchandising, MDM or PIM system |
| ITEM_NAME |
|
VARCHAR |
128 |
A name for the Item |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Item |
| LONG_DESCRIPTION |
|
VARCHAR |
1024 |
A long description for the Item |
| TAX_GROUP_ID |
|
VARCHAR |
128 |
The Tax Group to which this Item belongs |
| TAX_EXEMPT_CODE |
|
OTHER |
|
Whether this Item is tax exempt. Deprecated: assign the item to a 0% tax group instead. |
| TYPE_CODE |
|
VARCHAR |
128 |
The type of Item |
| TARE_WEIGHT |
|
DECIMAL |
12,3 |
The item's tare weight |
| FAMILY_CODE |
|
VARCHAR |
3 |
Identifies an item as part of a family of products |
| EXPIRATION_DATE |
|
TIMESTAMP |
|
The date in which this item expires such as the case of a COUPON type item |
| PRODUCT_ID |
|
VARCHAR |
128 |
The productId the item is associated with |
| ITEM_COPY_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_OPTION_TYPE (OptionTypeModel)
Supported product option types
| Column Name |
PK |
Type |
Size |
Description |
| OPTION_TYPE_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_OPTION_TYPE_VALUE_I18N (OptionTypeValueI18NModel)
I18n option values associated with an option type
| Column Name |
PK |
Type |
Size |
Description |
| OPTION_TYPE_ID |
X |
VARCHAR |
128 |
|
| OPTION_VALUE_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| OPTION_VALUE_NAME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_OPTION_TYPE_VALUE (OptionTypeValueModel)
Option values associated with an option type
| Column Name |
PK |
Type |
Size |
Description |
| OPTION_TYPE_ID |
X |
VARCHAR |
128 |
|
| OPTION_VALUE_ID |
X |
VARCHAR |
128 |
|
| OPTION_VALUE_NAME |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT_COPY_SECTION_I18N (ProductCopySectionI18NModel)
Supported product copy i18n values
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_COPY_ID |
X |
VARCHAR |
128 |
|
| SECTION_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| SECTION_TITLE |
|
VARCHAR |
128 |
|
| MARKDOWN_TEXT |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT_COPY_SECTION (ProductCopySectionModel)
An product copy section within the commerce platform
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_COPY_ID |
X |
VARCHAR |
128 |
|
| SECTION_ID |
X |
VARCHAR |
128 |
|
| SECTION_TITLE |
|
VARCHAR |
128 |
|
| MARKDOWN_TEXT |
|
OTHER |
|
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT_I18N (ProductI18NModel)
An product's i18n replacements within the commerce platform
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Product |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_INQ_ATTRIBUTE_ITEM_VAL (ProductInquiryAttributeItemValueModel)
An item's values for searchable/filterable attributes for a given attribute defined in ITM_INQ_ATTRIBUTE. I.E. if Brand and Color were defined as searchable/filterable attributes, then this table would have values for each item for those attributes (Brand=Nike, Color=Blue). It is important to note that attributes can be defined at the product or item level or both. If no attributes are defined at the item level, product level attributes will be used for search as each item is tied to a product.
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
The ID of the item to which this searchable attribute value is assigned |
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
The ID of the searchable attribute assigned a value |
| ATTRIBUTE_VALUE |
|
VARCHAR |
128 |
The value assigned to the searchable attribute |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_INQ_ATTRIBUTE (ProductInquiryAttributeModel)
The definition of searchable/filterable attributes that can be specified for products and items. This table holds the definitions of the attributes that can be levereaged in product search capabilities in the point of sale. I.E. Brand, Color, Size, Style, etc. The specific product and item values are not specified in this table, only the list of attributes that may be spedcified for each product and/or item.
| Column Name |
PK |
Type |
Size |
Description |
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
A unique identifier for this searchable item or product attribute |
| ATTRIBUTE_TYPE |
|
VARCHAR |
128 |
A technical descriptor (e.g. a bean name) for the mechanism by which values for this attribute are determined |
| DISPLAY_NAME |
|
VARCHAR |
128 |
A user-friendly label for this attribute |
| DISPLAY_ORDER |
|
INTEGER |
|
The order in which this attribute should be displayed relative to other searchable attributes. Attributes with lower values are afforded more prominent representation. |
| FILTER_SCOPE |
|
VARCHAR |
128 |
Dictates the context(s) in which this attribute should be made available for filtering by the user performing an inquiry |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_INQ_ATTRIBUTE_PRODUCT_VAL (ProductInquiryAttributeProductValueModel)
A product's values for searchable/filterable attributes for a given attribute defined in ITM_INQ_ATTRIBUTE. I.E. if Brand and Color were defined as searchable/filterable attributes, then this table would have values for each product for those attributes (Brand=Nike, Color=Blue).
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_ID |
X |
VARCHAR |
128 |
The ID of the product to which this searchable attribute value is assigned |
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
The ID of the searchable attribute assigned a value |
| ATTRIBUTE_VALUE |
|
VARCHAR |
128 |
The value assigned to the searchable attribute |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_INQ_CATEGORY_MEMBER (ProductInquiryCategoryMemberModel)
A list of products that belong to a given product inquiry category defined in ITM_INQ_CATEGORY. I.E. For each product, this table lists the categories to which this product belongs.
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY_ID |
X |
VARCHAR |
128 |
The ID of the inquiry category to which a product is assigned |
| PRODUCT_ID |
X |
VARCHAR |
128 |
The ID of the inquiry-categorized product |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_INQ_CATEGORY (ProductInquiryCategoryModel)
The definition of categories that can be used to search for products in the product inquiry feature of point of sale. Each category defined in this table can specify a parent category thus allowing for a flexible hierarchy of product categories, I.E. Mens -> Shirts -> Short Sleeve, etc.
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY_ID |
X |
VARCHAR |
128 |
A unique identifier for this product inquiry category |
| PARENT_ID |
|
VARCHAR |
128 |
The ID of this category's parent category. "Root" categories have no parent; all other categories have exactly one. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
A user-friendly label for this product inquiry category |
| DISPLAY_ORDER |
|
INTEGER |
|
The order in which this category should be displayed relative to its sibling categories. Categories with lower values are afforded more prominent representation. |
| IMAGE_URL |
|
OTHER |
|
The URL of an image representing this inquiry category when presented to a user |
| EXPOSES_MATCHES_FLAG |
|
OTHER |
|
Whether the selection of this category during a product inquiry will expose all products which match the inquiry categories and filters specified thus far. This operation may have significant performance costs, so the flag should not be enabled at levels too high in the category hierarchy to produce a meaningfully-narrowed product result set. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT (ProductModel)
An product within the commerce platform
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_ID |
X |
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Product |
| PRODUCT_COPY_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT_OPTION (ProductOptionModel)
Options types associated to a product
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_ID |
X |
VARCHAR |
128 |
|
| OPTION_TYPE_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PRODUCT_OPTION_TYPE_VALUE (ProductOptionTypeValueModel)
Association of the product, optionTypes and option values
| Column Name |
PK |
Type |
Size |
Description |
| PRODUCT_ID |
X |
VARCHAR |
128 |
|
| OPTION_TYPE_ID |
X |
VARCHAR |
128 |
|
| OPTION_VALUE_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_PROMPT_REF (PromptRefModel)
references specific prompts for item or item group
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| ITEM_GROUP_ID |
X |
VARCHAR |
128 |
|
| PROMPT_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| CONDITION_BEAN_NAME |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| ON_SALE_FLAG |
|
OTHER |
|
|
| ON_RETURN_FLAG |
|
OTHER |
|
|
| SHOW_ONCE_PER_SKU |
|
OTHER |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
An association between two items where the two items are commonly sold together.
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| RELATED_ITEM_ID |
X |
VARCHAR |
128 |
|
| RELATED_ITEM_TYPE_CODE |
|
VARCHAR |
128 |
DEPOSIT_FEE, CONSUMABLE_ITEM, HANDLING_FEE, BATTERY_CORE_CHARGE, WARRANTY, EXCHANGE, RESTOCKING_FEE |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_SELLING_PRICE (SellingPriceModel)
The available selling prices for an item
| Column Name |
PK |
Type |
Size |
Description |
| SELLING_PRICE_ID |
X |
VARCHAR |
128 |
The unique identifier for the Selling Price |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| ITEM_ID |
|
VARCHAR |
128 |
The Item to which this Selling Price belongs |
| PRODUCT_ID |
|
VARCHAR |
128 |
The product group to which this Selling Price belongs |
| PRICE_TYPE |
|
VARCHAR |
128 |
The type of Selling Price |
| LIST_PRICE |
|
DECIMAL |
12,3 |
The list price is the full price amount for any product without factoring in discounts, promotions, or other deals. The list price is sometimes known as catalog price or the manufacturer's suggested retail price (MSRP) |
| PRICE |
|
DECIMAL |
12,3 |
The price |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of Item provided for the given price |
| COST |
|
DECIMAL |
12,3 |
The price the retailer paid for the item |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_SELLING_RULE (SellingRuleModel)
Rules associated with the selling of an Item
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| SELLING_STATUS_CODE |
|
VARCHAR |
128 |
AVAIL, NA, RECALLED |
| COUPON_ALLOWED |
|
OTHER |
|
Denotes whether a coupon can be redeemed for this item |
| PRICE_ENTRY_REQUIRED |
|
OTHER |
|
|
| WEIGHT_ENTRY_REQUIRED |
|
OTHER |
|
|
| LENGTH_ENTRY_REQUIRED |
|
OTHER |
|
|
| QUANTITY_ENTRY_REQUIRED |
|
OTHER |
|
|
| DESCRIPTION_ENTRY_REQUIRED |
|
OTHER |
|
|
| EXTERNAL_SYSTEM_ID_REQUIRED |
|
OTHER |
|
|
| USERNAME_REQUIRED |
|
OTHER |
|
|
| MINIMUM_SELLER_AGE |
|
INTEGER |
|
|
| MINIMUM_BUYER_AGE |
|
INTEGER |
|
|
| EMPLOYEE_DISCOUNT_ALLOWED |
|
OTHER |
|
|
| RETURN_PROHIBITED |
|
OTHER |
|
|
| LOYALTY_POINTS_ELIGIBLE |
|
OTHER |
|
|
| DISCOUNT_ELIGIBLE |
|
OTHER |
|
|
| PRICE_OVERRIDE_ELIGIBLE |
|
OTHER |
|
|
| ACTIVATION_REQUIRED |
|
OTHER |
|
|
| WIC_ELIGIBLE |
|
OTHER |
|
|
| SNAP_ELIGIBLE |
|
OTHER |
|
|
| EBT_ELIGIBLE |
|
OTHER |
|
|
| WARRANTY_ELIGIBLE |
|
OTHER |
|
|
| LEASE_ELIGIBLE |
|
OTHER |
|
|
| HAZARDOUS_WARNING_REQUIRED |
|
OTHER |
|
Support for prop 65 warning |
| ORDER_ELIGIBLE |
|
OTHER |
|
|
| LAYAWAY_ELIGIBLE |
|
OTHER |
|
|
| RAIN_CHECK_ELIGIBLE |
|
OTHER |
|
|
| REPEAT_DELIVERY_ELIGIBLE_FLAG |
|
OTHER |
|
|
| LOYALTY_POINTS |
|
INTEGER |
|
|
| MINIMUM_SALE_UNIT_COUNT |
|
INTEGER |
|
|
| MAXIMUM_SALE_UNIT_COUNT |
|
INTEGER |
|
|
| QUANTITY_MODIFIABLE |
|
OTHER |
|
|
| WEIGHT_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
|
| LENGTH_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
|
| RESTRICTED_HOURS_CRON |
|
VARCHAR |
128 |
|
| REQUIRE_SERIAL_NUMBER |
|
OTHER |
|
When true, the POS will prompt for serial number entry when the item is added to the transaction |
| REQUIRE_WARRANTY_SIGNUP |
|
OTHER |
|
When true, the POS will prompt for serial number entry when the item is added to the transaction |
| TAX_GROUP_ID_OVERRIDE |
|
VARCHAR |
128 |
Allows for overriding any value present for the item in itm_item.tax_group_id and thus, via use of tagging, allows for different tax groups to be assigned to an item. This could be useful, for example, if different countries have different tax group assignments for an item.Any non-null or non-empty value present here will take precedence over the value found in itm_item.tax_group_id. |
| RESTOCKING_FEE_APPLIES |
|
OTHER |
|
When true, a restocking fee will apply when returning the item. |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
ITM_WARRANTY (WarrantyModel)
| Column Name |
PK |
Type |
Size |
Description |
| WARRANTY_ITEM_ID |
X |
VARCHAR |
128 |
The identifier of the 'ItemModel' that contains the warranty information. Typically the unique Id associated with the item when the item is setup in the merchandising, MDM or PIM system. |
| ITEM_ID |
X |
VARCHAR |
128 |
The identifier for the item that the warranty specified by 'warrantyPosItemId' is linked to. Typically the unique Id associated with the item when the item is setup in the merchandising, MDM or PIM system. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| BUSINESS_UNIT_GROUP_ID |
X |
VARCHAR |
128 |
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUAL_ATTR_CONF (AttributeConfigModel)
The configuration for a promotion attribute, either TRANS or ITEM level.
| Column Name |
PK |
Type |
Size |
Description |
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
A unique identifier for the attribute. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
A display friendly name for the attribute. |
| EDITABLE |
|
OTHER |
|
Whether the configuration is editable |
| ATTRIBUTE_LEVEL |
|
VARCHAR |
128 |
The level at which this attribute applies to. ie ITEM or TRANS |
| ATTRIBUTE_TYPE_CODE |
|
VARCHAR |
128 |
The type of value this attribute expects. ie TEXT, NUMERIC, or LIST |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUAL_ATTR_VAL_OPTION_CONF (AttributeValueOptionConfigModel)
| Column Name |
PK |
Type |
Size |
Description |
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
The id of the attribute this value option ties to. |
| ATTRIBUTE_VALUE_OPTION_ID |
X |
VARCHAR |
128 |
The unique id of the value option |
| ATTRIBUTE_VALUE |
|
VARCHAR |
128 |
The value for the attribute |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_NEAR_MISS (NearMissConfigModel)
| Column Name |
PK |
Type |
Size |
Description |
| REFERENCE_ID |
X |
VARCHAR |
128 |
|
| REFERENCE_TYPE |
X |
VARCHAR |
128 |
|
| TRIGGER_AMOUNT |
|
DECIMAL |
12,3 |
|
| MESSAGE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMO_CODE_ID |
X |
VARCHAR |
128 |
A unique identifier for the customer loyalty reward. Typically a barcode. |
| LOCALE |
X |
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
128 |
A description for this loyalty reward that can be shown visually |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMO_CODE_ID |
X |
VARCHAR |
128 |
A unique internal identifier for the promo code. |
| LOYALTY_NUMBER |
|
VARCHAR |
128 |
The loyalty customer that this promo code applies to |
| PROMOTION_ID |
|
VARCHAR |
128 |
The id of the rewarding promotion model that this promo code maps to |
| ORIGIN_PROMOTION_ID |
|
VARCHAR |
128 |
The id of the originating promotion (if generated from a bounce back) that this promo code was created from |
| CODE |
|
VARCHAR |
128 |
The code or barcode associated with the promo code. |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| USED_TIME |
|
TIMESTAMP |
|
The date in which this promo code was used |
| PROMPT_USER_FLAG |
|
OTHER |
|
Whether the user should be prompted to use this promo code |
| DESCRIPTION |
|
VARCHAR |
128 |
A description for this promo code that can be shown visually |
| MAX_USES |
|
INTEGER |
|
Maximum number of times this promo code can be used. -1 means it is unlimited |
| TIMES_USED |
|
INTEGER |
|
Count of times this promo code has been used. |
| PRINT_ON_RECEIPT_FLAG |
|
OTHER |
|
Flag denoting whether this promo code should be printed on the transaction receipt |
| INVALIDATED_FLAG |
|
OTHER |
|
Flag denoting whether this promo code has been invalidated since the time of creation |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_COPY_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| PROMOTION_ID |
|
VARCHAR |
128 |
|
| COPY_TEXT |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_COPY_ID |
X |
VARCHAR |
128 |
|
| PROMOTION_ID |
|
VARCHAR |
128 |
|
| COPY_TEXT |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_ID |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| PROMOTION_NAME |
|
VARCHAR |
128 |
|
| LONG_DESCRIPTION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_ID |
X |
VARCHAR |
128 |
A unique identifier for the promotion. Typically provided by the source core merchandising system. |
| CAMPAIGN_ID |
|
VARCHAR |
128 |
The is an informational field that ties back to the campaign this promotion was created for. It can also be used for reporting. |
| PROMOTION_NAME |
|
VARCHAR |
128 |
A descriptive name for the promotion that is shown on the receipts and sale screen. |
| LONG_DESCRIPTION |
|
VARCHAR |
128 |
An optional long description of the promotion to be used in displaying promotion information on item inquiry details |
| PROMOTION_TYPE |
|
VARCHAR |
128 |
the categorical type that the promotion falls under. Ex: ITEM, TRANS, STORE_COUPON, LOYALTY_REWARD, etc. |
| SINGLE_USE |
|
OTHER |
|
Whether the promotion is a single use promotion. If false, the promotion can be used multiple times |
| AUTO_APPLY |
|
OTHER |
|
Whether this promotion should be auto-applied if meets qualifications. Value is false when conditionally applied such as loyalty reward promotions. |
| MAX_USES |
|
DECIMAL |
12,3 |
The maximum number of times the promotion can be applied per transaction. |
| VENDOR_FUNDED |
|
OTHER |
|
Whether the promotion is vendorFunded. Deprecated. See RewardModel.vendorFunded |
| REWARD_APPLICATION_TYPE_CODE |
|
VARCHAR |
128 |
Whether the reward items that satisfy this promotion should be applied to LOWEST_PRICE or HIGHEST_PRICE items first |
| QUALIFY_APPLICATION_TYPE_CODE |
|
VARCHAR |
128 |
Whether the qualification items that satisfy this promotion should be selected LOWEST_PRICE or HIGHEST_PRICE first. If null, the reward application type setting will be used |
| REWARD_OPERATOR_TYPE_CODE |
|
VARCHAR |
128 |
The logical operator that should be used when applying rewards if a promotion has more than one reward model. Ie. If AND, it can apply all of the rewards. If OR, it can only apply one of the rewards, whichever is the best value. |
| REWARD_BASE_PRICE_TYPE_CODE |
|
VARCHAR |
128 |
|
| EXTERNAL_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_ID |
X |
VARCHAR |
128 |
A unique identifier for the promotion. Typically provided by the source core merchandising system. |
| TRANS_SEQUENCE_NUMBER |
X |
BIGINT |
|
transaction sequence number |
| DEVICE_ID |
X |
VARCHAR |
128 |
Device ID |
| BUSINESS_DATE |
X |
VARCHAR |
128 |
Business date of this statistic's capturing |
| CAMPAIGN_ID |
|
VARCHAR |
128 |
A unique identifier for the campaign the promotion falls under. Typically provided by the source core merchandising system. |
| CAPTURE_TIME |
|
TIMESTAMP |
|
timestamp of this capture |
| AMOUNT_SAVED |
|
DECIMAL |
12,3 |
Business date of this statistic's capturing |
| ESTIMATED_REVENUE |
|
DECIMAL |
12,3 |
Estimated amount charged due to promotion |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| PROMOTION_TYPE |
X |
VARCHAR |
128 |
The type that identifies this promotion |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| PRIORITY |
|
DECIMAL |
12,3 |
The order in numeric ascending order in which this promotion type will be applied to items in a basket. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUALIFICATION_ATTR (QualificationAttributeModel)
| Column Name |
PK |
Type |
Size |
Description |
| QUALIFICATION_ATTR_ID |
X |
VARCHAR |
128 |
A unique identifier for the qualification attribute. Typically provided by the source core merchandising system. |
| QUALIFICATION_ID |
|
VARCHAR |
128 |
The Qualification to which this Qualification Item belongs, identified by the Qualification Id. |
| ATTRIBUTE_ID |
|
VARCHAR |
128 |
|
| OPERATOR_CODE |
|
VARCHAR |
128 |
|
| RIGHT_HAND_SIDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUALIFICATION_ITEM_ATTR (QualificationItemAttributeModel)
| Column Name |
PK |
Type |
Size |
Description |
| QUALIFICATION_ITEM_ATTR_ID |
X |
VARCHAR |
128 |
A unique identifier for the qualification attribute. Typically provided by the source core merchandising system. |
| QUALIFICATION_ITEM_ID |
|
VARCHAR |
128 |
The Qualification to which this Qualification Item belongs, identified by the Qualification Id. |
| ATTRIBUTE_ID |
|
VARCHAR |
128 |
|
| OPERATOR_CODE |
|
VARCHAR |
128 |
|
| RIGHT_HAND_SIDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUALIFICATION_ITEM (QualificationItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| QUALIFICATION_ITEM_ID |
X |
VARCHAR |
128 |
A unique identifier for the qualification item. Typically provided by the source core merchandising system. |
| QUALIFICATION_ID |
|
VARCHAR |
128 |
The Qualification to which this Qualification Item belongs, identified by the Qualification Id. |
| QUALIFICATION_MERCHANDISE_ID |
|
VARCHAR |
128 |
An item or merchandise classification that qualifies. There can be many qualification items for a given qualification, each of which is treated as an OR condition. Any of the Qualification Items will count towards the Qualification. |
| QUALIFICATION_ITEM_TYPE |
|
VARCHAR |
128 |
The Item Type Code, either INCLUDE if this item should be included as a qualification item, or exclude if this item should be excluded as an item. I.E. INCLUDE class 32 merchandise, but EXCLUDE item 1234. |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_QUALIFICATION (QualificationModel)
| Column Name |
PK |
Type |
Size |
Description |
| QUALIFICATION_ID |
X |
VARCHAR |
128 |
A unique identifier for the qualification. Typically provided by the source core merchandising system. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion to which this qualification belongs, identified by the Promotion Id. |
| QUALIFICATION_TYPE_CODE |
|
VARCHAR |
128 |
The type of this qualification, either 'AMT', 'QTY', 'TRN_AMT', 'TRN_QTY', 'ATTRIBUTE'. The amount or quantity of QualificationItems the basket must contain or the total amount or total quantity of all items in the basket needed in order to satisfy the Qualification. |
| QUALIFICATION |
|
DECIMAL |
12,3 |
The qualification that must be met in either AMT or QTY based on the QualificationTypeCode. i.e. If the qualification is 5 and the type is AMT, then the qualification is $5 of QualificationItems. |
| REWARD_ELIGIBLE |
|
OTHER |
|
Whether the items used to satisfy the qualification are eligible to be used as reward items |
| QUAL_ITEMS_REWARD_PREFERENCE |
|
VARCHAR |
128 |
The preference on whether the qualified items are required to be, allowed to be, or prevented from being the rewarded items. Possible values are ALLOW, PREVENT, REQUIRE |
| TIER |
|
INTEGER |
|
The tier that this qualification should be evaluated on. A tier of 0 would be evaluated with every other tier (it is common) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD_CATEGORY_CONFIG (RewardCategoryConfigModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY_ID |
X |
VARCHAR |
128 |
A unique identifier for the category. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
A display friendly name for the category. |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD_CATEGORY (RewardCategoryModel)
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_ID |
X |
VARCHAR |
128 |
A unique identifier for the Reward. Typically provided by the source core merchandising system. |
| CATEGORY_ID |
|
VARCHAR |
128 |
|
| REWARD_CATEGORY_TYPE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD (RewardModel)
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_ID |
X |
VARCHAR |
128 |
A unique identifier for the Reward. Typically provided by the source core merchandising system. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion to which this reward belongs, identified by the Promotion Id. |
| REWARD_TYPE |
|
VARCHAR |
128 |
The type of Reward for this Promotion. Either AMT, PCT, PRICE, PRICE_TOTAL, TRN_AMT, TRN_PCT. AMT = A reward of a specified amount for an item or group of items, PCT = A percent off an item or group of items, PRICE = A specific price point for an item or group of items, PRICE_TOTAL = A specific total price split across the reward items. The reward is always on the original qualifying items if qualificationEligible is set, TRN_AMT = A specified amount off of the transaction, TRN_PCT = A percent off of the transaction. |
| REWARD |
|
DECIMAL |
12,3 |
The amount of the Reward. |
| MAX_REWARD_AMOUNT |
|
DECIMAL |
12,3 |
The ceiling/maximum amount that can be rewarded |
| REWARD_QUANTITY |
|
DECIMAL |
12,3 |
The maximum number of times the reward can be applied per one successful grouping of qualifying items met. Additional rewards would require the qualifications to be met with new qualifying items. |
| TIER |
|
INTEGER |
|
The tier that this reward should be evaluated on |
| QUALIFICATION_ELIGIBLE |
|
OTHER |
|
Whether the items used to satisfy the reward are eligible to be used as qualification items |
| QUALIFICATION_PRORATE |
|
OTHER |
|
If true then the reward will be prorated across qualification items |
| VENDOR_FUNDED |
|
OTHER |
|
Whether this reward for the promotion is vendorFunded |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD_ITEM_ATTR (RewardItemAttributeModel)
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_ITEM_ATTR_ID |
X |
VARCHAR |
128 |
A unique identifier for the reward attribute. Typically provided by the source core merchandising system. |
| REWARD_ITEM_ID |
|
VARCHAR |
128 |
The Reward to which this Reward Item belongs, identified by the Reward Id. |
| ATTRIBUTE_ID |
|
VARCHAR |
128 |
|
| OPERATOR_CODE |
|
VARCHAR |
128 |
|
| RIGHT_HAND_SIDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD_ITEM (RewardItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_ITEM_ID |
X |
VARCHAR |
128 |
|
| REWARD_ID |
|
VARCHAR |
128 |
|
| REWARD_ITEM_TYPE |
|
VARCHAR |
128 |
|
| REWARD_MERCHANDISE_ID |
|
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
128 |
|
| VENDOR_FUNDED |
|
OTHER |
|
Whether this specific reward item for the promotion is vendorFunded |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_REWARD (RewardModel)
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_ID |
X |
VARCHAR |
128 |
A unique identifier for the Reward. Typically provided by the source core merchandising system. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion to which this reward belongs, identified by the Promotion Id. |
| REWARD_TYPE |
|
VARCHAR |
128 |
The type of Reward for this Promotion. Either AMT, PCT, PRICE, PRICE_TOTAL, TRN_AMT, TRN_PCT. AMT = A reward of a specified amount for an item or group of items, PCT = A percent off an item or group of items, PRICE = A specific price point for an item or group of items, PRICE_TOTAL = A specific total price split across the reward items. The reward is always on the original qualifying items if qualificationEligible is set, TRN_AMT = A specified amount off of the transaction, TRN_PCT = A percent off of the transaction. |
| REWARD |
|
DECIMAL |
12,3 |
The amount of the Reward. |
| MAX_REWARD_AMOUNT |
|
DECIMAL |
12,3 |
The ceiling/maximum amount that can be rewarded |
| REWARD_QUANTITY |
|
DECIMAL |
12,3 |
The maximum number of times the reward can be applied per one successful grouping of qualifying items met. Additional rewards would require the qualifications to be met with new qualifying items. |
| TIER |
|
INTEGER |
|
The tier that this reward should be evaluated on |
| QUALIFICATION_ELIGIBLE |
|
OTHER |
|
Whether the items used to satisfy the reward are eligible to be used as qualification items |
| QUALIFICATION_PRORATE |
|
OTHER |
|
If true then the reward will be prorated across qualification items |
| VENDOR_FUNDED |
|
OTHER |
|
Whether this reward for the promotion is vendorFunded |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| REWARD_PROMO_CODE_ID |
X |
VARCHAR |
128 |
Unique id for this reward promo code. |
| REWARD_ID |
|
VARCHAR |
128 |
Unique id for the prm_reward record that this ties back to. |
| REWARD_PROMOTION_ID |
|
VARCHAR |
128 |
Unique id for the prm_promotion record that the generated promo code will point to. |
| DESCRIPTION |
|
VARCHAR |
128 |
Description to be copied to the new promo code. This is likely to be the details that display on the screen or receipt |
| START_DATE_OR_OFFSET |
|
VARCHAR |
128 |
String representing when the generated promo code should start being effective. Either absolute date or an offset from the time of generation |
| END_DATE_OR_OFFSET |
|
VARCHAR |
128 |
String representing when the generated promo code should expire. Either absolute date or an offset from the time of generation |
| PRINT_ON_RECEIPT_FLAG |
|
OTHER |
|
Flag copied to generated promo code deciding whether the new code is printed on the sale receipt. |
| PROMPT_USER_FLAG |
|
OTHER |
|
Flag copied to generated promo code deciding whether the user should be prompted to use this promo code. |
| LOYALTY_PROMOTION_FLAG |
|
OTHER |
|
Flag copied to generated promo code deciding whether loyaltyNumber is required to have a value |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PRM_STACKING_RULE (StackingRuleModel)
| Column Name |
PK |
Type |
Size |
Description |
| STACKING_RULE_ID |
X |
VARCHAR |
128 |
A unique identifier for the stacking rule. |
| PROMOTION_TYPE_X |
|
VARCHAR |
128 |
One of two promotion type codes that are defined to be stackable with each other by this rule. |
| PROMOTION_TYPE_Y |
|
VARCHAR |
128 |
One of two promotion type codes that are defined to be stackable with each other by this rule. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Tax Microservice
TAX_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_DIFF_AUTHORITY (DiffTaxAuthorityModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| ID |
X |
VARCHAR |
128 |
A unique identifier for the Authority |
| ACTION_TYPE_CODE |
X |
VARCHAR |
128 |
|
| DIFF_DATE |
X |
INTEGER |
|
|
| JOB_NUMBER |
X |
BIGINT |
|
|
| AUTH_NAME |
|
VARCHAR |
128 |
The name of the Authority |
| ROUNDING_CODE |
|
VARCHAR |
128 |
The rounding mode for the Authority |
| ROUNDING_DIGITS_QUANTITY |
|
INTEGER |
|
The number of digits in which to round to for the Authority |
| AUTH_TYPE_NAME |
|
VARCHAR |
128 |
The type of the authority |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_DIFF_GROUP (DiffTaxGroupModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| ID |
X |
VARCHAR |
128 |
A unique identifier for the Group |
| ACTION_TYPE_CODE |
X |
VARCHAR |
128 |
|
| DIFF_DATE |
X |
INTEGER |
|
|
| JOB_NUMBER |
X |
BIGINT |
|
|
| GROUP_NAME |
|
VARCHAR |
128 |
A name for the Group |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Group |
| RECEIPT_PRINT_CODE |
|
VARCHAR |
128 |
A description for the group to be displayed to the Customer for Receipt purposes |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_DIFF_GROUP_RULE (DiffTaxGroupRuleModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The authority for the rate rule |
| GROUP_ID |
X |
VARCHAR |
128 |
The tax group that this rate rule is for |
| TAX_TYPE |
X |
VARCHAR |
128 |
A description of the type of tax this is |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
The date/time this rule will be effective |
| ACTION_TYPE_CODE |
X |
VARCHAR |
128 |
|
| DIFF_DATE |
X |
INTEGER |
|
|
| JOB_NUMBER |
X |
BIGINT |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The date/time when this rule should no longer be effective |
| RULE_NAME |
|
VARCHAR |
128 |
A name for this group rule |
| DESCRIPTION |
|
VARCHAR |
255 |
A description of this rule |
| TAX_HOLIDAY_INDICATOR |
|
INTEGER |
|
|
| COMPOUND_SEQUENCE_NUMBER |
|
INTEGER |
|
A sequential number that indicates the order to which multiple applicable group rules should be applied. If the group rule is to NOT compound then the value should be 0. Any value greater than 0 will be compounded on top of the previous group rules |
| TAX_ON_GROSS_AMOUNT_FLAG |
|
INTEGER |
|
A flag denoting that the TaxGroupRule is to be applied to the gross amount of the items being sold ie: before any discounts, price-rules or deals have been applied to the regular retail price. |
| CALCULATION_METHOD_CODE |
|
VARCHAR |
128 |
CALCULATION_TRANSACTION = TAX_TRANSACTION, CALCULATION_ITEM_TRANSACTION = TAX_ITEM_TRANSACTION, CALCULATION_ITEM = TAX_ITEM |
| RATE_RULE_USAGE_CODE |
|
VARCHAR |
128 |
USAGE_PICK_ONE = FLAT_RATE, USAGE_TAX_TABLE = CYCLICAL_RATE |
| CYCLE_AMOUNT |
|
DECIMAL |
12,3 |
When dealing with tax tables identifies the break point in the table where the table will cycle until the last cycle on which the full table will be used |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_DIFF_JURISDICTION (DiffTaxJurisdictionModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| GEO_CODE |
X |
VARCHAR |
128 |
The geographic location of this Jurisdiction. Depending on how the tax data is setup this could be a location id or it could be a zip code |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The Authority under which this Jurisdiction belongs |
| ACTION_TYPE_CODE |
X |
VARCHAR |
128 |
|
| DIFF_DATE |
X |
INTEGER |
|
|
| JOB_NUMBER |
X |
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_DIFF_RATE_RULE (DiffTaxRateRuleModel)
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| TAX_TYPE |
X |
VARCHAR |
128 |
A description of the type of tax this is |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The authority for the rate rule |
| GROUP_ID |
X |
VARCHAR |
128 |
The tax group that this rate rule is for |
| RATE_RULE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
The date/time this rule will be effective |
| ACTION_TYPE_CODE |
X |
VARCHAR |
128 |
|
| DIFF_DATE |
X |
INTEGER |
|
|
| JOB_NUMBER |
X |
BIGINT |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The date/time when this rule should no longer be effective |
| TYPE_CODE |
|
VARCHAR |
128 |
TYPE_PERCENT_RATE = PERCENT TYPE_FLAT_RATE = AMOUNT, VAT_PERCENT = VAT_PERCENT |
| THRESHOLD_RULE |
|
INTEGER |
|
Rule that dictates how a threshold is processed. AMOUNT_FULL=1 AMOUNT_OVER=2 |
| THRESHOLD_AMOUNT |
|
DECIMAL |
12,3 |
The threshold over which this rate will apply |
| MIN_TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
Defines the min range amount for a tax table entry |
| MAX_TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
Defines the max range amount for a tax table entry |
| TAX_PERCENT |
|
DECIMAL |
12,3 |
|
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
|
| TAX_HOLIDAY_INDICATOR |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_AUTHORITY (TaxAuthorityModel)
A government Authority that levies sales taxes and on whose behalf the Business Unit collects these sales taxes.
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| ID |
X |
VARCHAR |
128 |
A unique identifier for the Authority |
| AUTH_NAME |
|
VARCHAR |
128 |
The name of the Authority |
| ROUNDING_CODE |
|
VARCHAR |
128 |
The rounding mode for the Authority. UP = ROUND_UP, DOWN = ROUND_DOWN,HALF_UP = ROUND_HALF_UP, HALF_DOWN = ROUND_HALF_DOWN |
| ROUNDING_DIGITS_QUANTITY |
|
INTEGER |
|
The number of digits in which to round to for the Authority |
| AUTH_TYPE_NAME |
|
VARCHAR |
128 |
The type of the authority |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_EXEMPTION_RULE (TaxExemptionRuleModel)
A rule defining how taxes should be applied to line items qualifying for tax exemptions
| Column Name |
PK |
Type |
Size |
Description |
| RULE_TYPE |
X |
VARCHAR |
128 |
The category of exemption for which this rule applies |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
The date/time this rule will be effective |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The date/time when this rule should no longer be effective |
| RULE_ACTION |
|
VARCHAR |
128 |
The action to take on a line item whose taxes are exempted by this rule |
| RULE_ACTION_PARAMETER |
|
VARCHAR |
128 |
An optional parameter which qualifies the ruleAction assigned to this rule |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_GROUP (TaxGroupModel)
A group of Items for which an Authority defines tax group rules
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| ID |
X |
VARCHAR |
128 |
A unique identifier for the Group |
| GROUP_NAME |
|
VARCHAR |
128 |
A name for the Group |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the Group |
| RECEIPT_PRINT_CODE |
|
VARCHAR |
128 |
A description for the group to be displayed to the Customer for Receipt purposes |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_GROUP_RULE (TaxGroupRuleModel)
A rule that prescribes how a particular tax is to be applied to a group of items.
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The authority for the rate rule |
| GROUP_ID |
X |
VARCHAR |
128 |
The tax group that this rate rule is for |
| TAX_TYPE |
X |
VARCHAR |
128 |
A description of the type of tax this is |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
The date/time this rule will be effective |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The date/time when this rule should no longer be effective |
| RULE_NAME |
|
VARCHAR |
128 |
A name for this group rule |
| DESCRIPTION |
|
VARCHAR |
255 |
A description of this rule |
| TAX_HOLIDAY_INDICATOR |
|
INTEGER |
|
|
| COMPOUND_SEQUENCE_NUMBER |
|
INTEGER |
|
A sequential number that indicates the order to which multiple applicable group rules should be applied. If the group rule is to NOT compound then the value should be 0. Any value greater than 0 will be compounded on top of the previous group rules |
| TAX_ON_GROSS_AMOUNT_FLAG |
|
INTEGER |
|
A flag denoting that the TaxGroupRule is to be applied to the gross amount of the items being sold ie: before any discounts, price-rules or deals have been applied to the regular retail price. |
| CALCULATION_METHOD_CODE |
|
VARCHAR |
128 |
TRANSACTION = round by authority against aggregate transaction tax; ITEM = round by authority against each item's tax, ITEM_TRANSACTION = round by authority against each item's tax and then again against the sum of those rounded item-level taxes |
| RATE_RULE_USAGE_CODE |
|
VARCHAR |
128 |
FLAT = assign a fixed tax rate or amount; CYCLICAL = apply tax amounts iteratively based on a tax table |
| CYCLE_AMOUNT |
|
DECIMAL |
12,3 |
When dealing with tax tables identifies the break point in the table where the table will cycle until the last cycle on which the full table will be used |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_JURISDICTION (TaxJurisdictionModel)
Tax Jurisdiction
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| GEO_CODE |
X |
VARCHAR |
128 |
The geographic location of this Jurisdiction. Depending on how the tax data is setup this could be a location ID or it could be a zip code |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The Authority under which this Jurisdiction belongs |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TAX_RATE_RULE (TaxRateRuleModel)
A rule denoting what percentage or dollar amount of tax is applied to a particular taxable total in a RetailTransaction.
| Column Name |
PK |
Type |
Size |
Description |
| CATEGORY |
X |
VARCHAR |
128 |
A way to provide different categories of tax data. The system will use the data as configured in openpos.tax.categoryToUse |
| TAX_TYPE |
X |
VARCHAR |
128 |
A description of the type of tax this is |
| AUTHORITY_ID |
X |
VARCHAR |
128 |
The authority for the rate rule |
| GROUP_ID |
X |
VARCHAR |
128 |
The tax group that this rate rule is for |
| RATE_RULE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
The date/time this rule will be effective |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The date/time when this rule should no longer be effective |
| TYPE_CODE |
|
VARCHAR |
128 |
PERCENT = tax as a designated percentage of an item's taxable amount; AMOUNT = tax at a designated fixed amount regardless of an item's taxable amount; VAT_PERCENT = a designated percentage of an item's taxable amount is already included in that item's price |
| THRESHOLD_RULE |
|
INTEGER |
|
Rule that dictates how a threshold is processed. AMOUNT_FULL=1 AMOUNT_OVER=2 |
| THRESHOLD_AMOUNT |
|
DECIMAL |
12,3 |
The threshold over which this rate will apply |
| MIN_TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
Defines the min range amount for a tax table entry |
| MAX_TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
Defines the max range amount for a tax table entry |
| TAX_PERCENT |
|
DECIMAL |
14,5 |
|
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
|
| TAX_HOLIDAY_INDICATOR |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Sales Microservice
SLS_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ACCOUNT_LINE_ITEM (AccountLineItemModel)
A table to store account based transactions, for example enrollment in a private label credit card
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| REQUEST_ID |
|
VARCHAR |
128 |
|
| REQUEST_TYPE |
|
VARCHAR |
128 |
|
| RETURN_CODE |
|
VARCHAR |
128 |
|
| RETURN_MESSAGE |
|
VARCHAR |
128 |
|
| ACCOUNT_ID |
|
VARCHAR |
128 |
|
| ACCOUNT_TYPE |
|
VARCHAR |
128 |
|
| LOYALTY_ID |
|
VARCHAR |
128 |
|
| RESPONSE_TIMESTAMP |
|
TIMESTAMP |
|
|
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the line item that created this account, if the account was created in this transaction |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ASSOCIATED_TRANS (AssociatedTransModel)
Represents a retail transaction. This is the header record for the transaction.
| Column Name |
PK |
Type |
Size |
Description |
| ASSOCIATED_TRANS_ID |
X |
VARCHAR |
128 |
|
| TRANSACTION_TYPE |
|
VARCHAR |
128 |
|
| DEVICE_ID |
|
VARCHAR |
128 |
|
| BUSINESS_DATE |
|
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
|
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_AUDITABLE_ACTION_TRANS (AuditableActionTransModel)
Represents an action that has been performed on a device that needs audited.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ACTION_CODE |
|
VARCHAR |
128 |
|
| OLD_VALUE |
|
VARCHAR |
128 |
|
| NEW_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_AUTH_LINE_ITEM (AuthLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the line item that cause this authorization to occur. The entity that is referenced is determined by the auth_type_code (either sls_tender_line_item or sls_retail_line_item) |
| CARD_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to sls_card_line_item if this authorization was made with a card |
| VOIDED |
|
OTHER |
|
A flag to determine if the auth_line_item has been voided |
| POST_VOID |
|
OTHER |
|
A flag that indicates that this void auth was part of a post void (versus partial void) |
| AUTH_TYPE_CODE |
|
VARCHAR |
128 |
A code indicating the type of authorization that was performed |
| RESULT_CODE |
|
VARCHAR |
128 |
A code indicating the overall result of the authorization. E.g., Approved, declined, timeout, etc. |
| REQUESTED_AMOUNT |
|
DECIMAL |
12,3 |
Amount requested for this authorization |
| AUTHORIZED_AMOUNT |
|
DECIMAL |
12,3 |
Amount actually approved for this authorization |
| REMAINING_BALANCE_AMOUNT |
|
DECIMAL |
12,3 |
For stored value tenders, the balance remaining on the tender |
| AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization transaction |
| VERIFICATION_METHOD_CODE |
|
VARCHAR |
128 |
Customer verification method |
| AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Method used for authorizing the transaction |
| AUTH_RESULT_CODE |
|
VARCHAR |
128 |
An optional code indicating a more specific result. E.g., Bank decline, processor decline, etc. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
|
| PARTIALLY_APPROVED |
|
OTHER |
|
|
| PAYMENT_TOKEN |
|
VARCHAR |
1024 |
|
| ORIGINAL_SALE_REF |
|
VARCHAR |
2048 |
|
| TOKEN_TYPE |
|
VARCHAR |
128 |
|
| EMV_APPLICATION_ID |
|
VARCHAR |
128 |
|
| EMV_APPLICATION_CRYPTOGRAM |
|
VARCHAR |
128 |
|
| PROVIDER_NAME |
|
VARCHAR |
128 |
|
| SIGNATURE_FORMAT_CODE |
|
VARCHAR |
128 |
The data format of the signature. E.g., POINTS, TIFF, JPG, PNG, etc. When storing an image as POINTS, the format is a List of point groups as specified by the org.jumpmind.pos.core.model.Signature.pointGroups attribute. What is persisted in the database is a serialized JSON representation of that attribute. |
| SIGNATURE_NAME |
|
VARCHAR |
128 |
Optional name for the signature. Can be used to store a file name or other related text. |
| RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the payment provider to be displayed on the receipt. |
| STORE_ONLY_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the payment provider to be displayed on the receipt, specific to the store copy of the receipt |
| CURRENCY_CONVERSION_TEXT |
|
VARCHAR |
4000 |
A block of receipt text with currency conversion information to be displayed on the receipt. |
| SIGNATURE |
|
OTHER |
|
The signature data itself. Base 64 encoded and then encrypted. |
| STAN |
|
VARCHAR |
128 |
System Trace Audit Number, used by banks/payment providers to identify transactions |
| SESSION_DATA |
|
OTHER |
|
Session or transaction related data specific to payment provider, serialized to json |
| AUTH_TIME |
|
TIMESTAMP |
|
Timestamp of when the authorization occurred |
| MERCHANT_REF |
|
VARCHAR |
128 |
Merchant-determined reference for the transaction |
| TERMINAL_ID |
|
VARCHAR |
128 |
Terminal identifier |
| APPLICATION_LABEL |
|
VARCHAR |
128 |
Mnemonic associated with the applicationId according to ISO/IEC 7816-5 |
| APPLICATION_ID |
|
VARCHAR |
128 |
A unique sequence of numbers for specific card type |
| TERMINAL_VERIFICATION_RESULT |
|
VARCHAR |
128 |
Terminal tests to accept, decline or go on-line for a payment transaction (5 bytes) |
| ISSUER_APPLICATION_DATA |
|
VARCHAR |
128 |
Contains proprietary application data for transmission to the issuer in an online transaction |
| TRANSACTION_STATUS_INFORMATION |
|
VARCHAR |
128 |
Terminal tests to accept, decline or go on-line for a payment transaction (2 bytes) |
| AUTHORIZATION_RESPONSE_CODE |
|
VARCHAR |
128 |
Code that defines the disposition of a message (online approval = 00, online decline = 05...) |
| APPLICATION_CRYPTOGRAM |
|
VARCHAR |
128 |
This cryptogram is sent to the card issuer in online authorization and clearing messages, and can be verified by the issuer to confirm the legitimacy of the transaction |
| REFERENCED_RETURN |
|
OTHER |
|
A flag that indicates that this auth was part of a referenced return |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_CARD_LINE_ITEM (CardLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| BRAND |
|
VARCHAR |
128 |
|
| CARD_NAME |
|
VARCHAR |
128 |
|
| CODE |
|
VARCHAR |
128 |
|
| TYPE_CODE |
|
VARCHAR |
128 |
|
| PAYMENT_PROVIDER_CODE |
|
VARCHAR |
128 |
|
| MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
|
| ENTRY_MODE |
|
VARCHAR |
128 |
|
| SERVICE_CODE |
|
VARCHAR |
128 |
Service Code, Security Verification Code, or CVV from Card |
| EXPIRATION_DATE |
|
VARCHAR |
128 |
|
| CARD_NUMBER |
|
VARCHAR |
128 |
The full card number for non-PCI numbers (gift cards, store credit) |
| GIFT_CARD_ACTION_CODE |
|
VARCHAR |
128 |
If this line represents a Gift Card, this is the action being performed on the card. |
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the line item that represents this card |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_CARRIER (CarrierModel)
Represents the possible carriers available to fulfill order shipments.
| Column Name |
PK |
Type |
Size |
Description |
| CARRIER_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_NAME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_CATEGORY_REWARD_LINE_ITEM (CategoryRewardLineItemModel)
A table to store Line Items for Category Rewards
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| REWARD_CATEGORY_TYPE |
|
VARCHAR |
128 |
|
| REWARD |
|
DECIMAL |
12,3 |
|
| CATEGORY_ID |
|
VARCHAR |
128 |
|
| PROMOTION_ID |
|
VARCHAR |
128 |
|
| LINE_ITEM_REF |
|
VARCHAR |
128 |
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_CLOSE_STORE_TRANS (CloseStoreTransModel)
Represents a close store transaction
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_DOCUMENT_LINE_ITEM (DocumentLineItemModel)
Represents a document associated with a given transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| DOCUMENT_NAME |
|
VARCHAR |
128 |
The name of the document. |
| DOCUMENT_TYPE |
|
VARCHAR |
128 |
The type of the document |
| DOCUMENT_CONTENT |
|
OTHER |
|
The content of the document. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_HANDLING_METHOD (HandlingMethodModel)
Represents a handling method for orders.
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| HANDLING_FEE |
|
DECIMAL |
12,3 |
|
| HANDLING_METHOD_TYPE_CODE |
|
VARCHAR |
128 |
|
| LEAD_TIME_DAYS |
|
INTEGER |
|
|
| ITEM_ID |
|
VARCHAR |
128 |
The ID of the item associated with the retail line representing this handling method within a transaction |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| EXPECTED_SHIP_DATE |
|
VARCHAR |
128 |
|
| MIN_THRESHOLD_AMOUNT |
|
DECIMAL |
12,3 |
|
| THRESHOLD_STRATEGY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_INQUIRY_TRANS (InquiryTransModel)
Represents an inquiry done outside of a retail transaction
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_LTY_RWD_LINE_ITEM (LoyaltyRewardLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| LOYALTY_PROMOTION_ID |
X |
VARCHAR |
128 |
A unique identifier for the customer loyalty reward. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion model this maps back to |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_MANAGER_OVERRIDE (ManagerOverrideLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| PERMISSION_ID |
|
VARCHAR |
128 |
|
| REQUESTING_USER_ID |
|
VARCHAR |
128 |
|
| AUTHENTICATING_DEVICE_ID |
|
VARCHAR |
128 |
|
| AUTHENTICATING_USER_ID |
|
VARCHAR |
128 |
|
| OVERRIDE_TYPE |
|
VARCHAR |
128 |
|
| RESOLUTION |
|
VARCHAR |
128 |
The resolution of the manager override. APPROVED, DENIED, DISMISSED, etc. |
| AUTHENTICATION_METHOD |
|
VARCHAR |
128 |
The authentication method used to resolve the manager override. PASSWORD, BIOMETRIC, etc. |
| TIME_REQUESTED |
|
TIMESTAMP |
|
|
| TIME_RESOLVED |
|
TIMESTAMP |
|
|
| ADDITIONAL_DATA |
|
OTHER |
|
JSON formatted additional data for external systems to interpret |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_AUTH (OrderAuthorizationLineModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| AUTH_TYPE_CODE |
|
VARCHAR |
128 |
A code indicating the type of authorization that was performed |
| RESULT_CODE |
|
VARCHAR |
128 |
A code indicating the overall result of the authorization. E.g., Approved, declined, timeout, etc. |
| REQUESTED_AMOUNT |
|
DECIMAL |
12,3 |
Amount requested for this authorization |
| AUTHORIZED_AMOUNT |
|
DECIMAL |
12,3 |
Amount actually approved for this authorization |
| REMAINING_BALANCE_AMOUNT |
|
DECIMAL |
12,3 |
For stored value tenders, the balance remaining on the tender |
| AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization transaction |
| VERIFICATION_METHOD_CODE |
|
VARCHAR |
128 |
Customer verification method |
| AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Method used for authorizing the transaction |
| AUTH_RESULT_CODE |
|
VARCHAR |
128 |
An optional code indicating a more specific result. E.g., Bank decline, processor decline, etc. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
|
| PARTIALLY_APPROVED |
|
OTHER |
|
|
| PAYMENT_TOKEN |
|
VARCHAR |
1024 |
|
| ORIGINAL_SALE_REF |
|
VARCHAR |
2048 |
|
| TOKEN_TYPE |
|
VARCHAR |
128 |
|
| EMV_APPLICATION_ID |
|
VARCHAR |
128 |
|
| EMV_APPLICATION_CRYPTOGRAM |
|
VARCHAR |
128 |
|
| PROVIDER_NAME |
|
VARCHAR |
128 |
|
| SIGNATURE_FORMAT_CODE |
|
VARCHAR |
128 |
The data format of the signature. E.g., POINTS, TIFF, JPG, PNG, etc. When storing an image as POINTS, the format is a List of point groups as specified by the org.jumpmind.pos.core.model.Signature.pointGroups attribute. What is persisted in the database is a serialized JSON representation of that attribute. |
| SIGNATURE_NAME |
|
VARCHAR |
128 |
Optional name for the signature. Can be used to store a file name or other related text. |
| RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the payment provider to be displayed on the receipt. |
| STORE_ONLY_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the payment provider to be displayed on the receipt, specific to the store copy of the receipt |
| CURRENCY_CONVERSION_TEXT |
|
VARCHAR |
4000 |
A block of receipt text with currency conversion information to be displayed on the receipt. |
| SIGNATURE |
|
OTHER |
|
The signature data itself. Base 64 encoded and then encrypted. |
| STAN |
|
VARCHAR |
128 |
System Trace Audit Number, used by banks/payment providers to identify transactions |
| SESSION_DATA |
|
OTHER |
|
Session or transaction related data specific to payment provider, serialized to json |
| AUTH_TIME |
|
TIMESTAMP |
|
Timestamp of when the authorization occurred |
| MERCHANT_REF |
|
VARCHAR |
128 |
Merchant-determined reference for the transaction |
| TERMINAL_ID |
|
VARCHAR |
128 |
Terminal identifier |
| APPLICATION_LABEL |
|
VARCHAR |
128 |
Mnemonic associated with the applicationId according to ISO/IEC 7816-5 |
| APPLICATION_ID |
|
VARCHAR |
128 |
A unique sequence of numbers for specific card type |
| TERMINAL_VERIFICATION_RESULT |
|
VARCHAR |
128 |
Terminal tests to accept, decline or go on-line for a payment transaction (5 bytes) |
| ISSUER_APPLICATION_DATA |
|
VARCHAR |
128 |
Contains proprietary application data for transmission to the issuer in an online transaction |
| TRANSACTION_STATUS_INFORMATION |
|
VARCHAR |
128 |
Terminal tests to accept, decline or go on-line for a payment transaction (2 bytes) |
| AUTHORIZATION_RESPONSE_CODE |
|
VARCHAR |
128 |
Code that defines the disposition of a message (online approval = 00, online decline = 05...) |
| APPLICATION_CRYPTOGRAM |
|
VARCHAR |
128 |
This cryptogram is sent to the card issuer in online authorization and clearing messages, and can be verified by the issuer to confirm the legitimacy of the transaction |
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the corresponding tender line item which required authorization |
| CARD_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the corresponding card line item if this authorization was initiated for a card tender |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_BILL_TO_ADDRESS (OrderBillToAddressModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
Unique identifier of the order this address is associated with |
| USE_AS_SHIPPING_ADDRESS |
|
OTHER |
|
|
| FIRST_NAME |
|
VARCHAR |
128 |
Customer first name |
| LAST_NAME |
|
VARCHAR |
128 |
Customer last name |
| PHONE |
|
VARCHAR |
128 |
Customer phone number |
| EMAIL |
|
VARCHAR |
128 |
Customer email address |
| SUGGESTION_ACCEPTED_FLAG |
|
OTHER |
|
Flag indicating whether the recommended address was used |
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_CARD_LINE_ITEM (OrderCardLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| BRAND |
|
VARCHAR |
128 |
|
| CARD_NAME |
|
VARCHAR |
128 |
|
| CODE |
|
VARCHAR |
128 |
|
| TYPE_CODE |
|
VARCHAR |
128 |
|
| PAYMENT_PROVIDER_CODE |
|
VARCHAR |
128 |
|
| MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
|
| ENTRY_MODE |
|
VARCHAR |
128 |
|
| SERVICE_CODE |
|
VARCHAR |
128 |
Service Code, Security Verification Code, or CVV from Card |
| EXPIRATION_DATE |
|
VARCHAR |
128 |
|
| CARD_NUMBER |
|
VARCHAR |
128 |
The full card number for non-PCI numbers (gift cards, store credit) |
| GIFT_CARD_ACTION_CODE |
|
VARCHAR |
128 |
If this line represents a Gift Card, this is the action being performed on the card. |
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
A reference to the line item that represents this card |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_LINE_ITEM (OrderLineItemModel)
Represents a line item for a customer order.
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| EXTERNAL_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item. Usually the item id set by the core merchandising system. |
| EPC |
|
VARCHAR |
128 |
The epc code of the item that was scanned if present. |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_TYPE |
|
VARCHAR |
128 |
The type of item (STOCK, SERVICE, GIFTCARD, COUPON, DONATION, WARRANTY, FEE, OTHER). |
| PRICE_TYPE |
|
VARCHAR |
128 |
The price type as specific by the selling price's price type |
| LIST_UNIT_PRICE |
|
DECIMAL |
12,3 |
The list price is the full price amount for any product without factoring in discounts, promotions, or other deals. The list price is sometimes known as catalog price or the manufacturer's suggested retail price (MSRP). |
| RETAIL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The retail price is the amount that the retailer is currently charging for the item |
| REGULAR_UNIT_PRICE |
|
DECIMAL |
12,3 |
The original (regular) unit price for the item at the time it was transacted. |
| ACTUAL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The Actual Unit Price should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of items transacted via this line item. Usually 1 unless the quantity function is used to sell multiples of a single item. |
| EXTENDED_AMOUNT |
|
DECIMAL |
12,3 |
The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. |
| DISCOUNT_AMOUNT |
|
DECIMAL |
12,3 |
The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. |
| EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary value of this LineItem, calculated by multiplying the Quantity by the lookup price; and subtracting any applicable discounts |
| RTN_EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary return value of this line item. This amount may be different from extended discounted amount if there was a tender coupon applied |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total monetary value of all taxes to be collected for this LineItem. |
| REASON_CODE_GROUP_ID |
|
VARCHAR |
128 |
The reason code group id if any for this LineItem. See the reasonCode field. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code if any for this LineItem. I.E. on a return, the reason code will be filled with the return reason code for that line item's return. From CTX_REASON_CODE.REASON_CODE_ID. |
| DISPOSITION_CODE |
|
VARCHAR |
128 |
The disposition code if any for this line item. |
| GIFT_RECEIPT |
|
OTHER |
|
A flag (1 or 0) designating whether a gift receipt was produced for this line item. |
| ITEM_RETURNABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item is returnable. |
| ITEM_TAXABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item was taxable. |
| QUANTITY_AVAIL_FOR_RETURN |
|
DECIMAL |
12,3 |
Denotes the quantity of this line item that are currently available for return. |
| ITEM_DISCOUNTABLE |
|
OTHER |
|
Denotes whether the item can be discounted |
| EMPLOYEE_DISCOUNT_ALLOWED |
|
OTHER |
|
Denotes whether employee discount is allowed |
| ITEM_PRICE_OVERRIDABLE |
|
OTHER |
|
Denotes whether the item price can be overridden |
| DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied. |
| DAMAGE_DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied due to damage of the item. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was included in the price of the item. |
| TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group that was associated with this line item for tax-ability purposes. From TAX_GROUP.ID. |
| ITEM_TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group inherent to this line's SKU; will be the same as @taxGroupId unless the latter is modified via an exemption rule |
| TAX_GROUP_TYPE |
|
VARCHAR |
128 |
The tax group rule type to enforce on this line item as the result of an applied exemption rule |
| TAX_EXEMPTED |
|
OTHER |
|
True if any alterations to this line's tax were made as the result of a tax exemption |
| TAX_GROUP_ID_MODIFICATION_TYPE |
|
VARCHAR |
128 |
The type of modification made, if any, to this line's @taxGroupId |
| ORIG_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
If this line item is for the return of an item, the original line item sequence number of the original transaction. |
| ORIG_SEQUENCE_NUMBER |
|
BIGINT |
|
If this line item is for the return of an item, the sequence number of the original transaction. |
| ORIG_BUSINESS_DATE |
|
VARCHAR |
128 |
If this line item is for the return of an item, the business date of the original transaction. |
| ORIG_DEVICE_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the device on which the original transaction was sold. |
| ORIG_ORDER_ID |
|
VARCHAR |
128 |
|
| ORIG_USERNAME |
|
VARCHAR |
128 |
If this line item is for the return of an item, the username of the original transaction. |
| ORIG_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the businessUnitId on which the original transaction was sold. |
| RETURN_POLICY_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the return policy that was used during the return process. From SLS_RTN_POLICY.RETURN_POLICY_ID. |
| ITEM_RETURNED |
|
OTHER |
|
A flag (1 or 0) indicating whether this line item has been returned. 0 for an initial sale item, 1 for an initial return item, 1 for a sale item that has been returned. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the line item was transacted. |
| TARE_WEIGHT |
|
DECIMAL |
12,3 |
The tare weight (weight of the container) of an item sold by weight. |
| ITEM_WEIGHT |
|
DECIMAL |
12,3 |
The calculated weight of an item sold by weight (itemWeightPlusTare minus tareWeight). |
| ITEM_WEIGHT_PLUS_TARE |
|
DECIMAL |
12,3 |
The total measured weight of an item sold by weight. |
| WEIGHT_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for weighted items (ie. oz, lb, g, mg) |
| WEIGHT_ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
Entry method of weight, KEYED or SCALE_READ |
| FAMILY_CODE |
|
VARCHAR |
3 |
Identifies an item as part of a family of products |
| ITEM_LENGTH |
|
DECIMAL |
12,3 |
The total measured length of an item sold by length. |
| LENGTH_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for length items (ie in, cm, mm, ft) |
| QUANTITY_MODIFIABLE |
|
OTHER |
|
|
| SAVE_VALUE |
|
DECIMAL |
12,3 |
If line item is a coupon, then this is the save value of the coupon |
| SAVE_VALUE_TYPE |
|
VARCHAR |
128 |
If line item is a coupon, then this is the type of savings the save value corresponds to |
| COUPON_ALLOWED |
|
OTHER |
|
Denotes whether a coupon can be redeemed for this item |
| USERNAME |
|
VARCHAR |
128 |
The user associated with this line item. Can be the service user for service skus, or a commission user for individual line items. |
| EXTERNAL_SYSTEM_ID |
|
VARCHAR |
128 |
Used to store an external system id for items such as services. I.E. the system id for this service scheduled in another system. |
| PRODUCT_ID |
|
VARCHAR |
128 |
Product Id associated with this line item |
| ITEM_NAME |
|
VARCHAR |
128 |
The name for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_LONG_DESCRIPTION |
|
VARCHAR |
128 |
The long description for the item, used to display in the commerce engine, receipts, etc. |
| ADDITIONAL_CLASSIFIERS |
|
VARCHAR |
2048 |
Additional classifiers for an item, use for applying promotions |
| ADDITIONAL_ATTRIBUTES |
|
VARCHAR |
1024 |
Additional attributes for an item, use for applying promotions |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates how the item should be authorized during tendering. |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The serial number of this item, if promptForSerialNumber is true and it was entered |
| FULFILLING_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| ESTIMATED_AVAILABILITY_DATE |
|
VARCHAR |
128 |
|
| ACTUAL_AVAILABILITY_DATE |
|
VARCHAR |
128 |
|
| ORDER_ITEM_STATUS_CODE |
|
VARCHAR |
128 |
|
| PACKAGE_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| PICKUP_BIN_ID |
|
VARCHAR |
128 |
Id of the bin that the order item can be found in after it has been prepared for pickup |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_LINE_ITEM_PRICE_MOD (OrderLineItemPriceModifierModel)
A price modification to an order line item
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| MOD_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A unique identifier for the retail line item price modifier. |
| USERNAME |
|
VARCHAR |
128 |
The user name of the operator that allowed the price modifier. From USR_USER.USERNAME. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code for the price modification. From CTX_REASON_CODE.REASON_CODE_ID. |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| MOD_BY_PERCENTAGE |
|
DECIMAL |
12,3 |
The percent amount of the price modification if the price was modified by percent. |
| MOD_BY_AMOUNT |
|
DECIMAL |
12,3 |
The unit amount of the price modification. |
| MODIFICATION_TOTAL |
|
DECIMAL |
12,3 |
The total amount for this price modification to modify the price of the line item by with quantity accounted |
| CALC_METHOD |
|
VARCHAR |
128 |
The method of price modification. Either PERCENTAGE, AMOUNT, OVERRIDE, or OTHER. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion identifier of the promotion that caused the price modification (if any.) From PRM_PROMOTION.PROMOTION_ID |
| PROMOTION_TYPE |
|
VARCHAR |
128 |
The promotion type of the promotion that caused the price modification. From PRN_PROMOTION.PROMOTION_TYPE |
| PROMOTION_REWARD_QUANTITY |
|
DECIMAL |
12,3 |
The number of items that could be rewarded for one qualification of the promotion corresponding to the promotionId |
| PROMO_CODE_ID |
|
VARCHAR |
128 |
The identifier for the promo code that triggered the promotion (if promotion is due to a promo code). |
| APPLIED_COUPON_ITEM_IDS |
|
VARCHAR |
128 |
The item ids of the coupon(s) that qualified this price modification (if any). If more than one, appended to string and delimited with commas |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which this price modification was transacted. |
| PRICE_MOD_TYPE_CODE |
|
VARCHAR |
128 |
The type of price modifier. Either ITEM or TRANS |
| PRICE_MOD_SOURCE_TYPE_CODE |
|
VARCHAR |
128 |
The source of the price modification. Either MANUAL, APR, COUPON, or TENDER_COUPON |
| PRICE_MOD_SOURCE_SUB_TYPE_CODE |
|
VARCHAR |
128 |
An additional detail to the source of the price modification. eg. LOYALTY |
| REWARD_BASE_PRICE_TYPE_CODE |
|
VARCHAR |
128 |
|
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
Generic line item reference. Can be used as a reference to tender line item if the mod source type is TENDER_COUPON, for example |
| VENDOR_FUNDED_FLAG |
|
OTHER |
|
Indicates whether or not this line was the result of a vendor funded discount. |
| QUANTITY_INDEX |
|
INTEGER |
|
Identifies which unit on a line item the price modifier is applied to |
| RTN_DEVICE_ID |
|
VARCHAR |
128 |
The device the return transaction was initiated on |
| RTN_BUSINESS_DATE |
|
VARCHAR |
128 |
The business date of the return transaction that the price modifier was applied to |
| RTN_SEQUENCE_NUMBER |
|
BIGINT |
|
Identifies which return transaction (if any) the price modifier was applied to |
| RETURNED_FLAG |
|
OTHER |
|
Identifies whether the unit associated with the line has been returned |
| EXTERNAL_ID |
|
VARCHAR |
128 |
|
SLS_ORDER_LI_STATUS_TRANS (OrderLineItemStatusTransModel)
Represents a change in order status
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ORDER_ID |
|
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| ORDER_STATUS_CODE |
|
VARCHAR |
128 |
|
| REASON_CODE |
|
VARCHAR |
128 |
The Reason for the status update. Valid codes from CTX_REASON_CODE.REASON_CODE_GROUP_ID='orderfullfillment.cannotfullfill'. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_LTY_RWD_LINE_ITEM (OrderLoyaltyRewardLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| LOYALTY_PROMOTION_ID |
X |
VARCHAR |
128 |
A unique identifier for the customer loyalty reward. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion model this maps back to |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER (OrderModel)
Represents a customer order for goods or services.
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
|
VARCHAR |
10 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| DEVICE_ID |
|
VARCHAR |
128 |
|
| CUSTOMER_ID |
|
VARCHAR |
128 |
|
| SELLING_CHANNEL_CODE |
|
VARCHAR |
128 |
The channel under which this transaction was created (STORE, WEB, KIOSK or OTHER). |
| LOYALTY_CARD_NUMBER |
|
VARCHAR |
128 |
|
| TAX_EXEMPT_CUSTOMER_ID |
|
VARCHAR |
128 |
The Id of the tax exempt customer if this transaction was designated as tax exempt. Id from CUST_CUSTOMER.ID |
| TAX_EXEMPT_CERTIFICATE |
|
VARCHAR |
128 |
The tax exempt identifier |
| TAX_EXEMPT_CODE |
|
VARCHAR |
128 |
The 2 digit reason code associated to the exemption type description |
| EMPLOYEE_ID_FOR_DISCOUNT |
|
VARCHAR |
128 |
The employee Id entered to apply an employee discount |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the transaction was tendered. |
| LINE_ITEM_COUNT |
|
INTEGER |
|
The number of line items that were created as part of this transaction (SLS_RETAIL_LINE_ITEM). |
| AGE_RESTRICTED_DATE_OF_BIRTH |
|
TIMESTAMP |
|
Preserve the date of birth of a customer for age restricted items |
| ITEM_COUNT |
|
INTEGER |
|
The number of items in the transaction as displayed on the receipt |
| CUSTOMER_NAME |
|
VARCHAR |
128 |
The full name of the customer, if a customer is attached to the transaction. |
| TENDER_TYPE_CODES |
|
VARCHAR |
128 |
A space delimited list of the TenderTypeCodes used when tendering this transaction. |
| VOIDABLE_FLAG |
|
OTHER |
|
Whether or not this transaction is voidable. |
| TAX_GEO_CODE_ORIGIN |
|
VARCHAR |
128 |
The type of geo code used for establishing the transaction tax rates. The value is used for determining if taxes are based on an initial device location or business unit postal code. The values here should be one of the values defined in the GeoCodeOrigin class. |
| ORDER_CUSTOMER_FIRST_NAME |
|
VARCHAR |
128 |
|
| ORDER_CUSTOMER_LAST_NAME |
|
VARCHAR |
128 |
|
| ORDER_CUSTOMER_EMAIL |
|
VARCHAR |
128 |
|
| ORDER_CUSTOMER_PHONE_NUMBER |
|
VARCHAR |
128 |
|
| ORDER_CUSTOMER_ALTERNATE_NAME |
|
VARCHAR |
128 |
|
| TOTAL |
|
DECIMAL |
12,3 |
The final, total amount (in the transacted currency) of the transaction. |
| PRE_TENDER_BALANCE_DUE |
|
DECIMAL |
12,3 |
The amount due as presented to the user before any tenders (except possibly post-tax coupon tenders) were applied to the transaction. |
| EXTENDED_SUBTOTAL |
|
DECIMAL |
12,3 |
The pre-discount subtotal amount (total - tax + totalDiscount) of the transaction. |
| SUBTOTAL |
|
DECIMAL |
12,3 |
The subtotal amount (total - taxTotal) of the transaction. |
| TAX_TOTAL |
|
DECIMAL |
12,3 |
The final, total tax amount of the transaction. |
| TAX_TOTAL_FOR_DISPLAY |
|
DECIMAL |
12,3 |
The amount of tax that should be displayed to the end user. This is useful for accessing the tax amount which is already incorporated into item prices (for example, in stores that use VAT). |
| DISCOUNT_TOTAL |
|
DECIMAL |
12,3 |
The final, total discount amount of the transaction. Includes all temporary discounts and advanced pricing rules. Does not include any tender based discounts. |
| ORDER_TYPE_CODE |
|
VARCHAR |
128 |
|
| PARENT_ORDER_ID |
|
VARCHAR |
128 |
|
| ESTIMATED_AVAILABILITY_DATE |
|
VARCHAR |
128 |
|
| ACTUAL_AVAILABILITY_DATE |
|
VARCHAR |
128 |
|
| ORDER_DUE_DATE |
|
VARCHAR |
128 |
|
| AMOUNT_DUE |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the tender due |
| PAYMENT_STATUS_CODE |
|
VARCHAR |
128 |
|
| HANDLING_METHOD_TYPE_CODE |
|
VARCHAR |
128 |
|
| HANDLING_COST |
|
DECIMAL |
12,3 |
|
| HANDLING_DATE |
|
VARCHAR |
128 |
The date that the order is expected to be delivered to the customer. |
| HANDLING_DESCRIPTION |
|
VARCHAR |
128 |
|
| EXPECTED_SHIP_DATE |
|
VARCHAR |
128 |
The date that the order is expected to be shipped. |
| ACTUAL_SHIP_DATE |
|
TIMESTAMP |
|
The date that the order was actually shipped. |
| EXPECTED_DELIVERY_DATE |
|
TIMESTAMP |
|
The date that the order is expected to be delivered. |
| ACTUAL_DELIVERY_DATE |
|
TIMESTAMP |
|
The date that the order was actually delivered. |
| SURCHARGE |
|
DECIMAL |
12,3 |
The total of all surcharges enforced on the fulfillment of the order; e.g. when shipping to Alaska or Hawaii |
| DELIVERY_GROUP |
|
VARCHAR |
128 |
The name, if any, of the delivery group associated with this order |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_NOTE (OrderNoteModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| NOTE |
|
VARCHAR |
128 |
|
| CUSTOMER |
|
OTHER |
|
|
| USER_NAME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_PACKAGE (OrderPackageModel)
Represents a package for a customer order.
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| VOIDED |
|
OTHER |
|
|
| PACKAGE_TYPE_ID |
|
VARCHAR |
128 |
|
| PACKAGE_TYPE_DISPLAY_NAME |
|
VARCHAR |
128 |
|
| CARRIER_ID |
|
VARCHAR |
128 |
|
| CARRIER_DISPLAY_NAME |
|
VARCHAR |
128 |
|
| TRACKING_NUMBER |
|
VARCHAR |
128 |
|
| TRACKING_URL |
|
OTHER |
|
|
| LABEL_DATA |
|
OTHER |
|
|
| PACKAGE_WEIGHT |
|
VARCHAR |
128 |
Weight of the package in the units of weightUOM |
| WEIGHT_U_O_M |
|
VARCHAR |
128 |
Weight Unit of Measure (i.e. 'lbs, kgs...) |
| PACKAGE_LENGTH |
|
VARCHAR |
128 |
Length of the package in the units of dimensionsUOM |
| PACKAGE_WIDTH |
|
VARCHAR |
128 |
Width of the package in the units of dimensionsUOM |
| PACKAGE_HEIGHT |
|
VARCHAR |
128 |
Height of the package in the units of dimensionsUOM |
| DIMENSIONS_U_O_M |
|
VARCHAR |
128 |
Dimensions Unit of Measure (i.e. 'in., cm., etc...) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_PICKUP_LINE_ITEM (OrderPickupLineItemModel)
Line items added to a retail transaction for order items being picked up
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| ORDER_ID |
|
VARCHAR |
128 |
The identifier of the order the pickup item is associated with |
| ORDER_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
The sequence number of the item on the order |
| ITEM_ID |
|
VARCHAR |
128 |
The id of the item being picked up as a part of this transaction |
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| QUANTITY |
|
DECIMAL |
12,3 |
Quantity of items picked up |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_SHIP_TO_ADDRESS (OrderShipToAddressModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
Unique identifier of the order this address is associated with |
| FIRST_NAME |
|
VARCHAR |
128 |
Customer first name |
| LAST_NAME |
|
VARCHAR |
128 |
Customer last name |
| PHONE |
|
VARCHAR |
128 |
Customer phone number |
| EMAIL |
|
VARCHAR |
128 |
Customer email address |
| SUGGESTION_ACCEPTED_FLAG |
|
OTHER |
|
Flag indicating whether the recommended address was used |
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_TAX_GROUP_LINE_ITEM (OrderTaxGroupLineItemModel)
Tax information for a tax group for the order.
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| AUTHORITY_ID |
|
VARCHAR |
128 |
The authority under which the tax was collected. From TAX_AUTHORITY.ID. |
| AUTHORITY_TYPE |
|
VARCHAR |
128 |
The authority type which the tax was collected. From TAX_AUTHORITY.AUTH_TYPE_NAME |
| GROUP_ID |
|
VARCHAR |
128 |
The tax group under which the tax was collected. From TAX_GROUP.ID |
| TAX_TYPE |
|
VARCHAR |
128 |
The tax type under which the tax was collected. From TAX_GROUP.TAX_TYPE |
| RULE_NAME |
|
VARCHAR |
128 |
The name of the rule under which the tax was collected. From TAX_GROUP_RULE.RULE_NAME |
| RULE_DESCRIPTION |
|
VARCHAR |
128 |
The description of the rule under which the tax was collected. From TAX_GROUP_RULE.DESCRIPTION |
| TAX_PERCENTAGE |
|
DECIMAL |
12,3 |
The tax percentage applied to items in the transation for this tax group. |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total amount of tax collected for this tax group. |
| MONEY_TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total Money tax amount of tax collected for this tax group where the value of this field is sum of the item's Money taxAmounts |
| TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
The total amount of the items tax was collected for under this tax group. |
| RETURN_TAX_FLAG |
|
OTHER |
|
Whether the tax group line is for a return tax |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the tax was collected. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
Indicates whether the tax applied to this line is already included in its taxable amount |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_TAX_LINE_ITEM (OrderTaxLineItemModel)
Tax information applied to items in the transaction for a given tax authority.
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| TAX_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A unique identifier for the tax line item. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| AUTHORITY_ID |
|
VARCHAR |
128 |
The tax authority under which the tax was collected. |
| AUTHORITY_TYPE |
|
VARCHAR |
128 |
The tax authority type under which the tax was collected. From TAX_AUTHORITY.AUTH_TYPE_NAME |
| GROUP_ID |
|
VARCHAR |
128 |
The tax group applied to calculate the tax. From TAX_GROUP.GROUP_ID. |
| RULE_NAME |
|
VARCHAR |
128 |
The name of the tax rule applied to calculate the tax. |
| RULE_DESCRIPTION |
|
VARCHAR |
128 |
The description of the tax rule applied to calculate the tax. |
| TAX_TYPE |
|
VARCHAR |
128 |
The tax type under which the tax was collected. From TAX_GROUP.TAX_TYPE |
| TAX_HOLIDAY_INDICATOR |
|
OTHER |
|
An indicator that this was a tax holiday. |
| RATE_RULE_SEQUENCE_NUMBER |
|
INTEGER |
|
The tax rate rule sequence number applied to calculate the tax. From TAX_RATE_RULE.RATE_RULE_SEQUENCE_NUMBER. |
| OVERRIDE_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was overridden on the transaction. |
| TAX_EXEMPT_ID |
|
VARCHAR |
128 |
The tax exempt identifier provided, if the the customer was a tax exempt organization. |
| TAX_EXEMPT |
|
OTHER |
|
A flag (1 or 0) denoting whether the transaction was tax exempt. |
| TAX_EXEMPT_AMOUNT |
|
DECIMAL |
12,3 |
The amount of the transaction that was deemed exempt from taxes. |
| OVERRIDE_PERCENT |
|
DECIMAL |
12,3 |
If tax was overridden by a percentage, then the percentage by which the was overridden. |
| OVERRIDE_AMOUNT |
|
DECIMAL |
12,3 |
if tax was overridden by an amount, then the amount by which the tax was overridden. |
| OVERRIDE_REASON_CODE |
|
VARCHAR |
128 |
If the tax was overridden, then the reason code entered by the operator for the tax override. From CTX_REASON_CODE.REASON_CODE_ID. |
| TAX_PERCENTAGE |
|
DECIMAL |
12,4 |
The resulting tax percentage applied to the transaction. |
| TAX_AMOUNT |
|
DECIMAL |
12,4 |
The amount of tax collected for the authority. |
| MONEY_TAX_AMOUNT |
|
DECIMAL |
12,3 |
The Money amount of tax collected for the authority |
| TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
The taxable amount of the transaction basket. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the tax was collected. |
| CALCULATION_METHOD |
|
VARCHAR |
128 |
The algorithm by which this tax amount was calculated. From TAX_RATE_RULE.TYPE_CODE |
| CALCULATION_SOURCE |
|
VARCHAR |
128 |
Tracks what tax calculation engine was used to compute this. Normally JMC |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
Indicates whether the tax applied to this line is already included in its taxable amount |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_ORDER_TENDER_LINE_ITEM (OrderTenderLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| ORDER_ID |
X |
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| TENDER_CODE |
|
VARCHAR |
128 |
Unique code that identifies the tender used |
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the tender |
| CHANGE_FLAG |
|
OTHER |
|
Indicates whether or not this line item represents change issued back to the customer |
| CUSTOMER_ACCOUNT_NUMBER |
|
VARCHAR |
128 |
Future use. |
| TENDER_ACCOUNT_NUMBER |
|
VARCHAR |
128 |
Future use. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The ISO code of the store's local currency, regardless of the currency of the tender submitted by the customer |
| TENDER_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the tender submitted by the customer |
| CASH_BACK_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the tender returned to the customer |
| ISO_FOREIGN_CURRENCY_CODE |
|
VARCHAR |
128 |
If the customer used foreign currency, this is the currency code for the tender submitted |
| FOREIGN_CURRENCY_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoForeignCurrencyCode) of the tender submitted by the customer |
| EXCHANGE_RATE |
|
DECIMAL |
12,3 |
If the customer used foreign currency, this is the exchange rate that the system used to convert the given foreignCurrencyAmount into the tenderAmount |
| OVERTENDERED |
|
OTHER |
|
Whether or not this was an overtendered tender in the transaction |
| PARTIALLY_APPROVED |
|
OTHER |
|
Whether or not this tender amount was a partially approved amount of the original requested amount |
| TENDER_FINANCE_ID |
|
VARCHAR |
128 |
The tenderFinanceId of the selected TenderFinancingModel (if applicable) |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates when the authorization for this tender line was or will be done. |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this line item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| CERTIFICATE_NUMBER |
|
VARCHAR |
128 |
The number associate with a generic certificate (i.e. a Mall Certificate) |
| VOUCHER_ID |
|
VARCHAR |
128 |
The number associated with a single use, redeemable voucher |
| LOYALTY_POINTS_REDEEMED |
|
DECIMAL |
12,3 |
The amount of loyalty points redeemed |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| REWARD_PROMO_CODE_ID |
|
VARCHAR |
128 |
A unique identifier for the reward promo code used to generate a promo code |
| PROMO_CODE_ID |
|
VARCHAR |
128 |
A unique identifier for the promo code. |
| LOYALTY_NUMBER |
|
VARCHAR |
128 |
The loyalty customer that this promo code applies to |
| LOYALTY_PROMOTION_FLAG |
|
OTHER |
|
Flag to denote if loyaltyNumber is required to have a value |
| ORIGIN_PROMOTION_ID |
|
VARCHAR |
128 |
The originating promotionId that generated this promo code, if this promo code was created through a bounce back promotion. |
| REWARD_PROMOTION_ID |
|
VARCHAR |
128 |
The rewarding promotionId that is applied when the promo code is used/redeemed |
| CODE |
|
VARCHAR |
128 |
The unique code/barcode of the promo code that is scanned or entered in order to apply |
| DESCRIPTION |
|
VARCHAR |
128 |
The description of the promo code, used to display in the commerce engine, receipts, etc |
| EVENT_TYPE_CODE |
|
VARCHAR |
128 |
The event that resulted in this promo code line item being added to the transaction (EARNED, REDEEMED, INVALIDATED) |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
The effective start time of the promo code |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
The effective end time of the promo code |
| PRINT_ON_RECEIPT_FLAG |
|
OTHER |
|
Flag denoting whether this promo code should be printed on the transaction receipt |
| REWARD_PROMOTION_JSON |
|
OTHER |
|
A field where a dynamic promotion can be stored so it can be rehydrated when reading a transaction back out of the database. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_REPEAT_DELIVERY_LINE_ITEM (RepeatDeliveryLineItemModel)
A Repeat Delivery created as part of a transaction for recurring automatic delivery of items to the customer. There is one repeat delivery line item for each item or sku thatis set up for repeat delivery on the transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| REPEAT_DELIVERY_ID |
|
VARCHAR |
128 |
The identifier of the final Repeat Delivery created and persisted upon finalization of the transaction. This is a reference to the Repeat Delivery stored in rpd_repeat_delivery that will result in orders being fulfilled by an OMS.This identifier is expected to be set as long at the repeat delivery was created. If the repeat delivery was voided, for example,this id will not be set. |
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item. Usually the item id set by the core merchandising system. |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_TYPE |
|
VARCHAR |
128 |
The type of item (STOCK, SERVICE, GIFTCARD, COUPON, DONATION, WARRANTY, FEE, OTHER). |
| REGULAR_UNIT_PRICE |
|
DECIMAL |
12,3 |
The original (regular) unit price for the item at the time it was transacted. |
| ACTUAL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The Actual Unit Price should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of items transacted via this line item. Usually 1 unless the quantity function is used to sell multiples of a single item. |
| EXTENDED_AMOUNT |
|
DECIMAL |
12,3 |
The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. |
| DISCOUNT_AMOUNT |
|
DECIMAL |
12,3 |
The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. |
| EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary value of this LineItem, calculated by multiplying the Quantity by the lookup price; and subtracting any applicable discounts |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the line item was transacted. |
| LINE_ITEM_TYPE |
|
VARCHAR |
128 |
The type of line item (STORE_SALE, WEB, BOPIS, BISPIS, ORDER_IN_STORE, SFS, CURBSIDE, SEND_SALE, GIFT_CARD, REPEAT_DELIVERY) |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates how the item should be authorized during tendering. |
| REF_LINE_IDS |
|
VARCHAR |
128 |
If multiple retail lines were aggregated into a single Repeat Delivery deal, this fieldwill contain the comma separated list of the associated transaction line IDs. If the Repeat Delivery Deal is associated with only one line, that line id will be specified here. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RESUME_TRANS (ResumeTransModel)
Represents a resumed transaction. This is the transaction that references a retail transaction that has been resumed.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| SUSPENDED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the original transaction that has been resumed. |
| SUSPENDED_DEVICE_ID |
|
VARCHAR |
128 |
The device id of which the suspended transaction occurred |
| RESUMED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the resumed transaction |
| RESUMED_DEVICE_ID |
|
VARCHAR |
128 |
The device id of which the resumed transaction occurred |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_CART_LINE_ITEM_HIST (RetailCartLineItemHistModel)
Represents historical line items of a retail e-commerce cart for audit purposes.
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
The unique identifier of the customer who's tied to this cart |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The id of the business unit |
| UUID |
X |
VARCHAR |
128 |
A sequence number that makes this entry unique to the cart |
| STATUS_CODE |
|
VARCHAR |
128 |
The status of the historical cart item |
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item. Usually the item id set by the core merchandising system. |
| EPC |
|
VARCHAR |
128 |
The epc code of the item that was scanned if present. |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_TYPE |
|
VARCHAR |
128 |
The type of item (STOCK, SERVICE, GIFTCARD, COUPON, DONATION, WARRANTY, FEE, OTHER). |
| PRICE_TYPE |
|
VARCHAR |
128 |
The price type as specific by the selling price's price type |
| LIST_UNIT_PRICE |
|
DECIMAL |
12,3 |
The list price is the full price amount for any product without factoring in discounts, promotions, or other deals. The list price is sometimes known as catalog price or the manufacturer's suggested retail price (MSRP). |
| RETAIL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The retail price is the amount that the retailer is currently charging for the item |
| REGULAR_UNIT_PRICE |
|
DECIMAL |
12,3 |
The original (regular) unit price for the item at the time it was transacted. |
| ACTUAL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The Actual Unit Price should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of items transacted via this line item. Usually 1 unless the quantity function is used to sell multiples of a single item. |
| EXTENDED_AMOUNT |
|
DECIMAL |
12,3 |
The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. |
| DISCOUNT_AMOUNT |
|
DECIMAL |
12,3 |
The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. |
| EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary value of this LineItem, calculated by multiplying the Quantity by the lookup price; and subtracting any applicable discounts |
| RTN_EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary return value of this line item. This amount may be different from extended discounted amount if there was a tender coupon applied |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total monetary value of all taxes to be collected for this LineItem. |
| REASON_CODE_GROUP_ID |
|
VARCHAR |
128 |
The reason code group id if any for this LineItem. See the reasonCode field. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code if any for this LineItem. I.E. on a return, the reason code will be filled with the return reason code for that line item's return. From CTX_REASON_CODE.REASON_CODE_ID. |
| DISPOSITION_CODE |
|
VARCHAR |
128 |
The disposition code if any for this line item. |
| GIFT_RECEIPT |
|
OTHER |
|
A flag (1 or 0) designating whether a gift receipt was produced for this line item. |
| ITEM_RETURNABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item is returnable. |
| ITEM_TAXABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item was taxable. |
| QUANTITY_AVAIL_FOR_RETURN |
|
DECIMAL |
12,3 |
Denotes the quantity of this line item that are currently available for return. |
| ITEM_DISCOUNTABLE |
|
OTHER |
|
Denotes whether the item can be discounted |
| EMPLOYEE_DISCOUNT_ALLOWED |
|
OTHER |
|
Denotes whether employee discount is allowed |
| ITEM_PRICE_OVERRIDABLE |
|
OTHER |
|
Denotes whether the item price can be overridden |
| DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied. |
| DAMAGE_DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied due to damage of the item. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was included in the price of the item. |
| TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group that was associated with this line item for tax-ability purposes. From TAX_GROUP.ID. |
| ITEM_TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group inherent to this line's SKU; will be the same as @taxGroupId unless the latter is modified via an exemption rule |
| TAX_GROUP_TYPE |
|
VARCHAR |
128 |
The tax group rule type to enforce on this line item as the result of an applied exemption rule |
| TAX_EXEMPTED |
|
OTHER |
|
True if any alterations to this line's tax were made as the result of a tax exemption |
| TAX_GROUP_ID_MODIFICATION_TYPE |
|
VARCHAR |
128 |
The type of modification made, if any, to this line's @taxGroupId |
| ORIG_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
If this line item is for the return of an item, the original line item sequence number of the original transaction. |
| ORIG_SEQUENCE_NUMBER |
|
BIGINT |
|
If this line item is for the return of an item, the sequence number of the original transaction. |
| ORIG_BUSINESS_DATE |
|
VARCHAR |
128 |
If this line item is for the return of an item, the business date of the original transaction. |
| ORIG_DEVICE_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the device on which the original transaction was sold. |
| ORIG_ORDER_ID |
|
VARCHAR |
128 |
|
| ORIG_USERNAME |
|
VARCHAR |
128 |
If this line item is for the return of an item, the username of the original transaction. |
| ORIG_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the businessUnitId on which the original transaction was sold. |
| RETURN_POLICY_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the return policy that was used during the return process. From SLS_RTN_POLICY.RETURN_POLICY_ID. |
| ITEM_RETURNED |
|
OTHER |
|
A flag (1 or 0) indicating whether this line item has been returned. 0 for an initial sale item, 1 for an initial return item, 1 for a sale item that has been returned. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the line item was transacted. |
| TARE_WEIGHT |
|
DECIMAL |
12,3 |
The tare weight (weight of the container) of an item sold by weight. |
| ITEM_WEIGHT |
|
DECIMAL |
12,3 |
The calculated weight of an item sold by weight (itemWeightPlusTare minus tareWeight). |
| ITEM_WEIGHT_PLUS_TARE |
|
DECIMAL |
12,3 |
The total measured weight of an item sold by weight. |
| WEIGHT_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for weighted items (ie. oz, lb, g, mg) |
| WEIGHT_ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
Entry method of weight, KEYED or SCALE_READ |
| FAMILY_CODE |
|
VARCHAR |
3 |
Identifies an item as part of a family of products |
| ITEM_LENGTH |
|
DECIMAL |
12,3 |
The total measured length of an item sold by length. |
| LENGTH_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for length items (ie in, cm, mm, ft) |
| QUANTITY_MODIFIABLE |
|
OTHER |
|
|
| SAVE_VALUE |
|
DECIMAL |
12,3 |
If line item is a coupon, then this is the save value of the coupon |
| SAVE_VALUE_TYPE |
|
VARCHAR |
128 |
If line item is a coupon, then this is the type of savings the save value corresponds to |
| COUPON_ALLOWED |
|
OTHER |
|
Denotes whether a coupon can be redeemed for this item |
| USERNAME |
|
VARCHAR |
128 |
The user associated with this line item. Can be the service user for service skus, or a commission user for individual line items. |
| EXTERNAL_SYSTEM_ID |
|
VARCHAR |
128 |
Used to store an external system id for items such as services. I.E. the system id for this service scheduled in another system. |
| PRODUCT_ID |
|
VARCHAR |
128 |
Product Id associated with this line item |
| ITEM_NAME |
|
VARCHAR |
128 |
The name for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_LONG_DESCRIPTION |
|
VARCHAR |
128 |
The long description for the item, used to display in the commerce engine, receipts, etc. |
| ADDITIONAL_CLASSIFIERS |
|
VARCHAR |
2048 |
Additional classifiers for an item, use for applying promotions |
| ADDITIONAL_ATTRIBUTES |
|
VARCHAR |
1024 |
Additional attributes for an item, use for applying promotions |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates how the item should be authorized during tendering. |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The serial number of this item, if promptForSerialNumber is true and it was entered |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_CART_LINE_ITEM (RetailCartLineItemModel)
Represents line items of a retail e-commerce cart.
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
The unique identifier of the customer who's tied to this cart |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The id of the business unit |
| UUID |
X |
VARCHAR |
128 |
A sequence number that makes this entry unique to the cart |
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item. Usually the item id set by the core merchandising system. |
| EPC |
|
VARCHAR |
128 |
The epc code of the item that was scanned if present. |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_TYPE |
|
VARCHAR |
128 |
The type of item (STOCK, SERVICE, GIFTCARD, COUPON, DONATION, WARRANTY, FEE, OTHER). |
| PRICE_TYPE |
|
VARCHAR |
128 |
The price type as specific by the selling price's price type |
| LIST_UNIT_PRICE |
|
DECIMAL |
12,3 |
The list price is the full price amount for any product without factoring in discounts, promotions, or other deals. The list price is sometimes known as catalog price or the manufacturer's suggested retail price (MSRP). |
| RETAIL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The retail price is the amount that the retailer is currently charging for the item |
| REGULAR_UNIT_PRICE |
|
DECIMAL |
12,3 |
The original (regular) unit price for the item at the time it was transacted. |
| ACTUAL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The Actual Unit Price should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of items transacted via this line item. Usually 1 unless the quantity function is used to sell multiples of a single item. |
| EXTENDED_AMOUNT |
|
DECIMAL |
12,3 |
The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. |
| DISCOUNT_AMOUNT |
|
DECIMAL |
12,3 |
The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. |
| EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary value of this LineItem, calculated by multiplying the Quantity by the lookup price; and subtracting any applicable discounts |
| RTN_EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary return value of this line item. This amount may be different from extended discounted amount if there was a tender coupon applied |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total monetary value of all taxes to be collected for this LineItem. |
| REASON_CODE_GROUP_ID |
|
VARCHAR |
128 |
The reason code group id if any for this LineItem. See the reasonCode field. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code if any for this LineItem. I.E. on a return, the reason code will be filled with the return reason code for that line item's return. From CTX_REASON_CODE.REASON_CODE_ID. |
| DISPOSITION_CODE |
|
VARCHAR |
128 |
The disposition code if any for this line item. |
| GIFT_RECEIPT |
|
OTHER |
|
A flag (1 or 0) designating whether a gift receipt was produced for this line item. |
| ITEM_RETURNABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item is returnable. |
| ITEM_TAXABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item was taxable. |
| QUANTITY_AVAIL_FOR_RETURN |
|
DECIMAL |
12,3 |
Denotes the quantity of this line item that are currently available for return. |
| ITEM_DISCOUNTABLE |
|
OTHER |
|
Denotes whether the item can be discounted |
| EMPLOYEE_DISCOUNT_ALLOWED |
|
OTHER |
|
Denotes whether employee discount is allowed |
| ITEM_PRICE_OVERRIDABLE |
|
OTHER |
|
Denotes whether the item price can be overridden |
| DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied. |
| DAMAGE_DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied due to damage of the item. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was included in the price of the item. |
| TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group that was associated with this line item for tax-ability purposes. From TAX_GROUP.ID. |
| ITEM_TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group inherent to this line's SKU; will be the same as @taxGroupId unless the latter is modified via an exemption rule |
| TAX_GROUP_TYPE |
|
VARCHAR |
128 |
The tax group rule type to enforce on this line item as the result of an applied exemption rule |
| TAX_EXEMPTED |
|
OTHER |
|
True if any alterations to this line's tax were made as the result of a tax exemption |
| TAX_GROUP_ID_MODIFICATION_TYPE |
|
VARCHAR |
128 |
The type of modification made, if any, to this line's @taxGroupId |
| ORIG_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
If this line item is for the return of an item, the original line item sequence number of the original transaction. |
| ORIG_SEQUENCE_NUMBER |
|
BIGINT |
|
If this line item is for the return of an item, the sequence number of the original transaction. |
| ORIG_BUSINESS_DATE |
|
VARCHAR |
128 |
If this line item is for the return of an item, the business date of the original transaction. |
| ORIG_DEVICE_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the device on which the original transaction was sold. |
| ORIG_ORDER_ID |
|
VARCHAR |
128 |
|
| ORIG_USERNAME |
|
VARCHAR |
128 |
If this line item is for the return of an item, the username of the original transaction. |
| ORIG_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the businessUnitId on which the original transaction was sold. |
| RETURN_POLICY_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the return policy that was used during the return process. From SLS_RTN_POLICY.RETURN_POLICY_ID. |
| ITEM_RETURNED |
|
OTHER |
|
A flag (1 or 0) indicating whether this line item has been returned. 0 for an initial sale item, 1 for an initial return item, 1 for a sale item that has been returned. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the line item was transacted. |
| TARE_WEIGHT |
|
DECIMAL |
12,3 |
The tare weight (weight of the container) of an item sold by weight. |
| ITEM_WEIGHT |
|
DECIMAL |
12,3 |
The calculated weight of an item sold by weight (itemWeightPlusTare minus tareWeight). |
| ITEM_WEIGHT_PLUS_TARE |
|
DECIMAL |
12,3 |
The total measured weight of an item sold by weight. |
| WEIGHT_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for weighted items (ie. oz, lb, g, mg) |
| WEIGHT_ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
Entry method of weight, KEYED or SCALE_READ |
| FAMILY_CODE |
|
VARCHAR |
3 |
Identifies an item as part of a family of products |
| ITEM_LENGTH |
|
DECIMAL |
12,3 |
The total measured length of an item sold by length. |
| LENGTH_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for length items (ie in, cm, mm, ft) |
| QUANTITY_MODIFIABLE |
|
OTHER |
|
|
| SAVE_VALUE |
|
DECIMAL |
12,3 |
If line item is a coupon, then this is the save value of the coupon |
| SAVE_VALUE_TYPE |
|
VARCHAR |
128 |
If line item is a coupon, then this is the type of savings the save value corresponds to |
| COUPON_ALLOWED |
|
OTHER |
|
Denotes whether a coupon can be redeemed for this item |
| USERNAME |
|
VARCHAR |
128 |
The user associated with this line item. Can be the service user for service skus, or a commission user for individual line items. |
| EXTERNAL_SYSTEM_ID |
|
VARCHAR |
128 |
Used to store an external system id for items such as services. I.E. the system id for this service scheduled in another system. |
| PRODUCT_ID |
|
VARCHAR |
128 |
Product Id associated with this line item |
| ITEM_NAME |
|
VARCHAR |
128 |
The name for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_LONG_DESCRIPTION |
|
VARCHAR |
128 |
The long description for the item, used to display in the commerce engine, receipts, etc. |
| ADDITIONAL_CLASSIFIERS |
|
VARCHAR |
2048 |
Additional classifiers for an item, use for applying promotions |
| ADDITIONAL_ATTRIBUTES |
|
VARCHAR |
1024 |
Additional attributes for an item, use for applying promotions |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates how the item should be authorized during tendering. |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The serial number of this item, if promptForSerialNumber is true and it was entered |
| LINE_ITEM_TYPE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_CART (RetailCartModel)
Represents a retail e-commerce cart.
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
The unique identifier of the customer who's tied to this cart |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
The id of the business unit |
| CUSTOMER_NAME |
|
VARCHAR |
128 |
The full name of the customer who's tied to this cart |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which this cart can be tendered |
| TOTAL |
|
DECIMAL |
12,3 |
The final, total amount (in the transacted currency) of the cart. |
| SUBTOTAL |
|
DECIMAL |
12,3 |
The subtotal amount of the cart. |
| DISCOUNT_TOTAL |
|
DECIMAL |
12,3 |
The final, total discount amount of the cart. Includes all temporary discounts and advanced pricing rules. Does not include any tender based discounts. |
| LINE_ITEM_COUNT |
|
INTEGER |
|
The number of line items that were created as part of this cart (SLS_RETAIL_CART_LINE_ITEM). |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_LINE_ITEM_ADDRESS (RetailLineItemAddressModel)
An association between an address and a retail line item
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| CUSTOMER_FIRST_NAME |
|
VARCHAR |
128 |
The first name of the customer. |
| CUSTOMER_LAST_NAME |
|
VARCHAR |
128 |
The last name of the customer. |
| CUSTOMER_EMAIL |
|
VARCHAR |
128 |
The email of the customer. |
| CUSTOMER_PHONE |
|
VARCHAR |
128 |
The phone number of the customer. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item the customer address is associated with. Usually the item id set by the core merchandising system. |
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_LINE_ITEM (RetailLineItemModel)
Represents line items of a retail transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| POS_ITEM_ID |
|
VARCHAR |
128 |
The item identifier for the item that was transacted as part of this retail line item. Usually the vendor UPC for the item. |
| ITEM_ID |
|
VARCHAR |
128 |
The internal item identifier for the item. Usually the item id set by the core merchandising system. |
| EPC |
|
VARCHAR |
128 |
The epc code of the item that was scanned if present. |
| ITEM_DESCRIPTION |
|
VARCHAR |
128 |
The description for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_TYPE |
|
VARCHAR |
128 |
The type of item (STOCK, SERVICE, GIFTCARD, COUPON, DONATION, WARRANTY, FEE, OTHER). |
| PRICE_TYPE |
|
VARCHAR |
128 |
The price type as specific by the selling price's price type |
| LIST_UNIT_PRICE |
|
DECIMAL |
12,3 |
The list price is the full price amount for any product without factoring in discounts, promotions, or other deals. The list price is sometimes known as catalog price or the manufacturer's suggested retail price (MSRP). |
| RETAIL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The retail price is the amount that the retailer is currently charging for the item |
| REGULAR_UNIT_PRICE |
|
DECIMAL |
12,3 |
The original (regular) unit price for the item at the time it was transacted. |
| ACTUAL_UNIT_PRICE |
|
DECIMAL |
12,3 |
The actual per-unit price paid by the customer for this particular sale. It is obtained by applying applicable price derivation rules to the regular unit price. The Actual Unit Price should reflect the RegularUnitPrice increased by UnitPriceIncreaseAmount and reduced by the Unit ExtendedDiscountAmount. |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of items transacted via this line item. Usually 1 unless the quantity function is used to sell multiples of a single item. |
| EXTENDED_AMOUNT |
|
DECIMAL |
12,3 |
The product of multiplying Quantity by the retail selling unit price derived from price lookup (and any applicable price derivation rules) (i.e.,ActualUnitPrice). This retail sale unit price excludes sales and/or value added tax. |
| DISCOUNT_AMOUNT |
|
DECIMAL |
12,3 |
The monetary total of all Discounts and price reduction RetailPriceModifiers that were applied to this Item. |
| EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary value of this LineItem, calculated by multiplying the Quantity by the lookup price; and subtracting any applicable discounts |
| RTN_EXTENDED_DISCOUNTED_AMOUNT |
|
DECIMAL |
12,3 |
The extended, discounted total monetary return value of this line item. This amount may be different from extended discounted amount if there was a tender coupon applied |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total monetary value of all taxes to be collected for this LineItem. |
| REASON_CODE_GROUP_ID |
|
VARCHAR |
128 |
The reason code group id if any for this LineItem. See the reasonCode field. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code if any for this LineItem. I.E. on a return, the reason code will be filled with the return reason code for that line item's return. From CTX_REASON_CODE.REASON_CODE_ID. |
| DISPOSITION_CODE |
|
VARCHAR |
128 |
The disposition code if any for this line item. |
| GIFT_RECEIPT |
|
OTHER |
|
A flag (1 or 0) designating whether a gift receipt was produced for this line item. |
| ITEM_RETURNABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item is returnable. |
| ITEM_TAXABLE |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item was taxable. |
| QUANTITY_AVAIL_FOR_RETURN |
|
DECIMAL |
12,3 |
Denotes the quantity of this line item that are currently available for return. |
| ITEM_DISCOUNTABLE |
|
OTHER |
|
Denotes whether the item can be discounted |
| EMPLOYEE_DISCOUNT_ALLOWED |
|
OTHER |
|
Denotes whether employee discount is allowed |
| ITEM_PRICE_OVERRIDABLE |
|
OTHER |
|
Denotes whether the item price can be overridden |
| DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied. |
| DAMAGE_DISCOUNT_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item had a discount applied due to damage of the item. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was included in the price of the item. |
| TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group that was associated with this line item for tax-ability purposes. From TAX_GROUP.ID. |
| ITEM_TAX_GROUP_ID |
|
VARCHAR |
128 |
The ID of the tax group inherent to this line's SKU; will be the same as @taxGroupId unless the latter is modified via an exemption rule |
| TAX_GROUP_TYPE |
|
VARCHAR |
128 |
The tax group rule type to enforce on this line item as the result of an applied exemption rule |
| TAX_EXEMPTED |
|
OTHER |
|
True if any alterations to this line's tax were made as the result of a tax exemption |
| TAX_GROUP_ID_MODIFICATION_TYPE |
|
VARCHAR |
128 |
The type of modification made, if any, to this line's @taxGroupId |
| ORIG_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
If this line item is for the return of an item, the original line item sequence number of the original transaction. |
| ORIG_SEQUENCE_NUMBER |
|
BIGINT |
|
If this line item is for the return of an item, the sequence number of the original transaction. |
| ORIG_BUSINESS_DATE |
|
VARCHAR |
128 |
If this line item is for the return of an item, the business date of the original transaction. |
| ORIG_DEVICE_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the device on which the original transaction was sold. |
| ORIG_ORDER_ID |
|
VARCHAR |
128 |
|
| ORIG_USERNAME |
|
VARCHAR |
128 |
If this line item is for the return of an item, the username of the original transaction. |
| ORIG_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the businessUnitId on which the original transaction was sold. |
| RETURN_POLICY_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the return policy that was used during the return process. From SLS_RTN_POLICY.RETURN_POLICY_ID. |
| ITEM_RETURNED |
|
OTHER |
|
A flag (1 or 0) indicating whether this line item has been returned. 0 for an initial sale item, 1 for an initial return item, 1 for a sale item that has been returned. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the line item was transacted. |
| TARE_WEIGHT |
|
DECIMAL |
12,3 |
The tare weight (weight of the container) of an item sold by weight. |
| ITEM_WEIGHT |
|
DECIMAL |
12,3 |
The calculated weight of an item sold by weight (itemWeightPlusTare minus tareWeight). |
| ITEM_WEIGHT_PLUS_TARE |
|
DECIMAL |
12,3 |
The total measured weight of an item sold by weight. |
| WEIGHT_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for weighted items (ie. oz, lb, g, mg) |
| WEIGHT_ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
Entry method of weight, KEYED or SCALE_READ |
| FAMILY_CODE |
|
VARCHAR |
3 |
Identifies an item as part of a family of products |
| ITEM_LENGTH |
|
DECIMAL |
12,3 |
The total measured length of an item sold by length. |
| LENGTH_UNIT_OF_MEASURE |
|
VARCHAR |
128 |
the unit of measure for length items (ie in, cm, mm, ft) |
| QUANTITY_MODIFIABLE |
|
OTHER |
|
|
| SAVE_VALUE |
|
DECIMAL |
12,3 |
If line item is a coupon, then this is the save value of the coupon |
| SAVE_VALUE_TYPE |
|
VARCHAR |
128 |
If line item is a coupon, then this is the type of savings the save value corresponds to |
| COUPON_ALLOWED |
|
OTHER |
|
Denotes whether a coupon can be redeemed for this item |
| USERNAME |
|
VARCHAR |
128 |
The user associated with this line item. Can be the service user for service skus, or a commission user for individual line items. |
| EXTERNAL_SYSTEM_ID |
|
VARCHAR |
128 |
Used to store an external system id for items such as services. I.E. the system id for this service scheduled in another system. |
| PRODUCT_ID |
|
VARCHAR |
128 |
Product Id associated with this line item |
| ITEM_NAME |
|
VARCHAR |
128 |
The name for the item, used to display in the commerce engine, receipts, etc. |
| ITEM_LONG_DESCRIPTION |
|
VARCHAR |
128 |
The long description for the item, used to display in the commerce engine, receipts, etc. |
| ADDITIONAL_CLASSIFIERS |
|
VARCHAR |
2048 |
Additional classifiers for an item, use for applying promotions |
| ADDITIONAL_ATTRIBUTES |
|
VARCHAR |
1024 |
Additional attributes for an item, use for applying promotions |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates how the item should be authorized during tendering. |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The serial number of this item, if promptForSerialNumber is true and it was entered |
| ORDER_LINE_NUMBER |
|
INTEGER |
|
|
| ORDER_ID |
|
VARCHAR |
128 |
|
| CART_LINE_ITEM_UUID |
|
VARCHAR |
128 |
|
| LINE_ITEM_TYPE |
|
VARCHAR |
128 |
|
| INQUIRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| RELATED_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| EXTERNAL_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_LINE_ITEM_PRICE_MOD (RetailLineItemPriceModifierModel)
A price modification to a retail line item.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| MOD_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A unique identifier for the retail line item price modifier. |
| USERNAME |
|
VARCHAR |
128 |
The user name of the operator that allowed the price modifier. From USR_USER.USERNAME. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code for the price modification. From CTX_REASON_CODE.REASON_CODE_ID. |
| DESCRIPTION |
|
VARCHAR |
128 |
|
| MOD_BY_PERCENTAGE |
|
DECIMAL |
12,3 |
The percent amount of the price modification if the price was modified by percent. |
| MOD_BY_AMOUNT |
|
DECIMAL |
12,3 |
The unit amount of the price modification. |
| MODIFICATION_TOTAL |
|
DECIMAL |
12,3 |
The total amount for this price modification to modify the price of the line item by with quantity accounted |
| CALC_METHOD |
|
VARCHAR |
128 |
The method of price modification. Either PERCENTAGE, AMOUNT, OVERRIDE, or OTHER. |
| PROMOTION_ID |
|
VARCHAR |
128 |
The promotion identifier of the promotion that caused the price modification (if any.) From PRM_PROMOTION.PROMOTION_ID |
| PROMOTION_TYPE |
|
VARCHAR |
128 |
The promotion type of the promotion that caused the price modification. From PRN_PROMOTION.PROMOTION_TYPE |
| PROMOTION_REWARD_QUANTITY |
|
DECIMAL |
12,3 |
The number of items that could be rewarded for one qualification of the promotion corresponding to the promotionId |
| PROMO_CODE_ID |
|
VARCHAR |
128 |
The identifier for the promo code that triggered the promotion (if promotion is due to a promo code). |
| APPLIED_COUPON_ITEM_IDS |
|
VARCHAR |
128 |
The item ids of the coupon(s) that qualified this price modification (if any). If more than one, appended to string and delimited with commas |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which this price modification was transacted. |
| PRICE_MOD_TYPE_CODE |
|
VARCHAR |
128 |
The type of price modifier. Either ITEM or TRANS |
| PRICE_MOD_SOURCE_TYPE_CODE |
|
VARCHAR |
128 |
The source of the price modification. Either MANUAL, APR, COUPON, or TENDER_COUPON |
| PRICE_MOD_SOURCE_SUB_TYPE_CODE |
|
VARCHAR |
128 |
An additional detail to the source of the price modification. eg. LOYALTY |
| REWARD_BASE_PRICE_TYPE_CODE |
|
VARCHAR |
128 |
|
| REF_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
Generic line item reference. Can be used as a reference to tender line item if the mod source type is TENDER_COUPON, for example |
| VENDOR_FUNDED_FLAG |
|
OTHER |
|
Indicates whether or not this line was the result of a vendor funded discount. |
| QUANTITY_INDEX |
|
INTEGER |
|
Identifies which unit on a line item the price modifier is applied to |
| RTN_DEVICE_ID |
|
VARCHAR |
128 |
The device the return transaction was initiated on |
| RTN_BUSINESS_DATE |
|
VARCHAR |
128 |
The business date of the return transaction that the price modifier was applied to |
| RTN_SEQUENCE_NUMBER |
|
BIGINT |
|
Identifies which return transaction (if any) the price modifier was applied to |
| RETURNED_FLAG |
|
OTHER |
|
Identifies whether the unit associated with the line has been returned |
| EXTERNAL_ID |
|
VARCHAR |
128 |
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
An association between two line items in either the same or a different transaction
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| RELATED_DEVICE_ID |
X |
VARCHAR |
128 |
|
| RELATED_BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| RELATED_SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| RELATED_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| RELATED_ITEM_TYPE_CODE |
|
VARCHAR |
128 |
|
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_TRANS (RetailTransModel)
Represents a retail transaction. This is the header record for the transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| CUSTOMER_ID |
|
VARCHAR |
128 |
|
| SELLING_CHANNEL_CODE |
|
VARCHAR |
128 |
The channel under which this transaction was created (STORE, WEB, KIOSK or OTHER). |
| LOYALTY_CARD_NUMBER |
|
VARCHAR |
128 |
|
| TAX_EXEMPT_CUSTOMER_ID |
|
VARCHAR |
128 |
The Id of the tax exempt customer if this transaction was designated as tax exempt. Id from CUST_CUSTOMER.ID |
| TAX_EXEMPT_CERTIFICATE |
|
VARCHAR |
128 |
The tax exempt identifier |
| TAX_EXEMPT_CODE |
|
VARCHAR |
128 |
The 2 digit reason code associated to the exemption type description |
| EMPLOYEE_ID_FOR_DISCOUNT |
|
VARCHAR |
128 |
The employee Id entered to apply an employee discount |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the transaction was tendered. |
| LINE_ITEM_COUNT |
|
INTEGER |
|
The number of line items that were created as part of this transaction (SLS_RETAIL_LINE_ITEM). |
| AGE_RESTRICTED_DATE_OF_BIRTH |
|
TIMESTAMP |
|
Preserve the date of birth of a customer for age restricted items |
| ITEM_COUNT |
|
INTEGER |
|
The number of items in the transaction as displayed on the receipt |
| CUSTOMER_NAME |
|
VARCHAR |
128 |
The full name of the customer, if a customer is attached to the transaction. |
| TENDER_TYPE_CODES |
|
VARCHAR |
128 |
A space delimited list of the TenderTypeCodes used when tendering this transaction. |
| VOIDABLE_FLAG |
|
OTHER |
|
Whether or not this transaction is voidable. |
| TAX_GEO_CODE_ORIGIN |
|
VARCHAR |
128 |
The type of geo code used for establishing the transaction tax rates. The value is used for determining if taxes are based on an initial device location or business unit postal code. The values here should be one of the values defined in the GeoCodeOrigin class. |
| TOTAL |
|
DECIMAL |
12,3 |
The final, total amount (in the transacted currency) of the transaction. |
| PRE_TENDER_BALANCE_DUE |
|
DECIMAL |
12,3 |
The amount due as presented to the user before any tenders (except possibly post-tax coupon tenders) were applied to the transaction. |
| EXTENDED_SUBTOTAL |
|
DECIMAL |
12,3 |
The pre-discount subtotal amount (total - tax + totalDiscount) of the transaction. |
| SUBTOTAL |
|
DECIMAL |
12,3 |
The subtotal amount (total - taxTotal) of the transaction. |
| TAX_TOTAL |
|
DECIMAL |
12,3 |
The final, total tax amount of the transaction. |
| TAX_TOTAL_FOR_DISPLAY |
|
DECIMAL |
12,3 |
The amount of tax that should be displayed to the end user. This is useful for accessing the tax amount which is already incorporated into item prices (for example, in stores that use VAT). |
| DISCOUNT_TOTAL |
|
DECIMAL |
12,3 |
The final, total discount amount of the transaction. Includes all temporary discounts and advanced pricing rules. Does not include any tender based discounts. |
| RCPT_RTN_TOTAL |
|
DECIMAL |
12,3 |
The final, total amount of receipted returns for the transaction. Receipted return amount includes any return item that has been validated and tied to an original transaction. Does not include any returned tax amounts. |
| NON_RCPT_RTN_TOTAL |
|
DECIMAL |
12,3 |
The final, total amount of non-receipted returns for the transaction. Non-receipted return amount includes any return item that cannot be validated and tied to an original transaction. Does not include any returned tax amounts. |
| CUSTOMER_ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
The method of entry for customer identification for the transaction (SCANNED, KEYED, ALT_ID or OTHER). |
| CUST_OTHER_ID |
|
VARCHAR |
128 |
|
| RCPT_RTN_COUNT |
|
INTEGER |
|
If this transaction is a return transacion, the count of items that were returned via a receipted (verified) return. |
| NON_RCPT_RTN_COUNT |
|
INTEGER |
|
If this transaction is a return transaction, the count of items that were returned via a non-recipted (unverified) return. |
| RING_ELAPSED_TIME_IN_SECS |
|
INTEGER |
|
The amount of time in seconds it took for the entire transaction to be completed. |
| TENDER_ELAPSED_TIME_IN_SECS |
|
INTEGER |
|
The amount of time in seconds it took for the tender portion of transaction to be completed. |
| IDLE_ELAPSED_TIME_IN_SECS |
|
INTEGER |
|
The amount of time in seconds the register was idle during the transaction. |
| LOCK_ELAPSED_TIME_IN_SECS |
|
INTEGER |
|
The amount of time in seconds the register was locked during the transaction. |
| ENTRY_MODE_CODE |
|
VARCHAR |
128 |
The mode of entry for this transaction (NORMAL, MANAGER, MAINTENANCE). |
| SUSPENDED_REASON_CODE |
|
VARCHAR |
128 |
The reason selected by the operator for suspending a transaction. Valid codes from CTX_REASON_CODE.REASON_CODE_GROUP_ID='SuspendTransaction'. |
| SUSPENDED_NOTE |
|
VARCHAR |
128 |
An additional note that can be entered for suspended transaction in order to aid lookup of that transaction. |
| ORDER_ID |
|
VARCHAR |
128 |
If an order is shipped it can be integrated back into the point of sale with the order id at the transaction header level for lookup and return purposes |
| PARENT_ORDER_ID |
|
VARCHAR |
128 |
A unique string key value used to tie together multiple orders for a transaction. All orders for a given transaction have the same parentOrderId. |
| LOYALTY_POINTS_EARNED |
|
DECIMAL |
12,3 |
A place to record loyalty points earned (tentative or real) as part of this sale |
| CUSTOMER_CALLOUT |
|
VARCHAR |
128 |
A shorthand identifier for a customer on a transaction. Mainly used to help navigate multiple suspended transactions where customers may interact with multiple devices before finally checking out. |
| GIFT_RECEIPT_PRINT_TYPE |
|
VARCHAR |
128 |
Gift receipt printing mode. |
| ADDITIONAL_ATTRIBUTES |
|
VARCHAR |
1024 |
Additional attributes for a transaction, use for applying promotions |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_TRANS_PRICE_MOD (RetailTransPriceModifierModel)
A price modification to the transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| MOD_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A unique identifier for the retail trans price modifier. |
| USERNAME |
|
VARCHAR |
128 |
The user name of the operator that allowed the price modifier. From USR_USER.USERNAME. |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code for the price modification. From CTX_REASON_CODE.REASON_CODE_ID. |
| MOD_BY_PERCENTAGE |
|
DECIMAL |
12,3 |
The percent amount of the price modification if the price was modified by percent. |
| MOD_BY_AMOUNT |
|
DECIMAL |
12,3 |
The amount of the price modification if the price was modified by amount. |
| ROUNDING_AMOUNT |
|
DECIMAL |
12,3 |
The rounding amount of the price modification. |
| CALC_METHOD |
|
VARCHAR |
128 |
The method of price modification. Either PERCENTAGE, AMOUNT, OVERRIDE, or OTHER. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which this price modification was transacted. |
| PRICE_MOD_TYPE_CODE |
|
VARCHAR |
128 |
The type of price modifier. Either ITEM or TRANS |
| PRICE_MOD_SOURCE_TYPE_CODE |
|
VARCHAR |
128 |
The source of the price modification. Either MANUAL or APR |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETAIL_TRANS_TOTALS (RetailTransTotalsModel)
Stores the totals for the transaction, organized by tender group
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
The unique identifier of the device. |
| BUSINESS_DATE |
X |
VARCHAR |
10 |
The store business date when the transaction was created. |
| SEQUENCE_NUMBER |
X |
BIGINT |
|
A unique sequence number of the transaction for the device and business date. |
| TENDER_GROUP |
X |
VARCHAR |
128 |
The name for the group of items within the transaction, and which were tendered together, that these totals belong to. |
| TOTAL |
|
DECIMAL |
12,3 |
The final, total amount (in the transacted currency) of the transaction. |
| PRE_TENDER_BALANCE_DUE |
|
DECIMAL |
12,3 |
The amount due as presented to the user before any tenders (except possibly post-tax coupon tenders) were applied to the transaction. |
| EXTENDED_SUBTOTAL |
|
DECIMAL |
12,3 |
The pre-discount subtotal amount (total - tax + totalDiscount) of the transaction. |
| SUBTOTAL |
|
DECIMAL |
12,3 |
The subtotal amount (total - taxTotal) of the transaction. |
| TAX_TOTAL |
|
DECIMAL |
12,3 |
The final, total tax amount of the transaction. |
| TAX_TOTAL_FOR_DISPLAY |
|
DECIMAL |
12,3 |
The amount of tax that should be displayed to the end user. This is useful for accessing the tax amount which is already incorporated into item prices (for example, in stores that use VAT). |
| DISCOUNT_TOTAL |
|
DECIMAL |
12,3 |
The final, total discount amount of the transaction. Includes all temporary discounts and advanced pricing rules. Does not include any tender based discounts. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the transaction was tendered. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RTN_EVENT_LINE_ITEM (ReturnEventLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| RTN_EVENT_TYPE_CODE |
|
VARCHAR |
128 |
|
| RTN_REJECTION_CODE |
|
VARCHAR |
128 |
|
| POS_ITEM_ID |
|
VARCHAR |
128 |
|
| ITEM_ID |
|
VARCHAR |
128 |
|
| ENTRY_MODE_CODE |
|
VARCHAR |
128 |
|
| ORIG_LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
If this line item is for the return of an item, the litem item of the original transaction. |
| ORIG_SEQUENCE_NUMBER |
|
BIGINT |
|
If this line item is for the return of an item, the sequence number of the original transaction. |
| ORIG_BUSINESS_DATE |
|
VARCHAR |
128 |
If this line item is for the return of an item, the business date of the original transaction. |
| ORIG_DEVICE_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the device on which the original transaction was sold. |
| ORIG_ORDER_ID |
|
VARCHAR |
128 |
|
| RTN_POLICY_ID |
|
VARCHAR |
128 |
If this line item is for the return of an item, the return policy that was used during the return process. From SLS_RTN_POLICY.RETURN_POLICY_ID. |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RTN_POLICY_MATCH (ReturnPolicyMatchModel)
Return policy matching criteria to use. Evaluate in priority order matching on item group
| Column Name |
PK |
Type |
Size |
Description |
| POLICY_MATCH_ID |
X |
VARCHAR |
128 |
A unique identifier for the returns policy match rule. |
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| POLICY_MATCH_NAME |
|
VARCHAR |
128 |
A name for the return policy match rule. |
| DESCRIPTION |
|
VARCHAR |
255 |
A description for the return policy match rule. |
| PRIORITY |
|
INTEGER |
|
A numerical order (sorted lowest to highest) in which the match rules should be applied to the return policy. |
| RETURN_POLICY_ID |
|
VARCHAR |
128 |
The return policy to use if a match is made |
| RECEIPT_PRESENT |
|
OTHER |
|
If set and the receipt is present, consider the policy a match |
| GC_CASHOUT_PRESENT |
|
OTHER |
|
If set and a gift card cashout is present, consider the policy a match |
| ORDER_PRESENT |
|
OTHER |
|
If set and the item(s) are an order, consider the policy a match. A null value means the policy will match regardless of whether an order is present. |
| ALLOWED_FOR_EMPLOYEES |
|
OTHER |
|
If false, the policy will not match when an employee is linked to the transaction via employee discount. |
| NUMBER_OF_DAYS |
|
INTEGER |
|
If the return is in the number of days window, consider the policy a match |
| NUMBER_OF_DAYS_DEFN |
|
VARCHAR |
128 |
Defines which date (purchase date, delivery date, effective date, etc.) should be used as the start date for numberOfDays. |
| RETURN_BY_TIME |
|
TIMESTAMP |
|
The date an item needs to be returned by in order for this policy to apply. This parameter can be used in lieu of numberofDays and numberOfDaysDefn |
| PURCHASE_START_TIME |
|
TIMESTAMP |
|
If the policy should be selected based on a purchase date/time, this field should be populated with the beginning purchase time for this policy. |
| PURCHASE_END_TIME |
|
TIMESTAMP |
|
If the policy should be selected based on a purchase date/time, this field should be populated with the ending purchase time for this policy. |
| ITEM_GROUP_ID |
|
VARCHAR |
128 |
Match on an item group. If the value is NULL then the policy applies to all item groups |
| CUSTOMER_GROUP_ID |
|
VARCHAR |
128 |
Match on a specific customer group. If the value is NULL then the policy applies to all customer groups. |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RTN_POLICY (ReturnPolicyModel)
A table that defines return policies for the organization.
| Column Name |
PK |
Type |
Size |
Description |
| RETURN_POLICY_ID |
X |
VARCHAR |
128 |
A unique identifier for the return policy. |
| RETURN_POLICY_NAME |
|
VARCHAR |
128 |
The name for the return policy. |
| DESCRIPTION |
|
VARCHAR |
255 |
The description for the return policy. |
| REQUIRES_ADDITIONAL_INFO |
|
OTHER |
|
A flag (1 or 0) denoting whether the policy requires capturing additional customer information. |
| EXCHANGE_ONLY |
|
OTHER |
|
A flag (1 or 0) denoting whether the policy only allows exchanges. |
| ORIGINAL_TENDER_TYPE_ONLY |
|
OTHER |
|
A flag (1 or 0) denoting whether the policy only allows returns to the original tender type. |
| EXCHANGE_MERCHANDISE_LEVEL |
|
VARCHAR |
128 |
The level of merchandise that can be used for the exchange. Can be either PRODUCT or ITEM. |
| PERMISSION_ID |
|
VARCHAR |
128 |
The required permission that the cashier must have in order to fullfil the return of an item. From USR_PERMISSION.PERMISSION_ID |
| RCPT_RTN_TRANS_COUNT_LIMIT |
|
INTEGER |
|
The number of receipted return transactions allowed for a given customer during the transHistRefInDays period. |
| NON_RCPT_RTN_TRANS_COUNT_LIMIT |
|
INTEGER |
|
The number of non-receipted return transactions allowed for a given customer during the transHistRefInDays period. |
| RCPT_RTN_ITEM_COUNT_LIMIT |
|
INTEGER |
|
The number of receipted return items allowed for a given customer during the transHistRefInDays period. |
| NON_RCPT_RTN_ITEM_COUNT_LIMIT |
|
INTEGER |
|
The number of non-receipted return items allowed for a given customer during the transHistRefInDays period. |
| RCPT_RTN_RATIO_LIMIT |
|
DECIMAL |
12,3 |
A ratio applied to receipted returns calculations that will override receipted returns limits. I.E. If .50, then if the customer sales history during transHistRefInDays has greater than 50% of items not returned, then the customer will continue to be allowed to return, regardless of the number of transactions or items returned. |
| NON_RCPT_RTN_RATIO_LIMIT |
|
DECIMAL |
12,3 |
A ratio applied to non-receipted returns calculations that will override receipted returns limits. I.E. If .50, then if the customer sales history during transHistRefInDays has greater than 50% of items not returned, then the customer will continue to be allowed to return, regardless of the number of transactions or items returned. |
| TRANS_HIST_REF_IN_DAYS |
|
INTEGER |
|
The number of days to look at customer history in order to determine returns rules and limits. |
| OVERRIDE_ALLOWED |
|
OTHER |
|
A flag (1 or 0) that denotes whether this return policy is overridable by a manger level. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_RETURN_TENDER (ReturnTenderModel)
Amount remaining for return on each stored value return tender
| Column Name |
PK |
Type |
Size |
Description |
| SESSION_IDENTIFIER |
X |
VARCHAR |
2048 |
|
| AMOUNT_TENDERED |
|
DECIMAL |
12,3 |
|
| AMOUNT_REMAINING |
|
DECIMAL |
12,3 |
|
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_SIM_GIFT_CARD_BALANCE (SimulatedGiftCardBalanceModel)
| Column Name |
PK |
Type |
Size |
Description |
| GIFT_CARD_NUMBER |
X |
VARCHAR |
128 |
|
| GIFT_CARD_BALANCE |
|
DECIMAL |
12,3 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TAX_GROUP_LINE_ITEM (TaxGroupLineItemModel)
Tax information for a tax group for the transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| AUTHORITY_ID |
|
VARCHAR |
128 |
The authority under which the tax was collected. From TAX_AUTHORITY.ID. |
| AUTHORITY_TYPE |
|
VARCHAR |
128 |
The authority type which the tax was collected. From TAX_AUTHORITY.AUTH_TYPE_NAME |
| GROUP_ID |
|
VARCHAR |
128 |
The tax group under which the tax was collected. From TAX_GROUP.ID |
| TAX_TYPE |
|
VARCHAR |
128 |
The tax type under which the tax was collected. From TAX_GROUP.TAX_TYPE |
| RULE_NAME |
|
VARCHAR |
128 |
The name of the rule under which the tax was collected. From TAX_GROUP_RULE.RULE_NAME |
| RULE_DESCRIPTION |
|
VARCHAR |
128 |
The description of the rule under which the tax was collected. From TAX_GROUP_RULE.DESCRIPTION |
| TAX_PERCENTAGE |
|
DECIMAL |
12,3 |
The tax percentage applied to items in the transation for this tax group. |
| TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total amount of tax collected for this tax group. |
| MONEY_TAX_AMOUNT |
|
DECIMAL |
12,3 |
The total Money tax amount of tax collected for this tax group where the value of this field is sum of the item's Money taxAmounts |
| TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
The total amount of the items tax was collected for under this tax group. |
| RETURN_TAX_FLAG |
|
OTHER |
|
Whether the tax group line is for a return tax |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the tax was collected. |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
Indicates whether the tax applied to this line is already included in its taxable amount |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TAX_RETAIL_LINE_ITEM (TaxRetailLineItemModel)
Tax information applied to items in the transaction for a given tax authority.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| TAX_LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A unique identifier for the tax line item. |
| AUTHORITY_ID |
|
VARCHAR |
128 |
The tax authority under which the tax was collected. |
| AUTHORITY_TYPE |
|
VARCHAR |
128 |
The tax authority type under which the tax was collected. From TAX_AUTHORITY.AUTH_TYPE_NAME |
| GROUP_ID |
|
VARCHAR |
128 |
The tax group applied to calculate the tax. From TAX_GROUP.GROUP_ID. |
| RULE_NAME |
|
VARCHAR |
128 |
The name of the tax rule applied to calculate the tax. |
| RULE_DESCRIPTION |
|
VARCHAR |
128 |
The description of the tax rule applied to calculate the tax. |
| TAX_TYPE |
|
VARCHAR |
128 |
The tax type under which the tax was collected. From TAX_GROUP.TAX_TYPE |
| TAX_HOLIDAY_INDICATOR |
|
OTHER |
|
An indicator that this was a tax holiday. |
| RATE_RULE_SEQUENCE_NUMBER |
|
INTEGER |
|
The tax rate rule sequence number applied to calculate the tax. From TAX_RATE_RULE.RATE_RULE_SEQUENCE_NUMBER. |
| OVERRIDE_APPLIED |
|
OTHER |
|
A flag (1 or 0) denoting whether tax was overridden on the transaction. |
| TAX_EXEMPT_ID |
|
VARCHAR |
128 |
The tax exempt identifier provided, if the the customer was a tax exempt organization. |
| TAX_EXEMPT |
|
OTHER |
|
A flag (1 or 0) denoting whether the transaction was tax exempt. |
| TAX_EXEMPT_AMOUNT |
|
DECIMAL |
12,3 |
The amount of the transaction that was deemed exempt from taxes. |
| OVERRIDE_PERCENT |
|
DECIMAL |
12,3 |
If tax was overridden by a percentage, then the percentage by which the was overridden. |
| OVERRIDE_AMOUNT |
|
DECIMAL |
12,3 |
if tax was overridden by an amount, then the amount by which the tax was overridden. |
| OVERRIDE_REASON_CODE |
|
VARCHAR |
128 |
If the tax was overridden, then the reason code entered by the operator for the tax override. From CTX_REASON_CODE.REASON_CODE_ID. |
| TAX_PERCENTAGE |
|
DECIMAL |
12,4 |
The resulting tax percentage applied to the transaction. |
| TAX_AMOUNT |
|
DECIMAL |
12,4 |
The amount of tax collected for the authority. |
| MONEY_TAX_AMOUNT |
|
DECIMAL |
12,3 |
The Money amount of tax collected for the authority |
| TAXABLE_AMOUNT |
|
DECIMAL |
12,3 |
The taxable amount of the transaction basket. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the tax was collected. |
| CALCULATION_METHOD |
|
VARCHAR |
128 |
The algorithm by which this tax amount was calculated. From TAX_RATE_RULE.TYPE_CODE |
| CALCULATION_SOURCE |
|
VARCHAR |
128 |
Tracks what tax calculation engine was used to compute this. Normally JMC |
| TAX_INCLUDED_IN_PRICE |
|
OTHER |
|
Indicates whether the tax applied to this line is already included in its taxable amount |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_ADJUSTMENT_CONFIG (TenderAdjustmentConfigModel)
| Column Name |
PK |
Type |
Size |
Description |
| SOURCE_TENDER_CODE |
X |
VARCHAR |
128 |
The tender code of the tender from which the adjustment originates (see sls_tender). In an adjustment, this tender will be decremented. |
| REASON_CODE_GROUP_ID |
X |
VARCHAR |
128 |
The reason code group id from ctx_reason_code which is part of the key value to identify the reason code associated with an adjustment to a particular target tender type. |
| REASON_CODE_ID |
X |
VARCHAR |
128 |
The reason code id from ctx_reason_code which is part of the key value to identify the reason code associated with an adjustment to a particular target tender type. |
| TARGET_TENDER_CODE |
|
VARCHAR |
128 |
The tender code of the tender which will receive the adjustment. In an adjustment, this tender will be incremented. |
| EFFECTIVE_VERSION |
|
INTEGER |
|
Software Version at which this data should become available |
| EFFECTIVE_END_VERSION |
|
INTEGER |
|
Software Version at which any version after this data will expire and not become |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_BIN_RANGE (TenderBinRangeModel)
Provides a range for the bin numbers of specific tender types.
| Column Name |
PK |
Type |
Size |
Description |
| IDENTIFIER |
X |
INTEGER |
|
The arbitrary primary key to allow for multiple bin ranges under one tender type. |
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the tender |
| BIN_START |
|
VARCHAR |
128 |
The start of the acceptable bin range |
| BIN_END |
|
VARCHAR |
128 |
The end of the acceptable bin range |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_CONTROL_TRANS (TenderControlTransModel)
Represents a tender control transaction such as pay in, pay out, currency exchange, loans, etc.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| REASON_CODE |
|
VARCHAR |
128 |
The reason code for the tender control transaction |
| PAID_TO |
|
VARCHAR |
128 |
Who the amount was paid to |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The currency code under which the transaction was tendered. |
| STORE_BANK_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_FINANCING_I18N (TenderFinancingI18NModel)
Tender Financing Customer Description's i18n replacements
| Column Name |
PK |
Type |
Size |
Description |
| TENDER_FINANCE_ID |
X |
VARCHAR |
128 |
A unique id that represents the tender financing option |
| TENDER_CODE |
X |
VARCHAR |
128 |
Unique code that identifies the tender used |
| LOCALE |
X |
VARCHAR |
128 |
|
| CUSTOMER_DESCRIPTION |
|
VARCHAR |
128 |
A description of the financing option that is presented to the customer |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_FINANCING (TenderFinancingModel)
| Column Name |
PK |
Type |
Size |
Description |
| TENDER_FINANCE_ID |
X |
VARCHAR |
128 |
A unique id that represents the tender financing option |
| TENDER_CODE |
X |
VARCHAR |
128 |
Unique code that identifies the tender used |
| DESCRIPTION |
|
VARCHAR |
128 |
A summary of the financing option |
| CUSTOMER_DESCRIPTION |
|
VARCHAR |
128 |
A description of the financing option that is presented to the customer |
| THRESHOLD |
|
DECIMAL |
12,3 |
The minimum threshold for the financing option |
| RECEIPT_DISCLOSURE |
|
VARCHAR |
2048 |
The text that is printed on the receipt or chit |
| MONTHS |
|
INTEGER |
|
Number of months in the financing plan |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_LINE_ITEM (TenderLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| TENDER_CODE |
|
VARCHAR |
128 |
Unique code that identifies the tender used |
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the tender |
| CHANGE_FLAG |
|
OTHER |
|
Indicates whether or not this line item represents change issued back to the customer |
| CUSTOMER_ACCOUNT_NUMBER |
|
VARCHAR |
128 |
Future use. |
| TENDER_ACCOUNT_NUMBER |
|
VARCHAR |
128 |
Future use. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
The ISO code of the store's local currency, regardless of the currency of the tender submitted by the customer |
| TENDER_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the tender submitted by the customer |
| CASH_BACK_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the tender returned to the customer |
| ISO_FOREIGN_CURRENCY_CODE |
|
VARCHAR |
128 |
If the customer used foreign currency, this is the currency code for the tender submitted |
| FOREIGN_CURRENCY_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoForeignCurrencyCode) of the tender submitted by the customer |
| EXCHANGE_RATE |
|
DECIMAL |
12,3 |
If the customer used foreign currency, this is the exchange rate that the system used to convert the given foreignCurrencyAmount into the tenderAmount |
| OVERTENDERED |
|
OTHER |
|
Whether or not this was an overtendered tender in the transaction |
| PARTIALLY_APPROVED |
|
OTHER |
|
Whether or not this tender amount was a partially approved amount of the original requested amount |
| TENDER_FINANCE_ID |
|
VARCHAR |
128 |
The tenderFinanceId of the selected TenderFinancingModel (if applicable) |
| TENDER_AUTH_METHOD_CODE |
|
VARCHAR |
128 |
Indicates when the authorization for this tender line was or will be done. |
| TENDER_GROUP |
|
VARCHAR |
128 |
Indicates the tender group for this line item. All items with the same tender group will be tendered together upon checkout. See openpos.tender.tenderGroups.groups for the defined tender groups. |
| CERTIFICATE_NUMBER |
|
VARCHAR |
128 |
The number associate with a generic certificate (i.e. a Mall Certificate) |
| VOUCHER_ID |
|
VARCHAR |
128 |
The number associated with a single use, redeemable voucher |
| LOYALTY_POINTS_REDEEMED |
|
DECIMAL |
12,3 |
The amount of loyalty points redeemed |
| POST_VOID |
|
OTHER |
|
A flag that indicates that this void auth was part of a post void (versus partial void) |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER (TenderModel)
| Column Name |
PK |
Type |
Size |
Description |
| TENDER_CODE |
X |
VARCHAR |
128 |
Unique code to identify this tender, typically a combination of tenderTypeCode, isoCurrencyCode, and/or a card brand |
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the tender |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
Currency code for this tender and used to define the currency of its associated amount attributes. If the tender can represent multiple tenders then use an asterisk for the code |
| DESCRIPTION |
|
VARCHAR |
128 |
Description for this tender |
| CASH_DRAWER_OPEN_REQUIRED |
|
OTHER |
|
Whether or not opening of the cash drawer is required for this tender |
| TILL_UNIT_COUNT_REQUIRED |
|
OTHER |
|
Whether or not units/denominations of this tender must be counted |
| TILL_AMOUNT_COUNT_REQUIRED |
|
OTHER |
|
Whether or not the total amount of this tender must be counted |
| RETURN_TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The preferred tender type code when returning this tender |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_POLICY (TenderPolicyModel)
A table that represents what tenders are allowed for a given type of transaction. This can also link to a specific button model that is used to represent the tender at checkout.
| Column Name |
PK |
Type |
Size |
Description |
| TENDER_POLICY_ID |
X |
VARCHAR |
128 |
A unique string identifier for the tender policy |
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The tender type code for the tender policy |
| TENDER_CODE |
|
VARCHAR |
128 |
Unique code to identify this tender |
| TENDER_OPERATION |
|
VARCHAR |
128 |
The operation for the tender policy (e.g. SALE, RETURN, ZERO_BALANCE, or CHANGE_DUE) |
| MIN_TENDER_AMOUNT |
|
DECIMAL |
12,3 |
The minimum amount that can be accepted for this tender and operation |
| MAX_TENDER_AMOUNT |
|
DECIMAL |
12,3 |
The maximum amount that can be accepted for this tender and operation |
| OVER_TENDER_ALLOWED |
|
OTHER |
|
Whether or not this tender require supports overpayment from the customer |
| DEFAULT_TO_AMOUNT_DUE |
|
OTHER |
|
Whether or not to default the tender amount to the amount due |
| PAYMENT_SERVICE_REQUIRED |
|
OTHER |
|
Whether or not the payment service is required to process this tender |
| AUTO_FOCUS_ENABLED |
|
OTHER |
|
Whether or not the tender amount is auto focused for editing |
| BUTTON_GROUP_ID |
|
VARCHAR |
128 |
The button group id associated with this tender type |
| BUTTON_ID |
|
VARCHAR |
128 |
The button id associated with this tender type |
| PAYMENT_BRAND |
|
VARCHAR |
128 |
The brand of the payment/provider of this Tender Policy (e.g. 'WeChat' as supported by Adyen) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_RTN_POLICY (TenderReturnPolicyModel)
A table that defines tender return policies for the organization.
| Column Name |
PK |
Type |
Size |
Description |
| TENDER_TYPE_CODE |
X |
VARCHAR |
128 |
The classification for the tender |
| RETURN_POLICY_ID |
X |
VARCHAR |
128 |
A unique identifier for the return policy. |
| PERMISSION_ID |
|
VARCHAR |
128 |
e.g. sell.apply.discount OR sell.* |
| REQUIRE_PERMISSION_THRESHOLD |
|
DECIMAL |
12,3 |
The maximum allowed amount before permission is required |
| BLOCK_OVER_TENDER |
|
OTHER |
|
Should tender amount be limited to original tender amount |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_SETTLEMENT_LINE_ITM (TenderSettlementLineItemModel)
Represents line items of a tender settlement transaction.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| SESSION_ID |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
|
| STORE_BANK_ID |
|
VARCHAR |
128 |
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TENDER_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the tender |
| TENDER_CODE |
|
VARCHAR |
128 |
|
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
Currency code for this tender control line item and used to define the currency of its associated amount attributes |
| OPEN_SESSION_AMOUNT |
|
DECIMAL |
12,3 |
The opening tender balance for the tender type in the till or store safe for a given session which is the time period bounded by two tender settlement transactions (OPEN, RECONCILE). |
| CLOSE_SESSION_AMOUNT |
|
DECIMAL |
12,3 |
The closing tender balance for the tender type in the till or store safe for a given session which is the time period bounded by two tender settlement transactions (OPEN, RECONCILE). The closing balance represents the system's total. |
| COUNTED_SESSION_AMOUNT |
|
DECIMAL |
12,3 |
The counted tender balance for the tender type in the till or store safe for a given session which is a time period bounded by two tender settlement transactions (OPEN, RECONCILE). This represents the manually counted amount that is compared to the system's closing amount to determine over/under balance. |
| OVER_UNDER_SESSION_AMOUNT |
|
DECIMAL |
12,3 |
The difference between the counted session amount and closing session amount calculated by subtracting the closing from the counted. A negative amount means an UNDER variance and a positive amount means an OVER variance |
| OPEN_MEDIA_QUANTITY |
|
INTEGER |
|
The opening quantity of the tender type in the till or store safe for a given session which is the time period bounded by two tender settlement transactions (OPEN, RECONCILE). |
| CLOSE_MEDIA_QUANTITY |
|
INTEGER |
|
The closing quantity of the tender type in the till or store safe for a given session which is the time period bounded by two tender settlement transactions (OPEN, RECONCILE). The closing media quantity represents the system's expected quantity. |
| COUNTED_MEDIA_QUANTITY |
|
INTEGER |
|
The counted quantity of the tender type in the till or store safe for a given session which is the time period bounded by two tender settlement transactions (OPEN, RECONCILE). This represents the manually counted quantity that is compared to the system's closing quantity. |
| OVER_UNDER_MEDIA_QUANTITY |
|
INTEGER |
|
The difference between the counted media quantity and closing media quantity calculated by subtracting the closing from the counted. A negative quantity means an UNDER variance and a positive over under quantity means an OVER variance. |
| FROM_REPOSITORY |
|
VARCHAR |
128 |
The repository in which the pickup amount is being moved from |
| TO_REPOSITORY |
|
VARCHAR |
128 |
The repository in which the pickup amount is being moved to |
| PICKUP_AMOUNT |
|
DECIMAL |
12,3 |
The amount of tender picked up from the fromRepository and moved to the toRepository during this session which is the time period bounded by two tender settlement transactions |
| REASON_CODE |
|
VARCHAR |
128 |
The optional code that describes the reason for the settlement line item |
| DIFFERENCE_REASON |
|
VARCHAR |
1024 |
The optional comment that describes the reason for the settlement line item difference |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TENDER_SETTLEMENT_TRANS (TenderSettlementTransModel)
Represents a tender settlement transaction
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_AUDIT_CHECK_RESULT (TransAuditCheckResultModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| DEPLOYMENT_TIER |
X |
VARCHAR |
128 |
|
| CHECK_NAME |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| SUCCESS_FLAG |
|
OTHER |
|
|
| CHECK_RESULT |
|
VARCHAR |
2048 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_AUDIT (TransAuditModel)
| Column Name |
PK |
Type |
Size |
Description |
| TRANS_AUDIT_ID |
X |
VARCHAR |
128 |
|
| DEPLOYMENT_TIER |
|
VARCHAR |
128 |
|
| DEVICE_ID |
|
VARCHAR |
128 |
|
| BUSINESS_DATE |
|
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
|
BIGINT |
|
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| TRANS_TYPE |
|
VARCHAR |
128 |
|
| TRANS_STATUS |
|
VARCHAR |
128 |
|
| DML_TYPE |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_AUDIT_RESULT (TransAuditResultModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| DEPLOYMENT_TIER |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| SUCCESS_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_LOCATION (TransLocationModel)
Represents the location in which the transaction took place
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| POSTAL_CODE |
|
VARCHAR |
128 |
The postal code of the location in which the transaction takes place |
| COUNTRY |
|
VARCHAR |
128 |
The country in which the transaction takes place |
| LATITUDE |
|
VARCHAR |
128 |
Transaction location latitude |
| LONGITUDE |
|
VARCHAR |
128 |
Transaction location longitude |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_PUBLISH (TransPublishModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ORDER_ID |
X |
VARCHAR |
128 |
|
| TIMEZONE_OFFSET |
|
VARCHAR |
128 |
String for timezone correction |
| MESSAGE_TYPE_CODE |
|
VARCHAR |
128 |
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| APP_VERSION |
|
INTEGER |
|
|
| PAYLOAD |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_PUBLISH_STATUS (TransPublishStatusModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ORDER_ID |
X |
VARCHAR |
128 |
|
| PUBLISH_STATUS |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_QUEUE (TransQueueModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| PROCESS_NAME |
X |
VARCHAR |
128 |
Name of the process utilizing these transaction records. (RTLOG,...) |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| BATCH_ID |
|
VARCHAR |
128 |
A field that can be used to indicate what all rows were processed together |
| STATUS_CODE |
|
VARCHAR |
128 |
Process status of the transaction in the table. (NEW, IN_PROCESS, PROCESSED) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_QUEUE_PROCESSED (TransQueueProcessedModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| PROCESS_NAME |
X |
VARCHAR |
128 |
Name of the process utilizing these transaction records. (RTLOG,...) |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| BATCH_ID |
|
VARCHAR |
128 |
A field that can be used to indicate what all rows were processed together |
| STATUS_CODE |
|
VARCHAR |
128 |
Process status of the transaction in the table. (NEW, IN_PROCESS, PROCESSED) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_SUMMARY (TransSummaryModel)
Represents a summary of the transaction with the associated transaction key
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
The unique identifier of the device that the transaction was created on. |
| BUSINESS_DATE |
X |
VARCHAR |
10 |
The businessDate of the transaction |
| SEQUENCE_NUMBER |
X |
BIGINT |
|
The sequenceNumber of the transaction |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which the transaction was created. |
| DEVICE_TYPE |
|
VARCHAR |
128 |
The type of device that the transaction was created on |
| TRANS_TYPE_CODE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE, PAY_IN, PAY_OUT, CASH_UP). |
| TRANS_STATUS_CODE |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
The timezone offset in millis from UTC for the server which created the transaction. |
| CLIENT_OFFSET |
|
INTEGER |
|
The timezone offset from UTC in milliseconds of the client which created the transaction. |
| TRANSACTION_DURATION_IN_SEC |
|
BIGINT |
|
The duration of time in seconds that it took for the transaction to complete |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| CUSTOMER_ID |
|
VARCHAR |
128 |
The unique identifier of the customer, if a customer is attached to the transaction. |
| LOYALTY_CARD_NUMBER |
|
VARCHAR |
128 |
The loyalty card number(loyaltyId) of the customer, if a loyalty customer is attached to the transaction |
| CUSTOMER_NAME |
|
VARCHAR |
128 |
The full name of the customer, if a customer is attached to the transaction. |
| EMPLOYEE_ID_FOR_DISCOUNT |
|
VARCHAR |
128 |
The employee Id entered to apply an employee discount |
| VOIDABLE_FLAG |
|
OTHER |
|
Whether or not this transaction is voidable. |
| ITEM_COUNT |
|
INTEGER |
|
The number of items in the transaction as displayed on the receipt |
| RCPT_RTN_COUNT |
|
INTEGER |
|
If this transaction is a return transacion, the count of items that were returned via a receipted (verified) return. |
| NON_RCPT_RTN_COUNT |
|
INTEGER |
|
If this transaction is a return transaction, the count of items that were returned via a non-recipted (unverified) return. |
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
Currency code used to define the currency of its associated amount attributes |
| TOTAL |
|
DECIMAL |
12,3 |
The final, total amount (in the transacted currency) of the transaction. |
| PRE_TENDER_BALANCE_DUE |
|
DECIMAL |
12,3 |
The amount due as presented to the user before any tenders (except possibly post-tax coupon tenders) were applied to the transaction. |
| TAX_TOTAL |
|
DECIMAL |
12,3 |
The final, total tax amount of the transaction. |
| DISCOUNT_TOTAL |
|
DECIMAL |
12,3 |
The final, total discount amount of the transaction. Includes all temporary discounts and advanced pricing rules. Does not include any tender based discounts. |
| TENDER_TYPE_CODES |
|
VARCHAR |
128 |
A space delimited list of the TenderTypeCodes used when tendering the transaction. |
| TENDER1_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the first tender applied |
| TENDER1_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the first tender submitted by the customer |
| TENDER1_CARD_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the card type used for the first tender applied, if the first tender type was a card type (CC, GiftCard, etc) |
| TENDER1_MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
The masked card number for the first tender applied, if the first tender was a card type (CC, GiftCard, etc) |
| TENDER1_AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization of the first tender, if the first tender was a card type (CC, GiftCard, etc) |
| TENDER2_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the second tender applied, if a second tender was applied |
| TENDER2_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the second tender submitted by the customer, if more than one tender applied |
| TENDER2_CARD_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the card type used for the second tender applied, if a second tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER2_MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
The masked card number for the second tender applied, if a second tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER2_AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization of the second tender, if the second tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER3_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the third tender applied, if a third tender was applied |
| TENDER3_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the third tender submitted by the customer, if more than two tenders applied |
| TENDER3_CARD_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the card type used for the third tender applied, if a third tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER3_MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
The masked card number for the third tender applied, if a third tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER3_AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization of the third tender, if a third tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER4_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the fourth tender applied, if a fourth tender was applied |
| TENDER4_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the fourth tender submitted by the customer, if more than three tenders applied |
| TENDER4_CARD_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the card type used for the fourth tender applied, if a fourth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER4_MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
The masked card number for the fourth tender applied, if a fourth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER4_AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization of the third tender, if a fourth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER5_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the fifth tender applied, if a fifth tender was applied |
| TENDER5_AMOUNT |
|
DECIMAL |
12,3 |
The monetary value (in the isoCurrencyCode) of the fifth tender submitted by the customer, if more than four tenders applied |
| TENDER5_CARD_TYPE_CODE |
|
VARCHAR |
128 |
The classification for the card type used for the fifth tender applied, if a fifth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER5_MASKED_CARD_NUMBER |
|
VARCHAR |
128 |
The masked card number for the fifth tender applied, if a fifth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| TENDER5_AUTH_CODE |
|
VARCHAR |
128 |
Payment provider authorization code for the authorization of the fifth tender, if a fifth tender was applied and the tender type was a card type (CC, GiftCard, etc) |
| VOIDED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the original transaction that has been voided, if this transaction is a VOID trans type. |
| SUSPENDED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the original transaction that has been resumed. |
| SUSPENDED_DEVICE_ID |
|
VARCHAR |
128 |
The device id of which the suspended transaction occurred |
| RESUMED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the resumed transaction |
| RESUMED_DEVICE_ID |
|
VARCHAR |
128 |
The device id of which the resumed transaction occurred |
| REASON_CODE |
|
VARCHAR |
128 |
The reason code for the transaction, if this transaction requires a reason code such as a tender control transaction (CASH_UP, PAY_IN, PAY_OUT, etc.) or a post void transaction (VOID) |
| PAID_TO |
|
VARCHAR |
128 |
Who the amount was paid to in a tender control transaction |
| STORE_BANK_ID |
|
VARCHAR |
128 |
The identifier of the store bank associated with this business unit. |
| MFR_COUPONS_TOTAL |
|
DECIMAL |
12,3 |
The total value of all manufacturer GS1 coupons applied to the transaction |
| MFR_COUPONS_COUNT |
|
INTEGER |
|
The total count of all manufacturer GS1 coupons applied to the transaction |
| MFR_COUPONS_TAXABLE_TOTAL |
|
DECIMAL |
12,3 |
The total value of all manufacturer G1 coupons in the transaction that are taxable (defined as applied to the item(s)/transaction before tax calculation) |
| MFR_COUPONS_TAXABLE_COUNT |
|
INTEGER |
|
The total count of all manufacturer G1 coupons in the transaction that are taxable (defined as applied to the item(s)/transaction before tax calculation) |
| MFR_COUPONS_NON_TAXABLE_TOTAL |
|
DECIMAL |
12,3 |
The total value of all manufacturer G1 coupons in the transaction that are non-taxable (defined as applied to the item(s)/transaction after tax calculation) |
| MFR_COUPONS_NON_TAXABLE_COUNT |
|
INTEGER |
|
The total count of all manufacturer G1 coupons in the transaction that are non-taxable (defined as applied to the item(s)/transaction after tax calculation) |
| STORE_PROMOS_TOTAL |
|
DECIMAL |
12,3 |
The total value of all store level promotions, which includes physical coupons, electronic promos, and vendor-funded non-GS1 coupons applied to the transaction |
| STORE_PROMOS_COUNT |
|
INTEGER |
|
The total count of all store level promotions, which includes physical coupons, electronic promos, and vendor-funded non-GS1 coupons applied to the transaction |
| STORE_PHYSICAL_COUPONS_TOTAL |
|
DECIMAL |
12,3 |
The total value of all store level promotions that were applied to the transaction using a physical coupon |
| STORE_PHYSICAL_COUPONS_COUNT |
|
INTEGER |
|
The total count of all store level promotions that were applied to the transaction using a physical coupon |
| STORE_ELECTRONIC_PROMOS_TOTAL |
|
DECIMAL |
12,3 |
The total value of all store level promotions that were electronically applied to the transaction |
| STORE_ELECTRONIC_PROMOS_COUNT |
|
INTEGER |
|
The total count of all store level promotions that were electronically applied to the transaction |
| STORE_PROMOS_TAXABLE_TOTAL |
|
DECIMAL |
12,3 |
The total value of all store level promotions that are taxable (defined as applied to the item(s)/transaction before tax calculation) |
| STORE_PROMOS_TAXABLE_COUNT |
|
INTEGER |
|
The total count of all store level promotions that are taxable (defined as applied to the item(s)/transaction before tax calculation) |
| STORE_PROMOS_NON_TAXABLE_TOTAL |
|
DECIMAL |
12,3 |
The total value of all store level promotions that are non-taxable (defined as applied to the item(s)/transaction after tax calculation) |
| STORE_PROMOS_NON_TAXABLE_COUNT |
|
INTEGER |
|
The total count of all store level promotions that are non-taxable (defined as applied to the item(s)/transaction after tax calculation) |
| TOTAL_PHYSICAL_COUPONS_COUNT |
|
INTEGER |
|
The total count of all promotions including GS1 manufacturer coupons that were applied to the transaction using a physical coupon |
| LOYALTY_REWARDS_TOTAL |
|
DECIMAL |
12,3 |
The total value of all loyalty rewards applied to the transaction |
| LOYALTY_REWARDS_COUNT |
|
INTEGER |
|
The total count of all loyalty rewards applied to the transaction |
| RECEIPT_DOCUMENTS |
|
VARCHAR |
128 |
A list of receipt document names delimited by a comma. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_TEMP (TransTempModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| PAYLOAD |
|
OTHER |
|
|
| TRANS_STATUS |
|
VARCHAR |
128 |
|
| TRAINING_MODE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS_USER_ACTION (TransUserActionModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ACTION_SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| USERNAME |
|
VARCHAR |
128 |
|
| USER_ACTION_USER_TYPE_CODE |
|
VARCHAR |
128 |
|
| USER_ACTION_TYPE_CODE |
|
VARCHAR |
128 |
|
| ACTION_BEGIN_TIME |
|
TIMESTAMP |
|
|
| ACTION_END_TIME |
|
TIMESTAMP |
|
|
| REFERENCE_DATA |
|
VARCHAR |
1024 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_VAT_REFUND_LINE_ITEM (VatRefundLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| QR_CODE |
|
VARCHAR |
128 |
The VAT Refund Provider's QR code |
| TAG_NUMBER |
|
VARCHAR |
128 |
The VAT Refund Provider's unique Tag number for the transaction |
| VOIDED |
|
OTHER |
|
A flag (1 or 0) denoting whether this line item has been voided. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
|
| ENTRY_METHOD_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_VAT_REFUND_TRANS (VatRefundLinkedTransModel)
Represents a linked VAT refund transaction. This is the split record for the VAT refund details. Used to opt a prior transaction into VAT refund.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| ORIGINAL_BUSINESS_DATE |
|
VARCHAR |
128 |
The link to the original transaction's business date. |
| ORIGINAL_DEVICE_ID |
|
VARCHAR |
128 |
The link to the original transaction's device id. |
| ORIGINAL_SEQUENCE_NUMBER |
|
BIGINT |
|
The links to the original transaction's sequence number. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_VOID_TRANS (VoidTransModel)
Represents a void transaction. This is the transaction that references a retail transaction that has been voided.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| VOIDED_SEQUENCE_NUMBER |
|
BIGINT |
|
The sequence number of the original transaction that has been voided. |
| VOIDED_DEVICE_ID |
|
VARCHAR |
128 |
The device id of the original transaction that has been voided. |
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| ENTRY_MODE_CODE |
|
VARCHAR |
128 |
The mode of entry for this transaction (NORMAL, MANAGER, MAINTENANCE). |
| REASON_CODE |
|
VARCHAR |
128 |
The reason selected by the operator for voiding a transaction. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_TRANS (TransModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE |
|
VARCHAR |
128 |
The type of transaction. (SALE, RETURN, VOID, NO_SALE, OPEN_BUSINESS_UNIT, CLOSE_BUSINESS_UNIT, OPEN_DEVICE, CLOSE_DEVICE). |
| TRANS_STATUS |
|
VARCHAR |
128 |
The status of the transaction. (IN_PROGRESS, COMPLETED, CANCELLED, SUSPENDED, FAILED, SUSPEND_RETRIEVED, SUSPEND_CANCELLED, VOIDED). |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The businessUnitId under which this transaction was created. |
| USERNAME |
|
VARCHAR |
128 |
The logged in user when the transaction was created. |
| BEGIN_TIME |
|
TIMESTAMP |
|
The time the transaction was initially begun. |
| END_TIME |
|
TIMESTAMP |
|
The time the transaction was completed. |
| LOCAL_OFFSET |
|
INTEGER |
|
Offset from beginTime/endTime to UTC. |
| CLIENT_OFFSET |
|
INTEGER |
|
Client timezone offset from UTC in milliseconds. |
| KEYED_OFFLINE |
|
OTHER |
|
Whether the transaction was created when the register was in offline mode. |
| OVERRIDE_USER_ID |
|
VARCHAR |
128 |
If any portion of the transaction needed elevated privileges to be completed, the userid that provided those privileges. |
| BARCODE |
|
VARCHAR |
128 |
The numeric representation of the barcode for the transaction. Used to provide backwards compatibility for lookup in case of barcode format changes. |
| TRAINING_MODE |
|
OTHER |
|
Whether the transaction was created during training mode |
| TRAINER_ID |
|
VARCHAR |
128 |
ID of training user |
| SESSION_ID |
|
VARCHAR |
128 |
The session Id of the till used in the transaction |
| TRANS_PIN |
|
VARCHAR |
128 |
A randomly-generated PIN used to corroborate this transaction against its artifacts |
| SUSPENDED_TRANS_DATA |
|
OTHER |
|
|
| BANK_BAG_NUMBER |
|
VARCHAR |
128 |
|
| TILL_ID |
|
VARCHAR |
128 |
The tillId for the till under which this transaction was created. |
| APP_ID |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| FISCAL_TERMINAL_ID |
|
VARCHAR |
128 |
For EFTSA fiscal service, the terminal id is equivalent to the Commerce installationId where the transaction was completed. Some countries require this information when processing a return. |
| FISCAL_CONTROL_NUMBER |
|
VARCHAR |
128 |
A unique number for this transaction returned from the fiscal processor. For example, a number returned from the fiscal processor after submitting transaction data for Puerto Rico stores. |
| FISCAL_DATE_TIME |
|
TIMESTAMP |
|
Date and time from the fiscal device |
| FISCAL_PROCESSOR_CODE |
|
VARCHAR |
128 |
The code of the fiscal processor in PuertoRico Stores. Value is fetched from YAML and saved for reference in case Fiscal Processor is changed in future and for receipts |
| FISCAL_TRANSACTION_ID |
|
VARCHAR |
128 |
A unique number for this transaction generated by the fiscalization implementation. Some fiscalization implementations use this number for definitively linking the fiscal transaction with the POS transaction. |
| FISCAL_DOCUMENT_ID |
|
VARCHAR |
128 |
Receipt number or id created by the fiscal device. |
| FISCAL_RECEIPT_TEXT |
|
VARCHAR |
4000 |
A block of receipt text we receive from the fiscal device/service. |
| FISCAL_Q_R_CODE_DATA |
|
VARCHAR |
2000 |
Data returned from the fiscal service to print on the receipt in form of a QRCode |
| FISCAL_LINK |
|
VARCHAR |
128 |
Web link returned from the fiscal service for printing on the receipt. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SLS_WORK_QUEUE (WorkQueueModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| WORKER_NAME |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| STATUS_CODE |
|
VARCHAR |
128 |
|
| LINE_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| PAYLOAD |
|
OTHER |
|
|
| ERROR_MESSAGE |
|
OTHER |
|
|
| RUN_COUNT |
|
INTEGER |
|
|
| START_TIME |
|
TIMESTAMP |
|
|
| COMPLETE_TIME |
|
TIMESTAMP |
|
|
| APP_ID |
|
VARCHAR |
128 |
|
| LOCALE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Operations Microservice
OPS_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_TILL_ASSIGNMENT (TillAssignmentModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| TILL_ID |
X |
VARCHAR |
128 |
|
| OPERATOR_USERNAME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_TILL (TillModel)
| Column Name |
PK |
Type |
Size |
Description |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| TILL_ID |
X |
VARCHAR |
128 |
|
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
|
| EXPECTED_OPENING_FLOAT |
|
DECIMAL |
12,3 |
|
| DESIRED_FLOAT_AMOUNT |
|
DECIMAL |
12,3 |
|
| SESSION_ID |
|
VARCHAR |
128 |
|
| TILL_TYPE_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_TILL_TENDER_ADJUSTMENT (TillTenderAdjustmentModel)
| Column Name |
PK |
Type |
Size |
Description |
| TILL_ID |
X |
VARCHAR |
128 |
The till identifier. |
| BUSINESS_DATE |
X |
VARCHAR |
128 |
The business date of the adjustments for the till. |
| SOURCE_TENDER_CODE |
X |
VARCHAR |
128 |
|
| TARGET_TENDER_CODE |
X |
VARCHAR |
128 |
|
| ADJUSTMENT_STATUS |
|
VARCHAR |
128 |
The current status of the adjustments for this till session. All adjustments for the till will have the same status. |
| REVIEWED_BY |
|
VARCHAR |
128 |
The username of the user that approved or rejected the adjustment. |
| REVIEWED_TIME |
|
TIMESTAMP |
|
The timestamp in local time when the adjustment was approved or rejected. |
| REJECT_REASON |
|
OTHER |
|
If an adjustment was rejected, this captures the reason for the rejection. |
| REASON_CODE_GROUP_ID |
|
VARCHAR |
128 |
|
| REASON_CODE_ID |
|
VARCHAR |
128 |
|
| AMOUNT |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
OPS_UNIT_STATUS (UnitStatusModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| UNIT_ID |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| UNIT_STATUS |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Customer Microservice
CUST_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PHONE_BLACKLIST (BlacklistedPhoneNumberModel)
| Column Name |
PK |
Type |
Size |
Description |
| PHONE_NUMBER |
X |
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_ACCOUNT_LINK (CustomerAccountLinkModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
Customer reference |
| ACCOUNT_ID |
X |
VARCHAR |
128 |
Account reference |
| ACCOUNT_TYPE |
X |
VARCHAR |
128 |
Account type |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_ADDRESS (CustomerAddressModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| OPT_INTO_MARKETING_FLAG |
|
OTHER |
|
|
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CUSTOMER_ATTRIBUTE (CustomerAttributeModel)
Link name value attribute values to customers. These attributes are passed to the promotion engine and can be used to target specific customers for promotions
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| ATTRIBUTE_ID |
X |
VARCHAR |
128 |
|
| ATTRIBUTE_VALUE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CLIPPED_COUPON (CustomerClippedCouponModel)
A mapping of clipped coupon promotions to customers
| Column Name |
PK |
Type |
Size |
Description |
| CLIPPED_COUPON_ID |
X |
VARCHAR |
128 |
Id of the clipped coupon link |
| CUSTOMER_ID |
|
VARCHAR |
128 |
customerId of the customer that has clipped this coupon |
| COUPON_ITEM_ID |
|
VARCHAR |
128 |
itemId of the coupon clipped by the customer |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| CONTACT_FUNCTION |
X |
VARCHAR |
128 |
|
| CONTACT_METHOD |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| EMAIL_ID |
|
BIGINT |
|
|
| PHONE_ID |
|
INTEGER |
|
|
| ADDRESS_ID |
|
INTEGER |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_EMAIL (CustomerEmailModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| EMAIL |
|
VARCHAR |
128 |
|
| PRIMARY_EMAIL |
|
OTHER |
|
|
| EMAIL_TYPE |
|
VARCHAR |
128 |
|
| OPT_INTO_MARKETING_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_ID_TYPE_COUNTRY (CustomerIdTypeCountryModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID_TYPE_ID |
X |
VARCHAR |
128 |
|
| COUNTRY_ID |
X |
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_ID_TYPE (CustomerIdTypeModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID_TYPE_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_VALUE |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| SCAN_ALLOWED |
|
OTHER |
|
|
| COUNTRY_REQUIRED |
|
OTHER |
|
|
| STATE_REQUIRED |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CUSTOMER_IDENTIFIER (CustomerIdentifierModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_IDENTIFIER_ID |
X |
VARCHAR |
128 |
|
| IDENTIFIER |
|
VARCHAR |
128 |
|
| FIRST_NAME |
|
VARCHAR |
128 |
|
| LAST_NAME |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| DATE_OF_BIRTH |
|
TIMESTAMP |
|
|
| CUSTOMER_ID_TYPE |
|
VARCHAR |
128 |
|
| ENTRY_MODE_TYPE_CODE |
|
VARCHAR |
128 |
|
| BARCODE |
|
VARCHAR |
128 |
|
| EXPIRATION_DATE |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CUSTOMER (CustomerModel)
This table represents a customer
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| FIRST_NAME |
|
VARCHAR |
128 |
|
| LAST_NAME |
|
VARCHAR |
128 |
|
| STATUS_CODE |
|
VARCHAR |
128 |
|
| BIRTHDAY |
|
TIMESTAMP |
|
|
| BIRTH_MONTH |
|
INTEGER |
|
|
| BIRTH_DAY_OF_MONTH |
|
INTEGER |
|
|
| GENDER |
|
VARCHAR |
128 |
|
| ORGANIZATION |
|
OTHER |
|
|
| ORGANIZATION_NAME |
|
VARCHAR |
128 |
|
| OTHER_IDENTIFICATION |
|
VARCHAR |
128 |
|
| OPT_INTO_MARKETING_FLAG |
|
OTHER |
|
|
| PREFERRED_LANGUAGE |
|
VARCHAR |
128 |
|
| NATIONALITY |
|
VARCHAR |
128 |
|
| ADDITIONAL_INFO_JSON |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PHONE (CustomerPhoneModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_ID |
X |
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| PHONE_NUMBER |
|
VARCHAR |
128 |
|
| PRIMARY_NUMBER |
|
OTHER |
|
|
| PHONE_NUMBER_TYPE |
|
VARCHAR |
128 |
The CodeModel associated with this phone, e.g. HOME, CELL, MAIN |
| PHONE_NUMBER_LABEL |
|
VARCHAR |
128 |
|
| OPT_INTO_MARKETING_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CUSTOMER_PROGRAM_COPY (CustomerProgramCopyModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_PROGRAM_ID |
X |
VARCHAR |
128 |
Reference for customer program |
| SECTION_ID |
X |
VARCHAR |
128 |
Section for copy |
| MARKDOWN_TEXT |
|
OTHER |
|
Copy content |
| DISPLAY_ORDER |
|
INTEGER |
|
Order in the section that copy is displayed |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_CUSTOMER_PROGRAM (CustomerProgramModel)
| Column Name |
PK |
Type |
Size |
Description |
| CUSTOMER_PROGRAM_ID |
X |
VARCHAR |
128 |
Customer program ID |
| STATUS_CODE |
|
VARCHAR |
128 |
Status code |
| DISPLAYABLE |
|
OTHER |
|
Displayable flag |
| DISPLAY_ORDER |
|
INTEGER |
|
Order that program is displayed in the UI |
| TITLE |
|
VARCHAR |
128 |
Full title |
| SHORT_TITLE |
|
VARCHAR |
128 |
Abbreviated title |
| DESCRIPTION |
|
VARCHAR |
128 |
Description of program |
| IMAGE_ASSET_ID |
|
VARCHAR |
128 |
Associated image for program |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_LOYALTY_ACCOUNT (LoyaltyAccountModel)
| Column Name |
PK |
Type |
Size |
Description |
| ACCOUNT_ID |
X |
VARCHAR |
128 |
Unique identifier for account |
| ACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was activated |
| DEACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was deactivated |
| ACTIVE |
|
OTHER |
|
Account active flag |
| PRIMARY_ACCOUNT |
|
OTHER |
|
Primary account flag |
| STATUS_CODE |
|
VARCHAR |
128 |
Account status code |
| OTHER_IDENTIFICATION |
|
VARCHAR |
128 |
Other account identification |
| POINTS_BALANCE |
|
DECIMAL |
12,3 |
Loyalty points balance |
| POINTS_UNTIL_NEXT_REWARD |
|
DECIMAL |
12,3 |
Points required for next reward |
| TIER |
|
VARCHAR |
128 |
The specific tier that this loyalty account belongs to. ie. Silver, Gold, Platinum |
| SUBTYPE |
|
VARCHAR |
128 |
If a retailer has multiple loyalty programs, this field can be used for specifying the identifier of the program. |
| DISPLAY_NAME |
|
VARCHAR |
128 |
If a retailer has multiple loyalty programs, this field can be used for specifying the display name or i18n key. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PRIVATE_LABEL_ACCOUNT (PrivateLabelAccountModel)
| Column Name |
PK |
Type |
Size |
Description |
| ACCOUNT_ID |
X |
VARCHAR |
128 |
Unique identifier for account |
| ACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was activated |
| DEACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was deactivated |
| ACTIVE |
|
OTHER |
|
Account active flag |
| PRIMARY_ACCOUNT |
|
OTHER |
|
Primary account flag |
| STATUS_CODE |
|
VARCHAR |
128 |
Account status code |
| OTHER_IDENTIFICATION |
|
VARCHAR |
128 |
Other account identification |
| ACCOUNT_SUB_TYPE |
|
VARCHAR |
128 |
Specific private label account type |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PROGRAM_PLAN_COPY (ProgramPlanCopyModel)
| Column Name |
PK |
Type |
Size |
Description |
| PROGRAM_PLAN_ID |
X |
VARCHAR |
128 |
Reference for program plan |
| SECTION_ID |
X |
VARCHAR |
128 |
Section for copy |
| MARKDOWN_TEXT |
|
OTHER |
|
Copy content |
| DISPLAY_ORDER |
|
INTEGER |
|
Order in the section that copy is displayed |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PROGRAM_PLAN (ProgramPlanModel)
| Column Name |
PK |
Type |
Size |
Description |
| PROGRAM_PLAN_ID |
X |
VARCHAR |
128 |
Program plan model |
| CUSTOMER_PROGRAM_ID |
|
VARCHAR |
128 |
Reference for customer program |
| STATUS_CODE |
|
VARCHAR |
128 |
Status code |
| DISPLAYABLE |
|
OTHER |
|
Displayable flag |
| DISPLAY_ORDER |
|
INTEGER |
|
Order that plan is displayed in UI |
| TITLE |
|
VARCHAR |
128 |
Full title |
| SHORT_TITLE |
|
VARCHAR |
128 |
Abbreviated title |
| DESCRIPTION |
|
VARCHAR |
128 |
Description of plan |
| ENROLLMENT_ITEM_ID |
|
VARCHAR |
128 |
SKU that represents the retail line item when enrolling in program |
| PLAN_ITEM_ID |
|
VARCHAR |
128 |
SKU that represents the loyalty reward line item after linking customer in transaction |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PROGRAM_PLAN_OPTION_COPY (ProgramPlanOptionCopy)
| Column Name |
PK |
Type |
Size |
Description |
| PLAN_OPTION_ID |
X |
VARCHAR |
128 |
Reference for plan option |
| MARKDOWN_TEXT |
|
OTHER |
|
Copy content |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_PROGRAM_PLAN_OPTION (ProgramPlanOptionModel)
| Column Name |
PK |
Type |
Size |
Description |
| PLAN_OPTION_ID |
X |
VARCHAR |
128 |
Option plan model |
| PROGRAM_PLAN_ID |
|
VARCHAR |
128 |
Program plan model |
| ENROLLMENT_ITEM_ID |
|
VARCHAR |
128 |
SKU that represents the retail line item when enrolling in program |
| DISPLAY_ORDER |
|
INTEGER |
|
Order that option is displayed in UI |
| DEFAULT_SELECTED |
|
OTHER |
|
Is default selected |
| TITLE |
|
VARCHAR |
128 |
Full title |
| CONFIG_VALUES |
|
VARCHAR |
128 |
PED config values, expected as JSON string name/value pairs |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_SUBSCRIPTION_ACCOUNT (SubscriptionAccountModel)
| Column Name |
PK |
Type |
Size |
Description |
| ACCOUNT_ID |
X |
VARCHAR |
128 |
Unique identifier for account |
| ACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was activated |
| DEACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was deactivated |
| ACTIVE |
|
OTHER |
|
Account active flag |
| PRIMARY_ACCOUNT |
|
OTHER |
|
Primary account flag |
| STATUS_CODE |
|
VARCHAR |
128 |
Account status code |
| OTHER_IDENTIFICATION |
|
VARCHAR |
128 |
Other account identification |
| PROGRAM_PLAN_ID |
|
VARCHAR |
128 |
Reference to program plan |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_TAX_EXEMPT_ACCOUNT (TaxExemptAccountModel)
| Column Name |
PK |
Type |
Size |
Description |
| ACCOUNT_ID |
X |
VARCHAR |
128 |
Unique identifier for account |
| ACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was activated |
| DEACTIVATED_TIMESTAMP |
|
TIMESTAMP |
|
Time account was deactivated |
| ACTIVE |
|
OTHER |
|
Account active flag |
| PRIMARY_ACCOUNT |
|
OTHER |
|
Primary account flag |
| STATUS_CODE |
|
VARCHAR |
128 |
Account status code |
| OTHER_IDENTIFICATION |
|
VARCHAR |
128 |
Other account identification |
| TAX_EXEMPT_CODE |
|
VARCHAR |
128 |
The type of tax exemption rule enforced by this account |
| TAX_EXEMPT_CODE_GROUP |
|
VARCHAR |
128 |
Tax exempt code group mapping to a ReasonCodeGroupId |
| TAX_EXEMPT_CERTIFICATE |
|
VARCHAR |
128 |
Tax exempt certificate identification |
| ORGANIZATION_FLAG |
|
OTHER |
|
Organization flag |
| ORGANIZATION_NAME |
|
VARCHAR |
128 |
Organization name |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CUST_VOUCHER (VoucherModel)
| Column Name |
PK |
Type |
Size |
Description |
| VOUCHER_ID |
X |
VARCHAR |
128 |
A unique internal identifier for the voucher |
| CUSTOMER_ID |
|
VARCHAR |
128 |
A unique customer reference id |
| EFFECTIVE_START_TIME |
|
TIMESTAMP |
|
|
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| USED_TIME |
|
TIMESTAMP |
|
|
| DESCRIPTION |
|
VARCHAR |
128 |
|
| BALANCE |
|
DECIMAL |
12,3 |
|
| ISO_CURRENCY_CODE |
|
VARCHAR |
128 |
|
| VOUCHER_STATUS_TYPE_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Payment Microservice
PAY_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_PAYMENT_LINK_ACTION (PaymentLinkActionModel)
| Column Name |
PK |
Type |
Size |
Description |
| PAYMENT_LINK_ID |
X |
VARCHAR |
128 |
The payment link id |
| ACTION_ID |
X |
VARCHAR |
128 |
The unique identifer for the action taken by the system or customer |
| ACTION_CODE |
|
VARCHAR |
128 |
The action taken on the payment link either by the system or customer |
| VENDOR_SPECIFIC_DATA |
|
VARCHAR |
128 |
Vendor specific data that goes along with the action |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_PAYMENT_LINK (PaymentLinkModel)
| Column Name |
PK |
Type |
Size |
Description |
| PAYMENT_LINK_ID |
X |
VARCHAR |
128 |
The payment link id associated with this payment link |
| PAYMENT_LINK |
|
VARCHAR |
128 |
The Payment link generated by the third party and provided to the customer |
| DEVICE_ID |
|
VARCHAR |
128 |
|
| BUSINESS_DATE |
|
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
|
BIGINT |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_ASSIGNED_PAYMENT_DEVICE (AssignedPaymentDeviceModel)
Default payment device assignments for individual devices.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| PAYMENT_DEVICE_ID |
|
VARCHAR |
128 |
|
| PERMANENT_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
PAY_PAYMENT_DEVICES (PaymentDeviceModel)
Payment devices.
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| CONFIG_NAME |
|
VARCHAR |
128 |
|
| DISPLAY_NAME |
|
VARCHAR |
128 |
|
| SERVER_ADDRESS |
|
VARCHAR |
128 |
|
| TERMINAL_ID |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| SHARED_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Document Microservice
DOC_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_ASSIGNED_RECEIPT_PRINTER (AssignedReceiptPrinterModel)
Default printer assignments for individual devices.
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| PRINTER_ID |
|
VARCHAR |
128 |
|
| PERMANENT_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_DOCUMENT_CONFIG (DocumentConfigModel)
| Column Name |
PK |
Type |
Size |
Description |
| DOCUMENT_ID |
X |
VARCHAR |
128 |
|
| DOCUMENT_DEFINITION_ID |
|
VARCHAR |
128 |
|
| DOCUMENT_TYPE |
|
VARCHAR |
128 |
|
| DOCUMENT_CATEGORY |
|
VARCHAR |
128 |
|
| DISPLAY_NAME |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| ENABLED_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_DOCUMENT_DEFINITION (DocumentDefinitionModel)
| Column Name |
PK |
Type |
Size |
Description |
| DOCUMENT_DEFINITION_ID |
X |
VARCHAR |
128 |
|
| DOCUMENT_DEFINITION_CONTENT |
|
OTHER |
|
|
| DOCUMENT_DEFINITION_MARKDOWN |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
DOC_RECEIPT_PRINTERS (ReceiptPrinterModel)
Receipt printers.
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| PRINTER_TYPE |
|
VARCHAR |
128 |
|
| DISPLAY_NAME |
|
VARCHAR |
128 |
|
| SERVER_ADDRESS |
|
VARCHAR |
128 |
|
| DISPLAY_ORDER |
|
INTEGER |
|
|
| SHARED_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
i18n Microservice
I18N_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
I18N_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
I18N_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
I18N_RESOURCE (ResourceModel)
Internationalization resource table
| Column Name |
PK |
Type |
Size |
Description |
| BASE_NAME |
X |
VARCHAR |
128 |
|
| LOCALE |
X |
VARCHAR |
128 |
|
| STRING_KEY |
X |
VARCHAR |
128 |
|
| EFFECTIVE_START_TIME |
X |
TIMESTAMP |
|
|
| PATTERN |
|
OTHER |
|
The Config value formatted in JSON format |
| EDIT_GROUP_ID |
|
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
Hash value of english pattern. Used to check if original has changed |
| SENTIMENT_SCORE |
|
INTEGER |
|
Sentiment match score from automated translation service. |
| OVERRIDE |
|
OTHER |
|
Flag to indicate that value has been overridden |
| EFFECTIVE_END_TIME |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Carrier Microservice
CAR_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CAR_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CAR_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CAR_CARRIER (CarrierModel)
A third party responsible for transporting goods to and from a retail unit
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| CARRIER_NAME |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CAR_LABEL_PRINTER (LabelPrinterModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| IP_ADDRESS |
|
VARCHAR |
128 |
|
| LABEL_TYPE |
|
VARCHAR |
128 |
|
| PROTOCOL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
CAR_PACKAGE_TYPE (PackageTypeModel)
Represents the possible predefined package types for a business
| Column Name |
PK |
Type |
Size |
Description |
| PACKAGE_TYPE_ID |
X |
VARCHAR |
128 |
|
| DISPLAY_NAME |
|
VARCHAR |
128 |
|
| PACKAGE_LENGTH |
|
VARCHAR |
128 |
Length of the package in the units of dimensionsUOM |
| PACKAGE_WIDTH |
|
VARCHAR |
128 |
Width of the package in the units of dimensionsUOM |
| PACKAGE_HEIGHT |
|
VARCHAR |
128 |
Height of the package in the units of dimensionsUOM |
| DIMENSIONS_U_O_M |
|
VARCHAR |
128 |
Dimensions Unit of Measure (i.e. 'in., cm., etc...) |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Inventory Microservice
INV_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CONTROL_TRANS (InventoryControlTransactionModel)
A transaction which tracks actions to take on inventory levels
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| SESSION_START |
|
TIMESTAMP |
|
|
| SESSION_END |
|
TIMESTAMP |
|
|
| APP_VERSION |
|
INTEGER |
|
|
| INVENTORY_TRANS_TYPE_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_TRANS_PUBLISH (InventoryTransPublishModel)
Model representing a queue of inventory transactions to publish
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| TRANS_TYPE_CODE |
|
VARCHAR |
128 |
|
| APP_VERSION |
|
INTEGER |
|
|
| PAYLOAD |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_TRANS_PUBLISH_STATUS (InventoryTransPublishStatusModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| PUBLISH_STATUS |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_ADJ_ACTION (AdjustmentActionModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| ACTION_NAME |
|
VARCHAR |
128 |
Name of the adjustment Action (ie Giving to Charity |
| FROM_STATE |
|
VARCHAR |
128 |
|
| TO_STATE |
|
VARCHAR |
128 |
|
| IMAGE_URL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_ADJ_TRANS_LINE_ITEM (ItemAdjustmentControlTransactionLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_ITEM_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| ITEM_ID |
|
VARCHAR |
128 |
|
| USER_ID |
|
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| ACTION_ID |
|
VARCHAR |
128 |
|
| DOC_TYPE |
|
VARCHAR |
128 |
|
| DOC_ID |
|
VARCHAR |
128 |
|
| DOC_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| CONTAINER_ID |
|
VARCHAR |
128 |
|
| FROM_STATE |
|
VARCHAR |
128 |
|
| TO_STATE |
|
VARCHAR |
128 |
|
| QUANTITY |
|
DECIMAL |
12,3 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_VENDOR (VendorModel)
A third party from whom a retail unit may purchase goods or services, or one responsible for transporting goods to and from a retail unit
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
A unique identifier for this vendor |
| VENDOR_NAME |
|
VARCHAR |
128 |
This vendor's name |
| ADDRESS_TYPE |
|
VARCHAR |
128 |
|
| ATTENTION |
|
VARCHAR |
128 |
|
| LINE1 |
|
VARCHAR |
128 |
|
| LINE2 |
|
VARCHAR |
128 |
|
| LINE3 |
|
VARCHAR |
128 |
|
| LINE4 |
|
VARCHAR |
128 |
|
| UNIT_NUMBER |
|
VARCHAR |
128 |
|
| UNIT_TYPE |
|
VARCHAR |
128 |
|
| CITY |
|
VARCHAR |
128 |
|
| STATE_ID |
|
VARCHAR |
128 |
|
| COUNTRY_ID |
|
VARCHAR |
128 |
|
| POSTAL_CODE |
|
VARCHAR |
128 |
|
| PRIMARY_ADDRESS_FLAG |
|
OTHER |
|
|
| LATITUDE |
|
VARCHAR |
128 |
|
| LONGITUDE |
|
VARCHAR |
128 |
|
| SEQUENCE_NUMBER |
|
INTEGER |
|
|
| PHONE_NUMBER |
|
VARCHAR |
128 |
|
| PRIMARY_NUMBER |
|
OTHER |
|
|
| PHONE_NUMBER_TYPE |
|
VARCHAR |
128 |
The CodeModel associated with this phone, e.g. HOME, CELL, MAIN |
| PHONE_NUMBER_LABEL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CYCLE_COUNT_CAT_MEMBER (CycleCountCategoryMemberModel)
| Column Name |
PK |
Type |
Size |
Description |
| CYCLE_COUNT_CATEGORY_ID |
X |
VARCHAR |
128 |
Cycle Count Category to which this item belongs |
| ITEM_ID |
X |
VARCHAR |
128 |
Item ID to put in this category |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CYCLE_COUNT_CATEGORY (CycleCountCategoryModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
ID of the category |
| PARENT_ID |
|
VARCHAR |
128 |
Typically these categories are viewed/navigated through in a hierarchical order. This field designates the parent (or the first, direct ancestor) to this category |
| CATEGORY_NAME |
|
VARCHAR |
128 |
Name to display for this category |
| THUMBNAIL_URL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CYC_TRANS_LINE_ITEM (CycleCountControlTransactionLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_ITEM_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| ITEM_ID |
|
VARCHAR |
128 |
|
| USER_ID |
|
VARCHAR |
128 |
|
| EXPECTED_COUNT |
|
DECIMAL |
12,3 |
|
| ACTUAL_COUNT |
|
DECIMAL |
12,3 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CYCLE_COUNT_LINE_ITEM (CycleCountLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| CYCLE_COUNT_ID |
X |
VARCHAR |
128 |
Cycle Count this item belongs too |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
|
| ITEM_ID |
|
VARCHAR |
128 |
|
| COUNT_STATUS |
|
VARCHAR |
128 |
|
| EXPECTED_COUNT |
|
DECIMAL |
12,3 |
|
| ACTUAL_COUNT |
|
DECIMAL |
12,3 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_CYCLE_COUNT (CycleCountModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
Business Unit that should perform the Cycle Count |
| DESCRIPTION |
|
VARCHAR |
128 |
Description of this Cycle Count |
| LOCATION_ID |
|
VARCHAR |
128 |
Location of inventory to be counted |
| CYCLE_COUNT_TYPE |
|
VARCHAR |
128 |
Type of count (Store Requested, Central Requested, Quick Count |
| REQUESTED_ON_DATE |
|
TIMESTAMP |
|
Date this Cycle Count was requested. The due date is calculated by adding this field to the value at openpos.inventory.cyclecounts.cycleCountExpirationDays |
| EXPIRATION_ACKNOWLEDGED |
|
OTHER |
|
A field acknowledging whether or not the user has acknowledged that a cycle count has expired |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_CONTAINER (ReceivingContainerModel)
A packaged item from the perspective of the receiver and from which instructions for its breakdown into sale units are derived
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
A unique identifier for this container |
| DOCUMENT_ID |
|
VARCHAR |
128 |
The ID of the receiving document to which this container belongs |
| CONTAINER_TYPE_CODE |
|
VARCHAR |
128 |
The classification of this container, by which its size, weight, material, and/or contents can be inferred |
| PARENT_ID |
|
VARCHAR |
128 |
The ID of the container conveying this one, if any; e.g. a carton might have a pallet container as a parent |
| TRACKING_NUMBER |
|
VARCHAR |
128 |
A carrier-assigned number by which this container's location and arrival time may be tracked by the retailer |
| CARRIER_ID |
|
VARCHAR |
128 |
The ID of the carrier responsible for conveying the inventory described by this container |
| RECEIVED_DATE |
|
TIMESTAMP |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_TRANS_LINE_ITEM (ReceivingControlTransactionLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_ITEM_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| ITEM_ID |
|
VARCHAR |
128 |
|
| USER_ID |
|
VARCHAR |
128 |
|
| REC_DOC_TYPE_CODE |
|
VARCHAR |
128 |
|
| REC_DOC_ID |
|
VARCHAR |
128 |
|
| REC_DOC_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| CONTAINER_ID |
|
VARCHAR |
128 |
|
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The unique serial number of the represented merchandise item, if any |
| RECEIVED_QUANTITY |
|
DECIMAL |
12,3 |
|
| STATE_TYPE_CODE |
|
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the business unit receiving this merchandise |
| SHIP_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the business unit designated to ship this merchandise |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_DOC_MERCH_LINE_COUNT (ReceivingDocumentMerchandiseLineItemCountModel)
An association between a receiving document merchandise line item and a disposition-specific intake quantity of that line's items
| Column Name |
PK |
Type |
Size |
Description |
| DOCUMENT_ID |
X |
VARCHAR |
128 |
The ID of the inventory control document to which this line item belongs |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
The locally-unique ID of this line item within its owning inventory control document |
| INVENTORY_STATE_TYPE |
X |
VARCHAR |
128 |
The receiver-designated disposition of some intake quantity of merchandise |
| RECEIVED_QUANTITY |
|
DECIMAL |
12,3 |
The quantity of the represented merchandise which has been received by a store |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_DOC_MERCH_LINE_ITEM (ReceivingDocumentMerchandiseLineItemModel)
A receiving document line item identifying stock merchandise or supplies sold or consumed by a store
| Column Name |
PK |
Type |
Size |
Description |
| DOCUMENT_ID |
X |
VARCHAR |
128 |
The ID of the inventory control document to which this line item belongs |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
The locally-unique ID of this line item within its owning inventory control document |
| ITEM_ID |
|
VARCHAR |
128 |
The retailer-assigned unique identifier for the merchandise represented by this line item |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of the represented merchandise item |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The unique serial number of the represented merchandise item, if any |
| CONTAINER_ID |
|
VARCHAR |
128 |
The ID of the container in which the merchandise units were packaged by the supplier |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_DOC (ReceivingDocumentModel)
A document which captures the movement of inventory from a supplier or retail unit to a store
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
The unique identifier for this inventory control document |
| DOCUMENT_TYPE_CODE |
|
VARCHAR |
128 |
The type of this document, dictating its semantics and additional properties |
| DOCUMENT_STATUS_CODE |
|
VARCHAR |
128 |
|
| RECEIVE_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the store receiving the inventory captured in this document |
| SHIP_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the store, distribution center, or administrative center sourcing the inventory captured in this document |
| VENDOR_ID |
|
VARCHAR |
128 |
The ID of the vendor fulfilling or receiving the inventory described by this document |
| COMPLETED_DATE |
|
TIMESTAMP |
|
The date and time on which this document was fully processed by its recipient |
| EXPECTED_DELIVERY_DATE |
|
TIMESTAMP |
|
The date on which delivery of the shipment described by this document is expected |
| ACTUAL_DELIVERY_DATE |
|
TIMESTAMP |
|
The date on which the shipment described by this document arrived at its destination |
| SUPPLIER_EXPECTED_SHIP_DATE |
|
TIMESTAMP |
|
The date on which the supplier expected to ship the inventory described by this document |
| SUPPLIER_ACTUAL_SHIP_DATE |
|
TIMESTAMP |
|
The date on which the supplier shipped the inventory described by this document |
| CONTRACT_REFERENCE_NUMBER |
|
VARCHAR |
128 |
The ID of the contract to which this document is bound |
| SERIAL_FORM_ID |
|
VARCHAR |
128 |
The serial number printed on the document hard-copy |
| PURCHASE_ORDER_NUMBER |
|
VARCHAR |
128 |
A specific reference code that's assigned to a purchase so that it can be tracked throughout the order process |
| RECEIVABLE_IN_FULL_FLAG |
|
OTHER |
|
True if the total quantity of all merchandise attached to this document can be received atomically; false if each unit must be received individually; null to defer to non-document-specific configuration |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_SESSION_DOCUMENT (ReceivingSessionDocumentModel)
An association between a receiving session and a document counted within that session
| Column Name |
PK |
Type |
Size |
Description |
| SESSION_ID |
X |
VARCHAR |
128 |
The unique, system-assigned ID for the session |
| DOCUMENT_ID |
X |
VARCHAR |
128 |
The unique ID of a document counted within the session |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_RCV_SESSION (ReceivingSessionModel)
A session within which receiving operations are performed
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
The unique, system-assigned ID for this session |
| SESSION_STATUS |
|
VARCHAR |
128 |
The type of this document, dictating its semantics and additional properties |
| SESSION_JSON |
|
OTHER |
|
The JSON representing the receiving session |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SHP_TRANS_LINE_ITEM (ShippingControlTransactionLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DEVICE_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_DATE |
X |
VARCHAR |
10 |
|
| SEQUENCE_NUMBER |
X |
BIGINT |
|
|
| LINE_ITEM_SEQUENCE_NUMBER |
X |
INTEGER |
|
A sequence number that makes this entry unique to the transaction |
| ITEM_ID |
|
VARCHAR |
128 |
|
| USER_ID |
|
VARCHAR |
128 |
|
| SHIPPING_DOC_TYPE_CODE |
|
VARCHAR |
128 |
|
| SHIPPING_DOC_ID |
|
VARCHAR |
128 |
|
| SHIPPING_DOC_SEQUENCE_NUMBER |
|
INTEGER |
|
|
| SHIPPED_COUNT |
|
DECIMAL |
12,3 |
|
| STATE_TYPE_CODE |
|
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the business unit shipping this merchandise |
| RECEIVE_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
The ID of the business unit designated to receive this merchandise |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SHP_CONTAINER (ShippingDocumentContainerModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| DOCUMENT_ID |
|
VARCHAR |
128 |
|
| CONTAINER_TYPE_CODE |
|
VARCHAR |
128 |
|
| TRACKING_NUMBER |
|
VARCHAR |
128 |
|
| TRACKING_URL |
|
OTHER |
|
|
| SHIPPING_LABEL_DATA |
|
OTHER |
|
|
| PARENT_ID |
|
VARCHAR |
128 |
|
| BOX_LENGTH |
|
OTHER |
|
|
| BOX_WIDTH |
|
OTHER |
|
|
| BOX_HEIGHT |
|
OTHER |
|
|
| DIMENSION_U_O_M |
|
VARCHAR |
128 |
|
| WEIGHT |
|
OTHER |
|
|
| WEIGHT_U_O_M |
|
VARCHAR |
128 |
|
| CARRIER_ID |
|
VARCHAR |
128 |
The ID of the carrier responsible for conveying the inventory in this container |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SHP_DOC_MERCH_LINE_ITEM (ShippingDocumentMerchandiseLineItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| DOCUMENT_ID |
X |
VARCHAR |
128 |
The ID of the inventory control document to which this line item belongs |
| ITEM_ID |
X |
VARCHAR |
128 |
The retailer-assigned unique identifier for the merchandise represented by this line item |
| SEQUENCE_NUMBER |
X |
INTEGER |
|
The locally-unique ID of this line item within its owning inventory control document |
| QUANTITY |
|
DECIMAL |
12,3 |
The quantity of the represented merchandise item |
| SERIAL_NUMBER |
|
VARCHAR |
128 |
The unique serial number of the represented merchandise item, if any |
| STATE_TYPE_CODE |
|
VARCHAR |
128 |
|
| CONTAINER_ID |
|
VARCHAR |
128 |
|
| REQUESTED_QUANTITY |
|
DECIMAL |
12,3 |
|
| ALL_ITEMS_REQUESTED_FLAG |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
INV_SHP_DOC (ShippingDocumentModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
The unique identifier for this inventory control document |
| DOCUMENT_TYPE_CODE |
|
VARCHAR |
128 |
|
| DOCUMENT_STATUS_CODE |
|
VARCHAR |
128 |
|
| RECEIVE_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| SHIP_BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| VENDOR_ID |
|
VARCHAR |
128 |
The ID of the vendor receiving the inventory described by this document |
| PURCHASE_ORDER_NUMBER |
|
VARCHAR |
128 |
A specific reference code that's assigned to a purchase so that it can be tracked throughout the order process |
| TRANSPORT_METHOD |
|
VARCHAR |
128 |
|
| REASON_CODE |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Inventory Item Microservice
JMCI_ITM_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
JMCI_ITM_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
JMCI_ITM_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
JMCI_ITM_ITEM (InventoryItemModel)
Inventory representation of items
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| ITEM_NAME |
|
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
128 |
|
| IMAGE_URL |
|
VARCHAR |
1024 |
The image url for the Item |
| RECEIVABLE_IN_FULL_FLAG |
|
OTHER |
|
True if the total quantity of this item for a given merchandise line can be received atomically; false if each unit must be received individually; null to defer to non-item-specific configuration |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
JMCI_ITM_ITEM_ID (ItemIdModel)
Inventory representation of items
| Column Name |
PK |
Type |
Size |
Description |
| POS_ITEM_ID |
X |
VARCHAR |
128 |
The scannable/keyable code for the Item |
| ITEM_ID |
|
VARCHAR |
128 |
The unique identifier for the Item |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Inventory Position Microservice
IVP_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
IVP_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
IVP_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
IVP_LOCATION (InventoryLocationModel)
Possible locations for inventory
| Column Name |
PK |
Type |
Size |
Description |
| LOCATION_ID |
X |
VARCHAR |
128 |
A unique system assigned identifier for the Location. |
| LOCATION_NAME |
|
VARCHAR |
128 |
Name assigned to this location |
| DESCRIPTION |
|
VARCHAR |
128 |
Description of this location |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
IVP_ITEM_INV_JOURNAL_ENTRY (ItemInvJournalEntryModel)
Model tracking all changes made to inventory positions
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| LOCATION_ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
|
| ITEM_INVENTORY_STATE |
X |
VARCHAR |
128 |
|
| SOURCE_ID |
X |
VARCHAR |
128 |
|
| SOURCE_LINE_NUMBER |
X |
INTEGER |
|
|
| SOURCE_TYPE_CODE |
|
VARCHAR |
128 |
|
| UNIT_COUNT |
|
DECIMAL |
12,3 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
IVP_ITEM_INVENTORY (ItemInventoryModel)
Model representing the current item inventory levels
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
A unique system assigned identifier for the retailer's SKU |
| LOCATION_ID |
X |
VARCHAR |
128 |
A unique system assigned identifier for the Location. |
| BUSINESS_UNIT_ID |
X |
VARCHAR |
128 |
Business unit that owns the merchandise |
| ITEM_INVENTORY_STATE |
X |
VARCHAR |
128 |
An identifier for ItemInventoryStates. (OnHand, OnOrder, OnLayaway, Damaged, ToBeReturned) |
| CURRENT_UNIT_COUNT |
|
DECIMAL |
12,3 |
The number of units of the nominated Item currently present in the nominated InventoryLocation. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Inventory Ticket Microservice
TKT_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_ITEM_TICKET (ItemTicketModel)
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
|
| BATCH_ID |
X |
VARCHAR |
128 |
|
| QUANTITY |
|
INTEGER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_TICKET_BATCH (TicketBatchModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| DESCRIPTION |
|
VARCHAR |
128 |
|
| SOURCE_TYPE_CODE |
|
VARCHAR |
128 |
Who created the batch, ie Receiving, Price Change |
| STATUS_CODE |
|
VARCHAR |
128 |
Batch status, ie OPEN, PRINTED |
| SOURCE_ID |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_PRINTER (TicketPrinterModel)
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
|
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
|
| IP_ADDRESS |
|
VARCHAR |
128 |
|
| TICKET_TYPE |
|
VARCHAR |
128 |
|
| PROTOCOL |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
TKT_TICKET_TYPE_ITEM (TicketTypeItemModel)
| Column Name |
PK |
Type |
Size |
Description |
| ITEM_ID |
X |
VARCHAR |
128 |
The Item Group to which this ticket type belongs |
| TICKET_TYPE |
|
VARCHAR |
128 |
The Ticket Type that belongs to this Item Group |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Shopkeeper Statistics Microservice
SK_STATS_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_STATS_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_STATS_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_STATS_SALES_TICKER (ShopkeeperSalesTickerModel)
Table to control Sales Ticker definition on Shopkeeper's Sales widget. There is no limit to the number of tickers, but additional tickers will occupy additional screen real estate. Additionally, it's good to be mindful of the frequency at which the tickers poll. Costly operations polling frequently may cause issues
| Column Name |
PK |
Type |
Size |
Description |
| TICKER_ID |
X |
VARCHAR |
128 |
The unique ID of the ticker. This ID can be anything, but must be unique to the business unit. Shopkeeper will provide this value when requesting data |
| TITLE |
|
VARCHAR |
128 |
The title of the ticker |
| SUBTITLE |
|
VARCHAR |
128 |
Optional field. The subtitle of the ticker |
| POLLING_INTERVAL |
|
INTEGER |
|
Refresh rate of the ticker in seconds. A refresh rate of 0 indicates that the ticker is never refreshed. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_STATS_SALES_TIMELINE (ShopkeeperSalesTimelineModel)
Table to control timeline definition on Shopkeeper's Sales widget. Each row corresponds to one line on the graph. All lines share an x-axis, but can optionally bind to two separate y-axes.
| Column Name |
PK |
Type |
Size |
Description |
| TIMELINE_ID |
X |
VARCHAR |
128 |
The unique ID of the timeline. This ID can be anything, but must be unique to the business unit. Shopkeeper will provide this value when requesting data. |
| TITLE |
|
VARCHAR |
128 |
The title of the timeline |
| COLOR |
|
VARCHAR |
128 |
The color of the timeline, as a hex code |
| BIND_TO_RIGHT_AXIS |
|
OTHER |
|
Controls axis binding. By default, all timelines will attempt to bind to the left axis. Binding a timeline to the right axis will introduce a separately scaled axis. |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
Shopkeeper Device Management Microservice
SK_DEVICE_MICROSERVICE (MicroserviceModel)
This table is used to track runtime information about the module.
| Column Name |
PK |
Type |
Size |
Description |
| INSTALLATION_ID |
X |
VARCHAR |
128 |
|
| CURRENT_VERSION |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_DEVICE_SERVICE_SAMPLE (ServiceSampleModel)
This table records statistics about service calls within openpos.
| Column Name |
PK |
Type |
Size |
Description |
| SAMPLE_ID |
X |
VARCHAR |
128 |
|
| INSTALLATION_ID |
|
VARCHAR |
128 |
|
| HOSTNAME |
|
VARCHAR |
128 |
|
| SERVICE_NAME |
|
VARCHAR |
128 |
|
| SERVICE_PATH |
|
VARCHAR |
128 |
|
| SERVICE_TYPE |
|
VARCHAR |
128 |
|
| SERVICE_RESULT |
|
VARCHAR |
128 |
|
| START_TIME |
|
TIMESTAMP |
|
|
| END_TIME |
|
TIMESTAMP |
|
|
| DURATION_MS |
|
BIGINT |
|
|
| ERROR_FLAG |
|
OTHER |
|
|
| ERROR_SUMMARY |
|
VARCHAR |
128 |
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_DEVICE_SCRIPT_VERSION (ScriptVersionModel)
This table is used to track runtime information about scripts that have been applied
| Column Name |
PK |
Type |
Size |
Description |
| FILE_NAME |
X |
VARCHAR |
128 |
|
| CHECK_SUM |
|
VARCHAR |
128 |
|
| IN_USE_ID |
|
VARCHAR |
128 |
|
| LAST_SUCCESS_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_TIME |
|
TIMESTAMP |
|
|
| LAST_FAILURE_MESSAGE |
|
OTHER |
|
|
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
SK_DEVICE_NOTIFICATION (ShopkeeperNotificationModel)
Table designed to encapsulate historical information about various notifications Shopkeeper has processed. Shopkeeper will populate this table,it does not need to be filled by external means.
| Column Name |
PK |
Type |
Size |
Description |
| ID |
X |
VARCHAR |
128 |
Unique ID of the request |
| NOTIFICATION_TYPE |
|
VARCHAR |
128 |
Notification type. Post-void, help-requested, etc |
| NOTIFICATION_TYPE_V2 |
|
VARCHAR |
128 |
Notification type for client V2. Success, warning, etc |
| RESOLVED |
|
OTHER |
|
Has the notification been resolved either by POS or Shopkeeper |
| SENT_BY_USERNAME |
|
VARCHAR |
128 |
Username of the sending user |
| RESOLVED_BY_USERNAME |
|
VARCHAR |
128 |
Username of the responding user (if applicable) |
| SENT_TIME |
|
TIMESTAMP |
|
Date this notification was sent |
| RESOLVED_TIME |
|
TIMESTAMP |
|
Date this notification was resolved, or presumed to be resolved |
| DEVICE_ID |
|
VARCHAR |
128 |
ID of the device who sent this notification |
| BUSINESS_UNIT_ID |
|
VARCHAR |
128 |
ID of the store who sent this notification |
| TITLE |
|
VARCHAR |
128 |
Notification title |
| DESCRIPTION |
|
VARCHAR |
128 |
Notification description |
| MESSAGE |
|
OTHER |
|
Notification message |
| CREATE_TIME |
|
TIMESTAMP |
|
Timestamp when this entry was created. |
| CREATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |
| LAST_UPDATE_TIME |
|
TIMESTAMP |
|
Timestamp when a user last updated this entry. |
| LAST_UPDATE_BY |
|
VARCHAR |
50 |
The user who last updated this entry. |