| Review the available fields, required fields, valid values, and field-specific requirements for importing Plans and Charges into Ordway. |
A Plans & Charges import includes the following tabs:
Contents
- Before You Begin
- Plans and Charges Imports
- Field Requirements
- Plans Tab
- Charges Tab
- Tiers Tab
- Transaction Posting Entries Tab
- Import Comments
- Related Topics
Before You Begin
- Review How to Build an Import File to learn how to prepare an import file.
- Review Step 2: Import Data for information about importing data.
- Download the Plans & Charges import template from the Import Wizard.
- Make sure you have the required permissions to import Plans and Charges.
Plans and Charges Imports
A Plans & Charges import file includes the following tabs:
- Plans — Contains the fields available for importing Plans.
- Charges — Contains the fields available for importing Charges.
- Tiers — Contains the fields available for importing pricing tiers.
- Transaction Posting Entries — Contains the fields available for importing transaction posting entries for Charges.
Field Requirements
The following indicators identify field requirements:
| Indicator | Description |
|---|---|
| X | Required for the specified operation. |
| * | May be required based on settings or additional selections. |
| — | No specific requirement is defined. |
Plans Tab
The Plans tab contains the fields available for importing Plans.
| Field | API Name | Type | Create | Update | Valid Values | Notes |
| ID | id | Text | X | X | — | — |
| Plan Name | name | Text | X | — | — | — |
| Status | status | Text | — | — | Active, Inactive | Defaults to Draft |
| Description | description | Text | — | — | — | — |
| Plan Lookup | plan_lookup | Lookup | — | — | — | — |
Charges Tab
The Charges tab contains the fields available for importing Charges.
| Field | API Name | Type | Create | Update | Valid Values | Notes |
| Plan ID | plan_id | Text | X | X | — | — |
| Plan Name | — | — | — | — | — | — |
| Product ID | product_id | Text | X | — | — | — |
| Product Name | — | — | — | — | — | |
| Charge ID | id | Text | * | X | — | Required when creating Tiers and/or Transaction Posting Entries. |
| Charge Name | name | Text | X | — | — | — |
| Charge Description | description | Text | — | — | — | — |
| Charge Type | type | Text | X | — | One Time, Recurring, Usage Based | — |
| Charge Status | status | Picker | — | — | Active, Inactive | Available in the import template. |
| Charge Timing | charge_timing | Text | — | — | In Advance, In Arrears, Initial, Termination | — |
| Charge Billing Date | charge_billing_date | Text | — | — | — | — |
| Unit Of Measure | unit_of_measure | Text | — | — | — | — |
| List Price | list_price | Currency | — | — | — | If not provided, defaults to 0. |
| List Price Base | list_price_base | Text | — | — | — | — |
| Pricing Model |
pricing_model |
Text | — | — | Per Unit, Volume, Tiered | — |
| Billing Period Start Alignment |
billing_period_start_alignment |
Text | — | — | Service Start Date, Customer's billing cycle day, Any day of the month 1-31 | Specifies the criteria used to determine the boundary of a charge period. |
| Billing Day |
billing_day |
Text | — | — | Customer's billing cycle day, Align with Billing Period, Any day of the month 1-31 | Specifies the criteria used to determine which day of the month or week the charge is invoiced. |
| Billing Period Start Alignment Month |
billing_period_start_alignment_month |
Text | — | — | — | — |
| Prorate Partial Periods | prorate_partial_periods | Boolean | — | — | Yes, No | If not provided, defaults to No. |
| Backcharge Current Period |
backcharge_current_period |
Boolean | — | — | Yes, No | If not provided, defaults to Yes. |
| Included Units | included_units | Number | — | — | — | — |
| Prepayment Periods | prepayment_periods |
Number | — | — | — | — |
| Prepaid Units |
prepayment_amount |
Number | — | — | — | — |
| Enable Prepaid Units | prepayment_enabled | Boolean | — | — | Yes, No | — |
| Enable Auto Refill Prepaid Units | auto_refill_prepaid_units | Boolean | — | — | Yes, No | — |
| Refill Quantity | refill_qty | Number | — | — | — | — |
| Refill Prepaid Units Based On |
refill_prepaid_units_for |
Text | — | — | Billing Period, Contract Renewal | — |
| Prepaid Units Expiration | prepaid_units_expiry | Text | — | — | Billing Period, Contract Term, Perpetual | — |
| Refund Units on Cancellation | refund_units_on_cancel |
Boolean | — | — | Yes, No | — |
| Remove Units on Cancellation | remove_units_on_cancel | Boolean | — | — | Yes, No | — |
| Billing Period | billing_period | Text | — | — | — | — |
| Enable FMV Allocation | fmv_allocation_enabled | Boolean | — | — | Yes, No | — |
| Fair Market Value (FMV) | fmv | Currency | — | — | — | — |
| Fair Market Value (FMV) Base | fmv_base | Text | — | — | — | — |
| Default Revenue Rule From Product |
default_from_product |
Boolean | — | — | Yes, No | — |
| Revenue Rule ID | revenue_rule_id | Text | — | — | — | — |
| Recognition Start Date | recognition_start_date | Text | — | — | Billing Start Date, Completion Date, Charge Start Date, Term Start Date, Invoice Date, Custom, Contract Effective Date | — |
| Recognition End Date | recognition_end_date | Text | — | — | Charge End Date, Term End Date, Custom | — |
| PrePayment Amount | — | — | — | — | — | — |
| Location ID | location_id | Text | X | — | — | — |
Charge Timing
The Charge Timing field supports the following values:
- In Advance
- In Arrears
- Initial
- Termination
The original import requirements specify that:
- For Recurring charges, Charge Timing defaults to the value configured in General Settings.
- For Usage Based charges, Charge Timing defaults to In Arrears.
Recognition Start Date
The Recognition Start Date field supports the following values:
- Billing Start Date
- Completion Date
- Charge Start Date
- Term Start Date
- Invoice Date
- Custom
- Contract Effective Date
Recognition End Date
The Recognition End Date field supports the following values:
- Charge End Date
- Term End Date
- Custom
Tiers Tab
Use the Tiers tab to import pricing tier information for Charges.
| Field | API Name | Type | Create | Update | Valid Values |
| Plan ID | plan_id | Text | — | — | — |
| Charge ID | charge_id | Text | X | X | — |
| Starting Unit | starting_unit | String | X | — | — |
| Ending Unit | ending_unit | String | X | — | — |
| Price | price | Currency | X | — | — |
| Type | type | Text | X | — | per_unit, flat_fee |
Transaction Posting Entries Tab
Use the Transaction Posting Entries tab to override the default GL accounts for specific transaction types on each Charge.
For information about default GL accounts and updating accounting information for transaction types such as Orders/Contract, Invoice Posting, and Revenue Schedule, see Default GL Accounts and Accounting Information.
Important
When updating Tiers or Transaction Posting Entries, include all records and fields that should be retained in the import file.
The import process overwrites the records on update by deleting the existing records for the subscription and creating new records from the import file.
| Field | API Name | Type | Create | Update | Valid Values |
| Plan ID | plan_id | Text | X | — | — |
| Charge ID | charge_id | Text | X | X | — |
| Transaction Type | transaction_type | Text | — | — | Orders/Contract, Invoice Posting, Revenue Schedule, Credit |
| Debit Account | debit_account | Text | — | — | — |
| Credit Account | credit_account | Text | — | — | — |
Transaction Type
The Transaction Type field supports the following values:
- Orders/Contract
- Invoice Posting
- Revenue Schedule
- Credit
Import Comments
You can add comments to the import file by starting a row with #. Any row that starts with # is ignored during import.
For example:
| # This row will be ignored during import |
Comments
0 comments
Please sign in to leave a comment.