Schema 'OCS.io Core'
Authentication
auth_registration
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'registration_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AuthRegistration. |
varchar(40) |
X |
|
auth_type |
Authorization Type. |
varchar(80) |
X |
|
organization_name |
Name of the Organization. |
varchar(80) |
||
organization_url |
URL of the Organization. |
varchar(255) |
||
organization_id |
Foreign Key to Organization. |
varchar(50) |
||
time_zone |
Time Zone. |
varchar(255) |
||
Email of the Organization Manager. |
varchar(80) |
|||
identity |
Identity as provided by OAuth Authority. |
varchar(512) |
||
full_name |
Full Name of the Organization Manager. |
varchar(255) |
X |
|
user_id |
Foreign key to AuthUser. |
varchar(50) |
||
invitation_token |
Invitation Token. |
varchar(128) |
||
encoded_password |
Password in Encoded form. |
varchar(512) |
||
registration_created |
Timestamp when Registration was created. |
timestamptz |
||
registration_finished |
Timestamp when Registration was finished. |
timestamptz |
||
email_confirmed |
Timestamp when Email was confirmed. |
timestamptz |
auth_role
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'auth_role_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AuthRole. |
varchar(40) |
X |
|
name |
Name of the AuthRole. |
varchar(80) |
X |
|
description |
Description of the AuthRole. |
varchar(255) |
||
internal_code |
${FIELD.DESCRIPTION} |
varchar(60) |
X |
|
server_dependent |
${FIELD.DESCRIPTION} |
boolean |
||
system_role |
${FIELD.DESCRIPTION} |
boolean |
||
default_role |
${FIELD.DESCRIPTION} |
boolean |
auth_user
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'auth_user_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AuthUser. |
varchar(40) |
X |
|
Registered Email of the user. |
varchar(80) |
X |
||
identity |
Identity as returned by provider. |
varchar(512) |
||
full_name |
Full name (First name + Last name) of the user. |
varchar(255) |
||
roles |
Roles assigned to user. |
text |
||
is_account_enabled |
Only in case Account Enabled = TRUE, user can sign-in. |
boolean |
||
account_expiration |
Date when account expires. After this date, user cannot sign-in. |
timestamptz |
||
registered |
Date when user was registered. |
timestamptz |
||
registration_type |
Registration type. |
varchar(30) |
||
last_logged_gui |
Date when user was logged last time via GUI. |
timestamptz |
||
last_logged_api |
Date when user was logged last time via API. |
timestamptz |
||
auth_type |
Authentication type. |
varchar(80) |
||
password |
Password of the user, never stored as plain text. |
varchar(1024) |
||
organization_id |
Foreign key to Organization. |
varchar(50) |
||
master_auth_user_id |
Foreign key to master AuthUser. |
varchar(50) |
||
token |
${FIELD.DESCRIPTION} |
varchar(128) |
||
locale |
Locale of the user. |
varchar(80) |
auth_user_detail
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'auth_user_detail_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AuthUserDetail. |
varchar(40) |
X |
|
fist_name |
${FIELD.DESCRIPTION} |
varchar(80) |
||
last_name |
${FIELD.DESCRIPTION} |
varchar(80) |
||
language |
${FIELD.DESCRIPTION} |
varchar(3) |
||
auth_user_id |
${FIELD.DESCRIPTION} |
varchar(50) |
auth_user_session
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'auth_user_session_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AuthUserSession. |
varchar(40) |
X |
|
auth_user_id |
${FIELD.DESCRIPTION} |
bigint |
||
organization_id |
${FIELD.DESCRIPTION} |
bigint |
invitation
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invitation_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Invitation. |
varchar(40) |
X |
|
auth_user_created_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
organization_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
token |
${FIELD.DESCRIPTION} |
varchar(128) |
X |
|
${FIELD.DESCRIPTION} |
varchar(255) |
X |
||
name |
${FIELD.DESCRIPTION} |
varchar(80) |
X |
|
message |
${FIELD.DESCRIPTION} |
varchar(255) |
||
created |
${FIELD.DESCRIPTION} |
timestamptz |
X |
|
expiry_days |
${FIELD.DESCRIPTION} |
bigint |
||
roles |
${FIELD.DESCRIPTION} |
text |
||
accepted |
${FIELD.DESCRIPTION} |
timestamptz |
||
auth_user_accepted_id |
${FIELD.DESCRIPTION} |
varchar(50) |
organization
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'organization_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Organization. |
varchar(40) |
X |
|
name |
Name of the Organization. |
varchar(80) |
X |
|
description |
Description of the Organization. |
varchar(255) |
||
url |
URL of the organization. Must be unique. |
varchar(255) |
X |
|
time_zone |
Time Zone. |
varchar(255) |
Cron Jobs
cron_job_cfg
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'cron_job_cfg_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CronJobCfg. |
varchar(40) |
X |
|
name |
Name of the CronJobCfg. |
varchar(80) |
X |
|
description |
Description of the CronJobCfg. |
varchar(255) |
||
internal_code |
Internal Code of the CronJobCfg. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CronJobCfg may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
cron_job_type_id |
Foreign Key to CronJobType. |
varchar(50) |
X |
|
cron_expression |
Cron expression. |
varchar(255) |
||
last_cron_job_run_id |
Foreign Key to last CronJobRun. |
varchar(50) |
||
last_execution |
Last Execution of the Cron Job. |
timestamptz |
||
disabled |
Indicates, whether Cron Job is temporarily disabled. |
boolean |
cron_job_run
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'cron_job_run_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CronJobRun. |
varchar(40) |
X |
|
cron_job_cfg_id |
Foreign Key to CronJobCfg. |
varchar(50) |
X |
|
cron_job_start |
Date/Time when Cron Job was started. |
timestamptz |
X |
|
cron_job_end |
Date/Time when Cron Job finished. |
timestamptz |
||
cron_job_duration |
Duration of the Cron Job in millis. |
bigint |
||
error_code |
Code of the Error. |
varchar(255) |
||
entities_processed |
Number of entities processed. |
bigint |
cron_job_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'cron_job_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CronJobType. |
varchar(40) |
X |
|
name |
Name of the CronJobType. |
varchar(80) |
X |
|
description |
Description of the CronJobType. |
varchar(255) |
||
internal_code |
Internal Code of the CronJobType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CronJobType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
class_name |
Cron Job’s Class name. |
varchar(255) |
X |
|
namespace |
Namespace of the Cron Job. |
varchar(60) |
X |
Extracts
extract_cfg
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'extract_cfg_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractCfg. |
varchar(40) |
X |
|
name |
Name of the ExtractCfg. |
varchar(80) |
X |
|
description |
Description of the ExtractCfg. |
varchar(255) |
||
internal_code |
Internal Code of the ExtractCfg. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ExtractCfg may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
extract_type_id |
Foreign Key to ExtractType. |
varchar(50) |
X |
|
compressed |
Indicates whether Extract is compressed. |
boolean |
extract_run
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'extract_run_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractRun. |
varchar(40) |
X |
|
extract_cfg_id |
Foreign Key to ExtractCfg. |
varchar(50) |
X |
|
extract_start |
Date/Time of Extract started. |
timestamptz |
X |
|
extract_end |
Date/Time when Extract finished. |
timestamptz |
||
extract_duration |
Duration of the Extract. |
bigint |
||
rows_extracted |
Number of rows extracted. |
bigint |
extract_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'extract_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractType. |
varchar(40) |
X |
|
name |
Name of the ExtractType. |
varchar(80) |
X |
|
description |
Description of the ExtractType. |
varchar(255) |
||
internal_code |
Internal Code of the ExtractType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ExtractType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
class_name |
Extract’s Class name. |
varchar(255) |
||
sql_statement |
Extract’s SQL. |
varchar |
||
payload_class_name |
Payload’s Class name, null in case payload is generic. |
varchar(255) |
||
format |
Extract format, e.g. 'JSON', 'CSV', etc. |
varchar(30) |
||
compress_capable |
Indicates whether Extract could be compressed. |
boolean |
||
fs_capable |
Indicates whether Extract is possible to File System. |
boolean |
||
url |
${FIELD.DESCRIPTION} |
varchar(60) |
X |
|
has_preprocessor |
Indicates whether Extract has Pre-Processor. |
boolean |
OCS.io GUI
localization_model
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'localization_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the LocalizationModel. |
varchar(40) |
X |
|
loc_key |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
||
category |
${FIELD.DESCRIPTION} |
varchar(512) |
X |
|
sub_category |
${FIELD.DESCRIPTION} |
varchar(512) |
||
html |
${FIELD.DESCRIPTION} |
boolean |
||
values_json |
${FIELD.DESCRIPTION} |
text |
navigation
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'navigation_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Navigation. |
varchar(40) |
X |
|
name |
Name of the Navigation. |
varchar(80) |
X |
|
description |
Description of the Navigation. |
varchar(255) |
||
internal_code |
Internal Code of the Navigation. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Navigation may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
version |
Version of the Navigation. |
varchar(30) |
X |
navigation_item
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'navigation_item_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the NavigationItem. |
varchar(40) |
X |
|
name |
Name of the NavigationItem. |
varchar(80) |
X |
|
description |
Description of the NavigationItem. |
varchar(255) |
||
navigation_id |
${FIELD.DESCRIPTION} |
varchar(50) |
X |
|
navigation_item_type_id |
${FIELD.DESCRIPTION} |
varchar(50) |
X |
|
page_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
page_parameters |
${FIELD.DESCRIPTION} |
varchar(255) |
||
link |
${FIELD.DESCRIPTION} |
varchar(255) |
||
item_label |
${FIELD.DESCRIPTION} |
varchar(80) |
||
icon_prepended |
${FIELD.DESCRIPTION} |
varchar(80) |
||
icon_appended |
${FIELD.DESCRIPTION} |
varchar(80) |
||
seqno |
${FIELD.DESCRIPTION} |
bigint |
||
roles |
${FIELD.DESCRIPTION} |
varchar(500) |
||
item_hidden |
Indicates whether item is itemHidden. |
boolean |
navigation_item_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'navigation_item_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the NavigationItemType. |
varchar(40) |
X |
|
name |
Name of the NavigationItemType. |
varchar(80) |
X |
|
description |
Description of the NavigationItemType. |
varchar(255) |
||
internal_code |
Internal Code of the NavigationItemType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the NavigationItemType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
custom |
${FIELD.DESCRIPTION} |
boolean |
||
class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
page_model
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'page_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PageModel. |
varchar(40) |
X |
|
name |
Name of the PageModel. |
varchar(80) |
X |
|
description |
Description of the PageModel. |
varchar(255) |
||
page_id |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
path |
${FIELD.DESCRIPTION} |
varchar(512) |
X |
|
url_coding_strategy |
${FIELD.DESCRIPTION} |
varchar(80) |
||
arr_parameter_names |
${FIELD.DESCRIPTION} |
text |
||
category |
${FIELD.DESCRIPTION} |
varchar(512) |
X |
|
sub_category |
${FIELD.DESCRIPTION} |
varchar(512) |
||
css_reference |
${FIELD.DESCRIPTION} |
varchar(512) |
||
abstr |
${FIELD.DESCRIPTION} |
boolean |
||
model_class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
view
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'gui_view_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the View. |
varchar(40) |
X |
|
name |
Name of the View. |
varchar(80) |
X |
|
description |
Description of the View. |
varchar(255) |
||
internal_code |
Internal Code of the View. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the View may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
top_navigation_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
top_right_navigation_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
left_navigation_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
right_navigation_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
home_page_id |
${FIELD.DESCRIPTION} |
varchar(50) |
X |
|
item_label |
${FIELD.DESCRIPTION} |
varchar(80) |
||
icon_prepended |
${FIELD.DESCRIPTION} |
varchar(80) |
||
icon_appended |
${FIELD.DESCRIPTION} |
varchar(80) |
||
seqno |
${FIELD.DESCRIPTION} |
bigint |
||
roles |
${FIELD.DESCRIPTION} |
varchar(500) |
||
dflt |
${FIELD.DESCRIPTION} |
boolean |
||
version |
Version of the View. |
varchar(30) |
X |
Notifications
notification
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'notification_schedule_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Notification. |
varchar(40) |
X |
|
notification_name |
Name of the Notification Type. |
varchar(60) |
X |
|
notification_code |
Code of the Notification ad defined in Notification Cfg. |
varchar(60) |
X |
|
notification_cfg_id |
Foreign Key to NotificationCfg. |
varchar(50) |
X |
|
notification_endpoint_id |
Foreign Key to NotificationEndpoint. |
varchar(50) |
X |
|
payload_json |
Payload in JSON. |
varchar |
X |
|
ent_date |
Date/Time when Notification was enetered. |
timestamptz |
X |
|
next_try_millis |
Date/Time of the Next try in Millis. |
bigint |
||
retry_count |
Number of Retries. |
bigint |
||
last_try_date |
Date/Time of the Last Try. |
timestamptz |
||
success_try_date |
Date/Time of the Successfull Try. |
timestamptz |
||
last_try_response_code |
Response Code of the Last Try. |
varchar(80) |
||
last_try_response_content |
Response Content of the Last Try. |
varchar(255) |
notification_cfg
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'notification_cfg_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the NotificationCfg. |
varchar(40) |
X |
|
name |
Name of the NotificationCfg. |
varchar(80) |
X |
|
description |
Description of the NotificationCfg. |
varchar(255) |
||
internal_code |
Internal Code of the NotificationCfg. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the NotificationCfg may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
endpoint_type |
Endpoint Type. |
varchar(80) |
X |
|
notification_type_id |
Foreign Key to NotificationType. |
varchar(50) |
X |
|
pubsub_endpoint_id |
Foreign Key to PubSubEndpoint in case NotificationType = PUBSUB. |
varchar(50) |
||
topic |
Topic to send Notification, concatenated with Pub-Sub Endpoint topic. |
varchar(255) |
||
rest_endpoint_id |
Foreign Key to RestEndpoint in case NotificationType = REST. |
varchar(50) |
||
retry_count |
Number of retries in case of error. |
bigint |
||
retry_wait |
Number of Seconds engine waits between Retries. |
bigint |
||
is_disabled |
Indicates, whether Notification is temporarily disabled. |
boolean |
||
is_stored |
Indicates, whether Notification is stored when sent. |
boolean |
notification_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'notification_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the NotificationHistory. |
varchar(40) |
X |
|
notification_name |
Name of the Notification Type. |
varchar(60) |
X |
|
notification_code |
Code of the Notification ad defined in Notification Cfg. |
varchar(60) |
X |
|
notification_cfg_id |
Foreign Key to NotificationCfg. |
varchar(50) |
X |
|
notification_endpoint_id |
Foreign Key to NotificationEndpoint. |
varchar(50) |
X |
|
payload_json |
Payload in JSON. |
varchar |
X |
|
ent_date |
Date/Time when Notification was enetered. |
timestamptz |
X |
|
next_try_millis |
Date/Time of the Next try in Millis. |
bigint |
||
retry_count |
Number of Retries. |
bigint |
||
last_try_date |
Date/Time of the Last Try. |
timestamptz |
||
success_try_date |
Date/Time of the Successfull Try. |
timestamptz |
||
last_try_response_code |
Response Code of the Last Try. |
varchar(80) |
||
last_try_response_content |
Response Content of the Last Try. |
varchar(255) |
||
partition_code |
Partition code for easier deletion. |
varchar(80) |
X |
|
fmt_month |
${FIELD.DESCRIPTION} |
text |
||
fmt_day |
${FIELD.DESCRIPTION} |
text |
notification_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'notification_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the NotificationType. |
varchar(40) |
X |
|
name |
Name of the NotificationType. |
varchar(80) |
X |
|
description |
Description of the NotificationType. |
varchar(255) |
||
internal_code |
Internal Code of the NotificationType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the NotificationType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
class_name |
Notification’s Class name. |
varchar(255) |
||
method_name |
Notifications' Method name, null in case annotation is on Class. |
varchar(255) |
||
payload_class_name |
Payload’s Class name, null in case payload is generic. |
varchar(255) |
||
pubsub_capable |
Indicates whether Notification is PUB/SUB Capable. |
boolean |
||
topic |
Topic to send Notification, concatenated with Pub-Sub Endpoint topic. |
varchar(255) |
||
rest_capable |
Indicates whether Notification is REST Capable. |
boolean |
||
max_tries |
Max Tries for given Notification Type. |
bigint |
||
min_wait |
Min Wait for given Notification Type. |
bigint |
Process
external_process
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'external_process_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExternalProcess. |
varchar(40) |
X |
|
name |
Name of the ExternalProcess. |
varchar(80) |
X |
|
description |
Description of the ExternalProcess. |
varchar(255) |
||
internal_code |
Internal Code of the ExternalProcess. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ExternalProcess may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
class_name |
Process’s Class name. |
varchar(255) |
X |
|
url |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
workers |
Number of concurrent workers. |
bigint |
||
is_disabled |
Indicates whether External Process is disabled. |
boolean |
Platform
api_request_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'api_request_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ApiRequestHistory. |
varchar(40) |
X |
|
request_id |
ID of the Request as received. |
varchar(255) |
X |
|
request_date |
Timestamp of the Request. |
timestamptz |
X |
|
request_name |
Name of the Request. |
varchar(255) |
X |
|
response_id |
ID of the Response. |
varchar(255) |
||
response_date |
Timestamp of the Response. |
timestamptz |
||
response_name |
Name of the Response. In case of Bulk Response, name is taken from main Response. |
varchar(255) |
||
response_status |
HTTP Response Status. 200=OK, other according to REST patterns. |
text |
||
bulk_response |
Indicates whether Response is Bulk. |
boolean |
||
error_code |
Code of the Error. |
varchar(255) |
||
request |
JSON containing Request. |
varchar |
||
response |
JSON containing Response. |
varchar |
||
parameters |
Main parameters of the request using for filtering. |
text |
||
partition_id |
Partition ID, consist of Request Name and Year, Month, Day. |
varchar(255) |
||
duration |
Duration of the request performing. |
bigint |
checksum
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'checksum_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Checksum. |
varchar(40) |
X |
|
tkey |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
checksum |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
last_updated |
${FIELD.DESCRIPTION} |
timestamptz |
X |
clob
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'clob_store_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Clob. |
varchar(40) |
X |
|
name |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
entity |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
cl |
${FIELD.DESCRIPTION} |
text |
X |
configuration_model
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'configuration_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ConfigurationModel. |
varchar(40) |
X |
|
name |
Name of the ConfigurationModel. |
varchar(80) |
X |
|
description |
Description of the ConfigurationModel. |
varchar(255) |
||
tkey |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
||
category |
${FIELD.DESCRIPTION} |
varchar(512) |
X |
|
sub_category |
${FIELD.DESCRIPTION} |
varchar(512) |
||
value_type |
${FIELD.DESCRIPTION} |
varchar(80) |
||
visibility |
${FIELD.DESCRIPTION} |
varchar(80) |
||
inherited |
${FIELD.DESCRIPTION} |
boolean |
||
value |
${FIELD.DESCRIPTION} |
varchar(255) |
custom_attribute
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'custom_attribute_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomAttribute. |
varchar(40) |
X |
|
name |
Name of the CustomAttribute. |
varchar(80) |
X |
|
description |
Description of the CustomAttribute. |
varchar(255) |
||
internal_code |
Internal Code of the CustomAttribute. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CustomAttribute may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
custom_entity_id |
Foreign Key to CustomEntity. |
varchar(50) |
X |
|
attribute_type |
Type of the Attribute. |
varchar(80) |
X |
|
nullable |
Indicates whether Value could be null. |
boolean |
||
min_length |
Minimal Length for String values. |
bigint |
||
max_length |
Maximal Length for String values. |
bigint |
||
range_from |
Range From for Number values. |
bigint |
||
range_to |
Range To for Number values. |
bigint |
||
regexpcond |
Regular Expression condition. |
varchar(255) |
||
seqno |
Seq No for ordering of the attributes within one Entity. |
bigint |
X |
custom_entity
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'custom_entity_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomEntity. |
varchar(40) |
X |
|
name |
Name of the CustomEntity. |
varchar(80) |
X |
|
description |
Description of the CustomEntity. |
varchar(255) |
||
internal_code |
Internal Code of the CustomEntity. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CustomEntity may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
url |
Entity piece in URL for REST GET API. |
varchar(60) |
X |
|
singleton |
Indicates whether only one Instance (Singleton) of the Entity is allowd. |
boolean |
custom_entity_instance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'custom_entity_inst_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomEntityInstance. |
varchar(40) |
X |
|
name |
Name of the CustomEntityInstance. |
varchar(80) |
X |
|
description |
Description of the CustomEntityInstance. |
varchar(255) |
||
internal_code |
Internal Code of the CustomEntityInstance. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CustomEntityInstance may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
custom_entity_id |
Foreign Key to CustomEntity. |
varchar(50) |
X |
|
url |
Instance piece in URL for REST GET API. |
varchar(60) |
X |
custom_entity_instance_value
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'custom_entity_inst_val_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomEntityInstanceValue. |
varchar(40) |
X |
|
custom_entity_instance_id |
Foreign Key to CustomEntityInstance. |
varchar(50) |
X |
|
custom_entity_id |
Foreign Key to CustomEntity. |
varchar(50) |
X |
|
name |
Name of the value (version). |
varchar(80) |
X |
|
description |
Description of the value (version). |
varchar(255) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
value_json |
Values in JSON. |
varchar |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
deployment_set
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'deployment_set_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DeploymentSet. |
varchar(40) |
X |
|
name |
Name of the DeploymentSet. |
varchar(80) |
X |
|
description |
Description of the DeploymentSet. |
varchar(255) |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
X |
|
created_by_id |
User created the Deployment Set. |
varchar(50) |
X |
|
created |
Timestamp when Set was created. |
timestamptz |
X |
|
deployed_by_id |
User deployed Deployment Set. |
varchar(50) |
||
deployed |
Timestamp when Set was deployed. |
timestamptz |
||
effective_date |
Effective Date/Time of Deployment. |
timestamptz |
||
deployment_set_hidden |
Indicates whether Set is hidden from the GUI. |
boolean |
deployment_set_entity
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'deployment_set_entity_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DeploymentSetEntity. |
varchar(40) |
X |
|
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
X |
|
entity_class_name |
Class Name of the Entity. |
varchar(255) |
X |
|
srv_class_name |
Class Name of the SRV behind Entity. |
varchar(255) |
X |
|
page_class_name |
Class Name of the Page with Entity’s form. |
varchar(255) |
||
entity |
Foreign Key to Entity. |
varchar(50) |
X |
|
entity_name |
Name of the Entity, if apply. |
varchar(80) |
||
entity_internal_code |
Internal Code of the Entity, if apply. |
varchar(60) |
||
entity_description |
Description of the Entity, if apply. |
varchar(255) |
||
entity_deployable |
Indicates whether Entity is deployable. |
boolean |
||
validation_code |
Deployment validation code, if apply. |
varchar(30) |
||
validation_error |
Deployment validation error, if apply. |
varchar(255) |
||
order_id |
Order ID composed from Time in millis. |
bigint |
||
componsed_index |
Composed index, consists of deploymentSet:entityClassName:entity. |
varchar(255) |
entity_tag
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'entity_tag_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the EntityTag. |
varchar(40) |
X |
|
entity_class_name |
Class Name of the Entity. |
varchar(255) |
X |
|
entity_id |
Foreign Key to Entity. |
varchar(50) |
X |
|
tag_id |
Foreign Key to Tag. |
varchar(50) |
X |
|
composed_index |
Composed index, consists of entityClassName:entity. |
varchar(255) |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
language
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'language_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Language. |
varchar(40) |
X |
|
name |
Name of the Language. |
varchar(80) |
X |
|
description |
Description of the Language. |
varchar(255) |
||
internal_code |
Internal Code of the Language. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Language may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
iso639 |
ISO 639 code (2 letters). |
varchar(2) |
X |
lock
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'entity_lock_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Lock. |
varchar(40) |
X |
|
entity |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
locked_by_id |
${FIELD.DESCRIPTION} |
varchar(50) |
||
locked_date |
${FIELD.DESCRIPTION} |
timestamptz |
X |
module
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'module_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Module. |
varchar(40) |
X |
|
name |
Name of the Module. |
varchar(80) |
X |
|
description |
Description of the Module. |
varchar(255) |
||
internal_code |
Internal Code of the Module. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Module may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
module_type_id |
Foreign Key to ModuleType. |
varchar(50) |
X |
|
config |
${FIELD.DESCRIPTION} |
varchar |
||
is_disabled |
Indicates, whether Module is temporarily disabled. |
boolean |
plugin_model
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'plugin_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PluginModel. |
varchar(40) |
X |
|
name |
Name of the PluginModel. |
varchar(80) |
X |
|
description |
Description of the PluginModel. |
varchar(255) |
||
internal_code |
Internal Code of the PluginModel. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the PluginModel may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
base_class_name |
Base class name from which Plugin class is derived. |
varchar(255) |
X |
|
class_name |
Class name of the plugin. |
varchar(255) |
X |
|
category |
Category of the Plugin. |
varchar(255) |
X |
|
sub_category |
Subcategory of the plugin. |
varchar(255) |
||
plugin_id |
Unique identification of the Plugin, taken from metadata. |
varchar(255) |
X |
|
version |
Version of the plugin, taken from Plugin metadata. Based on the version, plugins are re-deployed. |
varchar(30) |
X |
|
version_deployed |
Timestamp when actual version was deployed. |
timestamptz |
X |
|
active |
Plugin is active?. |
boolean |
X |
process_status
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'process_status_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProcessStatus. |
varchar(40) |
X |
|
auth_user_id |
${FIELD.DESCRIPTION} |
bigint |
||
process_name |
${FIELD.DESCRIPTION} |
varchar(80) |
X |
|
is_async |
${FIELD.DESCRIPTION} |
boolean |
X |
|
current_step |
${FIELD.DESCRIPTION} |
bigint |
||
steps |
${FIELD.DESCRIPTION} |
bigint |
||
status |
${FIELD.DESCRIPTION} |
varchar(80) |
X |
|
created |
${FIELD.DESCRIPTION} |
timestamptz |
X |
|
last_updated |
${FIELD.DESCRIPTION} |
timestamptz |
||
finished |
${FIELD.DESCRIPTION} |
timestamptz |
||
payload |
${FIELD.DESCRIPTION} |
varchar |
||
exception |
${FIELD.DESCRIPTION} |
varchar |
||
err_code |
${FIELD.DESCRIPTION} |
varchar |
||
err_msg |
${FIELD.DESCRIPTION} |
varchar(255) |
rest_service_model
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'rest_service_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RestServiceModel. |
varchar(40) |
X |
|
tkey |
${FIELD.DESCRIPTION} |
varchar(80) |
X |
|
path |
${FIELD.DESCRIPTION} |
varchar(80) |
X |
|
http_method |
${FIELD.DESCRIPTION} |
varchar(80) |
||
produces |
${FIELD.DESCRIPTION} |
varchar(80) |
||
return_type |
${FIELD.DESCRIPTION} |
varchar(80) |
||
srv_class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
model_class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
sequence_def
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'sequence_def_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SequenceDef. |
varchar(40) |
X |
|
name |
Name of the SequenceDef. |
varchar(80) |
X |
|
description |
Description of the SequenceDef. |
varchar(255) |
||
sequence_db_name |
DB Name of the Sequence. |
varchar(80) |
X |
|
initial_value |
Initial value of the Sequence. |
bigint |
spreadsheet_api
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'spreadsheet_api_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SpreadsheetApi. |
varchar(40) |
X |
|
name |
Name of the SpreadsheetApi. |
varchar(80) |
X |
|
description |
Description of the SpreadsheetApi. |
varchar(255) |
||
path |
URL path of the API. |
varchar(255) |
X |
|
read_only |
Indicates whether method is read-only. |
boolean |
||
seqno |
bigint |
X |
tag
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'tag_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Tag. |
varchar(40) |
X |
|
name |
Name of the Tag. |
varchar(80) |
X |
|
description |
Description of the Tag. |
varchar(255) |
||
internal_code |
Internal Code of the Tag. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Tag may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
entity_class_name |
Class Name of the Entity. |
varchar(255) |
Publish-Subscribe
pub_sub_endpoint
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'pub_sub_endpoint_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PubSubEndpoint. |
varchar(40) |
X |
|
name |
Name of the PubSubEndpoint. |
varchar(80) |
X |
|
description |
Description of the PubSubEndpoint. |
varchar(255) |
||
internal_code |
Internal Code of the PubSubEndpoint. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the PubSubEndpoint may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
topic |
Topic to send Event concatenated with Pub-Sub Message topic. |
varchar(255) |
||
custom_headers |
Custom Headers / Parameters in JSON. |
varchar |
||
key_stripped |
Indicates whether Key is stripped. |
boolean |
||
is_disabled |
Indicates, whether Pub-Sub Message is temporarily disabled. |
boolean |
pub_sub_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'pub_sub_history_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PubSubHistory. |
varchar(40) |
X |
|
publish_date |
Date/Time when Message is published. |
timestamptz |
X |
|
code |
Code of the Message. |
varchar(255) |
X |
|
topic |
Topic to which Message is published. |
varchar(255) |
X |
|
key |
Key of the Message. |
varchar(255) |
||
payload_class_name |
Class Name of the Payload. |
varchar(255) |
X |
|
payload |
Payload of the Message. |
varchar |
||
custom_headers |
Custom Headers of the Message. |
text |
||
parameters |
Main parameters of the Message using for filtering. |
text |
||
error_code |
Code of the Error. |
varchar(255) |
pub_sub_message_cfg
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'pub_sub_message_cfg_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PubSubMessageCfg. |
varchar(40) |
X |
|
name |
Name of the PubSubMessageCfg. |
varchar(80) |
X |
|
description |
Description of the PubSubMessageCfg. |
varchar(255) |
||
internal_code |
Internal Code of the PubSubMessageCfg. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the PubSubMessageCfg may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
pub_sub_message_type_id |
Foreign Key to PubSubMessageType. |
varchar(50) |
X |
|
pub_sub_endpoint_id |
Foreign Key to PubSubEndpoint. |
varchar(50) |
X |
|
topic |
Topic to send Event, concatenated with Pub-Sub Endpoint topic. |
varchar(255) |
||
is_disabled |
Indicates, whether Pub-Sub Message is temporarily disabled. |
boolean |
||
is_stored |
Indicates, whether Notification is stored when sent. |
boolean |
pub_sub_message_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'pub_sub_message_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PubSubMessageType. |
varchar(40) |
X |
|
name |
Name of the PubSubMessageType. |
varchar(80) |
X |
|
description |
Description of the PubSubMessageType. |
varchar(255) |
||
internal_code |
Internal Code of the PubSubMessageType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the PubSubMessageType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
class_name |
PubSub Message’s Class name. |
varchar(255) |
||
method_name |
PubSub Message’s Method name, null in case annotation is on Class. |
varchar(255) |
||
payload_class_name |
Payload’s Class name, null in case payload is generic. |
varchar(255) |
||
topic |
Topic to send Event. |
varchar(255) |
X |
Content - Configuration
content
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_content_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Content. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
content_def_id |
Foreign Key to ContentDef. |
varchar(50) |
X |
content_category
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'content_category_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ContentCategory. |
varchar(40) |
X |
|
name |
Name of the ContentCategory. |
varchar(80) |
X |
|
description |
Description of the ContentCategory. |
varchar(255) |
||
internal_code |
Internal Code of the ContentCategory. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ContentCategory may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
content_def_id |
Foreign Key to ContentDef. |
varchar(50) |
X |
|
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
content_def
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'content_def_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ContentDef. |
varchar(40) |
X |
|
name |
Name of the ContentDef. |
varchar(80) |
X |
|
description |
Description of the ContentDef. |
varchar(255) |
||
internal_code |
Internal Code of the ContentDef. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ContentDef may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
content_analysis_type |
varchar(80) |
X |
content_item
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'content_item_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ContentItem. |
varchar(40) |
X |
|
name |
Name of the ContentItem. |
varchar(80) |
X |
|
description |
Description of the ContentItem. |
varchar(255) |
||
content_def_id |
Foreign Key to ContentDef. |
varchar(50) |
X |
|
content_category_id |
Foreign Key to ContentCategory. |
varchar(50) |
||
charging_key |
Charging Key based on which Content is identified. |
varchar(255) |
X |
|
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
priority |
Priority used for evaluation of Regular Expressions. |
bigint |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
content_usage_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'content_usage_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ContentUsageCharge. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to ServiceValue. |
varchar(50) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
charge_valid_from |
Timestamp from when Charge is valid. |
timestamptz |
||
charge_valid_to |
Timestamp till when Charge is valid. |
timestamptz |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:chargingClass. |
varchar(255) |
X |
Core
account
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Account. |
varchar(40) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to Account Segment. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
external_id |
External ID of the Account. |
varchar(255) |
||
custom_name |
Custom Account name. |
varchar(255) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
bill_cycle_id |
Foreign Key to BillCycle. Only for Payment responsible accounts. |
varchar(50) |
||
bill_cycle_ent_date |
Timestamp when BillCycle was entered. |
timestamptz |
||
bill_cycle_valid_from |
Timestamp from when BillCycle is Valid. |
timestamptz |
||
bill_cycle_individual |
Indicates whether standard Billing Cycle per Account is individual (due to Billing Cycle change, On-Demand billing, etc.). |
boolean |
||
billing_day |
Day of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_month |
Month of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_year |
Year of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
parent_id |
Foreign Key to parent Account. |
varchar(50) |
||
payment_responsible |
Indicates whether Account is Payment Responsible. |
boolean |
||
payment_responsible_account_id |
Foreign Key to Payment Responsible Account. Not populated when Account is Payment responsible itself. |
varchar(50) |
||
tax_exemption |
Indicates whether Account is subject of Tax exemption. If true, TaxExemptionType on Invoice is set to ACCOUNT. |
boolean |
||
tax_residence |
Tax Residence of the Payment Responsible Account. |
varchar(255) |
||
state |
State of the Account. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
inactive_reason_id |
Reason associated with Inactive State. |
varchar(50) |
||
inactive_ent_date |
Timestamp when Inactive State was entered. |
timestamptz |
||
inactive_valid_from |
Timestamp from when Inactive State is Valid and when Inactive State was entered. |
timestamptz |
||
activated_reason_id |
Reason associated with Activated State. |
varchar(50) |
||
activated_ent_date |
Timestamp when Activated State was entered. |
timestamptz |
||
activated_valid_from |
Timestamp from when Activated State is Valid. |
timestamptz |
||
re_activated_reason_id |
Reason associated with Re-Activated State. |
varchar(50) |
||
re_activated_ent_date |
Timestamp when Re-Activated State was entered. |
timestamptz |
||
re_activated_valid_from |
Timestamp from when Re-Activated State is Valid. |
timestamptz |
||
suspended_reason_id |
Reason associated with Suspended State. |
varchar(50) |
||
suspended_ent_date |
Timestamp when Suspended State was entered. |
timestamptz |
||
suspended_valid_from |
Timestamp from when Suspended State is Valid. |
timestamptz |
||
deactivated_reason_id |
Reason associated with Deactivated State. |
varchar(50) |
||
deactivated_ent_date |
Timestamp when Deactivated State was entered. |
timestamptz |
||
deactivated_valid_from |
Timestamp from when Deactivated State is Valid. |
timestamptz |
||
bill_cycle_change_id |
Foreign Key to AccountBillCycleChange. Populated when Bill Cycle Change is scheduled. |
varchar(50) |
||
pending_state_id |
Foreign Key to PendingState. Populated when Account is in Pending state. |
varchar(50) |
||
test_account |
Indicates whether Account is a Test Account. |
boolean |
||
priority |
Priority of the Account within Billing and Invoicing processing. |
bigint |
account_bill_cycle_change
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_bill_cycle_change_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountBillCycleChange. |
varchar(40) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
bill_cycle_id |
Foreign Key to Bill Cycle. |
varchar(50) |
X |
|
bill_cycle_individual |
Indicates whether standard Billing Cycle per Account is individual (due to Billing Cycle change, On-Demand billing, etc.). |
boolean |
||
billing_day |
Day of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_month |
Month of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_year |
Year of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
bill_cycle_ent_date |
Timestamp when Bill Cycle was entered. |
timestamptz |
X |
|
bill_cycle_valid_from |
Timestamp from when Bill Cycle is Valid. |
timestamptz |
X |
|
transaction_id |
Transaction ID for grouping changing of Change into one logical transaction. |
varchar(255) |
X |
|
bill_cycle_changed_date |
Timestamp when Bill Cycle Change was realized. |
timestamptz |
||
bill_cycle_cancelled_date |
Timestamp when Bill Cycle Change was cancelled. |
timestamptz |
||
scheduled_run |
Scheduled Date/Time of the Bill Cycle Change Run. |
timestamptz |
account_bill_cycle_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_bill_cycle_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountBillCycleHistory. |
varchar(40) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
bill_cycle_id |
Foreign Key to Bill Cycle. |
varchar(50) |
X |
|
bill_cycle_individual |
Indicates whether standard Billing Cycle per Account is individual (due to Billing Cycle change, On-Demand billing, etc.). |
boolean |
||
billing_day |
Day of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_month |
Month of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
billing_year |
Year of the Billing in case Billing Cycle per Account is individual. |
bigint |
||
bill_cycle_ent_date |
Timestamp when Bill Cycle was entered. |
timestamptz |
X |
|
bill_cycle_valid_from |
Timestamp from when Bill Cycle is Valid. |
timestamptz |
X |
|
bill_cycle_valid_to |
Timestamp till when Bill Cycle is Valid. |
timestamptz |
||
transaction_id |
Transaction ID for grouping changing of Change into one logical transaction. |
varchar(255) |
X |
account_bill_cycle_run
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_bill_cycle_run_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountBillCycleRun. |
varchar(40) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
bill_cycle_id |
Foreign Key to Bill Cycle. |
varchar(50) |
X |
|
bill_cycle_type |
Type of the Billing Cycle. |
varchar(80) |
X |
|
invoice_reason |
Reason for Invoicing. |
varchar(80) |
X |
|
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
X |
|
account_semaphore |
Status of the Bill Cycle Run. |
varchar(80) |
X |
|
scheduled_run |
Scheduled Date/Time of the Next Bill Cycle Run. |
timestamptz |
||
billing_period_start |
Billing Period Start Date if custom for Account. |
timestamptz |
||
billing_period_end |
Billing Period End Date if custom for Account. |
timestamptz |
||
billing_start |
Date/Time when Billing for Account was started. |
timestamptz |
||
billing_end |
Date/Time when Billing for Account finished. |
timestamptz |
||
invoicing_start |
Date/Time when Invoicing for Account was started. |
timestamptz |
||
invoicing_end |
Date/Time when Invoicing for Account finished. |
timestamptz |
||
formatting_start |
Date/Time when Formatting for Account was started. |
timestamptz |
||
formatting_end |
Date/Time when Formatting for Account finished. |
timestamptz |
||
invoicing_duration |
Duration of the Last Invoicing in millis. |
bigint |
||
parent_id |
Foreign Key to Parent. Only for billCycleType = ADJUSTMENT or FINAL. |
varchar(50) |
||
reason |
Reason associated with Account Semaphore. |
varchar(255) |
||
result |
Result in JSON. |
varchar |
||
transaction_id |
Business Transaction ID. |
varchar(255) |
||
composed_index |
Composed index, consists of account:billCycleRun. |
varchar(255) |
X |
account_state_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_state_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountStateHistory. |
varchar(40) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
state |
State of the Subscriber. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_valid_to |
Timestamp till when State is Valid. |
timestamptz |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
balance_reservation
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'balance_reservation_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BalanceReservation. |
varchar(40) |
X |
|
reservation_id |
varchar(255) |
X |
||
balance_value_id |
Foreign Key to BalanceValue. |
varchar(50) |
X |
|
valid_to |
Timestamp till when Reservation is valid. |
timestamptz |
X |
balance_value
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'balance_value_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BalanceValue. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to Balance / RecurrentBalance (inherited from ServiceValue). |
varchar(50) |
X |
|
service_value_class_name |
Service Value Class Name (Simple). |
varchar(255) |
X |
|
granted_balance |
Balance granted. |
bigint |
X |
|
actual_balance |
Actual Balance. |
bigint |
X |
|
valid_from |
Timestamp from when Balance Value is valid. |
timestamptz |
X |
|
valid_to |
Timestamp till when Balance is valid. |
timestamptz |
||
expired |
Indicates whether Balance Value is Expired. |
boolean |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:expired. |
varchar(255) |
X |
|
reservations |
${FIELD.DESCRIPTION} |
varchar |
||
notifications |
${FIELD.DESCRIPTION} |
varchar |
||
threshold1 |
Notification Threshold #1. |
bigint |
||
threshold2 |
Notification Threshold #2. |
bigint |
||
threshold3 |
Notification Threshold #3. |
bigint |
||
sent_first_usage |
Timestamp when Notification First-Usage has been sent. |
timestamptz |
||
sent1 |
Timestamp when Notification #1 has been sent. |
timestamptz |
||
sent2 |
Timestamp when Notification #2 has been sent. |
timestamptz |
||
sent3 |
Timestamp when Notification #3 has been sent. |
timestamptz |
||
value_first_usage |
Balance value which triggers Notification First-Usage. |
bigint |
||
value1 |
Balance value which triggers Notification #1. |
bigint |
||
value2 |
Balance value which triggers Notification #2. |
bigint |
||
value3 |
Balance value which triggers Notification #3. |
bigint |
bill_cycle_run
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'bill_cycle_run_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BillCycleRun. |
varchar(40) |
X |
|
billing_period_start |
Billing Period Start Date. |
timestamptz |
X |
|
billing_period_end |
Billing Period End Date. |
timestamptz |
X |
|
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
X |
|
bill_cycle_type |
Type of the Billing Cycle. |
varchar(80) |
X |
|
bill_cycle_status |
Status of the Billing Cycle. |
varchar(80) |
X |
|
bill_date |
Date when Billing has been started. Truncated to Day using Organization timezone. |
timestamptz |
||
invoicing_start |
Date/Time when Invoicing was started. |
timestamptz |
||
invoicing_end |
Date/Time when Invoicing was finished. |
timestamptz |
||
invoicing_duration |
Duration of the Invoicing in Millis (invoicingEnd - invoicingStart). |
bigint |
||
accounts_processed |
Accounts processed. |
bigint |
||
accounts_ok |
Accounts processed with OK result. |
bigint |
||
accounts_err |
Accounts processed with ERROR result. |
bigint |
||
accounts_skipped |
Accounts skipped. |
bigint |
community_member
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'community_member_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CommunityMember. |
varchar(40) |
X |
|
value_set_on |
Indicates which Entity is linked. |
varchar(80) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
member_from |
Date/Time from when Community membership is valid. |
timestamptz |
X |
|
member_to |
Date/Time till when Community membership is valid. |
timestamptz |
||
composed_index |
Composed index, consists of valueSetOn:customer/account/subscriber. |
varchar(255) |
X |
customer
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'customer_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Customer. |
varchar(40) |
X |
|
customer_type |
Type of the customer. |
varchar(80) |
X |
|
customer_segment_id |
Foreign Key to Customer Segment. |
varchar(50) |
||
external_id |
External ID of the Customer. |
varchar(255) |
||
custom_name |
Custom Customer name. |
varchar(255) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
state |
State of the Customer. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
inactive_ent_date |
Timestamp when Inactive State was entered. |
timestamptz |
||
inactive_reason_id |
Reason associated with Inactive State. |
varchar(50) |
||
inactive_valid_from |
Timestamp from when Inactive State is Valid and when Inactive State was entered. |
timestamptz |
||
activated_reason_id |
Reason associated with Activated State. |
varchar(50) |
||
activated_ent_date |
Timestamp when Activated State was entered. |
timestamptz |
||
activated_valid_from |
Timestamp from when Activated State is Valid. |
timestamptz |
||
re_activated_reason_id |
Reason associated with Re-Activated State. |
varchar(50) |
||
re_activated_ent_date |
Timestamp when Re-Activated State was entered. |
timestamptz |
||
re_activated_valid_from |
Timestamp from when Re-Activated State is Valid. |
timestamptz |
||
suspended_reason_id |
Reason associated with Suspended State. |
varchar(50) |
||
suspended_ent_date |
Timestamp when Suspended State was entered. |
timestamptz |
||
suspended_valid_from |
Timestamp from when Suspended State is Valid. |
timestamptz |
||
deactivated_reason_id |
Reason associated with Deactivated State. |
varchar(50) |
||
deactivated_ent_date |
Timestamp when Deactivated State was entered. |
timestamptz |
||
deactivated_valid_from |
Timestamp from when Deactivated State is Valid. |
timestamptz |
||
pending_state_id |
Foreign Key to PendingState. Populated when Customer is in Pending state. |
varchar(50) |
||
test_customer |
Indicates whether Customer is a Test Customer. |
boolean |
customer_state_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'customer_state_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomerStateHistory. |
varchar(40) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
X |
|
state |
State of the Subscriber. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_valid_to |
Timestamp till when State is Valid. |
timestamptz |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
edr_file
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'edr_file_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the EdrFile. |
varchar(40) |
X |
|
name |
Name of the EdrFile. |
varchar(80) |
X |
|
description |
Description of the EdrFile. |
varchar(255) |
||
edr_file_processor_id |
Foreign Key to EdrFileProcessor. |
varchar(50) |
X |
|
file_type |
Type of the File. |
varchar(80) |
||
file_status |
Status of the File. |
varchar(80) |
X |
|
full_name |
Full name of the File including path. |
varchar(255) |
X |
|
hash |
MD5 like hash of the file content. |
varchar(255) |
||
file_created_date |
Timestamp when File was created on the filesystem. |
timestamptz |
X |
|
file_created_day |
File created day (YYYYMMDD). |
varchar(8) |
X |
|
file_ent_date |
Timestamp when File entered the system. |
timestamptz |
X |
|
file_closed_date |
Timestamp when File was closed. Null in case File is still open. |
timestamptz |
||
temporary_name |
Temporary File Name. |
varchar(255) |
||
event_count |
Number of events in the File. Applicable only for Non-Rejected files. |
bigint |
||
processed_count |
Number of processed events in the File. Applicable only for Non-Rejected files. |
bigint |
||
rejected_count |
Number of rejected events in the File. Applicable only for Non-Rejected files. |
bigint |
||
stats |
Statistics of the file. |
text |
||
composed_index |
Composed index, consists of edrFileType:edrFileProcessor:fileName. |
varchar(255) |
entity_segment_map
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'entity_segment_map_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the EntitySegmentMap. |
varchar(40) |
X |
|
value_set_on |
Indicates to which entity Segment is mapped to. |
varchar(80) |
X |
|
entity_id |
Foreign Key to Entity. |
text |
X |
|
entity_segment_id |
Foreign Key to Entity Segment. |
text |
X |
|
valid_from |
Timestamp from when Mapping is Valid. |
timestamptz |
X |
|
valid_to |
Timestamp till when Mapping is Valid. |
timestamptz |
offer_subscription
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'offer_subscription_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OfferSubscription. |
varchar(40) |
X |
|
value_set_on |
Indicates to which entity Offer is subscribed to. |
varchar(80) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to Account Segment. |
varchar(50) |
||
account_type_id |
Foreign Key to Account Type. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to Parent OfferSubscription. |
varchar(50) |
||
community_id |
Foreign Key to Community. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
offer_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
priority |
Priority of the Offer, copied from Offer during subscription or recurrent renewal. |
bigint |
||
external_id |
External ID of the Subscription. |
varchar(255) |
||
custom_name |
Custom Subscription name. |
varchar(255) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
state |
State of the Subscription. |
varchar(80) |
X |
|
state_reason_id |
Foreign Key to StateReason. |
varchar(50) |
X |
|
state_ent_date |
Date when State was entered. |
timestamptz |
X |
|
state_valid_from |
Date from when State is valid. |
timestamptz |
X |
|
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
inactive_reason_id |
Reason for Inactive State. |
varchar(50) |
||
inactive_ent_date |
Date when State Inactive was entered. |
timestamptz |
||
inactive_valid_from |
Date from when State Inactive is valid. |
timestamptz |
||
activated_reason_id |
Reason for Activated State. |
varchar(50) |
||
activated_ent_date |
Date when State Activated was entered. |
timestamptz |
||
activated_valid_from |
Date from when State Activated is valid. |
timestamptz |
||
re_activated_reason_id |
Reason associated with Re-Activated State. |
varchar(50) |
||
re_activated_ent_date |
Timestamp when Re-Activated State was entered. |
timestamptz |
||
re_activated_valid_from |
Timestamp from when Re-Activated State is Valid. |
timestamptz |
||
suspended_reason_id |
Reason for Suspended State. |
varchar(50) |
||
suspended_ent_date |
Date when State Suspended was entered. |
timestamptz |
||
suspended_valid_from |
Date from when State Suspended is valid. |
timestamptz |
||
deactivated_reason_id |
Reason for Deactivated State. |
varchar(50) |
||
deactivated_ent_date |
Date when State Deactivated was entered. |
timestamptz |
||
deactivated_valid_from |
Date from when Status Deactivated is valid. |
timestamptz |
||
pending_state_id |
Foreign Key to PendingState. Populated when Account is in Pending state. |
varchar(50) |
||
service_subscription_lookup |
Indicates whether Lookup to ServiceSubscription is needed. |
boolean |
X |
|
service_subscription_val_lkp |
Indicates whether Lookup to ServiceSubscriptionValue is needed. |
boolean |
X |
|
offer_ent_date |
Date when Offer was entered. |
timestamptz |
X |
|
offer_valid_from |
Date from when Offer is valid. |
timestamptz |
X |
|
offer_valid_to |
Date till when Offer is valid. |
timestamptz |
||
composed_index |
Composed index, consists of valueSetOn:entity. |
varchar(255) |
offer_subscription_state_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'offer_subs_state_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OfferSubscriptionStateHistory. |
varchar(40) |
X |
|
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
X |
|
state |
State of the Account. Can be 'INACTIVE', 'ACTIVE', 'SUSPENDED', 'DEACTIVATED'. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with the State. |
varchar(50) |
X |
|
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_valid_to |
Timestamp till when State is Valid. |
timestamptz |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
pending_state
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'pending_state_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PendingState. |
varchar(40) |
X |
|
value_set_on |
Indicates for which entity Pending is scheduled. |
varchar(80) |
X |
|
entity_id |
Foreign Key to Entity (Customer / Account / Subscriber / OfferSubscription). |
text |
X |
|
state |
State requested. |
varchar(80) |
X |
|
state_reason_id |
Foreign Key to StateReason. |
varchar(50) |
X |
|
state_ent_date |
Date/Time when State was entered. |
timestamptz |
X |
|
state_valid_from |
Date/Time from when State is valid. |
timestamptz |
X |
|
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
state_operation |
Operation of the Pending State. |
varchar(80) |
X |
|
state_operation_ent_date |
Date/Time when Pending State Operation was entered/modified. |
timestamptz |
X |
|
state_operation_valid_from |
Date/Time from when Pending State Operation is valid. |
timestamptz |
||
state_operation_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
scheduled_run |
Scheduled Date/Time of the State Change Run. |
timestamptz |
||
composed_index |
Composed index, consists of valueSetOn:entity. |
varchar(255) |
X |
service_subscription
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'service_subscription_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ServiceSubscription. |
varchar(40) |
X |
|
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
X |
|
offer_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
value_set_on |
Indicates to which entity Service is subscribed to. |
varchar(80) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
varchar(50) |
|||
account_segment_id |
Foreign Key to Account Segment. |
varchar(50) |
||
subscriber_id |
varchar(50) |
|||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
product_id |
varchar(50) |
X |
||
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
service_type |
Type of the Service. |
varchar(80) |
X |
|
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
X |
|
state |
varchar(80) |
X |
||
state_reason_id |
Foreign Key to StateReason. |
varchar(50) |
||
state_ent_date |
Date when State was entered. |
timestamptz |
X |
|
state_valid_from |
Date from when State is valid. |
timestamptz |
X |
|
pending_state_id |
Foreign Key to PendingState. Populated when Account is in Pending state. |
varchar(50) |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
offer_ent_date |
Date when Offer was entered. |
timestamptz |
X |
|
offer_valid_from |
Date from when Offer is valid. |
timestamptz |
X |
|
offer_valid_to |
Date till when Offer is valid. |
timestamptz |
||
class_name |
Discriminator column to recognize which entity sets the value. |
varchar(255) |
||
composed_index |
Composed index, consists of valueSetOn:entity:serviceType. |
varchar(255) |
service_subscription_state_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'service_subs_state_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ServiceSubscriptionStateHistory. |
varchar(40) |
X |
|
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
X |
|
state |
State of the Account. Can be 'I', 'A', 'S', 'D'. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with the State. |
varchar(50) |
X |
|
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_valid_to |
Timestamp till when State is Valid. |
timestamptz |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
subscriber
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'subscriber_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Subscriber. |
varchar(40) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
account_type_id |
Type of the account. |
varchar(50) |
X |
|
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
external_id |
External ID of the Subscriber. |
varchar(255) |
||
custom_name |
Custom Subscriber name. |
varchar(255) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
state |
State of the Subscriber. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
|
inactive_reason_id |
Reason associated with Inactive State. |
varchar(50) |
||
inactive_ent_date |
Timestamp when Inactive State was entered. |
timestamptz |
||
inactive_valid_from |
Timestamp from when Inactive State is Valid and when Inactive State was entered. |
timestamptz |
||
activated_reason_id |
Reason associated with Activated State. |
varchar(50) |
||
activated_ent_date |
Timestamp when Activated State was entered. |
timestamptz |
||
activated_valid_from |
Timestamp from when Activated State is Valid. |
timestamptz |
||
re_activated_reason_id |
Reason associated with Re-Activated State. |
varchar(50) |
||
re_activated_ent_date |
Timestamp when Re-Activated State was entered. |
timestamptz |
||
re_activated_valid_from |
Timestamp from when Re-Activated State is Valid. |
timestamptz |
||
suspended_reason_id |
Reason associated with Suspended State. |
varchar(50) |
||
suspended_ent_date |
Timestamp when Suspended State was entered. |
timestamptz |
||
suspended_valid_from |
Timestamp from when Suspended State is Valid. |
timestamptz |
||
deactivated_reason_id |
Reason associated with Deactivated State. |
varchar(50) |
||
deactivated_ent_date |
Timestamp when Deactivated State was entered. |
timestamptz |
||
deactivated_valid_from |
Timestamp from when Deactivated State is Valid. |
timestamptz |
||
pending_state_id |
Foreign Key to PendingState. Populated when Account is in Pending state. |
varchar(50) |
||
primary_resource_type_id |
Foreign Key to ResourceType. |
varchar(50) |
||
primary_resource_value |
Value of the Primary Resource. |
varchar(255) |
||
primary_resource_valid_from |
Timestamp from when Primary Resource is valid. |
timestamptz |
||
primary_resource_valid_to |
Timestamp till when Primary Resource is valid. |
timestamptz |
||
primary_resource_index |
${FIELD.DESCRIPTION} |
varchar(280) |
subscriber_profile
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'subscriber_profile_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SubscriberProfile. |
varchar(40) |
X |
|
name |
Name of the SubscriberProfile. |
varchar(80) |
X |
|
description |
Description of the SubscriberProfile. |
varchar(255) |
||
internal_code |
Internal Code of the SubscriberProfile. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the SubscriberProfile may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
offer_ids |
IDs of Offers initially activated. |
text |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
subscriber_state |
State to which Reason belongs to. |
varchar(80) |
X |
|
subscriber_state_reason_id |
Initial Subscriber State Reason. |
varchar(50) |
||
customer_profile_id |
Foreign key to Customer Profile. |
varchar(50) |
X |
|
account_profile_id |
Foreign key to Account Profile. |
varchar(50) |
X |
subscriber_resource
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'subscriber_resource_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SubscriberResource. |
varchar(40) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
subscriber_id |
Subscriber owning the Resource. Foreign Key to Resource. |
varchar(50) |
X |
|
resource_type_id |
Foreign Key to Resource Type. |
varchar(50) |
X |
|
resource_value |
Value of the Resource. |
varchar(255) |
X |
|
valid_from |
From when Resource is Valid. |
timestamptz |
X |
|
valid_to |
Till when Resource is valid. |
timestamptz |
||
composed_index |
Composed index, consists of resourceType:resourceValue. |
varchar(255) |
subscriber_state_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'subscriber_state_hist_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SubscriberStateHistory. |
varchar(40) |
X |
|
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
X |
|
state |
State of the Subscriber. |
varchar(80) |
X |
|
state_reason_id |
Reason associated with State. |
varchar(50) |
||
state_ent_date |
Timestamp when State was entered. |
timestamptz |
X |
|
state_valid_from |
Timestamp from when State is Valid. |
timestamptz |
X |
|
state_valid_to |
Timestamp till when State is Valid. |
timestamptz |
||
state_transaction_id |
Transaction ID for grouping changing of States into one logical transaction. |
varchar(255) |
X |
Core - Configuration
account_profile
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_profile_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountProfile. |
varchar(40) |
X |
|
name |
Name of the AccountProfile. |
varchar(80) |
X |
|
description |
Description of the AccountProfile. |
varchar(255) |
||
internal_code |
Internal Code of the AccountProfile. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the AccountProfile may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to Account Segment. |
varchar(50) |
||
billcycle_id |
Foreign key to Billcycle. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
account_state |
State to which Reason belongs to. |
varchar(80) |
X |
|
account_state_reason_id |
Initial Account State Reason. |
varchar(50) |
||
customer_profile_id |
Foreign Key to Customer Profile. |
varchar(50) |
X |
|
payment_responsible |
Indicates whether Account is Payment Responsible. |
boolean |
account_segment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_segment_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountSegment. |
varchar(40) |
X |
|
name |
Name of the AccountSegment. |
varchar(80) |
X |
|
description |
Description of the AccountSegment. |
varchar(255) |
||
internal_code |
Internal Code of the AccountSegment. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the AccountSegment may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
bigint |
account_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'account_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AccountType. |
varchar(40) |
X |
|
name |
Name of the AccountType. |
varchar(80) |
X |
|
description |
Description of the AccountType. |
varchar(255) |
||
internal_code |
Internal Code of the AccountType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the AccountType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
SEQ No for sorting in GUI. |
bigint |
X |
|
payment_responsible |
Indicates whether Account is Payment Responsible. |
boolean |
bill_cycle
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'bill_cycle_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BillCycle. |
varchar(40) |
X |
|
name |
Name of the BillCycle. |
varchar(80) |
X |
|
description |
Description of the BillCycle. |
varchar(255) |
||
internal_code |
Internal Code of the BillCycle. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the BillCycle may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
bill_cycle_type |
Type of the Bill Cycle. |
varchar(80) |
X |
|
duration |
Duration of the Billing Cycle. |
bigint |
||
billing_period |
Time Unit used for Duration. |
varchar(80) |
||
billing_day |
Day of the Billing. |
bigint |
||
billing_month |
Month of the Billing. |
bigint |
||
automatic_billing |
Indicates whether Billing is started automatically. |
boolean |
||
billing_offset |
Offset in hours to start Automatic Billing. |
bigint |
||
individual |
Indicates whether Billing days may be individual per Account. |
boolean |
||
adjustment_type |
Adjustment Type. |
varchar(80) |
||
parent_id |
Foreign Key to parent Bill Cycle. |
varchar(50) |
charging_class
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'charging_class_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ChargingClass. |
varchar(40) |
X |
|
name |
Name of the ChargingClass. |
varchar(80) |
X |
|
description |
Description of the ChargingClass. |
varchar(255) |
||
code |
Charging Class Code for External reference. |
varchar(255) |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
on_fee |
Indicates whether Charging Class is used during Fee definition. |
boolean |
||
on_usage |
Indicates whether Charging Class is used during Usage definition. |
boolean |
||
on_discount |
Indicates whether Charging Class is used during Discount definition. |
boolean |
||
parent_id |
Foreign Key to parent ChargingClass. |
varchar(50) |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
community
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'community_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Community. |
varchar(40) |
X |
|
name |
Name of the Community. |
varchar(80) |
X |
|
description |
Description of the Community. |
varchar(255) |
||
internal_code |
Internal Code of the Community. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Community may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
community_type |
Type of Community - Customer, Account, Subscriber. |
varchar(80) |
X |
country
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'country_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Country. |
varchar(40) |
X |
|
name |
Name of the Country. |
varchar(80) |
X |
|
description |
Description of the Country. |
varchar(255) |
||
code |
ISO Code of the Country. |
varchar(2) |
X |
|
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
country_state
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'country_state_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CountryState. |
varchar(40) |
X |
|
name |
Name of the CountryState. |
varchar(80) |
X |
|
description |
Description of the CountryState. |
varchar(255) |
||
country_id |
Foreign Key to Country. |
varchar(50) |
X |
|
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
currency
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'currency_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Currency. |
varchar(40) |
X |
|
name |
Name of the Currency. |
varchar(80) |
X |
|
description |
Description of the Currency. |
varchar(255) |
||
code |
ISO 4217 code (3 letters). |
varchar(3) |
X |
|
symbol |
Symbol of the Currency. |
varchar(3) |
X |
|
symbol_prepended |
Indicates wheter Symbol is Appended, default TRUE. |
boolean |
||
flag_url |
Flag URL. |
varchar(255) |
||
precision_gui |
Precision configured for the GUI. |
bigint |
X |
|
precision_invoice |
Precision configured for Invoicing. |
bigint |
X |
|
virtual |
Indicates whether Currency is Virtual. |
boolean |
||
is_primary |
Indicates whether Currency is Primary. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
currency_pair
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'currency_pair_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CurrencyPair. |
varchar(40) |
X |
|
currency_pair |
Concatenated from Currency From and Currency To. |
varchar(255) |
X |
|
currency_from_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
quantity_from |
Quantity for Currency From. |
bigint |
X |
|
currency_to_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
quantity_to |
Quantity for Curency To. |
bigint |
X |
customer_profile
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'customer_profile_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomerProfile. |
varchar(40) |
X |
|
name |
Name of the CustomerProfile. |
varchar(80) |
X |
|
description |
Description of the CustomerProfile. |
varchar(255) |
||
internal_code |
Internal Code of the CustomerProfile. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CustomerProfile may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
customer_segment_id |
Foreign key to Customer Segment. |
varchar(50) |
||
customer_state |
State to which Reason belongs to. |
varchar(80) |
X |
|
customer_state_reason_id |
Initial Customer State Reason. |
varchar(50) |
customer_segment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'customer_segment_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CustomerSegment. |
varchar(40) |
X |
|
name |
Name of the CustomerSegment. |
varchar(80) |
X |
|
description |
Description of the CustomerSegment. |
varchar(255) |
||
internal_code |
Internal Code of the CustomerSegment. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CustomerSegment may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
bigint |
X |
exchange_rate
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'exchange_rate_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExchangeRate. |
varchar(40) |
X |
|
value_set_on |
Indicates to which entity Exchange Rate is configured. |
varchar(80) |
||
currency_pair_id |
Foreign Key to CurrencyPair. |
varchar(50) |
X |
|
exchange_rate |
Exchange Rate. |
bigint |
X |
|
valid_from |
Date/Time from when Rate is valid. |
timestamptz |
X |
|
valid_to |
Date/Time till when Rate is valid. |
timestamptz |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
composed_index |
Composed index, consists of valueSetOn:entity. |
varchar(255) |
gl_code
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'gl_code_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the GlCode. |
varchar(40) |
X |
|
name |
Name of the GlCode. |
varchar(80) |
X |
|
description |
Description of the GlCode. |
varchar(255) |
||
internal_code |
Internal Code of the GlCode. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the GlCode may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
splited |
Indicates whether GL is splited. |
boolean |
||
portion |
Split portion in %, if null the remaining portion up to 100%. |
bigint |
||
parent_id |
Foreign Key to parent GL in case GL is splited. |
varchar(50) |
offer
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'offer_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Offer. |
varchar(40) |
X |
|
name |
Name of the Offer. |
varchar(80) |
X |
|
description |
Description of the Offer. |
varchar(255) |
||
internal_code |
Internal Code of the Offer. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Offer may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
priority |
Priority of the Offer. |
bigint |
X |
|
chargeable |
Indicates whether Offer contain a Service which can generate Chargeable Events. |
boolean |
||
value_set_on |
Indicates on which entity Offer is created. Limited to OFFER, CUSTOMER, ACCOUNT. |
varchar(80) |
X |
|
customer_id |
Foreign Key to Customer. Populated only when Offer is created on Customer or Account level. |
varchar(50) |
||
account_id |
Foreign Key to Account. Populated only when Offer is created on Account level. |
varchar(50) |
||
master |
Indicates whether other Offers can be inherited. |
boolean |
||
custom_name |
Custom Offer name. Populated only when Offer is created on Customer or Account level. |
varchar(255) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
parent_id |
Foreign Key to parent Offer. |
varchar(50) |
||
composed_index |
Composed index, consists of customer:account. |
varchar(255) |
operator
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'operator_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Operator. |
varchar(40) |
X |
|
name |
Name of the Operator. |
varchar(80) |
X |
|
description |
Description of the Operator. |
varchar(255) |
||
internal_code |
Internal Code of the Operator. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Operator may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
operator_type_id |
${FIELD.DESCRIPTION} |
varchar(50) |
X |
|
url |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
parent_id |
${FIELD.DESCRIPTION} |
varchar(50) |
operator_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'operator_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OperatorType. |
varchar(40) |
X |
|
name |
Name of the OperatorType. |
varchar(80) |
X |
|
description |
Description of the OperatorType. |
varchar(255) |
||
internal_code |
Internal Code of the OperatorType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the OperatorType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
product
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'product_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Product. |
varchar(40) |
X |
|
name |
Name of the Product. |
varchar(80) |
X |
|
description |
Description of the Product. |
varchar(255) |
||
internal_code |
Internal Code of the Product. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Product may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
chargeable |
Indicates whether Product contain a Service which can generate Chargeable Events. |
boolean |
||
recurrent |
Indicates whether Product contain a Service which is Recurrent. |
boolean |
||
offer_parameter |
Indicates whether Product’s Service(s) has Offer parameter. |
boolean |
||
product_parameter |
Indicates whether Product’s Service(s) has Product parameter. |
boolean |
||
subscriber_parameter |
Indicates whether Product’s Service(s) has Subscriber parameter. |
boolean |
||
single_service |
Indicates whether Product has single service. |
boolean |
||
transient_service |
Indicates whether Product has transient service. |
boolean |
||
resource_required |
Indicates whether Resource is required. |
boolean |
||
individual_offer |
Indicates whether Product supports Individual Offer. |
boolean |
||
|
Indicates whether Product is hidden on Invoice. |
boolean |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
product_service
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'product_service_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProductService. |
varchar(40) |
X |
|
name |
Name of the ProductService. |
varchar(80) |
X |
|
description |
Description of the ProductService. |
varchar(255) |
||
internal_code |
Internal Code of the ProductService. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ProductService may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
service_id |
Service belonging to the Product. Foreign Key to Service. |
varchar(50) |
X |
|
seqno |
Seq No, used for sorting of Services in the Product definition. |
bigint |
X |
|
chargeable |
Indicates whether Product contain a Service which can generate Chargeable Events. |
boolean |
||
offer_parameter |
Indicates whether Service has Offer parameter. |
boolean |
||
product_parameter |
Indicates whether Service has Product parameter. |
boolean |
||
subscriber_parameter |
Indicates whether Service has Subscriber parameter. |
boolean |
product_value
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'product_value_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProductValue. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
description |
${FIELD.DESCRIPTION} |
varchar(255) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to Account Segment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
product_version_id |
Foreign Key to ProductVersion. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
chargeable |
Indicates whether ProductValue contain a Service which can generate Chargeable Events. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
composed_index |
Composed index, consists of valueSetOn:entity. |
varchar(255) |
product_version
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'product_version_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProductVersion. |
varchar(40) |
X |
|
name |
Name of the ProductVersion. |
varchar(80) |
X |
|
description |
Description of the ProductVersion. |
varchar(255) |
||
internal_code |
Internal Code of the ProductVersion. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ProductVersion may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
value_set_on |
Indicates to which entity Version is created for. |
varchar(80) |
X |
|
valid_from |
Date/Time from when Version is valid. |
timestamptz |
||
valid_to |
Date/Time till when Version is valid. |
timestamptz |
rating_characteristic
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'rating_characteristic_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RatingCharacteristic. |
varchar(40) |
X |
|
name |
Name of the RatingCharacteristic. |
varchar(80) |
X |
|
description |
Description of the RatingCharacteristic. |
varchar(255) |
||
internal_code |
Internal Code of the RatingCharacteristic. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the RatingCharacteristic may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
resource_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'resource_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ResourceType. |
varchar(40) |
X |
|
name |
Name of the ResourceType. |
varchar(80) |
X |
|
description |
Description of the ResourceType. |
varchar(255) |
||
internal_code |
Internal Code of the ResourceType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ResourceType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
bigint |
X |
||
is_primary |
Indicates whether resource type is primary. |
boolean |
service
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'service_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Service. |
varchar(40) |
X |
|
name |
Name of the Service. |
varchar(80) |
X |
|
description |
Description of the Service. |
varchar(255) |
||
internal_code |
Internal Code of the Service. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Service may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
service_types |
${FIELD.DESCRIPTION} |
varchar |
||
instantiable |
Indicates whether Service can be intantiated (True), otherwise it is considered as Abstract. |
boolean |
||
chargeable |
Indicates whether Service can generate Chargeable Events. |
boolean |
||
recurrent |
Indicates whether Service is recurrent. |
boolean |
||
singleton |
Indicates whether Service is Singleton within the Product. |
boolean |
||
is_transient |
Indicates whether Service is Transient. |
boolean |
||
resource_required |
Indicates whether Resource is required. |
boolean |
||
individual_offer |
Indicates whether Service supports Individual Offer. |
boolean |
||
base_id |
Foreign Key to Base Service (for inheritances purposes). |
varchar(50) |
||
class_name |
${FIELD.DESCRIPTION} |
varchar(255) |
X |
|
offer_parameter |
Indicates whether Service has Offer parameter. |
boolean |
||
product_parameter |
Indicates whether Service has Product parameter. |
boolean |
||
subscriber_parameter |
Indicates whether Service has Subscriber parameter. |
boolean |
||
service_doc_url |
URL for documentation of the Service. |
varchar(255) |
service_dependency
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'service_dependency_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ServiceDependency. |
varchar(40) |
X |
|
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
depends_on_id |
Foreign Key to Dependent Service. |
varchar(50) |
X |
service_parameter
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'service_parameter_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ServiceParameter. |
varchar(40) |
X |
|
name |
Name of the ServiceParameter. |
varchar(80) |
X |
|
description |
Description of the ServiceParameter. |
varchar(255) |
||
internal_code |
Internal Code of the ServiceParameter. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ServiceParameter may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
seqno |
Seq No for ordering of the parameters within one Service. |
bigint |
X |
|
service_parameter_type |
Foreign Key to Service Parameter Type, implemented as Enumeration. |
varchar(80) |
||
offer |
Indicates whether Parameter is used in the Offer definition. |
boolean |
||
product |
Indicates whether Parameter is used in the Product definition. |
boolean |
||
provisioning |
Indicates whether Parameter is Provisioned to the external system. |
boolean |
||
rating |
Indicates whether Parameter is used in Rating. Note - Offer parameters are used in Rating by default. |
boolean |
||
override |
Indicates whether Parameter can be overridden on Subscription level. |
boolean |
||
required |
Indicates whether Parameter is required. |
boolean |
||
min_length |
Minimal Length for String values. |
bigint |
||
max_length |
Maximal Length for String values. |
bigint |
||
regexpcond |
Regular Expression condition. |
varchar(255) |
special_day
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'special_day_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SpecialDay. |
varchar(40) |
X |
|
name |
Name of the SpecialDay. |
varchar(80) |
X |
|
description |
Description of the SpecialDay. |
varchar(255) |
||
country_id |
Foreign Key to Country. |
varchar(50) |
X |
|
country_state_id |
Foreign Key to CountryState. |
varchar(50) |
||
day |
Day of Public Holiday. |
timestamptz |
X |
|
recurrent |
Indicates whether Date is recurrent (every year). |
boolean |
state_reason
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'state_reason_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the StateReason. |
varchar(40) |
X |
|
name |
Name of the StateReason. |
varchar(80) |
X |
|
description |
Description of the StateReason. |
varchar(255) |
||
internal_code |
Internal Code of the StateReason. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the StateReason may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
bigint |
|||
state |
State to which Reason belongs to. |
varchar(80) |
X |
|
charged |
Indicates whether Reason is Charged (Pro-Rated, etc.). |
boolean |
subscriber_segment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'subscriber_segment_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SubscriberSegment. |
varchar(40) |
X |
|
name |
Name of the SubscriberSegment. |
varchar(80) |
X |
|
description |
Description of the SubscriberSegment. |
varchar(255) |
||
internal_code |
Internal Code of the SubscriberSegment. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the SubscriberSegment may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
seqno |
bigint |
tax
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'tax_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Tax. |
varchar(40) |
X |
|
name |
Name of the Tax. |
varchar(80) |
X |
|
description |
Description of the Tax. |
varchar(255) |
||
internal_code |
Internal Code of the Tax. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Tax may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
tax_exemption |
Indicates whether Tax is subject of Tax exemption. If true, TaxExemptionType on Invoice is set to OFFER_TAX. |
boolean |
||
seqno |
Seqno. |
bigint |
tax_value
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'tax_value_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the TaxValue. |
varchar(40) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
X |
|
value |
Value of the Tax. |
bigint |
X |
|
value_ent_date |
timestamptz |
X |
||
value_valid_from |
Timestamp from when Tax Value is valid. |
timestamptz |
||
value_valid_to |
Timestamp till when Tax Value is valid. |
timestamptz |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
time_period
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'time_period_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the TimePeriod. |
varchar(40) |
X |
|
name |
Name of the TimePeriod. |
varchar(80) |
X |
|
description |
Description of the TimePeriod. |
varchar(255) |
||
internal_code |
Internal Code of the TimePeriod. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the TimePeriod may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
monday |
Indicates whether Monday is included. |
boolean |
||
tuesday |
Indicates whether Tuesday is included. |
boolean |
||
wednesday |
Indicates whether Wednesday is included. |
boolean |
||
thursday |
Indicates whether Thursday is included. |
boolean |
||
friday |
Indicates whether Friday is included. |
boolean |
||
saturday |
Indicates whether Saturday is included. |
boolean |
||
sunday |
Indicates whether Sunday is included. |
boolean |
||
special_day |
Indicates whether Special Days are included. |
boolean |
||
time_from |
Time Period From. |
timestamptz |
||
time_to |
Time Period To. |
timestamptz |
time_period_group
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'time_period_group_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the TimePeriodGroup. |
varchar(40) |
X |
|
name |
Name of the TimePeriodGroup. |
varchar(80) |
X |
|
description |
Description of the TimePeriodGroup. |
varchar(255) |
||
internal_code |
Internal Code of the TimePeriodGroup. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the TimePeriodGroup may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
time_period_ids |
IDs of the Time Period included. |
text |
usage_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'usage_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the UsageType. |
varchar(40) |
X |
|
name |
Name of the UsageType. |
varchar(80) |
X |
|
description |
Description of the UsageType. |
varchar(255) |
||
internal_code |
Internal Code of the UsageType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the UsageType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
X |
|
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
duplicity_checked |
Indicates whether to check for Duplicity of the Requests. |
boolean |
||
units_of_measurement |
Units Of Measurement. |
varchar(80) |
||
chargeable_event_stored |
Indicates whether to store Chargeable Event. |
boolean |
||
rejected_event_stored |
Indicates whether to store Rejected Event. |
boolean |
||
request_stored |
Indicates whether to store Request. |
boolean |
||
rating_result_stored |
Indicates whether to store Rating Result. |
boolean |
||
balances_responsed |
Indicates whether to include affected Balances in the Response. |
boolean |
||
streaming_disabled |
Indicates whether Request/Response streaming is disabled. |
boolean |
||
xcur_allowed |
Indicates whether ECUR/SCUR charging is allowed. |
boolean |
||
xcur_timeout |
Timeout of Reservation in case ECUR or SCUR charging in seconds. |
bigint |
||
xcur_quota |
Quota which is requested in case ECUR or SCUR charging in Units associated with UOM. |
bigint |
||
xcur_quota_min |
Quota which is minimally granted in case ECUR or SCUR charging in Units associated with UOM. |
bigint |
||
aggregation_level |
varchar(80) |
X |
||
composed_index |
Composed index, consists of product:productService. |
varchar(255) |
Processes
process_log
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'process_log_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProcessLog. |
varchar(40) |
X |
|
log_date |
Date/Time of the Log entry. |
timestamptz |
X |
|
logger |
Name of the Logger. |
varchar(80) |
X |
|
message |
Log message. |
varchar(255) |
||
parameters |
Main parameters of the log using for filtering. |
text |
Generic - Configuration
absolute_billing_discount
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_absolute_billing_disc_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AbsoluteBillingDiscount. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
ind_offer_attr_tax_included |
${FIELD.DESCRIPTION} |
varchar |
||
discount |
Amount of discount in Monetary units. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
||
billing_discount_type |
Reference to BillingDiscountType. |
varchar(80) |
X |
|
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_thresholds |
Indicates whether to Pro-Rate Min a Max Thresholds. |
boolean |
||
per_unit |
(Discount) Per Unit. |
bigint |
||
per_unit_uom |
(Discount) Per Unit UoM. |
varchar(80) |
absolute_discount
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_absolute_discount_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AbsoluteDiscount. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
ind_offer_attr_tax_included |
${FIELD.DESCRIPTION} |
varchar |
||
discount |
Amount of discount in Monetary units. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
activation_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_activation_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ActivationFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
auto_provisioning
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_auto_provisioning_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AutoProvisioning. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
product_provis_id |
Foreign Key to Product. |
varchar(50) |
X |
|
offer_provis_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
subscribe_on |
On which entity will be Offer subscribed. |
varchar(80) |
X |
|
account_type_id |
Foreign Key to AccountType. Populated only if subscribeOn == ACCOUNT. |
varchar(50) |
||
state |
Initial Subscription state. |
varchar(80) |
X |
|
state_reason_id |
Foreign Key to StateReason. |
varchar(50) |
X |
|
singleton |
Indicates whether Subscription could be provisioned only once. |
boolean |
balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Balance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
balance_def |
Definition of the Balance in JSON. |
varchar |
||
notification_def |
Definition of the Notification in JSON. |
varchar |
||
validity |
Validity of the Balance. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
billing_credit
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_billing_credit_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BillingCredit. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
billing_fee_type |
Reference to BillingFeeType. |
varchar(80) |
X |
|
charge |
${FIELD.DESCRIPTION} |
varchar |
billing_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_billing_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the BillingFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
billing_fee_type |
Reference to BillingFeeType. |
varchar(80) |
X |
|
charge |
${FIELD.DESCRIPTION} |
varchar |
charge_override
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_charge_override_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ChargeOverride. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
charge_override_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'charge_override_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ChargeOverrideCharge. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to ServiceValue. |
varchar(50) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
charge_valid_from |
Timestamp from when Charge is valid. |
timestamptz |
||
charge_valid_to |
Timestamp till when Charge is valid. |
timestamptz |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:chargingClass. |
varchar(255) |
X |
cost_control_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_costcontrol_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CostControlBalance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
balance_def |
Definition of the Balance in JSON. |
varchar |
||
notification_def |
Definition of the Notification in JSON. |
varchar |
||
validity |
Validity of the Balance. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
deactivation_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_deactivation_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DeactivationFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
generic_counter
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_generic_counter_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the GenericCounter. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
initial_value |
Initial value of the Counter, by default set to 0. |
bigint |
||
max_value |
If counter value reaches maxValue, LIMIT_REACHED Result Code is returned on Charging API. |
bigint |
||
value |
Actual value of the Counter. |
bigint |
||
units_of_measurement |
Define in which Units is Counter measured. |
varchar(80) |
maximal_spent
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_maximal_spent_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MaximalSpent. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
ind_offer_attr_tax_included |
${FIELD.DESCRIPTION} |
varchar |
||
discount |
Amount of discount in Monetary units. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
||
billing_discount_type |
Reference to BillingDiscountType. |
varchar(80) |
X |
|
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_thresholds |
Indicates whether to Pro-Rate Min a Max Thresholds. |
boolean |
||
per_unit |
(Discount) Per Unit. |
bigint |
||
per_unit_uom |
(Discount) Per Unit UoM. |
varchar(80) |
minimal_spent
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_minimal_spent_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MinimalSpent. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
ind_offer_attr_tax_included |
${FIELD.DESCRIPTION} |
varchar |
||
discount |
Amount of discount in Monetary units. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
||
billing_discount_type |
Reference to BillingDiscountType. |
varchar(80) |
X |
|
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_thresholds |
Indicates whether to Pro-Rate Min a Max Thresholds. |
boolean |
||
per_unit |
(Discount) Per Unit. |
bigint |
||
per_unit_uom |
(Discount) Per Unit UoM. |
varchar(80) |
monetary_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_monetary_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MonetaryBalance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
balance_def |
Definition of the Balance in JSON. |
varchar |
||
notification_def |
Definition of the Notification in JSON. |
varchar |
||
validity |
Validity of the Balance. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
offer_subscription_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_offer_subs_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OfferSubscriptionFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
one_time_credit
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_onetime_credit_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OneTimeCredit. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
one_time_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_onetime_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the OneTimeFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
percentage_billing_discount
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_perc_billing_discount_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PercentageBillingDiscount. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
discount |
Amount of discount in Percent. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
||
discount_min |
If populated, discount is set to this value in case calculated discount is lower. |
bigint |
||
discount_max |
If populated, discount is set to this value in case calculated discount is greater. |
bigint |
||
billing_discount_type |
Reference to BillingDiscountType. |
varchar(80) |
X |
|
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_thresholds |
Indicates whether to Pro-Rate Min a Max Thresholds. |
boolean |
||
discount_base |
Discount Base. |
varchar(80) |
percentage_discount
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_perc_discount_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PercentageDiscount. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
event_generated |
Indicates whether Tax Separate Discount Event is generated. |
boolean |
||
discount |
Amount of discount in Percent. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when discount is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when discount is applied. |
bigint |
||
discount_min |
If populated, discount is set to this value in case calculated discount is lower. |
bigint |
||
discount_max |
If populated, discount is set to this value in case calculated discount is greater. |
bigint |
pre_charged
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_pre_charged_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PreCharged. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
product_opt_out
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_product_opt_out_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProductOptOut. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
product_out_id |
Foreign Key to Product. |
varchar(50) |
X |
|
offer_out_id |
Foreign Key to Offer. |
varchar(50) |
re_activation_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_reactivation_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ReActivationFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
recurrent_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_recurrent_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RecurrentBalance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
execute_at |
When is recurrence executed. |
varchar(80) |
||
executed_immediately |
Indicates whether first cycle is executed immediately for non product-subscription recurrences. |
boolean |
||
pro_rate_active |
Indicates whether to Pro-Rate when State become Active. |
boolean |
||
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_ratio |
In case Pro-Rated, stores calculated Ratio of the Pro-Rating. |
bigint |
||
recurrence |
Recurrence every X (Recurrence Period). |
bigint |
||
recurrence_period |
Recurrence every (Recurrence) Period. |
varchar(80) |
||
recurrence_cycles |
Number of cycles. If empty, unlimited. |
bigint |
||
last_run |
Last Run of the Recurrent job. |
timestamptz |
||
next_run |
Scheduled Run of the Next Recurrent job. |
timestamptz |
||
period_start |
Start Date/Time of the Recurrent Period. |
timestamptz |
||
period_end |
End Date/Time of the Recurrent Period. |
timestamptz |
||
cycle |
SeqNo of the Cycle. |
bigint |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
||
balance_def |
${FIELD.DESCRIPTION} |
varchar |
||
notification_def |
${FIELD.DESCRIPTION} |
varchar |
||
roll_over |
Method how remaining Balance is Rolled-Over to next cycle. |
varchar(80) |
X |
|
roll_over_cycles |
How many Cycles is Ballance Rolled-over to next cycles. |
bigint |
recurrent_cost_control_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_rec_cost_ctrl_bal_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RecurrentCostControlBalance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
execute_at |
When is recurrence executed. |
varchar(80) |
||
executed_immediately |
Indicates whether first cycle is executed immediately for non product-subscription recurrences. |
boolean |
||
pro_rate_active |
Indicates whether to Pro-Rate when State become Active. |
boolean |
||
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_ratio |
In case Pro-Rated, stores calculated Ratio of the Pro-Rating. |
bigint |
||
recurrence |
Recurrence every X (Recurrence Period). |
bigint |
||
recurrence_period |
Recurrence every (Recurrence) Period. |
varchar(80) |
||
recurrence_cycles |
Number of cycles. If empty, unlimited. |
bigint |
||
last_run |
Last Run of the Recurrent job. |
timestamptz |
||
next_run |
Scheduled Run of the Next Recurrent job. |
timestamptz |
||
period_start |
Start Date/Time of the Recurrent Period. |
timestamptz |
||
period_end |
End Date/Time of the Recurrent Period. |
timestamptz |
||
cycle |
SeqNo of the Cycle. |
bigint |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
||
balance_def |
${FIELD.DESCRIPTION} |
varchar |
||
notification_def |
${FIELD.DESCRIPTION} |
varchar |
||
roll_over |
Method how remaining Balance is Rolled-Over to next cycle. |
varchar(80) |
X |
|
roll_over_cycles |
How many Cycles is Ballance Rolled-over to next cycles. |
bigint |
recurrent_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_recurrent_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RecurrentFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
execute_at |
When is recurrence executed. |
varchar(80) |
||
executed_immediately |
Indicates whether first cycle is executed immediately for non product-subscription recurrences. |
boolean |
||
pro_rate_active |
Indicates whether to Pro-Rate when State become Active. |
boolean |
||
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_ratio |
In case Pro-Rated, stores calculated Ratio of the Pro-Rating. |
bigint |
||
recurrence |
Recurrence every X (Recurrence Period). |
bigint |
||
recurrence_period |
Recurrence every (Recurrence) Period. |
varchar(80) |
||
recurrence_cycles |
Number of cycles. If empty, unlimited. |
bigint |
||
last_run |
Last Run of the Recurrent job. |
timestamptz |
||
next_run |
Scheduled Run of the Next Recurrent job. |
timestamptz |
||
period_start |
Start Date/Time of the Recurrent Period. |
timestamptz |
||
period_end |
End Date/Time of the Recurrent Period. |
timestamptz |
||
cycle |
SeqNo of the Cycle. |
bigint |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
per_unit |
(Charge) Per Unit. |
bigint |
||
per_unit_uom |
(Charge) Per Unit UoM. |
varchar(80) |
recurrent_monetary_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_rec_monetary_bal_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RecurrentMonetaryBalance. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
execute_at |
When is recurrence executed. |
varchar(80) |
||
executed_immediately |
Indicates whether first cycle is executed immediately for non product-subscription recurrences. |
boolean |
||
pro_rate_active |
Indicates whether to Pro-Rate when State become Active. |
boolean |
||
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_ratio |
In case Pro-Rated, stores calculated Ratio of the Pro-Rating. |
bigint |
||
recurrence |
Recurrence every X (Recurrence Period). |
bigint |
||
recurrence_period |
Recurrence every (Recurrence) Period. |
varchar(80) |
||
recurrence_cycles |
Number of cycles. If empty, unlimited. |
bigint |
||
last_run |
Last Run of the Recurrent job. |
timestamptz |
||
next_run |
Scheduled Run of the Next Recurrent job. |
timestamptz |
||
period_start |
Start Date/Time of the Recurrent Period. |
timestamptz |
||
period_end |
End Date/Time of the Recurrent Period. |
timestamptz |
||
cycle |
SeqNo of the Cycle. |
bigint |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
||
balance_def |
${FIELD.DESCRIPTION} |
varchar |
||
notification_def |
${FIELD.DESCRIPTION} |
varchar |
||
roll_over |
Method how remaining Balance is Rolled-Over to next cycle. |
varchar(80) |
X |
|
roll_over_cycles |
How many Cycles is Ballance Rolled-over to next cycles. |
bigint |
recurrent_tiered_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_rec_tiered_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RecurrentTieredCharge. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
execute_at |
When is recurrence executed. |
varchar(80) |
||
executed_immediately |
Indicates whether first cycle is executed immediately for non product-subscription recurrences. |
boolean |
||
pro_rate_active |
Indicates whether to Pro-Rate when State become Active. |
boolean |
||
pro_rate_not_charged |
Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'. |
boolean |
||
pro_rate_ratio |
In case Pro-Rated, stores calculated Ratio of the Pro-Rating. |
bigint |
||
recurrence |
Recurrence every X (Recurrence Period). |
bigint |
||
recurrence_period |
Recurrence every (Recurrence) Period. |
varchar(80) |
||
recurrence_cycles |
Number of cycles. If empty, unlimited. |
bigint |
||
last_run |
Last Run of the Recurrent job. |
timestamptz |
||
next_run |
Scheduled Run of the Next Recurrent job. |
timestamptz |
||
period_start |
Start Date/Time of the Recurrent Period. |
timestamptz |
||
period_end |
End Date/Time of the Recurrent Period. |
timestamptz |
||
cycle |
SeqNo of the Cycle. |
bigint |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
||
balance_def |
${FIELD.DESCRIPTION} |
varchar |
||
notification_def |
${FIELD.DESCRIPTION} |
varchar |
||
roll_over |
Method how remaining Balance is Rolled-Over to next cycle. |
varchar(80) |
X |
|
roll_over_cycles |
How many Cycles is Ballance Rolled-over to next cycles. |
bigint |
revenue_share
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_revenue_share_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RevenueShare. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
revenue_share |
Amount of Revenue share in Percent. |
bigint |
X |
|
charge_min |
If populated, indicates minimum charge when Revenue share is applied. |
bigint |
||
charge_max |
If populated, indicates maximum charge when Revenue share is applied. |
bigint |
||
share_min |
If populated, Revenue share is set to this value in case calculated Revenue share is lower. |
bigint |
||
share_max |
If populated, Revenue share is set to this value in case calculated Revenue share is greater. |
bigint |
||
tax_included |
Indicates whether Tax is included in the charge. |
boolean |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
simple_charging
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_simple_charging_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SimpleCharging. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
simple_charging_usage_mapping
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'simple_charging_usage_map_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SimpleChargingUsageMapping. |
varchar(40) |
X |
|
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
usage_type_id |
Type of the Usage. |
varchar(50) |
||
time_period_group_id |
Foreign Key to TimePeriodGroup. Either timePeriodGroup or timePeriod must be populated. |
varchar(50) |
||
time_period_id |
Foreign Key to TimePeriod. Either timePeriodGroup or timePeriod must be populated. |
varchar(50) |
||
rating_characteristic_id |
Foreign Key to RatingCharacteristic. |
varchar(50) |
||
priority |
Priority during analysis lookup - Higher number = Higher priority. |
bigint |
X |
suspend_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_suspend_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SuspendFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
state |
varchar(80) |
|||
reason_id |
varchar(50) |
|||
charge |
${FIELD.DESCRIPTION} |
varchar |
usage_barring
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_usage_barring_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the UsageBarring. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
validity |
Validity of the Add-On. |
bigint |
||
validity_period |
Valid (validity) Period(s). |
varchar(80) |
||
charging_classes |
List of applicable Charging Class IDs in JSON. |
varchar |
Charging
aggregated_event
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'aggregated_event_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the AggregatedEvent. |
varchar(40) |
X |
|
logger |
${FIELD.DESCRIPTION} |
text |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
offer_subscription_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
payment_responsible_id |
Foreign Key to Payment Responsible Account. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
account_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
subscriber_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
X |
|
offer_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
offer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
resource_type_id |
Foreign Key to ResourceType. |
varchar(50) |
||
resource_value |
Resource made the Event. |
varchar(255) |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile. |
varchar(50) |
||
event_entry |
Timestamp when event was entered. |
timestamptz |
X |
|
event_start |
Start Timestamp of the event. |
timestamptz |
X |
|
event_end |
End Timestamp of the event. |
timestamptz |
||
event_day |
Event day (YYYYMMDDHH). |
varchar(10) |
X |
|
billing_day |
Billing day (XYYYYMMDD), X = Y/M/W/D. |
varchar(10) |
X |
|
event_count |
Events count. |
bigint |
X |
|
volume |
Volume of the event as in the Charging Request. |
bigint |
X |
|
units_of_measurement |
Units Of Measurement. |
varchar(80) |
X |
|
event_total_volume |
Total Volume of the event after Charging completed. |
bigint |
X |
|
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Including Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. Calculated as a diff between totalPriceNet and totalPrice. |
bigint |
||
event_catalogue_price |
Catalogue Price per Units and UoM. Excluding Tax. |
bigint |
||
event_catalogue_price_net |
Catalogue Price per Units and UoM. Including Tax. |
bigint |
||
event_catalogue_price_per_unit |
Catalogue Price per Unit. |
bigint |
||
event_catalogue_price_per_unit_uom |
Catalogue Price per Unit UoM. |
varchar(80) |
||
rated_total_price |
Total Price after Rating. Excluding Tax. |
bigint |
||
rated_total_volume |
Total Volume after Rating. |
bigint |
||
override_unit_price |
Price passed to Charging Request which overrides Offer Price. Excluding Tax. |
bigint |
||
override_unit_price_net |
Net Price passed to Charging Request which overrides Offer Price. Including Tax. |
bigint |
||
charge_type |
Charge Type. |
varchar(80) |
X |
|
charge_tax_included |
Indicates whether Charging was performed with Tax Included charges. |
boolean |
X |
|
charge_tax_value |
Charge Tax Value applied. |
bigint |
||
pro_rate_ratio |
In case of Pro-Rating, Ratio which was used. In 0.0001%. |
bigint |
||
pro_rate_mode |
In case of Pro-Rating, Mode which was used. |
varchar(80) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
X |
|
gl_code_tax_id |
Foreign Key to GlCode for Tax. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
usage_type_id |
Foreign Key to UsageType. |
varchar(50) |
||
usage_type_code |
Usage Type Code as come in the Request. |
varchar(80) |
||
reservation_id |
ID of the Reservation in case ECUR or SCUR charging. |
varchar(80) |
||
session_id |
Session ID in case SCUR charging. |
varchar(80) |
||
request_type |
Indicates Type of the Request in case ECUR or SCUR charging. |
varchar(80) |
||
request_class_name |
Class Name of the Request. |
varchar(255) |
||
aggregated_event_id |
Foreign Key to AggregatedEvent. |
varchar(50) |
||
aggregation_level |
Aggregation Level. |
varchar(80) |
||
request_json |
Request in JSON form, may be changed using GUI. |
varchar |
||
request_unchanged_json |
Request in JSON form, unchanged. |
varchar |
||
rating_result_class_name |
Class Name of the Rating Result. |
varchar(255) |
||
rating_result_json |
Rating Result in JSON form. |
varchar |
||
parent_id |
Foreign Key to Parent ChargingEvent. |
varchar(50) |
||
charged |
Indicates whether Event is Charged. |
boolean |
||
billed |
Indicates whether Event is Billed. |
boolean |
||
rejected |
Indicates whether Event is Rejected. |
boolean |
||
guided |
Indicates whether Event is Guided. |
boolean |
||
aggregation_key |
Key used for Aggregation. |
varchar(80) |
||
composed_index |
Composed index, consists of charged:account:billCycleRun:subscriber:offerSubscription. |
varchar(255) |
chargeable_event
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'chargeable_event_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ChargeableEvent. |
varchar(40) |
X |
|
logger |
${FIELD.DESCRIPTION} |
text |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
offer_subscription_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
payment_responsible_id |
Foreign Key to Payment Responsible Account. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
account_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
subscriber_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
X |
|
offer_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
offer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
resource_type_id |
Foreign Key to ResourceType. |
varchar(50) |
||
resource_value |
Resource made the Event. |
varchar(255) |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile. |
varchar(50) |
||
event_entry |
Timestamp when event was entered. |
timestamptz |
X |
|
event_start |
Start Timestamp of the event. |
timestamptz |
X |
|
event_end |
End Timestamp of the event. |
timestamptz |
||
event_day |
Event day (YYYYMMDDHH). |
varchar(10) |
X |
|
billing_day |
Billing day (XYYYYMMDD), X = Y/M/W/D. |
varchar(10) |
X |
|
event_count |
Events count. |
bigint |
X |
|
volume |
Volume of the event as in the Charging Request. |
bigint |
X |
|
units_of_measurement |
Units Of Measurement. |
varchar(80) |
X |
|
event_total_volume |
Total Volume of the event after Charging completed. |
bigint |
X |
|
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Including Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. Calculated as a diff between totalPriceNet and totalPrice. |
bigint |
||
event_catalogue_price |
Catalogue Price per Units and UoM. Excluding Tax. |
bigint |
||
event_catalogue_price_net |
Catalogue Price per Units and UoM. Including Tax. |
bigint |
||
event_catalogue_price_per_unit |
Catalogue Price per Unit. |
bigint |
||
event_catalogue_price_per_unit_uom |
Catalogue Price per Unit UoM. |
varchar(80) |
||
rated_total_price |
Total Price after Rating. Excluding Tax. |
bigint |
||
rated_total_volume |
Total Volume after Rating. |
bigint |
||
override_unit_price |
Price passed to Charging Request which overrides Offer Price. Excluding Tax. |
bigint |
||
override_unit_price_net |
Net Price passed to Charging Request which overrides Offer Price. Including Tax. |
bigint |
||
charge_type |
Charge Type. |
varchar(80) |
X |
|
charge_tax_included |
Indicates whether Charging was performed with Tax Included charges. |
boolean |
X |
|
charge_tax_value |
Charge Tax Value applied. |
bigint |
||
pro_rate_ratio |
In case of Pro-Rating, Ratio which was used. In 0.0001%. |
bigint |
||
pro_rate_mode |
In case of Pro-Rating, Mode which was used. |
varchar(80) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
X |
|
gl_code_tax_id |
Foreign Key to GlCode for Tax. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
usage_type_id |
Foreign Key to UsageType. |
varchar(50) |
||
usage_type_code |
Usage Type Code as come in the Request. |
varchar(80) |
||
reservation_id |
ID of the Reservation in case ECUR or SCUR charging. |
varchar(80) |
||
session_id |
Session ID in case SCUR charging. |
varchar(80) |
||
request_type |
Indicates Type of the Request in case ECUR or SCUR charging. |
varchar(80) |
||
request_class_name |
Class Name of the Request. |
varchar(255) |
||
aggregated_event_id |
Foreign Key to AggregatedEvent. |
varchar(50) |
||
aggregation_level |
Aggregation Level. |
varchar(80) |
||
request_json |
Request in JSON form, may be changed using GUI. |
varchar |
||
request_unchanged_json |
Request in JSON form, unchanged. |
varchar |
||
rating_result_class_name |
Class Name of the Rating Result. |
varchar(255) |
||
rating_result_json |
Rating Result in JSON form. |
varchar |
||
parent_id |
Foreign Key to Parent ChargingEvent. |
varchar(50) |
||
charged |
Indicates whether Event is Charged. |
boolean |
||
billed |
Indicates whether Event is Billed. |
boolean |
||
rejected |
Indicates whether Event is Rejected. |
boolean |
||
guided |
Indicates whether Event is Guided. |
boolean |
||
event_invoiced_price |
Invoiced Price of the event, rounded to Currency precision. Excluding Tax. |
bigint |
||
event_invoiced_price_net |
Invoiced Price of the event, rounded to Currency precision. Including Tax. |
bigint |
||
event_invoiced_price_tax |
Tax part of the Invoiced Price. Calculated as a diff between invoicedPriceNet and invoicedPrice. |
bigint |
||
composed_index |
Composed index, consists of charged:account:billCycleRun:subscriber:offerSubscription. |
varchar(255) |
charging_request_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'chrh_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ChargingRequestHistory. |
varchar(40) |
X |
|
request_id |
ID of the Request as received. |
varchar(255) |
X |
|
request_date |
Timestamp of the Request. |
timestamptz |
X |
|
request_name |
Name of the Request. |
varchar(255) |
X |
|
request |
JSON containing Request. |
varchar |
||
charging_context |
Charging Context, Key - Value (String) Map. |
text |
||
response_date |
Timestamp of the Response. |
timestamptz |
||
response_name |
Name of the Response. In case of Bulk Response, name is taken from main Response. |
varchar(255) |
||
response |
JSON containing Response. |
varchar |
||
result_status |
Status of the Result. |
varchar(30) |
||
result_code |
Code of the Result. |
varchar(255) |
||
result |
Result in JSON. |
varchar |
||
partition_id |
Partition ID, consist of Request Name and Year, Month, Day. |
varchar(255) |
rejected_event
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'rejected_event_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the RejectedEvent. |
varchar(40) |
X |
|
logger |
${FIELD.DESCRIPTION} |
text |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
offer_subscription_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
payment_responsible_id |
Foreign Key to Payment Responsible Account. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
account_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
subscriber_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
X |
|
product_id |
Foreign Key to Product. |
varchar(50) |
X |
|
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
X |
|
offer_id |
Foreign Key to Offer. |
varchar(50) |
X |
|
offer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
resource_type_id |
Foreign Key to ResourceType. |
varchar(50) |
||
resource_value |
Resource made the Event. |
varchar(255) |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile. |
varchar(50) |
||
event_entry |
Timestamp when event was entered. |
timestamptz |
X |
|
event_start |
Start Timestamp of the event. |
timestamptz |
X |
|
event_end |
End Timestamp of the event. |
timestamptz |
||
event_day |
Event day (YYYYMMDDHH). |
varchar(10) |
X |
|
billing_day |
Billing day (XYYYYMMDD), X = Y/M/W/D. |
varchar(10) |
X |
|
event_count |
Events count. |
bigint |
X |
|
volume |
Volume of the event as in the Charging Request. |
bigint |
X |
|
units_of_measurement |
Units Of Measurement. |
varchar(80) |
X |
|
event_total_volume |
Total Volume of the event after Charging completed. |
bigint |
X |
|
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Including Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. Calculated as a diff between totalPriceNet and totalPrice. |
bigint |
||
event_catalogue_price |
Catalogue Price per Units and UoM. Excluding Tax. |
bigint |
||
event_catalogue_price_net |
Catalogue Price per Units and UoM. Including Tax. |
bigint |
||
event_catalogue_price_per_unit |
Catalogue Price per Unit. |
bigint |
||
event_catalogue_price_per_unit_uom |
Catalogue Price per Unit UoM. |
varchar(80) |
||
rated_total_price |
Total Price after Rating. Excluding Tax. |
bigint |
||
rated_total_volume |
Total Volume after Rating. |
bigint |
||
override_unit_price |
Price passed to Charging Request which overrides Offer Price. Excluding Tax. |
bigint |
||
override_unit_price_net |
Net Price passed to Charging Request which overrides Offer Price. Including Tax. |
bigint |
||
charge_type |
Charge Type. |
varchar(80) |
X |
|
charge_tax_included |
Indicates whether Charging was performed with Tax Included charges. |
boolean |
X |
|
charge_tax_value |
Charge Tax Value applied. |
bigint |
||
pro_rate_ratio |
In case of Pro-Rating, Ratio which was used. In 0.0001%. |
bigint |
||
pro_rate_mode |
In case of Pro-Rating, Mode which was used. |
varchar(80) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
X |
|
gl_code_tax_id |
Foreign Key to GlCode for Tax. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
usage_type_id |
Foreign Key to UsageType. |
varchar(50) |
||
usage_type_code |
Usage Type Code as come in the Request. |
varchar(80) |
||
reservation_id |
ID of the Reservation in case ECUR or SCUR charging. |
varchar(80) |
||
session_id |
Session ID in case SCUR charging. |
varchar(80) |
||
request_type |
Indicates Type of the Request in case ECUR or SCUR charging. |
varchar(80) |
||
request_class_name |
Class Name of the Request. |
varchar(255) |
||
aggregated_event_id |
Foreign Key to AggregatedEvent. |
varchar(50) |
||
aggregation_level |
Aggregation Level. |
varchar(80) |
||
request_json |
Request in JSON form, may be changed using GUI. |
varchar |
||
request_unchanged_json |
Request in JSON form, unchanged. |
varchar |
||
rating_result_class_name |
Class Name of the Rating Result. |
varchar(255) |
||
rating_result_json |
Rating Result in JSON form. |
varchar |
||
parent_id |
Foreign Key to Parent ChargingEvent. |
varchar(50) |
||
charged |
Indicates whether Event is Charged. |
boolean |
||
billed |
Indicates whether Event is Billed. |
boolean |
||
rejected |
Indicates whether Event is Rejected. |
boolean |
||
guided |
Indicates whether Event is Guided. |
boolean |
||
result |
${FIELD.DESCRIPTION} |
varchar |
||
event_status |
Status of the record. |
varchar(80) |
X |
|
note |
Free text note assigned to record. |
varchar(255) |
||
event_created |
Date/Time when event has been created. |
timestamptz |
X |
|
event_investigated |
Date/Time when record has been last investigated. |
timestamptz |
||
event_charged |
Date/Time when record has been successfully charged. |
timestamptz |
X |
Invoicing
control_group_account
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'control_group_account_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ControlGroupAccount. |
varchar(40) |
X |
|
control_group_id |
Foreign Key to ControlGroup. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
valid_from |
Date/Time from when Account is member of Control Group. |
timestamptz |
X |
|
valid_to |
Date/Time till when Account is member of Control Group. |
timestamptz |
||
composed_index |
Composed index, consists of controlGroup:account. |
varchar(255) |
control_group_run
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'control_group_run_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ControlGroupRun. |
varchar(40) |
X |
|
control_group_id |
Foreign Key to ControlGroup. |
varchar(50) |
X |
|
bill_cycle_type |
Type of the Billing Cycle. |
varchar(80) |
X |
|
effective_date |
Effective Date/Time for which Invoice within Control Group is calculated. If null, Account’s Billing period end date is effective. |
timestamptz |
||
ent_date |
Date/Time when request for Control Group run was entered. |
timestamptz |
X |
|
scheduled_millis |
Schedule Date/Time in millis. |
bigint |
invoice
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invoice_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Invoice. |
varchar(40) |
X |
|
customer_id |
Foreign Key to Customer. |
varchar(50) |
X |
|
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
X |
|
bill_cycle_type |
Type of the Billing Cycle. |
varchar(80) |
X |
|
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
X |
|
tax_exemption_type |
Indicates type of Tax Exemption. If null or NONE, Tax is not subject of exemption. |
varchar(80) |
||
tax_residence |
Tax Residence of the Payment Responsible Account. |
varchar(255) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
billing_period_start_date |
Timestamp when Billing Period starts. |
timestamptz |
X |
|
billing_period_end_date |
Timestamp when Billing Period ends. |
timestamptz |
X |
|
invoice_created_date |
Timestamp when Invoice has been created. |
timestamptz |
X |
|
total_amount |
Total Amount of the Invoice. Excluding Tax. |
bigint |
X |
|
total_amount_net |
Net Total Amount of the Invoice including Tax. Not present for Customers with VAT Exemption. |
bigint |
||
total_amount_tax |
Tax part of the Total Amount of the Invoice. Not present for Customers with VAT Exemption. |
bigint |
||
total_invoiced |
Invoiced Amount of the Document, after rounding. This amount may consider other due documents / over-payments. This is the amount which is expected to be paid by Payer in order to settle all debts. |
bigint |
X |
|
rounding_compensation |
Rounding Compensation, difference between Total Amount Net and Total Invoiced. |
bigint |
||
rounding_level |
Level on which Rounding is performed. |
varchar(80) |
X |
|
invoice_reason |
Invoice Reason - BillRun / OnDemand / Control. |
varchar(80) |
||
invoicing_start |
Date/Time when Invoicing was started. |
timestamptz |
||
invoicing_end |
Date/Time when Invoicing was finished. |
timestamptz |
||
invoicing_duration |
Duration of the Invoicing in Millis (invoicingEnd - invoicingStart). |
bigint |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
invoice_summary_event
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invoice_summary_event_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InvoiceSummaryEvent. |
varchar(40) |
X |
|
invoice_id |
Foreign Key to Invoice. |
varchar(50) |
X |
|
customer_id |
varchar(50) |
|||
customer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
account_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
subscriber_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
offer_subscription_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
offer_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
charge_type |
Charge Type. |
varchar(80) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
||
gl_code_tax_id |
Foreign Key to GlCode for Tax. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
usage_type_id |
Foreign Key to UsageType. |
varchar(50) |
||
event_count |
Count of events. |
bigint |
||
event_start |
Start Date Time of the event. |
timestamptz |
||
event_end |
End Date Time of the event. |
timestamptz |
||
units_of_measurement |
Units Of Measurement. |
varchar(80) |
||
volume |
Volume of the event as in the Charging Request. |
bigint |
||
event_total_volume |
Total Volume of the event. |
bigint |
||
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Sum of Total Price and Total Price Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. |
bigint |
||
rated_total_price |
Total Price after Rating. Excluding Tax. |
bigint |
||
rated_total_volume |
Total Volume after Rating. |
bigint |
||
event_invoiced_price |
Invoiced Price of the event after Charging completed, incl. all discounts, promos, free units, etc. As appear on the Invoice. Excluding Tax. |
bigint |
||
event_invoiced_price_net |
Sum of Invoiced Price and Invoiced Price Tax. This attribute is for information only - Tax will be calculated during Invoicing process from Invoiced Price. |
bigint |
||
event_invoiced_price_tax |
Tax part of the Invoiced Price. This attribute is for information only - Tax will be calculated during Invoicing process from Invoiced Price. |
bigint |
||
aggregation_type |
Aggregation Type. |
varchar(80) |
X |
|
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
Invoicing - Configuration
control_group
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'control_group_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ControlGroup. |
varchar(40) |
X |
|
name |
Name of the ControlGroup. |
varchar(80) |
X |
|
description |
Description of the ControlGroup. |
varchar(255) |
||
internal_code |
Internal Code of the ControlGroup. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the ControlGroup may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
accounts |
Number of accounts. |
bigint |
||
last_run |
Date/Time when Billing Cycle run for Control Group was executed. |
timestamptz |
invoice_layout
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invoice_layout_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InvoiceLayout. |
varchar(40) |
X |
|
name |
Name of the InvoiceLayout. |
varchar(80) |
X |
|
description |
Description of the InvoiceLayout. |
varchar(255) |
||
internal_code |
Internal Code of the InvoiceLayout. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the InvoiceLayout may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
empty_section_suppressed |
Indicates whether suppress empty section(s). |
boolean |
invoice_section
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invoice_section_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InvoiceSection. |
varchar(40) |
X |
|
name |
Name of the InvoiceSection. |
varchar(80) |
X |
|
description |
Description of the InvoiceSection. |
varchar(255) |
||
internal_code |
Internal Code of the InvoiceSection. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the InvoiceSection may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
invoice_layout_id |
Foreign Key to InvoiceLayout. |
varchar(50) |
X |
|
event_section |
Indicate whether Section is considered as Events section. If so, ChargingClass is configured and section cannot have further sub-section. |
boolean |
||
charging_classes |
${FIELD.DESCRIPTION} |
varchar |
||
events_included |
Indicates whether Chargeable Events are included. |
boolean |
||
events_summary_included |
Indicates whether Chargeable Events Summary is included. |
boolean |
||
child_events_summary_included |
Indicates whether Child’s Chargeable Events Summary is included. |
boolean |
||
seqno |
bigint |
|||
parent_id |
Foreign Key to Parent InvoiceSection. |
varchar(50) |
invoice_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'invoice_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InvoiceType. |
varchar(40) |
X |
|
name |
Name of the InvoiceType. |
varchar(80) |
X |
|
description |
Description of the InvoiceType. |
varchar(255) |
||
internal_code |
Internal Code of the InvoiceType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the InvoiceType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
invoice_layout_id |
Foreign Key to InvoiceLayout. |
varchar(50) |
X |
|
is_compact |
Indicates whether Invoice is generated in Compact mode. |
boolean |
||
itemized_bill |
Indicates whether Invoice is generated including Itemized Bill. |
boolean |
||
is_primary |
Indicates whether Invoice Type is Primary. |
boolean |
Nordic Telecom - Configuration
print_invoice_fee
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_print_invoice_fee_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PrintInvoiceFee. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
billing_fee_type |
Reference to BillingFeeType. |
varchar(80) |
X |
|
charge |
${FIELD.DESCRIPTION} |
varchar |
||
delivery_method_id |
Foreign Key to DeliveryMethod. |
varchar(50) |
X |
|
total_invoiced_threshold |
Threshold of Total Invoiced Amount (incl. tax), when no reached, Print Invoice Fee is not applied. |
bigint |
X |
Revenue Management
debit_request
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'debit_request_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DebitRequest. |
varchar(40) |
X |
|
debit_request_control_id |
Foreign Key to DebitRequestControl. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
|
document_created_date |
Date/Time when Document was created. |
timestamptz |
X |
|
amount |
Amount of the Debit Request. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
request_due_date |
Due date of the due amount. |
timestamptz |
X |
|
request_planned_date |
Date/Time when Debit Request is planned for processing. |
timestamptz |
||
request_created_date |
Date/Time when Debit Request was created. |
timestamptz |
X |
|
request_created_by |
Identification of the user who created the Debit Request. |
varchar(80) |
X |
|
request_processed_date |
Date/Time when Debit Request was processed. |
timestamptz |
||
request_cancelled_date |
Date/Time when Debit Request was cancelled. |
timestamptz |
||
request_cancelled_by |
Identification of the user who cancelled Debit Request. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
payment_ref_1 |
Payment Reference No.1 associated with the Payment. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 associated with the Payment. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 associated with the Payment. |
varchar(30) |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
result |
Result in JSON. |
varchar |
debit_request_control
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'debit_request_control_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DebitRequestControl. |
varchar(40) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
effective_date |
Effective date. |
timestamptz |
||
preparation_start |
Date/Time when Preparation process has been started. |
timestamptz |
X |
|
preparation_end |
Date/Time when Preparation process finished. |
timestamptz |
||
requests_total |
Number of Debit Requests processed. |
bigint |
||
last_document_created_date |
Date/Time of the last Document Created. |
timestamptz |
||
last_document_due_date |
Date/Time of the last Document DueDate. |
timestamptz |
||
edr_file_extractor_id |
Foreign Key to EdrFileExtractor processed the Debit Request. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile where Debit Request was extracted to. |
varchar(50) |
||
extraction_start |
Date/Time when Extraction process has been started. |
timestamptz |
||
extraction_end |
Date/Time when Extraction process finished. |
timestamptz |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
document
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Document. |
varchar(40) |
X |
|
document_no |
Number of the document (generated by RM module). |
varchar(80) |
X |
|
external_document_no |
External number of the document (generated by external system, e.g. OCS or CRM). |
varchar(80) |
||
document_source_id |
Foreign Key to DocumentSource. |
varchar(50) |
X |
|
document_type_id |
Foreign Key to DocumentType. |
varchar(50) |
X |
|
bill_cycle_id |
Foreign Key to BillCycle. Only for Document Type 'OCS Invoice' |
varchar(50) |
||
bill_cycle_type |
Type of the Billing Cycle. |
varchar(80) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. Only for Document Type 'OCS Invoice'. |
varchar(50) |
||
billing_period_start |
Billing Period Start Date. Populated only when differ from Bill Cycle Run. |
timestamptz |
||
billing_period_end |
Billing Period End Date. Populated only when differ from Bill Cycle Run. |
timestamptz |
||
invoice_id |
Foreign Key to Invoice. Only for Document Type 'OCS Invoice'. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
document_code |
Code of the Document as configured in external Product Catalogue. |
varchar(60) |
X |
|
document_name |
Name of the Document as configured in external Product Catalogue. |
varchar(80) |
X |
|
document_issued_date |
Date when Document was issued. |
timestamptz |
||
document_tax_date |
Tax performance date of the Document. |
timestamptz |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
total_amount |
Total Amount of the Document. Excluding Tax. |
bigint |
X |
|
total_amount_net |
Net Total Amount of the Document including Tax. Not present for Customers with TAX Exemption. |
bigint |
||
total_amount_tax |
Tax part of the Total Amount of the Document. Not present for Customers with TAX Exemption. |
bigint |
||
total_invoiced |
Invoiced Amount of the Document, after rounding. This amount may consider other due documents / over-payments. This is the amount which is expected to be paid by Payer in order to settle all debts. |
bigint |
X |
|
rounding_compensation |
Rounding Compensation, difference between Total Amount Net and Total Invoiced. |
bigint |
||
tax_exemption_type |
Indicates type of Tax Exemption. If null or NONE, document is not subject of exemption. |
varchar(80) |
||
tax_residence |
Tax Residence |
varchar(255) |
||
due_amount |
Due amount of the account receivable or liability including Tax. |
bigint |
X |
|
due_amount_type |
REF to DueAmountType. |
varchar(80) |
X |
|
document_due_date |
Due date of the Document. |
timestamptz |
X |
|
payment_ref_1 |
Payment Reference No.1 assigned to Document. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 assigned to Document. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 assigned to Document. |
varchar(30) |
||
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
||
delivery_method_id |
Foreign Key to DeliveryMethod. |
varchar(50) |
||
corrective_tax_document_reason |
Reason of corrective. Valid only for Corrective Tax document. |
varchar(255) |
||
parent_document_id |
Foreign Key to ParentDocument. Valid only for Corrective Tax document. |
varchar(50) |
||
debt_threshold_reached |
Indicates whether Debt of the Document exceed threshold. |
boolean |
||
due_amount_postponed |
Postponed due amount, populated when debtThresholdReached=False and dueAmount is postponed to future documents. |
bigint |
||
due_amount_postponed_transferred |
Postponed due amount which was transferred to another document. |
bigint |
||
due_amount_postponed_transferred_to_id |
Foreign Key to Document to which was dueAmountPostponed transferred. |
varchar(50) |
||
document_created_date |
Date/Time when Document was created. |
timestamptz |
X |
|
document_created_by |
Identification of the user who created this Document. |
varchar(80) |
X |
|
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
document_paid_date |
Date/Time when Document was paid (criteria when Document is considered as paid have been met). |
timestamptz |
||
document_cancelled_date |
Date/Time when Document was cancelled. |
timestamptz |
||
document_cancelled_by |
Identification of the user who cancelled this Document. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
cancellation_amount |
Cancellation amount of the account receivable or liability including Tax (= Due Amount at the time of Cancel). |
bigint |
||
document_stored |
Indicates whether Document is stored |
boolean |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
document_credit2_document
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'doc_credit_2_doc_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentCredit2Document. |
varchar(40) |
X |
|
source_document_id |
Foreign Key to the Source Document (Credit). |
varchar(50) |
X |
|
target_document_id |
Foreign Key to the Target Document (Debt). |
varchar(50) |
X |
|
transaction_amount |
Amount of the Transaction. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
transaction_created_date |
Date/Time when Transaction was created. |
timestamptz |
X |
|
transaction_created_by |
Identification of the user who created the Transaction. |
varchar(80) |
X |
|
transaction_cancelled_date |
Date/Time when Transaction was cancelled. |
timestamptz |
||
transaction_cancelled_by |
Identification of the user who cancelled the Transaction. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
document_credit2_outgoing_payment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'doc_credit_2_out_paym_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentCredit2OutgoingPayment. |
varchar(40) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
|
payment_id |
Foreign Key to Payment OUT. |
varchar(50) |
X |
|
transaction_amount |
Amount of the Transaction. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
transaction_created_date |
Date/Time when Transaction was created. |
timestamptz |
X |
|
transaction_created_by |
Identification of the user who created the Transaction. |
varchar(80) |
X |
|
transaction_cancelled_date |
Date/Time when Transaction was cancelled. |
timestamptz |
||
transaction_cancelled_by |
Identification of the user who cancelled the Transaction. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
document_detail
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_detail_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentDetail. |
varchar(40) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
|
seq_no |
Sequence Number of the DocumentDetail record. |
bigint |
X |
|
product_code |
Code of the product. |
varchar(60) |
X |
|
product_name |
Name of the product as configured in external Product Catalogue. |
varchar(80) |
X |
|
product_description |
Description of the product as configured in external Product Catalogue. |
varchar(255) |
||
units_of_measurement |
UnitsOfMeasurement as configured in external Product Catalogue. |
varchar(30) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
item_price |
Price per Item. |
bigint |
X |
|
tax_included |
Indicates whether Item Price is inclusive Tax. |
boolean |
||
quantity |
Quantity, number of items. |
bigint |
X |
|
quantity_decimals |
Decimal Shift for Quantity, if Quantity should be considered as decimal number. Must be >= 0 or NULL (represents value 0). |
bigint |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
X |
|
total_amount |
Total amount of the DocumentDetail record. Excluding Tax. |
bigint |
X |
|
total_amount_net |
Net Total Amount of the Record including Tax. Not present for Customers with VAT Exemption. |
bigint |
||
total_amount_tax |
Tax part of the Total Amount of the Record. Not present for Customers with VAT Exemption. |
bigint |
||
gl_code |
Gl Code as configured in external Product Catalogue. |
varchar(60) |
X |
|
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
document_store
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_store_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentStore. |
varchar(40) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
|
document_class_name |
Class Name of the Document. |
varchar(255) |
X |
|
document_version |
Document Version. |
varchar(8) |
X |
|
document_day |
Document day (YYYYMMDD). |
varchar(8) |
X |
|
clob |
Stored as Clob. |
varchar |
incoming_payment2_document
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'inc_paym_2_doc_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the IncomingPayment2Document. |
varchar(40) |
X |
|
payment_id |
Foreign Key to Payment. |
varchar(50) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
|
transaction_amount |
Amount of the Transaction. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
transaction_created_date |
Date/Time when Transaction was created. |
timestamptz |
X |
|
transaction_created_by |
Identification of the user who created the Transaction. |
varchar(80) |
X |
|
transaction_cancelled_date |
Date/Time when Transaction was cancelled. |
timestamptz |
||
transaction_cancelled_by |
Identification of the user who cancelled the Transaction. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
incoming_payment2_outgoing_payment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'inc_paym_2_out_paym_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the IncomingPayment2OutgoingPayment. |
varchar(40) |
X |
|
source_payment_id |
Foreign Key to Source Payment. |
varchar(50) |
X |
|
target_payment_id |
Foreign Key to Target Payment. |
varchar(50) |
X |
|
transaction_amount |
Amount of the Transaction. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
transaction_created_date |
Date/Time when Transaction was created. |
timestamptz |
X |
|
transaction_created_by |
Identification of the user who created the Transaction. |
varchar(80) |
X |
|
transaction_cancelled_date |
Date/Time when Transaction was cancelled. |
timestamptz |
||
transaction_cancelled_by |
Identification of the user who cancelled the Transaction. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
payer
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payer_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Payer. |
varchar(40) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
||
delivery_method_id |
Foreign Key to DeliveryMethod. |
varchar(50) |
||
invoicing_excluded |
Indicates whether Payer is excluded from Invoicing. |
boolean |
||
invoicing_excluded_to |
If Payer is excluded from Invoicing, this is optional date till when is Payer excluded. |
timestamptz |
||
due_date_offset |
Offset for calculation of Due Date of all Documents. |
bigint |
||
payment_moral |
Payment moral of the Account, calculated according to deployment. |
bigint |
||
payment_moral_calculated |
Last calculation of Payment moral for the Account. |
timestamptz |
||
bank_account_name |
Payer’s (Billing Account) bank account name. |
varchar(80) |
||
bank_account_number |
Payer’s (Billing Account) bank account number, including prefix, without bank number code. |
varchar(80) |
||
bank_number_code |
Payer’s (Billing Account) bank number code. |
varchar(10) |
||
iban |
varchar(50) |
|||
bic |
BIC code of bank. |
varchar(30) |
||
payment_ref_1 |
Payer’s (Billing Account) Payment Reference No.1 in case Payment Reference No.1 is static. |
varchar(30) |
||
payment_ref_2 |
Payer’s (Billing Account) Payment Reference No.2 in case Payment Reference #No. is static. |
varchar(30) |
||
payment_ref_3 |
Payer’s (Billing Account) Payment Reference No.3 in case Payment Reference No.3 is static. |
varchar(30) |
||
bank_account_number_direct_debit |
Payer’s (Billing Account) bank account number, including prefix, without bank number code for Direct debit. |
varchar(80) |
||
bank_number_code_direct_debit |
Payer’s (Billing Account) bank number code for Direct Debit. |
varchar(10) |
||
bank_account_number_direct_debit_provider |
Provider’s bank account number, including prefix, without bank number code for Direct debit. |
varchar(80) |
||
bank_number_code_direct_debit_provider |
Provider’s bank number code for Direct Debit. |
varchar(10) |
||
vat_liable |
Indicates whether Payer is liable for VAT. |
boolean |
||
vat_liable_valid_from |
Date/Time from when Payer is liable for VAT. |
timestamptz |
||
vat_liable_valid_to |
Date/Time till when Payer is liable for VAT. |
timestamptz |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
payer_collection_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payer_collection_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PayerCollectionBalance. |
varchar(40) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
collection_balance_total |
Total Collection Balance of the Payer. |
bigint |
X |
|
last_calculated |
Date/Time when Collection Balance was last calculated. |
timestamptz |
||
soonest_document_due_date |
Date/Time of the soonest Due Date. |
timestamptz |
||
payer_collection_trigger_id |
ForeignKey to last PayerCollectionTrigger. |
varchar(50) |
||
calculation_required |
Indicates whether Collection Balance Calculation is required. |
boolean |
payer_collection_trigger
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payer_collection_trigger_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PayerCollectionTrigger. |
varchar(40) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
collection_balance_total |
Total Collection Balance of the Payer at the time of Trigger. |
bigint |
X |
|
calculated |
Date/Time when Collection Balance which triggered Collection Process Start was calculated. |
timestamptz |
X |
|
last_document_processed_id |
Foreign Key to last Document processed. |
varchar(50) |
X |
|
last_document_due_date |
Date/Time of the last Document Due Date. |
timestamptz |
X |
|
collection_process_triggered |
DateTime when Collection was triggered. |
timestamptz |
payer_open_balance
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payer_open_balance_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PayerOpenBalance. |
varchar(40) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
open_balance_total |
Total Open Balance of the Payer. |
bigint |
X |
|
open_balance_total_ar |
Open Balance of AR Documents. |
bigint |
||
open_balance_total_liability |
Open Balance of LIABILITY Documents. |
bigint |
||
open_balance_total_future |
Total Open Balance of the Payer with Future Due date. |
bigint |
X |
|
open_balance_total_ar_future |
Open Balance of AR Documents with Future Due date. |
bigint |
||
open_balance_total_liability_future |
Open Balance of LIABILITY Documents with Future Due date. |
bigint |
||
open_balance_total_payment |
Open Balance of INCOMING Payments. |
bigint |
||
open_balance_detail |
Detailed Open Balance of the Payer in JSON. |
varchar |
||
last_calculated |
Date/Time when Open Balance was last calculated. |
timestamptz |
||
last_payment_processed |
Date/Time when Last Payment was processed. |
timestamptz |
||
soonest_due_date |
Date/Time of the soonest Due Date. |
timestamptz |
||
calculation_required |
Indicates whether Open Balance Calculation is required. |
boolean |
payer_payment_moral
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payer_payment_moral_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PayerPaymentMoral. |
varchar(40) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
payment_moral |
Payment Moral of the Payer. |
varchar(255) |
||
last_calculated |
Date/Time when Open Balance was last calculated. |
timestamptz |
||
soonest_document_due_date |
Date/Time of the soonest Due Date. |
timestamptz |
||
calculation_required |
Indicates whether Payment Moral Calculation is required. |
boolean |
payment
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Payment. |
varchar(40) |
X |
|
payment_no |
Number of the Payment (generated by RM module). |
varchar(80) |
X |
|
external_payment_no |
External number of the Payment (generated by external system, e.g. Bank or Payment Gateway). |
varchar(80) |
||
payment_type |
REF to PaymentType. Possible values: IN, PROMISE_TO_PAY. |
varchar(80) |
X |
|
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
||
payment_amount |
Amount of the Payment. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
payment_date_received |
Date/Time when Payment was received on provider’s bank account. |
timestamptz |
||
payment_date_sent |
Date/Time when Payment was sent from payer’s bank account. |
timestamptz |
||
payment_ref_1 |
Payment Reference No.1 associated with the Payment. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 associated with the Payment. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 associated with the Payment. |
varchar(30) |
||
payment_category |
Payment Category associated with the Payment. Used for statistical purposes. |
varchar(30) |
||
bank_account_number |
Payer’s (Billing Account) bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code |
Payer’s (Billing Account) bank number code. |
varchar(10) |
||
channel_type |
Type of channel (e.g. card, bank transfer, etc.). |
varchar(60) |
||
iban |
Payer’s (Billing Account) bank account number in international format. |
varchar(50) |
||
bic |
Payer’s (Billing Account) BIC code of the bank. |
varchar(30) |
||
bank_account_name |
Payer’s (Billing Account) bank account name. |
varchar(50) |
||
money_order |
${FIELD.DESCRIPTION} |
varchar |
||
recipient_note |
Recipient’s note/description of the Payment. |
varchar(255) |
||
payer_note |
Payer’s note/description of the Payment. |
varchar(255) |
||
bank_account_transaction_id |
Identifier of transaction in the context of bank account. |
varchar(80) |
||
bank_account_number_provider |
Provider’s bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code_provider |
Payer’s bank number code. |
varchar(10) |
||
iban_provider |
Provider’s bank account number in international format. |
varchar(50) |
||
bic_provider |
Provider’s BIC code of the bank. |
varchar(30) |
||
bank_account_name_provider |
Provider’s bank account name. |
varchar(50) |
||
payment_created_date |
Date/Time when Payment was created. |
timestamptz |
X |
|
payment_created_by |
Identification of the user who creates the Payment. |
varchar(80) |
X |
|
payment_identified_date |
Date/Time when Payment was lastly identified. |
timestamptz |
||
payment_identified_by |
Identification of the user who lastly identified the Payment. |
varchar(80) |
||
payment_assigned_date |
Date/Time when Payment was lastly assigned. |
timestamptz |
||
payment_assigned_by |
Identification of the user who lastly assigned the Payment. |
varchar(80) |
||
account_id |
Foreign key to Account. |
varchar(50) |
||
payer_id |
Foreign key to Payer. |
varchar(50) |
||
used_amount |
Valid only for incoming payments. Amount used in case of amount transactions. |
bigint |
||
remaining_amount |
Valid only for incoming payments. Remaining amount of payment after using some amount in case of amount transactions. |
bigint |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
payment_cancelled_date |
Date/Time when Payment was cancelled. |
timestamptz |
||
payment_cancelled_by |
Identification of the user who cancelled the Payment. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
cancellation_amount |
Cancellation amount (= Remaining Amount at the time of Cancel). |
bigint |
||
payment_identification_cancelled_date |
Date/Time when Payment Identification was cancelled. |
timestamptz |
||
payment_identification_cancelled_by |
Identification of the user who cancelled the Payment Identification. |
varchar(80) |
||
edr_file_loader_id |
Foreign Key to EdrFileLoader processed the Payment. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile where Payment was loaded from. |
varchar(50) |
||
promised_payment_id |
Foreign Key to Payment of PaymentType='PROMISE_TO_PAY' done via OnLine channels. |
varchar(50) |
||
promised_payment_due_date |
Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'. |
timestamptz |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
payment_history
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_history_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentHistory. |
varchar(40) |
X |
|
operation_type |
REF to HistoryOperationType. |
varchar(80) |
X |
|
operation_code |
Code of the Operation. |
varchar(60) |
X |
|
created_date |
Date/Time when History Entry was created. |
timestamptz |
X |
|
created_by |
Identification of the user who created the History Entry. |
varchar(80) |
X |
|
operation_parameters |
Parameters of the Operation, Key - Value (String) Map. |
text |
||
payment_type |
REF to PaymentType. |
varchar(80) |
X |
|
payment_id |
Foreign Key to Payment (IN, OUT). |
varchar(50) |
X |
|
effective_date |
Effective Date/Time of the Operation. |
timestamptz |
||
transaction_id |
Business Transaction ID. |
varchar(255) |
||
ref_payment_type |
REF to referenced Payment Type. |
varchar(80) |
||
ref_payment_id |
Foreign Key to referenced Payment. |
varchar(50) |
||
ref_document_id |
Foreign Key to referenced Document. |
varchar(50) |
payment_out
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_out_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentOut. |
varchar(40) |
X |
|
payment_no |
Number of the Payment (generated by RM module). |
varchar(80) |
X |
|
external_payment_no |
External number of the Payment (generated by external system, e.g. Bank or Payment Gateway). |
varchar(80) |
||
payment_type |
REF to PaymentType. Possible values: OUT, PAYMENT_OUT_REQ. |
varchar(80) |
X |
|
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
||
payment_amount |
Amount of the Payment. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
payment_date_sent |
Date/Time when Payment was sent from provider’s bank account. |
timestamptz |
||
payment_date_scheduled |
Date/Time when Payment is scheduled to be sent from provider’s bank account. |
timestamptz |
||
payment_ref_1 |
Payment Reference No.1 associated with the Payment. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 associated with the Payment. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 associated with the Payment. |
varchar(30) |
||
payment_category |
Payment Category associated with the Payment. Used for statistical purposes. |
varchar(30) |
||
bank_account_number |
Payer’s (Billing Account) bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code |
Payer’s (Billing Account) bank number code. |
varchar(10) |
||
channel_type |
Type of channel (e.g. card, bank transfer, etc.). |
varchar(60) |
||
iban |
Payer’s (Billing Account) bank account number in international format. |
varchar(50) |
||
bic |
Payer’s (Billing Account) BIC code of the bank. |
varchar(30) |
||
bank_account_name |
Payer’s (Billing Account) bank account name. |
varchar(50) |
||
money_order |
${FIELD.DESCRIPTION} |
varchar |
||
payer_note |
Payer’s note/description of the Payment. |
varchar(255) |
||
bank_account_transaction_id |
Identifier of transaction in the context of bank account. |
varchar(80) |
||
bank_account_number_provider |
Provider’s bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code_provider |
Payer’s bank number code. |
varchar(10) |
||
iban_provider |
Provider’s bank account number in international format. |
varchar(50) |
||
bic_provider |
Provider’s BIC code of the bank. |
varchar(30) |
||
bank_account_name_provider |
Provider’s bank account name. |
varchar(50) |
||
payment_created_date |
Date/Time when Payment was created. |
timestamptz |
X |
|
payment_created_by |
Identification of the user who creates the Payment. |
varchar(80) |
X |
|
payment_identified_date |
Date/Time when Payment was lastly identified. |
timestamptz |
||
payment_identified_by |
Identification of the user who lastly identified the Payment. |
varchar(80) |
||
account_id |
Foreign key to Account. |
varchar(50) |
||
payer_id |
Foreign key to Payer. |
varchar(50) |
||
used_amount |
Valid only for Payment Out Requests. Amount used in case of amount transactions. |
bigint |
||
remaining_amount |
Valid only for Payment Out Requests. Remaining amount of payment before/after Payment Out was performed. |
bigint |
||
custom_attributes |
Custom attributes, Key - Value (String) Map. |
text |
||
payment_cancelled_date |
Date/Time when Payment was cancelled. |
timestamptz |
||
payment_cancelled_by |
Identification of the user who cancelled the Payment. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
cancellation_amount |
Cancellation amount (= Remaining Amount at the time of Cancel). |
bigint |
||
payment_out_request_control_id |
Foreign Key to PaymentOutRequestControl. |
varchar(50) |
||
edr_file_processor_id |
Foreign Key to EdrFileProcessor processed the Payment Out. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile where Payment Request was extracted to. |
varchar(50) |
||
payment_out_req_id |
Foreign Key to Payment of PaymentType='PAYMENT_OUT_REQ'. |
varchar(50) |
||
payment_out_req_due_date |
Date/Time Due of the Payment OUT Request. Populated only for PaymentType='PAYMENT_OUT_REQ'. |
timestamptz |
||
record_state |
State of the record - 'A' = Active, 'R' = Archive, 'D' = Delete |
varchar(80) |
payment_out_request
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_out_request_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentOutRequest. |
varchar(40) |
X |
|
payment_out_request_control_id |
Foreign Key to PaymentOutRequestControl. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
payment_id |
Foreign Key to Payment. |
varchar(50) |
X |
|
payment_created_date |
Date/Time when Payment Out was created. |
timestamptz |
X |
|
amount |
Amount of the Payment Out Request. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
request_created_date |
Date/Time when Payment Out Request was created. |
timestamptz |
X |
|
request_created_by |
Identification of the user who created the Payment Out Request. |
varchar(80) |
X |
|
request_processed_date |
Date/Time when Payment Out Request was processed. |
timestamptz |
||
request_cancelled_date |
Date/Time when Payment Out Request was cancelled. |
timestamptz |
||
request_cancelled_by |
Identification of the user who cancelled Payment Out Request. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
payment_ref_1 |
Payment Reference No.1 associated with the Payment. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 associated with the Payment. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 associated with the Payment. |
varchar(30) |
||
bank_account_number |
Payer’s (Billing Account) bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code |
Payer’s (Billing Account) bank number code. |
varchar(10) |
||
channel_type |
Type of channel (e.g. card, direct debit, etc.). |
varchar(60) |
||
iban |
Payer’s (Billing Account) bank account number in international format. |
varchar(50) |
||
bic |
BIC code of the bank. |
varchar(30) |
||
bank_account_name |
Payer’s (Billing Account) bank account name. |
varchar(50) |
||
money_order |
varchar |
|||
payer_note |
Payer’s note/description of the Payment. |
varchar(255) |
payment_out_request
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_out_request_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentOutRequest. |
varchar(40) |
X |
|
payment_out_request_control_id |
Foreign Key to PaymentOutRequestControl. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
X |
|
payer_id |
Foreign Key to Payer. |
varchar(50) |
X |
|
payment_id |
Foreign Key to Payment. |
varchar(50) |
X |
|
payment_created_date |
Date/Time when Payment Out was created. |
timestamptz |
X |
|
amount |
Amount of the Payment Out Request. |
bigint |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
request_created_date |
Date/Time when Payment Out Request was created. |
timestamptz |
X |
|
request_created_by |
Identification of the user who created the Payment Out Request. |
varchar(80) |
X |
|
request_processed_date |
Date/Time when Payment Out Request was processed. |
timestamptz |
||
request_cancelled_date |
Date/Time when Payment Out Request was cancelled. |
timestamptz |
||
request_cancelled_by |
Identification of the user who cancelled Payment Out Request. |
varchar(80) |
||
cancellation_reason_id |
Foreign Key to CancellationReason. |
varchar(50) |
||
payment_ref_1 |
Payment Reference No.1 associated with the Payment. |
varchar(30) |
||
payment_ref_2 |
Payment Reference No.2 associated with the Payment. |
varchar(30) |
||
payment_ref_3 |
Payment Reference No.3 associated with the Payment. |
varchar(30) |
||
bank_account_number |
Payer’s (Billing Account) bank account number, including prefix, without bank number code. |
varchar(30) |
||
bank_number_code |
Payer’s (Billing Account) bank number code. |
varchar(10) |
||
channel_type |
Type of channel (e.g. card, direct debit, etc.). |
varchar(60) |
||
iban |
Payer’s (Billing Account) bank account number in international format. |
varchar(50) |
||
bic |
BIC code of the bank. |
varchar(30) |
||
bank_account_name |
Payer’s (Billing Account) bank account name. |
varchar(50) |
||
money_order |
varchar |
|||
payer_note |
Payer’s note/description of the Payment. |
varchar(255) |
payment_out_request_control
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_out_request_control_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentOutRequestControl. |
varchar(40) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
effective_date |
Effective date. |
timestamptz |
||
preparation_start |
Date/Time when Preparation process has been started. |
timestamptz |
X |
|
preparation_end |
Date/Time when Preparation process finished. |
timestamptz |
||
requests_total |
Number of Payment Out Requests processed. |
bigint |
||
last_payment_created_date |
Date/Time of the last Payment Created. |
timestamptz |
||
last_payment_scheduled_date |
Date/Time of the last Payment Scheduled. |
timestamptz |
||
edr_file_extractor_id |
Foreign Key to EdrFileExtractor processed the Payment Out Request. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile where Payment Out Request was extracted to. |
varchar(50) |
||
extraction_start |
Date/Time when Extraction process has been started. |
timestamptz |
||
extraction_end |
Date/Time when Extraction process finished. |
timestamptz |
extract_gl_detail
Detail Records of Extract GL.
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'nt_extract_gl_detail_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractGlDetail. |
varchar(40) |
X |
|
extract_gl_header_id |
Foreign Key to ExtractGlHeader. |
varchar(50) |
X |
|
record_type |
Type of the Extract GL Detail record. |
varchar(80) |
X |
|
document_id |
Foreign Key to Document. Populated only for ExtractGlRecordType = THRESHOLD or TAX_EXEMPTION. |
varchar(50) |
||
document_no |
Number of the document (generated by RM module). Populated only for ExtractGlRecordType = THRESHOLD or TAX_EXEMPTION. |
varchar(80) |
||
document_issued_date |
Date when Document was issued. |
timestamptz |
X |
|
document_tax_date |
Tax performance date of the Document. |
timestamptz |
X |
|
document_due_date |
Due date of the Document. |
timestamptz |
X |
|
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
invoice_id |
Foreign Key to Invoice. Only for Document Type 'OCS Invoice'. Populated only for ExtractGlRecordType = THRESHOLD or TAX_EXEMPTION. |
varchar(50) |
||
aggregation_type |
Aggregation Type. |
varchar(80) |
X |
|
account_id |
Foreign Key to Account. Populated only for ExtractGlRecordType = THRESHOLD or TAX_EXEMPTION. |
varchar(50) |
||
tax_exemption_type |
Indicates type of Tax Exemption. If null or NONE, document is not subject of exemption. |
varchar(80) |
||
gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
sap_gl_code |
Internal Code of SapGlCode. |
varchar(60) |
||
gl_code |
GL Code. |
varchar(60) |
||
tax_id |
Foreign Key to Tax. |
varchar(50) |
||
tax_value_id |
Foreign Key to TaxValue. |
varchar(50) |
||
tax_code |
Tax Code. |
varchar(60) |
||
tax_value |
Tax Value - Numeric. |
bigint |
||
gl_code_tax_id |
Foreign Key to GlCode for Tax. |
varchar(50) |
||
gl_code_tax |
GL Code Tax. |
varchar(60) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
currency_code |
Currency Code. |
varchar(3) |
||
charge_type |
Charge Type. |
varchar(80) |
||
event_count |
Count of events. |
bigint |
||
units_of_measurement |
Units Of Measurement. |
varchar(80) |
||
event_total_volume |
Total Volume of the event. |
bigint |
||
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Sum of Total Price and Total Price Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. |
bigint |
||
event_invoiced_price |
Invoiced Price of the event after Charging completed, incl. all discounts, promos, free units, etc. As appear on the Invoice. Excluding Tax. |
bigint |
||
event_invoiced_price_net |
Sum of Invoiced Price and Invoiced Price Tax. This attribute is for information only - Tax will be calculated during Invoicing process from Invoiced Price. |
bigint |
||
event_invoiced_price_tax |
Tax part of the Invoiced Price. This attribute is for information only - Tax will be calculated during Invoicing process from Invoiced Price. |
bigint |
extract_gl_document
Mapping between Extract GL and Document. For RecordType = SUM.
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'nt_extract_gl_document_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractGlDocument. |
varchar(40) |
X |
|
extract_gl_header_id |
Foreign Key to ExtractGlHeader. |
varchar(50) |
X |
|
document_id |
Foreign Key to Document. |
varchar(50) |
X |
extract_gl_header
Header for Extract GL.
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'nt_extract_gl_header_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ExtractGlHeader. |
varchar(40) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
provider_id |
Foreign Key to Provider. |
varchar(50) |
X |
|
extract_gl_type |
Type of the Extract. |
varchar(80) |
X |
|
period_start |
Period Start Date. |
timestamptz |
X |
|
period_end |
Period End Date. |
timestamptz |
X |
|
effective_date |
Effective date. |
timestamptz |
||
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
edr_file_extractor_id |
Foreign Key to EdrFileExtractor processed the GL Extract. |
varchar(50) |
||
edr_file_id |
Foreign Key to EdrFile where GL was extracted to. |
varchar(50) |
Revenue Management - Configuration
cancellation_reason
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'cancellation_reason_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the CancellationReason. |
varchar(40) |
X |
|
name |
Name of the CancellationReason. |
varchar(80) |
X |
|
description |
Description of the CancellationReason. |
varchar(255) |
||
internal_code |
Internal Code of the CancellationReason. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the CancellationReason may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
debit_request_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'debit_request_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DebitRequestType. |
varchar(40) |
X |
|
name |
Name of the DebitRequestType. |
varchar(80) |
X |
|
description |
Description of the DebitRequestType. |
varchar(255) |
||
internal_code |
Internal Code of the DebitRequestType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the DebitRequestType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
delivery_method
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'delivery_method_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DeliveryMethod. |
varchar(40) |
X |
|
name |
Name of the DeliveryMethod. |
varchar(80) |
X |
|
description |
Description of the DeliveryMethod. |
varchar(255) |
||
internal_code |
Internal Code of the DeliveryMethod. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the DeliveryMethod may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
document_delivery_method
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_delivery_method_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentDeliveryMethod. |
varchar(40) |
X |
|
document_preference_id |
Foreign Key to DocumentPreference. |
varchar(50) |
X |
|
is_default |
Indicates whether Delivery Method is default. |
boolean |
||
delivery_method_id |
Foreign Key to DeliveryMethod. |
varchar(50) |
X |
|
limit_min |
Minimal Limit for Delivery Method incl. Tax. If limit is not reached, alternate Delivery Method will be used. If null, no limit applied. |
bigint |
||
limit_max |
Maximal Limit for Delivery Method incl. Tax. If limit is over, alternate Delivery Method will be used. If null, no limit applied. |
bigint |
||
alternate_delivery_method_id |
Foreign Key to Alternate DeliveryMethod. |
varchar(50) |
document_number_series
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_number_series_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentNumberSeries. |
varchar(40) |
X |
|
name |
Name of the DocumentNumberSeries. |
varchar(80) |
X |
|
description |
Description of the DocumentNumberSeries. |
varchar(255) |
||
provider_id |
Foreign Key to Provider. |
varchar(50) |
X |
|
document_type_id |
Foreign Key to DocumentType. |
varchar(50) |
X |
|
prefix |
Prefix for Document Number. |
varchar(10) |
||
series_length |
Length of the Series. |
bigint |
X |
|
sequence_id |
Foreign Key to SequenceDef. |
varchar(50) |
X |
|
preview_value |
Example value which will be shown on Documents in 'Preview' mode. Excluding prefix. |
bigint |
||
valid_from |
Date from when Series is valid. |
timestamptz |
X |
|
valid_to |
Date till when Series is valid. |
timestamptz |
||
composed_index |
varchar(255) |
X |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
document_payment_method
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_payment_method_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentPaymentMethod. |
varchar(40) |
X |
|
document_preference_id |
Foreign Key to DocumentPreference. |
varchar(50) |
X |
|
is_default |
Indicates whether Delivery Method is default. |
boolean |
||
payment_method_id |
Foreign Key to PaymentMethod. |
varchar(50) |
X |
|
offset_shift |
Offset shift (+ / -) days. If null, no offset shift applied. |
bigint |
||
limit_min |
Minimal Limit for Payment Method incl. Tax. If limit is not reached, alternate Payment Method will be used. If null, no limit applied. |
bigint |
||
limit_max |
Maximal Limit for Payment Method incl. Tax. If limit is over, alternate Payment Method will be used. If null, no limit applied. |
bigint |
||
alternate_payment_method_id |
Foreign Key to Alternate PaymentMethod. |
varchar(50) |
document_preference
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_preference_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentPreference. |
varchar(40) |
X |
|
value_set_on |
Indicates to which entity Document Preference is assigned to. |
varchar(80) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
||
document_type_id |
Foreign Key to DocumentType. |
varchar(50) |
X |
|
currency_id |
Foreign Key to Currency. |
varchar(50) |
X |
|
invoice_type_id |
Foreign Key to InvoiceType. |
varchar(50) |
X |
|
due_date_offset |
Offset for calculation of Due Date of the Document. |
bigint |
X |
|
recommended_pay_date_offset |
Offset for calculation of Recommended Payment Date of the Document. |
bigint |
X |
|
created_date_offset |
Indicates whether Offsets are linked with document Created Date. |
boolean |
||
tax_performance_date |
Specify Document Tax Performance Date. |
varchar(80) |
X |
|
due_amount_threshold |
Threshold Amount (incl. Tax) under which Document will not be considered as due. |
bigint |
||
suppress_no_event |
Indicates whether Creation of Document is suppressed when no Chargeable Event. |
boolean |
||
suppress_print_limit |
Suppress Document print if Amount (incl. Tax) is lower than this Limit. |
bigint |
||
rounding_level |
Level on which Rounding is performed. |
varchar(80) |
X |
|
round_invoiced |
Round Invoiced Digits. |
bigint |
||
rounding_compensation_cost_gl_code_id |
Foreign Key to GlCode. |
varchar(50) |
||
rounding_compensation_revenue_gl_code_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
valid_from |
Timestamp from when Preference is valid. |
timestamptz |
X |
|
valid_to |
Timestamp till when Preference is valid. |
timestamptz |
||
composed_index |
Composed index, consists of valueSetOn:account/accountSegment/customer/customerSegment. |
varchar(255) |
document_source
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_source_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentSource. |
varchar(40) |
X |
|
name |
Name of the DocumentSource. |
varchar(80) |
X |
|
description |
Description of the DocumentSource. |
varchar(255) |
||
internal_code |
Internal Code of the DocumentSource. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the DocumentSource may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
document_type
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'document_type_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DocumentType. |
varchar(40) |
X |
|
name |
Name of the DocumentType. |
varchar(80) |
X |
|
description |
Description of the DocumentType. |
varchar(255) |
||
internal_code |
Internal Code of the DocumentType. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the DocumentType may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
document_category |
Category of the Document. |
varchar(80) |
X |
|
due_amount_type |
Due Amount Type. Enumerated value - AR or LIABILITY. |
varchar(80) |
||
store_document |
Indicates whether Document shall be stored. |
boolean |
||
balance |
Indicates whether Document Type is relevant for Open Balance calculation. |
boolean |
||
collection |
Indicates whether Document Type is relevant for Collection Balance calculation. |
boolean |
||
payment_moral |
Indicates whether Document Type is relevant for Payment Moral calculation. |
boolean |
payment_method
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'payment_method_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PaymentMethod. |
varchar(40) |
X |
|
name |
Name of the PaymentMethod. |
varchar(80) |
X |
|
description |
Description of the PaymentMethod. |
varchar(255) |
||
internal_code |
Internal Code of the PaymentMethod. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the PaymentMethod may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
direct_debit |
Indicates whether Payment Method is Direct Debit. |
boolean |
provider
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'provider_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Provider. |
varchar(40) |
X |
|
account_type_id |
Foreign Key to AccountType. |
varchar(50) |
X |
|
payment_methods |
Payment Methods supported by Provider. |
text |
||
delivery_methods |
Delivery Methods supported by Provider. |
text |
||
config_parameters |
Config Parameters in JSON. |
varchar |
||
disabled |
Indicates, whether Cron Job is temporarily disabled. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
provider_bank_account
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'provider_bank_account_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the ProviderBankAccount. |
varchar(40) |
X |
|
name |
Name of the ProviderBankAccount. |
varchar(80) |
X |
|
description |
Description of the ProviderBankAccount. |
varchar(255) |
||
provider_id |
Foreign Key to Provider. |
varchar(50) |
X |
|
bank_account_number |
Provider’s bank account number, including prefix, without bank number code. |
varchar(80) |
||
bank_number_code |
Provider’s bank number code. |
varchar(10) |
||
iban |
Provider’s bank account number in international format. |
varchar(50) |
||
bic |
BIC code of bank. |
varchar(30) |
||
bank_account_name |
Provider’s bank account name. |
varchar(80) |
||
default_payment_out |
Indicates whether Bank account is default for Payment OUT. |
boolean |
||
default_direct_debit |
Indicates whether Bank account is default for Direct Debit. |
boolean |
||
valid_from |
Date/Time from when Bank Account is valid. |
timestamptz |
X |
|
valid_to |
Date/Time till when Bank Account is valid. |
timestamptz |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
sap_gl_code
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'sap_gl_code_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SapGlCode. |
varchar(40) |
X |
|
name |
Name of the SapGlCode. |
varchar(80) |
X |
|
description |
Description of the SapGlCode. |
varchar(255) |
||
internal_code |
Internal Code of the SapGlCode. |
varchar(60) |
X |
|
provider_id |
Foreign Key to Provider. |
varchar(50) |
X |
|
sap_gl_code |
SAP GL Code. |
varchar(60) |
X |
|
sap_posting_type |
REF to SapPostingType. |
varchar(80) |
X |
|
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
sap_tax_group
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'sap_tax_group_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the SapTaxGroup. |
varchar(40) |
X |
|
tax_id |
Foreign Key to Tax. |
varchar(50) |
X |
|
sap_tax_code |
SAP Tax Code. |
varchar(60) |
X |
|
sap_gl_code |
SAP GL Code. |
varchar(60) |
X |
|
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
Telco
destination_exception
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'destination_exception_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DestinationException. |
varchar(40) |
X |
|
analysis_type |
Type of Analysis, only BEST_MATCH and EXACT_MATCH are allowed. |
varchar(80) |
X |
|
value |
Value for Destination Analysis. |
varchar(255) |
X |
|
destination_id |
Foreign Key to Destination. |
varchar(50) |
X |
|
valid_from |
Timestamp from when Exception in Destination Analysis is valid. |
timestamptz |
X |
|
valid_to |
Timestamp till when Exception in Destination Analysis is valid. If NULL validity is current. |
timestamptz |
session
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'session_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Session. |
varchar(40) |
X |
|
external_session_id |
External Session Identifier (acct-session-id). |
varchar(255) |
X |
|
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
X |
|
units_of_measurement |
varchar(80) |
X |
||
updates |
Count of Session Update. |
bigint |
X |
|
granted_quota_total |
Sum of all Quota granted in Session. |
bigint |
X |
|
granted_quota_last |
Last granted Quota. |
bigint |
X |
|
session_start |
Timestamp when Session has been started. |
timestamptz |
X |
|
session_update |
Timestamp of last Session Update. |
timestamptz |
X |
|
charging_class_id |
Foreign Key to ChargingClass. Charging Class was assigned during Session Initialize. |
varchar(50) |
X |
Telco - Configuration
destination
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'destination_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the Destination. |
varchar(40) |
X |
|
name |
Name of the Destination. |
varchar(80) |
X |
|
description |
Description of the Destination. |
varchar(255) |
||
internal_code |
Internal Code of the Destination. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the Destination may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
country_id |
Foreign Key to Country. |
varchar(50) |
||
destination_network_type |
Network type if applicable. |
varchar(80) |
X |
|
plmn |
PLMN of the Operator if applicable. |
varchar(5) |
||
mcc |
Mobile Country Code if applicable. |
varchar(3) |
||
mnc |
Mobile Network Code if applicable. |
varchar(3) |
||
mcc_mnc |
MCC + MNC. |
varchar(6) |
||
destination_analysis_type |
Type of Analysis. |
varchar(80) |
||
value |
Value for Destination Analysis. |
varchar(255) |
||
priority |
Priority during Destination analysis lookup - Higher number = Higher priority, applicable only for Regular Expression. |
bigint |
||
parent_id |
Foreign Key to parent entity. |
varchar(50) |
||
numbering_plan_defined |
Indicates whether to define Numbering Plan for related Country. |
boolean |
destination_group
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'destination_group_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DestinationGroup. |
varchar(40) |
X |
|
name |
Name of the DestinationGroup. |
varchar(80) |
X |
|
description |
Description of the DestinationGroup. |
varchar(255) |
||
internal_code |
Internal Code of the DestinationGroup. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the DestinationGroup may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
destination_ids |
Destination’s IDs belonging to DestinationGroup. |
text |
destination_group_mapping
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'destination_group_mapping_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the DestinationGroupMapping. |
varchar(40) |
X |
|
description |
${FIELD.DESCRIPTION} |
varchar(255) |
||
destination_group_id |
Foreign Key to DestinationGroup. |
varchar(50) |
X |
|
destination_ids |
Destination’s IDs belonging to DestinationGroup. |
text |
||
valid_from |
Timestamp from when mapping is valid. |
timestamptz |
||
valid_to |
Timestamp till when mapping is valid. |
timestamptz |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
interconnect_group
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'interconnect_group_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InterconnectGroup. |
varchar(40) |
X |
|
name |
Name of the InterconnectGroup. |
varchar(80) |
X |
|
description |
Description of the InterconnectGroup. |
varchar(255) |
||
internal_code |
Internal Code of the InterconnectGroup. |
varchar(60) |
X |
|
server_dependent |
Indicates whether 'internalCode' of the InterconnectGroup may be changed. |
boolean |
||
deployment_status |
Status of the Deployment. |
varchar(80) |
||
deployment_valid_from |
Deployment Valid From. |
timestamptz |
||
deployment_set_id |
Foreign Key to DeploymentSet. |
varchar(50) |
||
offer_subscription_id |
ForeignKey to OfferSubscrition. |
varchar(50) |
X |
|
valid_from |
Date/Time from when Interconnect Group is valid. |
timestamptz |
X |
|
valid_to |
Date/Time till when Interconnect Group is valid. |
timestamptz |
interconnect_point
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'interconnect_point_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the InterconnectPoint. |
varchar(40) |
X |
|
interconnect_group_id |
Foreign Key to InterconnectGroup. |
varchar(50) |
X |
|
code |
Code of the PoI. |
varchar(255) |
X |
|
valid_from |
Date/Time from when PoI is valid. |
timestamptz |
||
valid_to |
Date/Time till when PoI is valid. |
timestamptz |
mobile_sms
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_mobile_sms_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MobileSms. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
mobile_sms_usage_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'mobile_sms_usage_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MobileSmsUsageCharge. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to ServiceValue. |
varchar(50) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
charge_valid_from |
Timestamp from when Charge is valid. |
timestamptz |
||
charge_valid_to |
Timestamp till when Charge is valid. |
timestamptz |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:chargingClass. |
varchar(255) |
X |
mobile_voice
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_mobile_voice_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MobileVoice. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
mobile_voice_usage_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'mobile_voice_usage_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the MobileVoiceUsageCharge. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to ServiceValue. |
varchar(50) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
charge_valid_from |
Timestamp from when Charge is valid. |
timestamptz |
||
charge_valid_to |
Timestamp till when Charge is valid. |
timestamptz |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:chargingClass. |
varchar(255) |
X |
|
first_interval |
First rating interval in Seconds. |
bigint |
X |
|
second_interval |
Second rating interval in Seconds. |
bigint |
X |
|
next_intervals |
Third and next rating intervals in Seconds. Delimited by comma. |
varchar(255) |
||
setup_fee |
Setup Fee of the call. |
bigint |
packet_data
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_packet_data_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PacketData. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
||
charges |
${FIELD.DESCRIPTION} |
varchar |
packet_data_usage_charge
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'packet_data_usage_charge_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the PacketDataUsageCharge. |
varchar(40) |
X |
|
service_value_id |
Foreign Key to ServiceValue. |
varchar(50) |
||
charge |
${FIELD.DESCRIPTION} |
varchar |
||
charge_valid_from |
Timestamp from when Charge is valid. |
timestamptz |
||
charge_valid_to |
Timestamp till when Charge is valid. |
timestamptz |
||
composed_index |
Composed index, consists of serviceValueClass:serviceValue:chargingClass. |
varchar(255) |
X |
|
rounding |
Rounding UP to Units. If null, no rounding is applied. |
bigint |
||
rounding_units_of_measurement |
varchar(80) |
telco_usage_mapping
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'tc_usg_map_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the TelcoUsageMapping. |
varchar(40) |
X |
|
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
X |
|
usage_type_id |
Type of the Usage. |
varchar(50) |
X |
|
destination_group_from_id |
Foreign Key to DestinationGroup. Either destinationGroup or destination must be populated. |
varchar(50) |
||
destination_from_id |
Foreign Key to Destination. Either destinationGroup or destination must be populated. |
varchar(50) |
||
destination_group_to_id |
Foreign Key to DestinationGroup. Either roamingDestinationGroup or roamingDestination must be populated. |
varchar(50) |
||
destination_to_id |
Foreign Key to Destination. Either roamingDestinationGroup or roamingDestination must be populated. |
varchar(50) |
||
time_period_group_id |
Foreign Key to TimePeriodGroup. |
varchar(50) |
||
time_period_id |
Foreign Key to TimePeriod. |
varchar(50) |
||
rating_characteristic_id |
Foreign Key to RatingCharacteristic. |
varchar(50) |
||
priority |
Priority during Destination analysis lookup - Higher number = Higher priority. |
bigint |
X |
wholesale_voice
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'srv_wholesale_voice_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the WholesaleVoice. |
varchar(40) |
X |
|
value_set_on |
Discriminator column to recognize which entity sets the value. |
varchar(80) |
||
class_name |
Stored value Class name. |
varchar(255) |
||
product_value_id |
Foreign Key to ProductValue. |
varchar(50) |
||
service_id |
Foreign Key to Service. |
varchar(50) |
||
product_service_id |
Foreign Key to ProductService. |
varchar(50) |
||
product_id |
Foreign Key to Product. |
varchar(50) |
||
customer_id |
Foreign Key to Customer. |
varchar(50) |
||
customer_segment_id |
Foreign Key to CustomerSegment. |
varchar(50) |
||
account_id |
Foreign Key to Account. |
varchar(50) |
||
account_segment_id |
Foreign Key to AccountSegment. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
subscriber_segment_id |
Foreign Key to SubscriberSegment. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
service_subscription_id |
Foreign Key to ServiceSubscription. |
varchar(50) |
||
offer_id |
Foreign Key to Offer. |
varchar(50) |
||
currency_id |
Foreign Key to Currency. |
varchar(50) |
||
value_ent_date |
Entry Date of Value. |
timestamptz |
X |
|
value_valid_from |
Date from when Value is valid. |
timestamptz |
||
value_valid_to |
Date till when Value is valid. |
timestamptz |
||
reference_id |
Reference to another ServiceValue which holds actual value. |
varchar(50) |
||
composed_index |
Composed index, consists of indexType:entity:productService. |
varchar(255) |
Wholesale
wholesale_chargeable_event
Attribute | Description | Type | Not Null | See |
---|---|---|---|---|
id |
Internal ID, generated from the 'wholesale_chargeable_event_seq' Sequence. |
bigint |
X |
|
ref_id |
Ref ID of the WholesaleChargeableEvent. |
varchar(40) |
X |
|
edr_file_id |
Foreign Key to EdrFile. |
varchar(50) |
X |
|
account_id |
Foreign Key to Account. |
varchar(50) |
||
subscriber_id |
Foreign Key to Subscriber. |
varchar(50) |
||
offer_subscription_id |
Foreign Key to OfferSubscription. |
varchar(50) |
||
charged |
Indicates whether Event is Charged. |
boolean |
||
rejected |
Indicates whether Event is Rejected. |
boolean |
||
guided |
Indicates whether Event is Guided. |
boolean |
||
event_entry |
Timestamp when event was entered. |
timestamptz |
X |
|
event_day |
Event day (YYYYMMDDHH). |
varchar(10) |
||
request_class_name |
Class Name of the Request. |
varchar(255) |
||
request_json |
Request in JSON form, may be changed using GUI. |
varchar |
||
request_unchanged_plain |
Request in Plain form, unchanged. |
varchar |
||
aggregated_event_id |
Foreign Key to AggregatedEvent. |
varchar(50) |
X |
|
bill_cycle_id |
Foreign Key to BillCycle. |
varchar(50) |
||
bill_cycle_run_id |
Foreign Key to BillCycleRun. |
varchar(50) |
||
billing_day |
Billing day (XYYYYMMDD), X = Y/M/W/D. |
varchar(10) |
||
charging_class_id |
Foreign Key to ChargingClass. |
varchar(50) |
||
event_total_price |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Excluding Tax. |
bigint |
||
event_total_price_net |
Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Including Tax. |
bigint |
||
event_total_price_tax |
Tax part of the Total Price. Calculated as a diff between totalPriceNet and totalPrice. |
bigint |
||
composed_index |
Composed index, consists of charged:account:billCycleRun:subscriber:offerSubscription. |
varchar(255) |