Catalog Datatypes
Catalog Datatypes
The section covers datatypes that represent the product catalog.
- Catalog Datatypes
- Product Catalog Diagram (Including APIs)
- Product Catalog and Marketing Diagram
- Account_Field
- Available_NonSubscription_Offering_Scope
- Chart_Of_Accounts
- Collection_Account_Group
- Coupon
- Coupon_Group
- Discount_Rule
- Discount_Rule_Bundle
- Legal_Entity
- NonSubscription_Offering
- NonSubscription_Offering_Bundle_Type
- NonSubscription_Offering_Rate_Schedule
- Notification_Template
- Notification_Template_Group
- Payment_Term
- Plan
- Plan_Group
- Plan_NonSubscription_Offering_Scope
- Plan_Rate_Schedule
- Plan_Relationship
- Product_Field
- Product_Field_Assignment
- Product_Field_Category
- Product_Field_Value
- Rollover_Interval_Type
- Service
- Surcharge
- Surcharge_Rate_Schedule
- Tiered_Pricing_Rule
- Usage_Type
- Usage_Unit_Type
Product Catalog Diagram (Including APIs)
Product Catalog and Marketing Diagram
Account_Field
An Entity with IDs: field_no, field_name.
| Field name | Datatype |
|---|---|
| field_no | BigInt |
| field_name | Text |
| description | Text |
| is_required | Boolean |
| input_type | Ref<Field_Input_Type> |
| minimum_selections | Int |
| maximum_selections | Int |
| created_tstamp | DateTime |
| updated_tstamp | DateTime |
| is_restricted_to_allowed_values | Boolean |
| field_order | Int |
| allowed_values | Array<Account_Field$Allowed_Value> |
| locale_details | Array<Account_Field$Locale_Detail> |
Account_Field Allowed_Value
A component Object of Account_Field
| Field name | Datatype | Description |
|---|---|---|
| value_no | BigInt | |
| value_text | Text | |
| display_value_text | Text |
Account_Field Locale_Detail
A component Object of Account_Field
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| name | Text | |
| description | Text | |
| allowed_values | Array<Account_Field$Allowed_Value> |
Available_NonSubscription_Offering_Scope
An Entity with ID: item_inclusion_type_ind
Chart_Of_Accounts
An Entity with IDs: chart_of_accounts_no, client_chart_of_accounts_id. "chart_of_accounts_no" and "client_chart_of_accounts_id" each independently identify the same item object.
| Field name | Datatype |
|---|---|
| chart_of_accounts_no | BigInt |
| client_chart_of_accounts_id | Text |
| description | Text |
Collection_Account_Group
An Entity with IDs: group_no, client_group_id. "group_no" and "client_group_id" each independently identify the same item object.
Specification of fields in this entity is TBA.
Plan Contract_Completion_Rollover_Rate_Schedule
A component Object of Plan.
| Field name | Datatype |
|---|---|
| current_rate_schedule | Ref<Plan$Rate_Schedule> |
| target_rate_schedule | Ref<Plan$Rate_Schedule> |
Coupon
An Entity with IDs: coupon_code.
| Field name | Datatype |
|---|---|
| coupon_code | Text |
| description | Text |
| is_active | Boolean |
| start_date | Date |
| expire_date | Date |
| application_scope | Ref<Coupon_Application> |
| maximum_uses | BigInt |
| total_uses | BigInt |
| credit_templates | Array<Ref<Credit_Template>> |
| discount_rules | Array<Ref<Discount_Rule>> |
| discount_bundles | Ref<Discount_Rule_Bundle> |
| locale_details | Array<Coupon$Locale_Detail> |
Coupon Locale_Detail
A component Object of Coupon.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| description | Text |
Coupon_Group
An Entity with IDs: coupon_group_no, client_group_id. "coupon_group_no" and "client_coupon_group_id" each independently identify the same item object.
| Field name | Datatype |
|---|---|
| coupon_group_no | BigInt |
| client_coupon_group_id | Text |
| name | Text |
| description | Text |
| precedence | Int |
| coupons | Array<Ref<Coupon>> |
| created_tstamp | DateTime |
Discount_Rule
An Entity with IDs: discount_rule_no, client_discount_rule_id. "discount_rule_no" and "client_discount_rule_id" each independently identify the same item object.
| Field name | Datatype |
|---|---|
| discount_rule_no | BigInt |
| client_discount_rule_id | Text |
| name | Text |
| description | Text |
| external_description | Text |
| discount_type | Ref<Discount_Type> |
| fixed_amount | Decimal |
| percent_amount | Decimal |
| currency | Ref<Currency> |
| applicable_duration_type | Ref<Discount_Rule_Duration> |
| maximum_applicable_duration | Int |
| invoice_application_scope | Ref<Invoice_Application_scope> |
| is_inline_discount | Boolean |
| discount_behavior | Ref<Discount_Behavior> |
| discount_service | Ref<Service> |
| discount_rule_scope | Ref<Discount_Rule_scope> |
| plans | Array<Ref<Plan>> |
| services | Array<Ref<Service>> |
| nonsubscription_offerings | Array<Ref<NonSubscription_Offering>> |
| plan_service_details | Array<Discount_Rule$Plan_Service_Detail> |
| locale_details | Array<Discount_Rule$Locale_Detail> |
| created_tstamp | DateTime |
| remainder_discount_rule_ind | Boolean |
Discount_Rule Plan_Service_Detail
A component Object of Discount_Rule.
| Field name | Datatype |
|---|---|
| plan | Ref<Plan> |
| services | Array<Ref<Service>> |
Discount_Rule Locale_Detail
A component Object of Discount_Rule.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
| description | Text |
| external_description | Text |
Discount_Rule_Bundle
An Entity with IDs: bundle_no, client_bundle_id. "bundle_no" and "client_bundle_id" each independently identify the same item object.
Specification of fields in this entity is TBA.
Legal_Entity
An Entity with IDs: legal_entity_no, client_legal_entity_id.
Specification of fields in this entity is TBA.
NonSubscription_Offering
An Entity with IDs: nonsubscription_offering_no, client_nonsubscription_offering_id, client_sku. "nonsubscription_offering_no" and "client_nonsubscription_offering_id" and "client_sku" each independently identify the same plan object.
| Field name | Datatype |
|---|---|
| nonsubscription_offering_no | BigInt |
| client_nonsubscription_offering_id | Text |
| client_sku | Text |
| name | Text |
| description | Text |
| stock_level | BigInt |
| is_active | Boolean |
| queue_activation_status | Ref<Queue_Activation_Status> |
| queue_date | Date |
| is_auto_create_credit | Boolean |
| auto_created_credit_service | Ref<Service> |
| auto_created_credit_comments | Text |
| has_purchase_restriction | Boolean |
| service | Ref<Service> |
| subunit_quantity | BigInt |
| subunit_label | Text |
| nonsubscription_offering_rate_schedules | Array<Ref<NonSubscription_Offering_Rate_Schedule>> |
| locale_details | Array<NonSubscription_Offering$Locale_Detail> |
| product_field_assignments | Array<Product_Field$Assignment> |
Plan Plan_Nonsubscription_Offering_Individual Nonsubscription_Offering_Schedule_Assignment
AND
Plan Plan_Nonsubscription_Offering_Group Nonsubscription_Offering_Schedule_Assignment
| Field name | Datatype |
|---|---|
| plan_rate_schedule | Ref<Plan$Rate_Schedule> |
| nonsubscription_offering_rate_schedule | Ref<NonSubscription_Offering_Rate_Schedule> |
NonSubscription_Offering_Bundle_Type
An Entity with ID: item_type_code
NonSubscription_Offering Locale_Detail
A component Object of NonSubscription_Offering.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
| description | Text |
| subunit_label | Text |
NonSubscription_Offering_Rate_Schedule
An Entity with IDs: schedule_no, client_rate_schedule_id. "schedule_no" and "client_rate_schedule_id" each independently identify the same nso rate schedule object.
| Field name | Datatype |
|---|---|
| schedule_no | BigInt |
| name | Text |
| client_rate_schedule_id | Text |
| currency | Ref<Currency> |
| is_tax_inclusive | Boolean |
| created_tstamp | DateTime |
| is_default_for_currency | Boolean |
| rate_schedule_tiers | Array<NonSubscription_Offering_Rate_Schedule$NonSubscription_Offering_Rate_Schedule_Tier> |
NonSubscription_Offering_Rate_Schedule NonSubscription_Offering_Rate_Schedule_Tier
A component Object of NonSubscription_Offering_Rate_Schedule.
| Field name | Datatype |
|---|---|
| tier | Int |
| description | Text |
| unit_upper_limit | Decimal |
| rate_per_unit | Decimal |
Notification_Template
An Entity with IDs: template_no, client_template_id. "template_no" and "client_template_id" each independently identify the same plan object.
Specification of fields in this entity is TBA.
Notification_Template_Group
An Entity with IDs: notification_template_group_no, client_notification_template_group_id. "notification_template_group_no" and "client_notification_template_group_id" each independently identify the same plan object.
Specification of fields in this entity is TBA.
Payment_Term
An Entity with IDs: payment_term_no, client_payment_term_id. "payment_term_no" and "client_payment_term_id" each independently identify the same plan object.
Specification of fields in this entity is TBA.
Plan
An Entity with IDs: plan_no, client_plan_id. "plan_no" and "client_plan_id" each independently identify the same plan object.
| Field name | Datatype |
|---|---|
| plan_no | BigInt |
| client_plan_id | Text |
| name | Text |
| description | Text |
| is_active | Boolean |
| is_supplemental_plan | Boolean |
| is_template | Boolean |
| product_field_categories | Array<Ref<Product_Field_Category>> |
| proration_invoice_timing_cd | Ref<Proration_Invoice_Timing_Option> |
| statement_template | Ref<Email_Template> |
| notification_template_group | Ref<Notification_Template_Group> |
| credit_note_template | Ref<Email_Template> |
| credit_memo_template | Ref<Email_Template> |
| rebill_template | Ref<Email_Template> |
| has_plan_cancellation_fee | Boolean |
| cancellation_minimum_months | Int |
| surcharges | Array<Ref<Surcharge>> |
| services_details | Array<Plan$Service_Details> |
| plan_rate_schedules | Array<Ref<Plan$Rate_Schedule>> |
| nonsubscription_offering_bundle_type | Ref<NonSubscription_Offering_Bundle_Type> |
| nonsubscription_offering_individuals | Array<Plan$Plan_NonSubscription_Offering_Individual> |
| nonsubscription_offering_group | Plan_NonSubscription_Offering_Group> |
| available_nonsubscription_offering_scope | Ref<Available_NonSubscription_Offering_Scope> |
| available_nonsubscription_offerings | Array<Ref<NonSubscription_Offering>> |
| default_currency | Ref<Currency> |
| initial_free_period_quantity | Int |
| initial_free_period_type | Ref<Rollover_Interval_Type> |
| initial_plan_instance_status | Ref<Plan_Instance_Status> |
| plan_instance_status_rollover_period_quantity | Int |
| plan_instance_status_rollover_period_type | Ref<Rollover_Interval_Type> |
| rollover_plan_instance_status | Ref<Plan_Instance_Status> |
| rollover_plan | Ref<Plan> |
| rollover_plan_period_quantity | Int |
| rollover_plan_period_type | Ref<Rollover_Interval_Type> |
| contract_completion_rollover_plan | Ref<Plan> |
| contract_completion_rollover_rate_schedules | Array<Plan$Contract_Completion_Rollover_Rate_Schedule> |
| locale_details | Array<Plan$Locale_Detail> |
| product_field_assignments | Array<Product_Field$Assignment> |
| created_tstamp | DateTime |
Plan Locale_Detail
A component Object of Plan.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
Plan Plan_NonSubscription_Offering_Individual
A component Object of Plan.
| Field name | Datatype |
|---|---|
| nonsubscription_offering | Ref<NonSubscription_Offering> |
| item_scope | Ref<Plan_NonSubscription_Offering_Scope> |
| minimum_units_allowed | Int |
| maximum_units_allowed | Int |
| nonsubscription_offering_schedule_assignments | Array<Plan$Plan_NonSubscription_Offering_Individual$NonSubscription_Offering_Schedule_Assignment> |
Plan Plan_NonSubscription_Offering_Group
A component Object of Plan.
| Field name | Datatype |
|---|---|
| item_scope | Ref<Plan_NonSubscription_Offering_Scope> |
| minimum_units_allowed | Int |
| maximum_units_allowed | Int |
| plan_nonsubscription_offering | Array<Plan$Plan_NonSubscription_Offering_Group$NonSubscription_Offering_Schedule_Assignment> |
Plan_Group
An Entity with IDs: plan_group_no, client_plan_group_id. "plan_group_no" and "client_plan_group_id" each independently identify the same plan group object.
| Field name | Datatype |
|---|---|
| plan_group_no | BigInt |
| client_plan_group_id | Text |
| name | Text |
| description | Text |
| usage | Ref<Group_Usage> |
| plans | Array<Ref<Plan>> |
Plan_NonSubscription_Offering_Scope
An Entity with IDs: item_scope
Plan_Rate_Schedule
An Entity with IDs: schedule_no, client_rate_schedule_id. "schedule_no" and "client_rate_schedule_id" each independently identify the same rate schedule object.
| Field name | Datatype |
|---|---|
| schedule_no | BigInt |
| name | Text |
| client_rate_schedule_id | Text |
| currency | Ref<Currency> |
| available_from_date | Date |
| available_to_date | Date |
| recurring_billing_interval | Plan_Rate_Schedule$Billing_Interval |
| usage_billing_interval | Plan_Rate_Schedule$Billing_Interval |
| followup_default_rate_schedule | Ref<Plan_Rate_Schedule> |
| created_tstamp | DateTime |
| is_default_for_currency | Boolean |
| tiers | Array<Plan_Rate_Schedule$Tier> |
| queued_rate_change_date | Date |
| locale_details | Array<Plan_Rate_Schedule$Locale_Detail> |
Plan_Rate_Schedule Tier
A component Object of Plan_Rate_Schedle
| Field name | Datatype | Description |
|---|---|---|
| service | Ref<Service> | |
| tier | BigInt | |
| description | Text | |
| unit_upper_limit | Decimal | |
| rate_per_unit | Decimal | |
| queued_rate_per_unit | Decimal | |
| locale_details | Array<Plan_Rate_Schedule$Tier$Locale_Detail> |
Plan_Rate_Schedule Locale_Detail
A component Object of Plan_Rate_Schedule
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| name | Text |
Plan_Rate_Schedule Tier Locale_Detail
A component Object of Plan_Rate_Schedule$Tier
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| description | Text |
Plan_Rate_Schedule Billing_Interval
A component Object of Plan_Rate_Schedule
| Field name | Datatype | Description |
|---|---|---|
| interval_type | Ref<Billing_Interval_Type> | |
| value | Int |
Plan Service_Details
A component Object of Plan
| Field name | Datatype | Description |
|---|---|---|
| service | Ref<Service> | |
| tiered_pricing_rule | Ref<Tiered_Pricing_Rule> | |
| is_high_water | Boolean | |
| has_usage_tier_multiplier | Boolean | |
| pool_child_billable_unit_thresholds | Boolean | |
| billable_unit_usage_threshold | BigInt | |
| usage_thresholds | Array<Plan$Service_Details$Plan_Service_Usage_Threshold> | |
| is_tax_inclusive | Boolean | |
| avalanche_earn_on_cancel | Boolean | |
| is_fulfillment_based | Boolean | |
| has_single_line_proration | Boolean |
Plan Service_Details Plan_Service_Usage_Threshold
A component Object of Plan$Service_Details
| Field name | Datatype |
|---|---|
| notice_destination_type | Ref<Notice_Destination_Type> |
| notice_balance_type | Ref<Notice_Balance_Type> |
| units | BigInt |
| levels | Array<Plan$Service_Details$Plan_Service_Usage_Threshold$Plan_Service_Usage_Threshold_Level> |
Plan Service_Details Plan_Service_Usage_Threshold Plan_Service_Usage_Threshold_Level
A component Object of Plan$Service_Details$Plan_Service_Usage_Threshold
| Field name | Datatype |
|---|---|
| level_no | Int |
| value | Decimal |
Plan_Relationship
An Entity with IDs: parent_plan_no, child_plan_no. "parent_plan_no" and "child_plan_no" combine identify the plan_relationship object.
| Field name | Datatype |
|---|---|
| parent_plan_no | BigInt |
| child_plan_no | BigInt |
| parent_plan | Ref<Plan> |
| child_plan | Ref<Plan> |
| is_required | Boolean |
| is_default | Boolean |
| minimum_units | Int |
| maximum_units | Int |
| has_account_limits | Boolean |
Product_Field
An Entity with IDs: field_no, field_name.
| Field name | Datatype |
|---|---|
| field_no | BigInt |
| field_name | Text |
| description | Text |
| input_type | Ref<Field_Input_Type> |
| product_field_categories | Array<Ref<Product_Field_Category>> |
| minimum_selections | Int |
| maximum_selections | Int |
| allowed_values | Array<Product_Field$Allowed_Value> |
| object_type_configurations | Array<Product_Field$Object_Type_Configuration> |
| locale_details | Array<Product_Field$Locale_Detail> |
Product_Field Allowed_Value
A component Object of Product_Field
| Field name | Datatype | Description |
|---|---|---|
| value_no | BigInt | |
| value_text | Text | |
| primacy | Int |
Product_Field Object_Type_Configuration
A component Object of Product_Field
| Field name | Datatype | Description |
|---|---|---|
| object_type | Ref<Object_Type> | |
| is_required | Boolean | |
| is_active | Int | |
| is_displayed_on_statement | Boolean | |
| statement_field_replacement_number | Int |
Product_Field Locale_Detail
A component Object of Product_Field
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| name | Text | |
| description | Text | |
| allowed_values | Array<Product_Field$Allowed_Value> |
Product_Field_Assignment
A component Object of Service
| Field name | Datatype | Description |
|---|---|---|
| product_field | Ref<ProductField> | |
| values | Array<[Product_Field$Assignment$Value]> |
Product_Field_Category
An Entity with IDs: category_no, name.
| Field name | Datatype | Description |
|---|---|---|
| category_no | Int | |
| name | Text | |
| description | Text |
Product_Field_Value
A component Object of Product_Field_Assignment
| Field name | Datatype | Description |
|---|---|---|
| value | Text | |
| locale_details | Array<[Product_Field$Assignment$Value$Locale_Detail]> |
Product_Field Assignment Value Locale_Detail
A component Object of Product_Field_Value
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| value | Text |
Rollover_Interval_Type
An Entity with IDs: interval_type_no
Service
An Entity with IDs: service_no, client_service_id. "service_no" and "client_service_id" each independently identify the same service object.
| Field name | Datatype |
|---|---|
| service_no | BigInt |
| client_service_id | Text |
| name | Text |
| service_type | Ref<Service_Type> |
| is_taxable | Boolean |
| service_location | Ref<Service_Location> |
| is_service_credits_eligible | Boolean |
| commodity_code | Text |
| product_field_assignments | Array<Product_Field$Assignment> |
| locale_details | Array<Service$Locale_Detail> |
| tax_service_group | Ref<Tax_Service_Group> |
| revenue_account_gl_code | Ref<Chart_Of_Accounts> |
| account_receivable_gl_code | Ref<Chart_Of_Accounts> |
| deferred_gl_code | Ref<Chart_Of_Accounts> |
Service Locale_Detail
A component Object of Service.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
Surcharge
An Entity with IDs: surcharge_no and client_surcharge_id. "surcharge_no" and "client_surcharge_id" each independently identify the same surcharge object.
| Field name | Datatype |
|---|---|
| surcharge_no | BigInt |
| client_surcharge_id | Text |
| name | Text |
| description | Text |
| external_description | Text |
| assignment_level | Ref<Assignment_Level> |
| application_scope | Ref<Application_Scope> |
| plans | Array<Ref<Plan>> |
| services | Array<Ref<Service>> |
| nonsubscription_offerings | Array<Ref<NonSubscription_Offering>> |
| plan_service_details | Array<Discount_Rule$Plan_Service_Detail> |
| is_applied_before_discount | Boolean |
| is_inline_surcharge | Boolean |
| tax_service_group | Ref<Tax_Service_Group> |
| rate_calculation_type | Ref<Rate_Calculation_Type> |
| locale_details | Array<Surcharge$Locale_Detail> |
| surcharge_rate_schedules | Array<Ref<Surcharge_Rate_Schedule>> |
| created_tstamp | DateTime |
| tax_inclusive_ind | Boolean |
Surcharge Locale_Detail
A component Object of Surcharge.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
| description | Text |
| external_description | Text |
Surcharge_Rate_Schedule
An Entity with IDs: surcharge_no and schedule_no. "surcharge_no" and "schedule_no" together identify the surcharge rate schedule object.
| Field name | Datatype |
|---|---|
| surcharge_no | BigInt |
| schedule_no | BigInt |
| name | Text |
| currency | Ref<Currency> |
| minimum_surcharge_to_apply | Decimal |
| include_zero_in_rate_tier | Boolean |
| surcharge_rate_schedule_tiers | Array<Surcharge_Rate_Schedule$Tiers> |
| is_default_for_currency | Boolean |
| locale_details | Array<Surcharge_Rate_Schedule$Locale_Detail> |
Surcharge_Rate_Schedule Tiers
A component Object of Surcharge_Rate_Schedule
| Field name | Datatype | Description |
|---|---|---|
| tier | BigInt | |
| unit_upper_limit | Decimal | |
| rate | Decimal | |
| description | Text | |
| locale_details | Array<Surcharge_Rate_Schedule$Tiers$Locale_Detail> |
Surcharge_Rate_Schedule Locale_Detail
A component Object of Surcharge_Rate_Schedule
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| name | Text |
Surcharge_Rate_Schedule Tiers Locale_Detail
A component Object of Surcharge_Rate_Schedule$Tiers
| Field name | Datatype | Description |
|---|---|---|
| locale | Ref<Locale> | |
| description | Text |
Tiered_Pricing_Rule
An Entity with ID: rule_no.
Usage_Type
An Entity with IDs: usage_type_no, usage_type_cd. "usage_type_no" and "usage_type_cd" each independently identify the same usage type object.
| Field name | Datatype |
|---|---|
| usage_type_no | BigInt |
| usage_type_cd | Text |
| name | Text |
| display_name | Text |
| description | Text |
| usage_unit_type | Ref<Usage_Unit_Type> |
| product_field_assignments | Array<Product_Field$Assignment> |
| locale_details | Array<Usage_Type$Locale_Detail> |
Usage_Type Locale_Detail
A component Object of Usage_Type.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| name | Text |
| display_name | Text |
| description | Text |
Usage_Unit_Type
An Entity with IDs: usage_unit_type_no, client_usage_unit_type_id. "usage_unit_type_no" and "client_usage_unit_type_id" each independently identify the same usage unit type object.
| Field name | Datatype |
|---|---|
| usage_unit_type_no | BigInt |
| client_usage_unit_type_id | Text |
| description | Text |
| abbreviation | Text |
| display_format_mask | Text |
| locale_details | Array<Usage_Unit_Type$Locale_Detail> |
Usage_Unit_Type Locale_Detail
A component Object of Usage_Unit_Type.
| Field name | Datatype |
|---|---|
| locale | Ref<Locale> |
| description | Text |