Product aggregate import fields
Use this reference to view all the fields associated with the product aggregate data dictionary.
Note: Fields with an asterisk mark (*) indicate mandatory fields.
| Field Name |
Value | Required to create |
Description |
|---|---|---|---|
| IsNewProduct | boolean (True or False) | Required when creating a new product. Set to true when creating a new product; otherwise set to false or leave blank. | |
| Category* | string | Required for creating a new product. | Specify the product category. Enum:base, add_on, other. |
| End Date* | string (date) | Required for creating a new product. | Product effective end date (UTC, YYYY-MM-DD). Example:2050-12-31 |
| Name* | string | Required for creating a new product. | Product name. Example:New prod. |
| Start Date* | string (date) | Required for creating a new product. | Product effective start date (UTC, YYYY-MM-DD). Example:2024-01-01 |
| Product Number | string | optional | Unique product identifier in the product catalog. Example:PROD-001 |
| SKU | string | optional | Stock keeping unit (SKU) associated with the product or invoice item. Example:SKU-12345 |
| IsNewProductRatePlan | boolean (True or False) | Required when creating a new product rate plan. Set totrue when creating a new product rate plan; otherwise set to false or leave blank. | |
| Product Rate Plan > Active Currencies* | array of strings | Required for creating a new product rate plan. | ISO currency codes enabled for the rate plan. Example:USD |
| Product Rate Plan > End Date* | string (date) | Required for creating a new product rate plan. | Rate plan effective end date (UTC, YYYY-MM-DD). Example:2050-12-31 |
| Product Rate Plan > Name* | string | Required for creating a new product rate plan. | Rate plan name. Example:Consumer Bronze Monthly 2 |
| Product Rate Plan > Start Date* | string (date) | Required for creating a new product rate plan. | Rate plan effective start date (UTC, YYYY-MM-DD). Example:2024-01-01 |
| Product Rate Plan > Description | string | optional | Description of the rate plan. Example:Software service - basic edition |
| IsNewProductRatePlanProductRatePlanCharge | boolean (True or False) | Required when creating a product rate plan charge. Set totrue when creating a new product rate plan charge; otherwise set to false or leave blank. | |
| Product Rate Plan > Product Rate Plan Charge > Charge Model* | string | Required for creating a product rate plan charge. | Enum: flat_fee, per_unit, overage, volume, tiered, tiered_overage, discount_fixed_amount, discount_percentage, custom_charge_model, delivery, minimum_commitment_true_up, calculated, high_water_mark_volume_pricing, high_water_mark_tiered_pricing, multi_attribute_pricing, prerated_pricing, and prerated_per_unit. |
| Product Rate Plan > Product Rate Plan Charge > Charge Type* | string | Required for creating a product rate plan charge. | Enum: one_time, recurring, usage. |
| Product Rate Plan > Product Rate Plan Charge > End Date Condition* | string (date) | Required for creating a product rate plan charge. | Charge effective end date (UTC, YYYY-MM-DD). Example:2050-12-31 |
| Product Rate Plan > Product Rate Plan Charge > Name* | string | Required for creating a product rate plan charge. | Example: Data Usage Charge. |
| Product Rate Plan > Product Rate Plan Charge > Trigger Event* | string | Required for creating a product rate plan charge. | Event that triggers the charge. Enum:contract_effective, service_activation, customer_acceptance, specific_date. |
| Product Rate Plan > Product Rate Plan Charge > Default Quantity | number | optional | Default quantity for subscriptions created from this charge. Example:1 |
| Product Rate Plan > Product Rate Plan Charge > Description | string | optional | Description of the charge. |
| Product Rate Plan > Product Rate Plan Charge > List Price Base | string | optional | List price basis. Valid values: Per_Billing_Period, Per_Month, Per_Week, Per_Year, Per_Specific_Months, Per_Validity_Period. |
| Product Rate Plan > Product Rate Plan Charge > Max Quantity | number | optional | Maximum quantity allowed for this charge. Example: 999999 |
| Product Rate Plan > Product Rate Plan Charge > Min Quantity | number | optional | Minimum quantity allowed for this charge. Example: 1 |
| Product Rate Plan > Product Rate Plan Charge > Price Change Option | string | optional | Specifies how future price changes are handled. Valid values: no_change, specific_percentage_value, use_latest_product_catalog_pricing. |
| Product Rate Plan > Product Rate Plan Charge > Price Increase Percentage | number (double) | optional | Percentage used when the price change option applies a specific percentage increase. Example: 5 |
| Product Rate Plan > Product Rate Plan Charge > Specific List Price Base | string | optional | List price base for the charge. Valid values: Per_Billing_Period, Per_Month, Per_Week, Per_Year, Per_Specific_Months, Per_Validity_Period. Example: Per_Billing_Period. |
| Product Rate Plan > Product Rate Plan Charge > Tax Code | string | optional | Tax code used for tax calculation on this charge. |
| Product Rate Plan > Product Rate Plan Charge > Tax Mode | string | optional | Tax mode for this charge. Valid values: non_taxable, tax_exclusive, tax_inclusive. |
| Product Rate Plan > Product Rate Plan Charge >Taxable | boolean | optional | Determine if the charge is taxable. |
| Product Rate Plan > Product Rate Plan Charge > Unit of Measure | string | optional | Unit of measure for per-unit or usage charges. Example: Each |
| Product Rate Plan > Product Rate Plan Charge > Up To Periods | integer | optional | Number of periods used when end_date_condition = fixed_period. Example: 0 |
| Product Rate Plan > Product Rate Plan Charge > Up To Periods Type | string | optional | Time unit used when end_date_condition = fixed_period. Valid values: billing_periods, days, weeks, months, years. |
| Product Rate Plan > Product Rate Plan Charge > Use Tenant Default For Price Change | boolean | optional | Uses the tenant-level default setting for price change behavior instead of the charge-level setting. Example:true |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle > Bill Cycle Type* | string | Required for creating a new product rate plan charge | Determines how the billing day is selected. Valid values: default_from_customer, specific_day_of_month, subscription_start_day, charge_trigger_day, specific_day_of_week, term_start_day, term_end_day. |
| Product Rate Plan > Product Rate Plan Charge >Bill Cycle > Billing Period* | string | Required for creating a new product rate plan charge. | Length of each billing period. Valid values include bill_cycle_period_month, bill_cycle_period_quarter, bill_cycle_period_semi_annual, bill_cycle_period_annual, bill_cycle_period_eighteen_months, bill_cycle_period_two_years, bill_cycle_period_three_years, bill_cycle_period_five_years, bill_cycle_period_specific_months, bill_cycle_period_subscription_term, bill_cycle_period_week, bill_cycle_period_specific_weeks, and bill_cycle_period_specific_days. |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle > Period Alignment* | string | Required for creating a new product rate plan charge. | Defines how the billing period start aligns. Valid values: align_to_charge, align_to_subscription_start, align_to_term_start, align_to_term_end. |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle > Billing Timing | string | optional | Specifies when the charge is billed relative to the service period. Valid values: in_advance, in_arrears. |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle > Day of Month | integer (1–31) | optional | Required when bill cycle type is specific_day_of_month. Example: 5 |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle > Day of Week | string | optional | Used when bill cycle type is specific_day_of_week. Valid values: sunday, monday, tuesday, wednesday, thursday, friday, saturday. |
| Product Rate Plan > Product Rate Plan Charge > Bill Cycle >g Specific Period | string | optional | Specific period value used when billing period is bill_cycle_period_specific_months, bill_cycle_period_specific_weeks, or bill_cycle_period_specific_days. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Accounting Code | string | optional | Accounting code associated with the charge for reporting or ERP mapping. Example:PRPC-REV-001. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Accounts Receivable Account | string | optional | Accounts Receivable (AR) account used to book invoices. Example:Accounts Receivable. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Accounts Receivable Account Type | string | optional | Account type associated with the Accounts Receivable account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Adjustment Liability Account | string (≤100 characters) | optional | Name of the Adjustment Liability account. Example:adjustL-1 |
| Product Rate Plan > Product Rate Plan Charge > Accounting Adjustment Liability Account Type | string | optional | Account type associated with the Adjustment Liability account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Adjustment Revenue Account | string (≤100 characters) | optional | Name of the Adjustment Revenue account. Example:adjustRev-1 |
| Product Rate Plan > Product Rate Plan Charge > Accounting Adjustment Revenue Account Type | string | optional | Account type associated with the Adjustment Revenue account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Asset Account | string (≤100 characters) | optional | Name of the Contract Asset account. Example:CA-2 |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Asset Account Type | string | optional | Account type associated with the Contract Asset account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Liability Account | string (≤100 characters) | optional | Name of the Contract Liability account. Example:CL-2. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Liability Account Type | string | optional | Account type associated with the Contract Liability account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Recognized Revenue Account | string | optional | Recognized revenue account used for contract-based revenue recognition. Example:Contract Recognized Revenue |
| Product Rate Plan > Product Rate Plan Charge > Accounting Contract Recognized Revenue Account Type | string | optional | Account type associated with the Contract Recognized Revenue account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Deferred Revenue Account | string | optional | Deferred revenue liability account used before revenue recognition. Example:Deferred Revenue. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Deferred Revenue Accounting Type | string | optional | Accounting method or type applied to deferred revenue. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Recognized Revenue Account | string (≤100 characters) | optional | Name of the Recognized Revenue account. Example:ContractRevRec-1 |
| Product Rate Plan > Product Rate Plan Charge > Accounting Recognized Revenue Account Type | string | optional | Account type associated with the Recognized Revenue account. |
| Product Rate Plan > Product Rate Plan Charge > Accounting Unbilled Receivables Account | string (≤100 characters) | optional | Name of the Unbilled Receivables account. Example:unbilledR-1 |
| Product Rate Plan > Product Rate Plan Charge > Accounting Unbilled Receivables Account Type | string | optional | Account type associated with the Unbilled Receivables account. |
| Product Rate Plan > Product Rate Plan Charge > Overage Options > Number of Periods | integer | optional | Number of periods used for overage calculations. Example:0 |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Apply To | array of strings | optional | Charge types to which the discount applies. Valid values: one_time, recurring, usage. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Apply To Billing Period Partially | boolean | optional | Allows the discount to apply to partial billing periods. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Discount Class | string | optional | Discount class associated with this discount charge. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Discount Level | string | optional | Level at which the discount applies. Valid values: rate_plan, subscription, account. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Reflect Discount In Net Amount | boolean | optional | Reflects the discount directly in the net amount. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Rollover | boolean | Optional | Determines whether unused discount amounts roll over to the next billing period. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Specific Accounting Codes | boolean | optional | Uses discount-specific accounting codes instead of inheriting accounting codes from discounted charges. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Stacked Discount | boolean | optional | Determines whether this discount can be stacked with other discounts. |
| IsNewProductRatePlanProductRatePlanChargeDiscountOptionsDiscountApplyDetails | boolean (True or False) | Required when applying discounts. | Enter True when applying discounts to rate plan charges; otherwise, set to False or leave blank. |
| Product Rate Plan > Product Rate Plan Charge > Discount Options Apply Details > Applied Product Rate Plan Charge Id | string | Required for applying a discount to a rate plan charge. | ID of the target product rate plan charge. |
| Product Rate Plan Product Rate Plan Charge Discount Options Apply Details > Applied Product Rate Plan Id | string | Required for applying a discount to a rate plan. | ID of the target product rate plan. |