Home > Aria Crescendo Documentation > Data Feed Web Service > Data Feed Logical Object Model

Data Feed Logical Object Model

Index of Datatypes
Datatype Concepts
General Datatypes
1. Objects
  1. Ref
Financial Datatypes
Account Datatypes
Catalog Datatypes
Configuration Datatypes

Aria Billing Logical Model

Table of Contents

Index of Datatypes
Datatype Concepts
- Objects
- Entities
- Arrays
- Primitives
General Datatypes
- Objects
  - Ref
Financial Datatypes
Account Datatypes
Catalog Datatypes
Configuration Datatypes

Index of Datatypes

In this reference documentation, datatypes are grouped into the following broad categories. This grouping does not reflect any distinction in the datatype definitions or behavior.

Category	Description
General	General purpose datatypes
Financial	Data that relates to financial activity
Account	Data that relates to specific accounts
Product Catalog	Data that represents the product catalog
Configuration	Data that represents client configurations

DataType	Type Class	Doc Chapter
Account	Entity	Account
Account_Coupon_Assignment	Entity	Account
Account_Discount_Rule_Assignment	Entity	Account
Account_Field	Entity	Product Catalog
Account_Status	Entity	Configuration
Auto_Offset_Months_Option	Entity	Configuration
Available_NonSubscription_Offering_Scope	Entity	Product Catalog
BigInt	Primitive	General
Billing_Group	Entity	Account
Billing_Group_Status	Entity	Configuration
Boolean	Primitive	General
Collection_Account_Group	Entity	Product Catalog
Collection_Status	Entity	Configuration
Comment	Entity	Account
Contact	Entity	Account
Contract	Entity	Account
Contact_Type_Notified	Entity	Configuration
Contract_Scope	Entity	Configuration
Contract_Status	Entity	Configuration
Contract_Type	Entity	Configuration
Country	Entity	Configuration
Coupon	Entity	Product Catalog
Coupon_Directive	Entity	Configuration
Credit_Memo	Entity	Financial
Credit_Reason	Entity	Configuration
Credit_Ref_Type	Entity	Configuration
Currency	Entity	Configuration
Date	Primitive	General
DateTime	Primitive	General
Decimal	Primitive	General
Discount_Rule	Entity	Product Catalog
Discount_Rule_Bundle	Entity	Product Catalog
Dunning_Group	Entity	Account
Dunning_Process	Entity	Configuration
Dunning_Step	Entity	Configuration
Dunning_State	Entity	Configuration
Dunning_Group_Status	Entity	Configuration
Email_Template	Entity	Configuration
Fee_Configuration	Entity	Configuration
Fee_Type	Entity	Configuration
Field_Input_Type	Entity	Configuration
Force_Bill_Date_Reset	Entity	Configuration
Force_Master_Bill_Date_Reset	Entity	Configuration
Functional_Account_Group	Entity	Configuration
Int	Primitive	General
Invoice	Entity	Financial
Invoice_Reversal	Entity	Financial
Invoice_Status	Entity	Configuration
Invoice_Type	Entity	Configuration
Invoicing_Option	Entity	Configuration
Locale	Entity	Configuration
NonSubscription_Offering	Entity	Product Catalog
NonSubscription_Offering_Bundle_Type	Entity	Product Catalog
NonSubscription_Offering_Rate_Schedule	Entity	Product Catalog
Notice_Balance_Type>	Entity	Configuration
Notice_Destination_Type>	Entity	Configuration
Notification_Template	Entity	Product Catalog
Notification_Template_Group	Entity	Product Catalog
Notify_Method	Entity	Configuration
Object_Type	Entity	Configuration
Object_Type_Configuration	Entity	Configuration
Order	Entity	Financial
Order_Line	Entity	Financial
Order_Status	Entity	Configuration
Payment_Assignment	Entity	Configuration
Payment_Method	Entity	Configuration
Payment_Method_Status	Entity	Configuration
Payment_Method_Type	Entity	Configuration
Payment_Processor	Entity	Configuration
Payment_Term	Entity	Product Catalog
Pending_Invoice_Line	Entity	Financial
Plan	Entity	Product Catalog
Plan_Assignment	Entity	Configuration
Plan_Instance	Entity	Account
Plan_Instance_Change_Type	Entity	Configuration
Plan_Instance_Coupon_Assignment	Entity	Account
Plan_Instance_Discount_Rule_Assignment	Entity	Account
Plan_Instance_Status	Entity	Configuration
Plan_NonSubscription_Offering_Scope	Entity	Product Catalog
Plan_Payment_Assignment	Entity	Configuration
Plan_Rate_Schedule	Entity	Product Catalog
Plan_Relationship	Entity	Product Catalog
Plan_Unit_Instance	Entity	Account
Product_Field	Entity	Product Catalog
Product_Field_Category	Entity	Product_Catalog
Product_Field$Assignment	Object	Product Catalog
Product_Field$Assignment$Value	Object	Product Catalog
Product_Field$Assignment$Value$Locale_Detail	Object	Product Catalog
Product_Field_Assignment_Directive	Entity	Configuration
Proration_Directive	Entity	Configuration
Proration_Invoice_Timing_Option	Entity	Configuration
Queue_Activation_Status	Entity	Configuration
Queue_Status	Entity	Configuration
Queued_Plan_Instance_Change	Entity	Account
Rebill_Reason	Entity	Configuration
Recurring_Credit	Entity	Product Catalog
Recurring_Credit_Expiration_Type	Entity	Configuration
Recurring_Credit_Reason	Entity	Configuration
Recurring_Credit_Status	Entity	Configuration
Recurring_Credit_Type	Entity	Configuration
Ref	Object	General
Refund_Reason	Entity	Configuration
Responsibility_Level	Entity	Configuration
Rollover_Interval_Type	Entity	Product Catalog
Service	Entity	Product Catalog
Service_Credit	Entity	Financial
Service_Location	Entity	Product Catalog
Service_Type	Entity	Configuration
SmallInt	Primitive	General
Statement	Entity	Financial
Statement_Status	Entity	Configuration
Surcharge	Entity	Product Catalog
Surcharge_Rate_Schedule	Entity	Product Catalog
Tax_Authority_Level	Entity	Configuration
Tax_Detail	Object	Financial
Tax_Exempt_Level	Entity	Configuration
Tax_Service_Group	Entity	Configuration
Template_Class	Entity	Configuration
Template_Distillation_Behavior	Entity	Configuration
Text	Primitive	General
Tiered_Pricing_Rule>	Entity	Product Catalog
Transaction	Entity	Financial
Transaction_Application	Entity	Financial
Transaction_Type	Entity	Configuration
Usage_Record	Entity	Account
Usage_Type	Entity	Product Catalog
Usage_Accumulation_Renewal_Option	Entity	Configuration
Write_Off_Reason	Entity	Configuration

Datatype Concepts

Objects

At the highest level, all Aria logical model data are represented by objects. Objects are simply bundles of name/value pairs in a manner similar to JSON objects. Also similar to JSON objects, the fields of Aria logical model objects may be simple primitives, may be complex structured elements such as other objects or arrays.

Object fields may have null values. Such a value indicates that that object element is defined to have no value.

Entities

Entities are a special kind of object. They are objects that have clear and unique identifiers. Those identifiers are called "Refs". (See Ref.)

All entities are objects, but not all objects are entities. For instance, only entities may appear as the top-level values of data stream events. Non-entity objects may only appear as values contained within other higher level objects as either field or array elements.

Arrays

Some object fields are defined as being arrays of some other datatype. All elements of the array will conform to the defined element datatype. Arrays may have zero or more elements.

Primitives

These are the primitive datatypes used by the Aria logical model.

Type Name	Description
Text<max-size>	Freeform text. <max-size> is an optional indicator. Default is no limit.
BigInt	Range: +- 2^32 (+- 9223372036854775807)
Int	Range: +- 2^16 (+- 2147483647 )
SmallInt	Range: +- 2^8 (+- 32767 )
Decimal	Numerical representation with decimal part
Boolean	true or false
Date	A date with no time element
DateTime	A timestamp

General Datatypes

The section covers datatypes that apply broadly to all contexts.

Objects

Ref

An Object.

Refs are references to entities. Refs combine an entity object type and the id values that identify that object.

The specific ids vary by entity type and are documented for each entity datatype. Some types have multiple ids each of which can uniquely identify the entity by itself. An example is Account, where the "account_no", "client_account_id" and "userid" fields can each uniquely identify the same account by themselves. Other types require a combination of ids to fully identify an object. An example of this is Payment_Method, where a combination of both "account_no" and "payment_method_no" are necessary in order to identify a specific payment method object.

Field name	Datatype	Description
type	Text	Name of a logical model datatype
ids	Object	Associative array (a map) of an entity's id values

Examples in JSON:

{ "type": "Account", "ids": { "account_no": 543262, "client_account_id": "john.doe", "userid": "991124" } }
{ "type": "Plan_Instance", "ids": { "plan_instance_no": 959239423, "client_plan_instance_id": "992.2221-z" } }
{ "type": "Transaction", "ids": { "transaction_no": 623496 } }
{ "type": "Payment_Method", "ids": { "account_no": 543262, "payment_method_no": 3 } }

Financial Datatypes

The section covers datatypes that represent financial activity.

Credit_Memo

An Entity with ids: credit_memo_no.

Field name	Datatype	Description
credit_memo_no	BigInt
account	Ref<Account>
currency	Ref<Currency>
amount	Decimal	This value will always be negative since it represents a credit.
created_tstamp	DateTime
credit_reason	Ref<Credit_Reason>
credit_ref_type	Ref<Credit_Ref_Type>
invoice	Ref<Invoice>
comments	Text
customer_note	Text
lines	Array<Ref<Transaction>>
tax_details	Array<Tax_Detail>

Invoice

An Entity. Ids invoice_no.

Field name	Datatype	Description
invoice_no	BigInt
invoice_type	Ref<Invoice_Type>
status	Ref<Invoice_Status>
account	Ref<Account>
billing_group	Ref<Billing_Group>
statement	Ref<Statement>
original_invoice	Ref<Invoice>
rebill_invoice	Ref<Invoice>
rebill_reason	Ref<Rebill_Reason>
taxation_address	Ref<Contact>
recurring_bill_from	Date
recurring_bill_through	Date
usage_from	Date
usage_through	Date
currency	Ref<Currency>
amount	Decimal	negative amount denotes a credit
invoice_balance_forward	Decimal
total_due	Decimal
billed_tstamp	DateTime
paid_tstamp	DateTime
custom_status_label	Text
custom_status_description	Text
invoice_comments	Text
additional_comments	Text
client_notes	Text
created_tstamp	DateTime
updated_tstamp	DateTime
lines	Array<Ref<Transaction>>
pending_lines	Array<Ref<Invoice$Pending_Invoice_Line>>
tax_details	Array<Tax_Detail>
pending_tax_details	Array<Pending_Tax_Detail>
usage_record_status	Ref<Invoice_Usage_Record_Status>
discount_details	Array<Discount_Detail>
pending_discount_details	Array<Pending_Discount_Detail>
surchage_details	Array<Surcharge_Detail>
pending_surcharge_details	Array<Pending_Surcharge_Detail>

Invoice$Pending_Tax_Detail

A component Object of Invoice.

Field name	Datatype	Description
tax_detail_line_no	Int
summary_line	Ref<Pending_Invoice_Line>
taxed_line	Ref<Pending_Invoice_Line>
tax_rate	Decimal
tax_amount_unrounded	Decimal
previous_amount_carryover	Decimal
current_amount_carryover	Decimal
before_round_adjusted_tax_amount	Decimal
amount	Decimal
is_taxed_line_tax_inclusive	Boolean
tax_authority_level	Ref<Tax_Authority_Level>
external_tax_type_id	Text
external_tax_type_description	Text
external_category	Text
external_jurisdiction_name	Text
external_tax_summary	Text

Invoice$Discount_Detail

A component Object of Invoice.

Field name	Datatype	Description
discount_detail_line_no	Int
discount_invoice_line	Ref<Transaction>
discounted_invoice_line	Ref<Transaction>
discount_rule	Ref<Discount_Rule>
discount_amount	Decimal
source_coupon	Ref<Coupon>
remainder_discount_factor	Decimal

Invoice$Pending_Discount_Detail

A component Object of Invoice.

Field name	Datatype	Description
discount_detail_line_no	Int
discount_invoice_line	Ref<Pending_Invoice_Line>
discounted_invoice_line	Ref<Pending_Invoice_Line>
discount_rule	Ref<Discount_Rule>
discount_amount	Decimal
source_coupon	Ref<Coupon>
remainder_discount_factor	Decimal

Invoice$Surcharge_Detail

A component Object of Invoice.

Field name	Datatype	Description
surcharge_detail_line_no	Int
surcharge_invoice_line	Ref<Transaction>
surcharged_invoice_line	Ref<Transaction>
surcharge_amount	Decimal
surcharge	Ref<Surcharge>

Invoice$Pending_Surcharge_Detail

A component Object of Invoice.

Field name	Datatype	Description
surcharge_detail_line_no	Int
surcharge_invoice_line	Ref<Pending_Invoice_Line>
surcharged_invoice_line	Ref<Pending_Invoice_Line>
surcharge_amount	Decimal
surcharge	Ref<Surcharge>

Invoice_Reversal

An Entity with ids: reversal_no.

Field name	Datatype	Description
reversal_no	BigInt
account	Ref<Account>
currency	Ref<Currency>
amount	Decimal	This value will always be negative since it represents a credit.
created_tstamp	DateTime
comments	Text
lines	Array<Ref<Transaction>>
tax_details	Array<Tax_Detail>

Order

An Entity with ids: order_no, client_order_id. "order_no" and "client_order_id" each independently identify the same plan instance object.

Field name	Datatype	Description
order_no	BigInt
client_order_id	Text
purchase_order_number	Text
account	Ref<Account>
plan_instance	Ref<Plan_Instance>
invoice	Ref<Invoice>
status	Ref<Order_Status>
currency	Ref<Currency>
amount	Decimal
fulfill_date	Date
created_receipt_id	Text<50>
updated_receipt_id	Text<50>
statement_message	Text
lines	Array<Ref<Order_Line>>
comments	Text
created_tstamp	DateTime
updated_tstamp	DateTime

Order_Line

An Entity with ids: order_no, line_no. "order_no" and "line_no" in combination uniquely identify an order line object.

Field name	Datatype	Description
order	Ref<Order>
line_no	Int
nonsubscription_offering	Ref<Nonsubscription_Offering>
units	Decimal
unit_amount	Decimal
line_amount	Decimal
label	Text
long_description	Text
alt_label	Text
line_comments	Text
service_location	Ref<Service_Location>
destination_contact	Ref<Contact>

Pending_Invoice_Line

An Entity with ids: invoice_no, line_no. "invoice_no" and "line_no" in combination uniquely identify a pending invoice line object.

Field name	Datatype	Description
invoice	Ref<Invoice>
line_no	Int
plan	Ref<Plan>
plan_instance	Ref<Plan_Instance>
service	Ref<Service>
service_credit	Ref<Service_Credit>
service_credit_source_transaction	Ref<Transaction>
plan_rate_schedule	Ref<Plan_Rate_Schedule>
usage_type	Ref<Usage_type>
order_line	Ref<Order_Line>
credit_coupon	Ref<Coupon>
purchase_order_number	Text
start_date	Date
end_date	Date
advance_billing_period_total_days	SmallInt
plan_rate_schedule_service_tier	SmallInt
units	Decimal
rate	Decimal
base_plan_units	Decimal
proration_factor	Decimal
proration_description	Text
proration_remaining_days	SmallInt
credit_reason	Ref<Credit_Reason>
is_tax_related	Boolean
comments	Text
surcharge_rate_schedule	Ref<Surcharge_Rate_Schedule>
surcharge_rate_schedule_tier	SmallInt
proration_operation_type	Ref<Proration_Operation_Type>
nonsubscription_offering_rate_schedule	Ref<NonSubscription_Offering_Rate_Schedule>
nonsubscription_offering_rate_schedule_tier	Int
is_custom_rated	Boolean

Recurring_Credit

An Entity with ids: recurring_credit_no.

Field name	Datatype	Description
recurring_credit_no	BigInt
account	Ref<Account>
eligible_service_types	Array<Ref<Service_Type>>
eligible_plan_instances	Array<Recurring_Credit$Eligible_Plan_Instance>
eligible_plans	Array<Recurring_Credit$Eligible_Plan>
use_charge_service	Boolean
credit_service	Ref<Service>
recurring_credit_type	Ref<Recurring_Credit_Type>
recurring_credit_amount	Decimal
percentage_source_plan	Ref<Plan>
percentage_source_service	Ref<Service>
reason	Ref<Recurring_Credit_Reason>
comments	Text
currency	Ref<Currency>
number_of_credits_required	Int
number_of_credits_remaining	Int
created_tstamp	DateTime
credit_interval_months	Int
first_credit_date	Date
last_credit_date	Date
next_credit_date	Date
status	Ref<Recurring_Credit_Status>
cancel_date	Date
cancel_comments	Text
source_coupon	Ref<Coupon>
expiration_type_indicator	Ref<Recurring_Credit_Expiration_Type>
expiration_months	Int
expiration_date	Date
master_plan_instance	Ref<Plan_Instance>

Recurring_Credit$Eligible_Plan

A component Object of Recurring_Credit.

Field name	Datatype
plan	Ref<Plan>
service	Ref<Service>

Recurring_Credit$Eligible_Plan_Instance

A component Object of Recurring_Credit.

Field name	Datatype
plan_instance	Ref<Plan_Instance>
service	Ref<Service>

Service_Credit

An Entity with ids: credit_no.

Field name	Datatype	Description
credit_no	BigInt
account	Ref<Account>
master_plan_instance	Ref<Plan_Instance>
created_tstamp	DateTime
create_user	Text
amount	Decimal	This value will always be negative or zero since it represents a credit.
unconsumed_amount	Decimal	This value will always be negative or zero since it represents a credit.
amount_reserved_for_anniversary	Decimal	This value will always be negative or zero since it represents a credit.
currency	Ref<Currency>
credit_reason	Ref<Credit_Reason>
comments	Text
expiry_months	Int
expiry_tstamp	DateTime
cancelled_tstamp	DateTime
cancel_user	Text
credit_service	Ref<Service>
service_credit_eligibilities	Array<Service_Credit$Eligibility>
originating_coupon	Ref<Coupon>
originating_recurring_credit	Ref<Recurring_Credit>
originating_invoice_line	Ref<Transaction>
is_order_based	Boolean
use_charge_service	Boolean
remaining_days_when_prorated	Int
total_days_when_prorated	Int

Service_Credit$Eligibility

A component Object of Service_Credit.

Field name	Datatype
service_type	Ref<Service_Type>
service	Ref<Service>
plan	Ref<Plan>
plan_instance	Ref<Plan_Instance>

Statement

An Entity with id: statement_no.

Field name	Datatype	Description
statement_no	BigInt
account	Ref<Account>
invoice	Ref<Invoice>
billing_group	Ref<Billing_Group>
payment_method	Ref<Payment_Method>
master_plan_instances	Array<Ref<Plan_Instance>>
seq_statement_id	Text
statement_contact	Ref<Contact>
created_tstamp	DateTime
due_date	Date
due_date_plus_grace_period	Date
sent_tstamp	DateTime
resent_tstamp	DateTime
status	Ref<Statement_Status>
is_rebill	Boolean
currency	Ref<Currency>
new_charges_amount	Decimal
new_payments_amount	Decimal
balance_forward_amount	Decimal
total_owed	Decimal
unapplied_credit_balance	Decimal
unapplied_payment_balance	Decimal
transactions	Array<Ref<Transaction>>
mpi_transfers_in	Array<Ref<Plan_Instance>>
mpi_transfers_out	Array<Ref<Plan_Instance>>

Tax_Detail

An Object.

Field name	Datatype	Description
tax_detail_line_no	Int
summary_line	Ref<Transaction>
taxed_line	Ref<Transaction>
tax_rate	Decimal
tax_amount_unrounded	Decimal
previous_amount_carryover	Decimal
current_amount_carryover	Decimal
before_round_adjusted_tax_amount	Decimal
amount	Decimal
is_taxed_line_tax_inclusive	Boolean
tax_authority_level	Ref<Tax_Authority_Level>
external_tax_type_id	Text
external_tax_type_description	Text
external_category	Text
external_jurisdiction_name	Text
external_tax_summary	Text

Transaction

An Entity with ids: transaction_no.

Some fields only apply for certain transaction_type values.

Field name	Datatype	Description
transaction_no	BigInt	all transaction types
transaction_type	Ref<Transaction_Type>	all transaction types
created_tstamp	DateTime	all transaction types
source_no	BigInt	all transaction types
account	Ref<Account>	all transaction types
currency	Ref<Currency>	all transaction types
amount	Decimal	all transaction types<br/>Positive for debit, negative for credit.
applied_amount	Decimal	all transaction types<br/>Positive for debit, negative for credit.
fully_applied_tstamp	DateTime	all transaction types
statement	Ref<Statement>	all transaction types
master_plan_instance	Ref<Plan_Instance>	all transaction types
api_receipt_id	Text	all transaction types
transaction_supp_fields	Array<Transaction$Supplemental_Field>	all transaction types
voided_transaction	Ref<Transaction>	all transaction types
voiding_transaction	Ref<Transaction>	all transaction types
applications	Array<Ref<Transaction_Application>>	all transaction types
*<br/>=== External Payment types ===*
payment_tstamp	DateTime	only Type 2
reference_id	Text<40>	only Type 2
*<br/>=== Electronic Payment types ===*
payment_tstamp	DateTime	only Type 3
collection_status	Ref<Collection_Status>	only Type 3
payment_method	Ref<Payment_Method>	only Type 3
processor_payment_id	Text<1000>	only Type 3
payment_processor	Ref<Payment_Processor>	only Type 3
payment_method_type	Ref<Payment_Method_Type>	only Type 3
processor_status_cd	Text<20>	only Type 3
processor_status_label	Text	only Type 3
*<br/>=== Balance Transfer types ===*
from_account	Ref<Account>	only Types 4 and 5
from_master_plan_instance	Ref<Plan_Instance>	only Types 4 and 5
to_account	Ref<Account>	only Types 4 and 5
to_master_plan_instance	Ref<Plan_Instance>	only Types 4 and 5
invoice	Ref<Invoice>	only Types 4 and 5
*<br/>=== Balance Forward types ===*
comments	Text	only Types 9 and 18
*<br/>=== Write Off type ===*
write_off_tstamp	DateTime	only Type 6
comments	Text	only Type 6
write_off_reason	Ref<Write_Off_Reason>	only Type 6
secondary_write_off_reason	Ref<Write_Off_Reason>	only Type 6
invoice	Ref<Invoice>	only Type 6
*<br/>=== Cash Credit type ===*
comments	Text	only Type 10
credit_reason	Ref<Credit_Reason>	only Type 10
invoice	Ref<Invoice>	only Type 10
dispute_hold_expire_days	Int
*<br/>=== Dunning Charge type ===*
*<br/>=== Electronic Refund type ===*
refund_reason	Ref<Refund_Reason>	only Type 12
reversal	Ref<Invoice_Reversal>	only Type 12
payment_method	Ref<Payment_Method>	only Type 12
payment_method_type	Ref<Payment_Method_Type>	only Type 12
*<br/>=== Check Refund type ===*
processed_tstamp	DateTime	only Type 13
comments	Text	only Type 13
refund_reason	Ref<Refund_Reason>	only Type 13
reference_id	Text<40>	only Type 13
*<br/>=== Invoice Line types ===*
invoice	Ref<Invoice>	only Types 21 and 22
line_no	Int	only Types 21 and 22
plan	Ref<Plan>	only Types 21 and 22
plan_instance	Ref<Plan_Instance>	only Types 21 and 22
service	Ref<Service>	only Types 21 and 22
usage_type	Ref<Usage_Type>	only Types 21 and 22
order_line	Ref<Order_Line>	only Types 21 and 22
plan_rate_schedule	Ref<Plan_Rate_Schedule>	only Types 21 and 22
plan_rate_schedule_service_tier	SmallInt	only Types 21 and 22
service_credit	Ref<Service_Credit>	only Type 22
service_credit_source_transaction	Ref<Transaction>	only Types 21 and 22
service_credit_target_transaction	Ref<Transaction>	only Types 21 and 22
credit_coupon	Ref<Coupon>	only Types 21 and 22
credit_reason	Ref<Credit_Reason>	only Types 21 and 22
purchase_order_number	Text<1000>	only Types 21 and 22
start_date	Date	only Types 21 and 22
end_date	Date	only Types 21 and 22
rate	Decimal	only Types 21 and 22
units	Decimal	only Types 21 and 22
base_plan_units	Decimal	only Types 21 and 22
prompt_payment_discount_amount	Decimal	only Type 21
prompt_payment_discount_cutoff_date	Date	only Type 21
proration_factor	Decimal	only Types 21 and 22
proration_description	Text	only Types 21 and 22
proration_remaining_days	SmallInt	only Types 21 and 22
advance_billing_period_total_days	SmallInt	only Types 21 and 22
is_tax_related	Boolean	only Types 21 and 22
comments	Text	only Types 21 and 22
surcharge_rate_schedule	Ref<Surcharge_Rate_Schedule>
surcharge_rate_schedule_tier	SmallInt
proration_operation_type	Ref<Proration_Operation_Type>
nonsubscription_offering_rate_schedule	Ref<NonSubscription_Offering_Rate_Schedule>
nonsubscription_offering_rate_schedule_tier	Int
is_custom_rated	Boolean
*<br>=== Credit Memo Line type ===*
credit_memo	Ref<Credit_Memo>	only Type 24
line_no	SmallInt	only Type 24
invoice_line	Ref<Transaction>	only Type 24
*<br>=== Invoice Reversal Line type ===*
reversal	Ref<Invoice_Reversal>	only Type 8
line_no	SmallInt	only Type 8
invoice_line	Ref<Transaction>	only Type 8
invoice	Ref<Invoice>	only Type 8

Transaction$Supplemental_Field

A component Object of Transaction.

Field name	Datatype
field_name	Text
field_value	Text

Transaction_Application

An Entity with ids: application_no, payment_transaction_no, charge_transaction_no. "application_no", "payment_transaction_no" and "charge_transaction_no" in combination uniquely identify an order line object.

Field name	Datatype	Description
application_no	BigInt
payment_transaction_no	BigInt
charge_transaction_no	BigInt
payment_transaction	Ref<Transaction>
charge_transaction	Ref<Transaction>
created_tstamp	DateTime
applied_amount	Decimal	Always positive.
account	Ref<Account>
master_plan_instance	Ref<Plan_Instance>

Account Datatypes

The section covers datatypes that represent accounts and account related details.

Account

An Entity with ids: account_no, userid, client_account_id. "account_no", "userid" and "client_account_id" each independently identify the same account object.

Field name	Datatype	Description
account_no	BigInt
userid	Text
client_account_id	Text
balance	Decimal
status	Ref<Account_Status>
status_tstamp	DateTime
parent_account	Ref<Account>
created_tstamp	DateTime
updated_tstamp	DateTime
secret_question	Text
secret_question_answer	Text
is_test_account	Boolean
is_invoice_approval_required	Boolean
currency	Ref<Currency>
updated_receipt_id	Text
created_receipt_id	Text
sequence_functional_group	Ref<Functional_Account_Group>
start_date	Date
admin_contact	Ref<Contact>
is_consumer_account	Boolean
locale	Ref<Locale>
legal_entity	Ref<Legal_Entity>
is_anonymized	Boolean
notify_method	Ref<Notify_Method>
functional_account_groups	Array<Ref<Functional_Account_Group>>
collection_account_groups	Array<Ref<Collection_Account_Group>>
account_fields	Array<Account$Field_Value>
tax_exemption_level	Ref<Tax_Exempt_Level>
notification_overrides	Array<Account$Notification_Override>
notification_template_group	Ref<Notification_Template_Group>
surcharges	Array<Account$Surcharge>
revrec_profile_number	Int
purchase_order_number	Text
cc_email_addresses	Array<Text>
bcc_email_addresses	Array<Text>

Account$Notification_Override

A component Object of Account.

Field name	Datatype
template_class	Ref<Template_Class>
notification_template	Ref<Notification_Template>
behavioral_option	Ref<Template_Distillation_Behavior>

Account$Field_Value

A component Object of Account.

Field name	Datatype
account_field	Ref<Account_Field>
field_values	Array<Text>

Account$Surcharge

A component Object of Account.

Field name	Datatype
surcharge	Ref<Surcharge>
rate_schedule	Ref<Surcharge_Rate_Schedule>

Account_Coupon_Assignment

An Entity with ids: account_no, coupon_code.

Field name	Datatype
account_no	BigInt
coupon_code	String
account	Ref<Account>
coupon	Ref<Coupon>
created_tstamp	DateTime
cancelled_tstamp	DateTime

Account_Discount_Rule_Assignment

An Entity with ids: assignment_no.

Field name	Datatype	Description
assignment_no	BigInt
account	Ref<Account>
discount_rule	Ref<Discount_Rule>
discount_rule_bundle	Ref<Discount_Rule_Bundle>
source_coupon	Ref<Coupon>
override_max_applications	Int
override_max_applicable_months	Int
total_applications	Int
assigned_tstamp	DateTime
unassigned_tstamp	DateTime
expiration_date	Date

Billing_Group

An Entity with ids: billing_group_no, client_billing_group_id. "billing_group_no" and "client_billing_group_id" each independently identify the same billing group object.

Field name	Datatype	Description
billing_group_no	BigInt
client_billing_group_id	Text
account	Ref<Account>
name	Text
description	Text
status	Ref<Billing_Group_Status>
notify_method	Ref<Notify_Method>
notify_template_group	Ref<Notification_Template_Group>
primary_payment_method	Ref<Payment_Method>
backup_payment_method	Ref<Payment_Method>
statement_contact	Ref<Contact>
payment_term	Ref<Payment_Term>
credit_note_template	Ref<Notification_Template>
ean_gln_num	Text
ean_gln_requisition_num	Text
statement_template	Ref<Notification_Template>
credit_memo_template	Ref<Notification_Template>
rebill_template	Ref<Notification_Template>
cc_email_addresses	Array<Text>
bcc_email_addresses	Array<Text>
collection_account_groups	Array<Ref<Collection_Account_Group>>

Comment

An Entity with ids: comment_no.

Field name	Datatype	Description
comment_no	BigInt
account	Ref<Account>
comment	Text
created_tstamp	DateTime
author	Text
application_id	Text
application_tstamp_text	Text

Contact

An Entity with ids: contact_no.

Field name	Datatype	Description
contact_no	BigInt
account	Ref<Account>
first_name	Text
middle_initial	Text
last_name	Text
company_name	Text
birthdate	Date
email	Text
street	Array<Text>
city	Text
state_prov	Text
locality	Text
postal_code	Text
country	Ref<Country>
phone	Text
phone_ext	Text
cell_phone	Text
work_phone	Text
work_phone_ext	Text
fax	Text
created_tstamp	DateTime

Contract

An Entity with ids: contract_no and client_contract_id. "contract_no" and "client_contract_id" each independently identify the same billing group object.

Field name	Datatype	Description
contract_no	BigInt
client_contract_id	Text
account	Ref<Account>
status	Ref<Contract_Status>
created_tstamp	DateTime
updated_tstamp	DateTime
start_date	Date
end_date	Date
create_comments	Text
update_comments	Text
end_action	Ref<Contract_End_Action>
contract_months	Int
early_cancel_fee	Decimal
scope	Ref<Contract_Scope>
contract_plan_instances	Array<Contract$Plan_Instance>

Contract$Plan_Instance

A component Object of Contract.

Field name	Datatype
plan_instance	Ref<Plan_Instance>
rollover_plan	Ref<Plan>
rollover_plan_rate_schedule	Ref<Plan_Rate_Schedule>

Dunning_Group

An Entity with ids: dunning_group_no and client_dunning_group_id. "dunning_group_no" and "client_dunning_group_id" each independently identify the same billing group object.

Field name	Datatype	Description
dunning_group_no	BigInt
client_dunning_group_id	Text
account	Ref<Account>
status	Ref<Dunning_Group_Status>
name	Text
description	Text
dunning_process	Ref<Dunning_Process>

Payment_Method

An Entity with ids: account_no, payment_method_no, client_payment_method_id. "account_no" and "payment_method_no" in combination uniquely identify a payment method object. "client_payment_method_id" independently uniquely identifies a payment method object. The "account_no" value corresponds to the value in the Payment_Method's "account" field.

Field name	Datatype	Description
account	Ref<Account>
payment_method_no	Int
client_payment_method_id	Text
name	Text
description	Text
payment_method_type	Ref<Payment_Method_Type>
status	Ref<Payment_Method_Status>
suffix	Text
cc_type	Text
cc_expire_mm	Int
cc_expire_yyyy	Int
bill_agreement_id	Text
bank_routing_num	Text
bill_address	Ref<Contact>
created_tstamp	DateTime
updated_tstamp	DateTime
is_prepaid	Boolean
is_reloadable	Boolean
prepaid_balance	Decimal
prepaid_card_type	Text
affluence_type	Text
cc_issuing_country	Text
card_product_type	Text
is_durbin_regulated	Boolean
is_signature_debit	Boolean
bank_swift_cd	Text
bank_country_cd	Text
mandate_id	Text
bank_id_cd	Text
bank_branch_cd	Text
mandate_auth_date	Date
created_receipt_id	Text

Plan_Instance

An Entity with ids: plan_instance_no, client_plan_instance_id. "plan_instance_no" and "client_plan_instance_id" each independently identify the same plan instance object.

Field name	Datatype	Description
plan_instance_no	BigInt
client_plan_instance_id	Text
master_plan_instance	Ref<Plan_Instance>
parent_plan_instance	Ref<Plan_Instance>
account	Ref<Account>
plan	Ref<Plan>
plan_units	BigInt
last_bill_date	Date
next_bill_date	Date
last_bill_through_date	Date
last_arrears_bill_through_date	Date
last_arrears_recurring_bill_through_date	Date
created_tstamp	DateTime
updated_tstamp	DateTime
status	Ref<Plan_Instance_Status>
status_tstamp	DateTime
terminated_tstamp	DateTime
provisioned_tstamp	DateTime
rate_schedule	Ref<Plan_Rate_Schedule>
created_receipt_id	Text
description	Text
purchase_order_number	Text
is_usage_pooling_enabled	Boolean
usage_pooling_counter	BigInt
promotion_code	Text
bill_lag_days	Int
bill_day	Int
dunning_state	Ref<Dunning_State>
dunning_step	Int
dunning_degrade_date	Date
usage_accumulation_reset_months	Int
usage_accumulation_reset_months_renewal_option	Ref<Usage_Accumulation_Renewal>
usage_accumulation_reset_counter	BigInt
product_fields	Array<Plan_Instance$Product_Field>
custom_rates	Array<Plan_Instance$Custom_Rate>
service_details	Array<Plan_Instance$Service_Detail>
billing_group	Ref<Billing_Group>
dunning_group	Ref<Dunning_Group>
responsibility_level	Ref<Responsibility_Level>
responsible_plan_instance	Ref<Plan_Instance>
surcharges	Array<Plan_Instance$Surcharge>
balance	Decimal

Plan_Instance$Product_Field

A component Object of Plan_Instance.

Field name	Datatype
product_field	Ref<Product_Field>
values	Array<Text>

Plan_Instance$Service_Detail

A component Object of Plan_Instance.

Field name	Datatype	Description
service	Ref<Service>
service_location	Ref<Service_Location>
destination_address	Ref<Contact>

Plan_Instance$Surcharge

A component Object of Plan_Instance.

Field name	Datatype
surcharge	Ref<Surcharge>
surcharge_rate_schedule	Ref<Surcharge_Rate_Schedule>

Plan_Instance$Custom_Rate

A component Object of Plan_Instance.

Field name	Datatype
service	Ref<Service>
rate_seq_no	Int
to_unit	Decimal
rate_per_unit	Decimal

Plan_Instance_Coupon_Assignment

An Entity with ids: plan_instance_no, coupon_code. "plan_instance_no" and "coupon_code" together identify the plan instance coupon object.

Field name	Datatype	Description
plan_instance_no	BigInt
coupon_code	Text
plan_instance	Ref<Plan_Instance>
coupon	Ref<Coupon>
created_tstamp	DateTime
updated_tstamp	DateTime
cancelled_tstamp	DateTime

Plan_Instance_Discount_Rule_Assignment

An Entity with id: assignment_no.

Field name	Datatype	Description
assignment_no	BigInt
discount_rule	Ref<Discount_Rule>
discount_rule_bundle	Ref<Discount_Rule_Bundle>
plan_instance	Ref<Plan_Instance>
source_coupon	Ref<Coupon>
override_max_applications	Int
total_applications	Int
assigned_tstamp	DateTime
unassigned_tstamp	DateTime
expiration_date	Date
remainder_discount_factor	Decimal

Plan_Unit_Instance

An Entity with ids: plan_unit_instance_no, client_plan_unit_instance_id. "plan_unit_instance_no" and "client_plan_unit_instance_id" each independently identify the same plan unit instances object.

Field name	Datatype	Description
plan_unit_instance_no	BigInt
client_plan_unit_instance_id	Text
plan_instance	Ref<Plan_Instance>
status	Ref<Plan_Unit_Instance_Status>
services	Array<Plan_Unit_Instance$Services>
product_fields	Array<Plan_Unit_Instance$Product_Field>
created_tstamp	DateTime
updated_tstamp	DateTime

Plan_Unit_Instance$Product_Field

A component Object of Plan_Unit_Instance.

Field name	Datatype
product_field	Ref<Product_Field>
values	Array<Text>

Plan_Unit_Instance$Service

A component Object of Plan_Unit_Instance.

Field name	Datatype	Description
service	Ref<Service>
fulfillment_date	Date
is_fulfillment_based	Boolean
fulfillment_status	Ref<Fulfillment_Status>

Queued_Plan_Instance_Change

An Entity with ids: queue_no.

Field name	Datatype	Description
queue_no	BigInt
status	Ref<Queue_Status>
execute_on_anniversary	Boolean
effective_date	Date
plan_instance	Ref<Plan_Instance>
account	Ref<Account>
change_type	Ref<Plan_Instance_Change_Type>
created_tstamp	DateTime
updated_tstamp	DateTime
plan_instance_change	Queued_Plan_Instance_Change$Plan_Instance_Change
product_fields_changes	Array<Queued_Plan_Instance_Change$Product_Field_Change>
remove_plan_instance_custom_rates	Boolean
surcharge_changes	Array<Queued_Plan_Instance_Change$Surcharge_Change>
coupon_changes	Array<Queued_Plan_Instance_Change$Coupon_Change>
alternate_proration_start_date	Date
alternate_plan_instance_start_date	Date
status_until_alternate_start_date	Ref<Plan_Instance_Status>
proration_directive	Ref<Proration_Directive>
auto_cancel_incompatible_supp_plans	Boolean
auto_offset_months_option	Ref<Auto_Offset_Months_Option>
comments	Text
force_bill_date_reset	Ref<Force_Bill_Date_Reset>
force_master_bill_date_reset	Ref<Force_Master_Bill_Date_Reset>
invoice_unbilled_usage	Boolean
invoicing_option	Ref<Invoicing_Option>
nso_bill_immediately	Boolean
offset_months	Int
override_bill_thru_date	Date
proration_invoice_timing_option	Ref<Proration_Invoice_Timing_Option>
nso_items	Array<Queued_Plan_Instance_Change$Nso_Item_Addition>
retroactive_start_date	Date

Queued_Plan_Instance_Change$Coupon_Change

A component Object of Queued_Plan_Instance_Change.

Field name	Datatype
coupon	Ref<Coupon>
action	Ref<Coupon_Directive>

Queued_Plan_Instance_Change$Nso_Item_Addition

A component Object of Queued_Plan_Instance_Change.

Field name	Datatype
sku	Text
units	Int
service_location	Ref<Service_Location>
destination_contact	Ref<Contact>

Queued_Plan_Instance_Change$Plan_Instance_Change

A component Object of Queued_Plan_Instance_Change.

Field name	Datatype
client_plan_instance_id	Text
plan	Ref<Plan>
plan_units	BigInt
status	Ref<Plan_Instance_Status>
rate_schedule	Ref<Plan_Rate_Schedule>
plan_instance_description	Text
purchase_order_number	Text
promotion_code	Text
bill_lag_days	Int
bill_day	Int
custom_rates	Array<Plan_Instance_Custom_Rate>

Queued_Plan_Instance_Change$Product_Field_Change

A component Object of Queued_Plan_Instance_Change.

Field name	Datatype
product_field	Ref<Product_Field>
values	Text
action	Ref<Product_Field_Assignment_Directive>

Queued_Plan_Instance_Change$Surcharge_Change

A component Object of Queued_Plan_Instance_Change.

Field name	Datatype
surcharge	Ref<Surcharge>
surcharge_rate_schedule	Ref<Surcharge_Rate_Schedule>
action	Ref<Surcharge_Directive>

Usage_Record

An Entity with ids: usage_record_no, client_usage_record_id. "usage_record_no" and "client_usage_record_id" each independently identify the same usage record object.

Field name	Datatype	Description
usage_record_no	BigInt
client_usage_record_id	Text
usage_record_parent	Ref<Usage_Record>
account	Ref<Account>
plan	Ref<Plan>
plan_instance	Ref<Plan_Instance>
invoice	Ref<Invoice>
usage_type	Ref<Usage_Type>
usage_tstamp	DateTime
units	Decimal
billable_units	Decimal
rate	Decimal
amount	Decimal
is_excluded	Boolean
client_exclude_reason_cd	SmallInt
exclude_user	Text
exclude_tstamp	DateTime
exclusion_comments	Text
comments	Text
qualifier_1	Text
qualifier_2	Text
qualifier_3	Text
qualifier_4	Text
telco_from	Text
telco_to	Text

Catalog Datatypes

The section covers datatypes that represent the product catalog.

Account_Field

An Entity with id: 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](#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 ids: 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

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

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 ids: 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	Description
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

Service_Location

An Entity with ids: service_location_no, client_service_location_id. "service_location_no" and "client_service_location_id" each independently identify the same service location object.

Specification of fields in this entity is TBA.

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_Schedle

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

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

Tiered_Pricing_Rule

An Entity with id: rule_no.

Configuration Datatypes

The section covers datatypes that represent Aria client configuration.

Account_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Account_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-99	Archived
0	Deactivated
1	Active
32	Registered Pending Activation
51	Temporary Service Ban
99	Permanent

Application_Scope

An Entity with ids: scope_no and enum (deprecated). "scope_no" and "enum" each independently identify the same Application_Scope entity.

Field name	Datatype
scope_no	Int

scope_cd	Label
1	All Charges
2	All Plan Charges, All Plans
3	All Plan Charges, Specified Plans
4	All Plans, Specified Service Charges
5	Specified Plan/Service Charges
6	All Recurring Service Charges
7	All Usage Service Charges
8	All Activation Service Charges
9	All Item Charges
10	Specified Item Charges
11	Payment Method
12	Payment Term

Assignment_Level

An Entity with ids: level_no and enum (deprecated). "level_no" and "enum" each independently identify the same Assignment_Level entity.

Field name	Datatype
level_no	Int

level_no	Label
1	Account
2	Master Plan Instance
3	Account or Master Plan Instance

Auto_Offset_Months_Option

An Entity with ids: option_no and enum (deprecated). "option_no" and "enum" each independently identify the same Auto_Offset_Months_Option entity.

Field name	Datatype
option_no	Int

option_no	Label
`null`	Don't do offset
1	Align to Master plan bill thru date
2	Align to old supplemental plan bill thru date

Billing_Interval_Type

An Entity with ids: type_no, an Int value.

type_no	Label
1	Day
2	Week
3	Month

Billing_Group_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Billing_Group_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Inactive
1	Active

Collection_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Collection_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-1	Timeout
0	Requested
1	Authorized
2	Submitted
3	Approved
4	Reversed
5	Failed
6	Queued
7	Assigned

Contract_End_Action

An Entity with ids: action_no and enum (deprecated). "action_no" and "enum" each independently identify the same Contract_End_Action entity.

Field name	Datatype
action_no	Int

action_no	label
2	Continue existing service without contract
3	Renew existing contract automatically
6	Terminate service and billing
7	Terminate service and billing and prorate final invoice
8	Rollover to a Plan and/or a Rate Schedule

Contract_Scope

An Entity with ids: scope_no and enum (deprecated). "scope_no" and "enum" each independently identify the same Contract_Scope entity.

Field name	Datatype
scope_no	Int

scope_no	Label
1	Universal
2	Multi-plan

Contract_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Contract_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-3	Contract no longer in scope, usually due to mid-contract plan change on account.
-2	Contract terminated by client or system.
-1	Contract cancelled by end-user.
0	Contract completed and renewed. New contract record refers to this contract record.
1	Contract is currently in effect.
99	Contract completed, no renewal.

Country

An Entity with ids: country_cd and code (deprecated). "country_cd" and "code" each independently identify the same Country entity.

| Field name | Datatype | Description |:----------------------|----------------------------------------- | country_cd | String | Defined by ISO 3166-1 ALPHA-2 (the 2 character code)

Examples:

country_cd	Country
`"US"`	United States of America
`"GB"`	Great Britain
`"DE"`	Germany

Coupon_Application

An Entity with ids: scope_no and enum (deprecated). "scope_no" and "enum" each independently identify the same Coupon_Application entity.

Field name	Datatype
scope_no	Int

scope_no	Label
1	Account
2	Master Plan Instance
3	Account or Master Plan Instance

Coupon_Directive

An Entity with ids: directive_no and enum (deprecated). "directive_no" and "enum" each independently identify the same Coupon_Directive entity.

Field name	Datatype
directive_no	Int

directive_no	Label
1	Add
2	Remove

Credit_Reason

An Entity with ids: reason_no and enum (deprecated). "reason_no" and "enum" each independently identify the same Credit_Reason entity.

Field name	Datatype
reason_no	Int

reason_no	Label
1	General Credit/Other
2	Inadequate Service Delivery
3	Billing / Pricing Issue
4	Service no longer desired
5	Customer Dissatisfaction
6	Installation Issue
8	Shipping Error
9	Customer Return
11	System Testing
98	Prepay Credit Reconciliation
200	Automatic credit creation due to purchase of non-subscription offering with "Automatic Service Credit Creation" flag set.
9999	Coupon Application

Credit_Ref_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Credit_Ref_Type entity.

Field name	Datatype
type_no	Int

type_no	Label
0	Invoice Based Credit Memo
1	General
2	Price Change
3	Cancellation

Currency

An Entity with ids: currency_cd and code (deprecated). "currency_cd" and "enum" each independently identify the same Currency entity.

Field name	Datatype	Description
currency_cd	String	Defined by ISO 4217

Examples:

currency_cd	Currency
`"usd"`	United States dollar
`"eur"`	Euro
`"jpy"`	Japanese yen

Discount_Behavior

An Entity with ids: behavior_cd "behavior_cd" identifies the Discount_Behavior entity.

Field name	Datatype
behavior_cd	Text

type_cd	Label
N	Apply to resulting net amount after previously applied discounts
G	Apply to gross amount of the charge

Discount_Rule_Duration

An Entity with ids: duration_cd "duration_cd" identifies the Discount_Rule_Duration entity.

Field name	Datatype
duration_cd	Text

type_cd	Label
M	Months
U	Uses
T	No Expiration

Discount_Rule_Scope

An Entity with ids: scope_no "scope_no" identifies the Discount_Rule_Scope entity.

Field name	Datatype
scope_no	Int

scope_no	Label
0	All Charges
10	All Plan Charges, All Plans
11	All Plan Charges, Specified Plans
12	All Plans, Specified Service Charges
13	Specified Plan/Service Charges
21	All Recurring Service Charges
22	All Usage Service Charges
23	All Activation Service Charges
30	All Non-subscription Offering Charges
31	Specified Non-subscription Offering Charges

Discount_Type

An Entity with ids: type_cd "type_cd" identifies the Discount_Type entity.

Field name	Datatype
type_cd	Text

type_cd	Label
F	Fixed
P	Percentage

Dunning_Group_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Dunning_Group_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Inactive
1	Active

Dunning_State

An Entity with ids: state_no and enum (deprecated). "state_no" and "enum" each independently identify the same Dunning_State entity.

Field name	Datatype
state_no	Int

state_no	Label
0	None
1	In Progress

Dunning_Process

An Entity with ids: dunning_process_no, client_dunning_process_id. "dunning_process_no" and "client_dunning_process_id" each independently identify the same rate schedule object.

Field name	Datatype	Description
dunning_process_no	BigInt
client_dunning_process_id	Text
name	Text
description	Text
dunning_steps	Array<Dunning_Process$Dunning_Step
completion_notification_template	Ref<Notification_Template>
is_default	Boolean
plan_payment_assignments	Array<Account_Field$Allowed_Value>
plan_assignments	Array<Account_Field$Allowed_Value>
payment_assignments	Array<Account_Field$Allowed_Value>

Dunning_Process$Dunning_Step

A component Object of Dunning_Process

Field name	Datatype	Description
step_no	BigInt
duration	BigInt
notification_template	Ref<Notification_Template>
contact_type_notified	Ref<Contact_Type_Notified>
fee_type	Ref<Fee_Type>
fee_configurations	Array<Dunning_Process$>

Dunning_Process$Plan_Payment_Assignment

A component Object of Dunning_Process

Field name	Datatype	Description
master_plan	Ref<Plan>
payment_method_type	Ref<Payment_Method_Type>
payment_term	Ref<Payment_Term>

Dunning_Process$Plan_Assignment

A component Object of Dunning_Process

Field name	Datatype	Description
master_plan	Ref<Plan>

Dunning_Process$Payment_Assignment

A component Object of Dunning_Process

Field name	Datatype	Description
payment_method_type	Ref<Payment_Method_Type>
payment_term	Ref<Payment_Term>

Dunning_Process$Dunning_Step$Fee_Configuration

A component Object of Dunning_Step

Field name	Datatype	Description
currency	Ref<Currency>
rate	Ref<Decimal>

Dunning_Process$Dunning_Step$Contact_Type_Notified

An Entity with id: email_dest_no.

Field name	Datatype
email_dest_no	Int

email_dest_no	Label
0	Default
1	Account only
2	Billing only
3	Statement only
4	Account & Billing
5	Account & Statement
6	Billing & Statement
7	Account & Billing & Statement

Dunning_Process$Dunning_Step$Fee_Type

An Entity with id: dunning_fee_type

dunning_fee_type	Label
0	None
1	Percentage Fee
2	Flat Fee

Email_Template

An Entity with ids: template_no, client_template_id. "template_no" and "client_template_id" each independently identify the same rate schedule object.

Field_Input_Type

An Entity with id: input_type

input_type	description
"checkbox"	checkbox UI input control
"radio"	radio UI input control
"select"	select UI input control
"text"	text UI input control
"textarea"	textarea UI input control

Force_Bill_Date_Reset

An Entity with ids: reset_no and enum (deprecated). "reset_no" and "enum" each independently identify the same Force_Bill_Date_Reset entity.

Field name	Datatype
reset_no	Int

reset_no	Label
`null`	Honor client parameter
0	No reset
1	Reset to status change date
2	Reset to anniversary

Force_Master_Bill_Date_Reset

An Entity with ids: reset_no and enum (deprecated). "reset_no" and "enum" each independently identify the same Force_Master_Bill_Date_Reset entity.

Field name	Datatype
reset_no	Int

reset_no	Label
`null`	Honor client parameter
1	No reset
2	Refer to API doc
3	Refer to API doc

Fulfillment_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Fulfillment_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Not fulfilled
1	Invoiced
2	Ready for Invoice

Functional_Account_Group

An Entity with ids: group_no, client_group_id.

Specification of fields in this entity is TBA.

Group_Usage

An Entity with ids: usage_no and enum (deprecated). "usage_no" and "enum" each independently identify the same Group_Usage entity.

Field name	Datatype
usage_no	Int

usage_no	Label
0	CSR Only
1	USS Only
2	Both CSR and USS

Invoice_Application_Scope

An Entity with ids: scope_cd "scope_cd" identifies the Invoice_Application_Scope entity.

Field name	Datatype
scope_cd	Text

type_cd	Label
E	Each Line Item
M	All Line Items

Invoice_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Invoice_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	pending
1	not pending (approved)

Invoice_Type

An Entity with ids: type_cd and code (deprecated). "type_cd" and "code" each independently identify the same Invoice_Type entity.

Field name	Datatype
type_cd	String

type_cd	Label
O	Order based invoice.
P	Proration invoice.
F	Full invoice.
C	Combined invoice.
R	Rebill invoice.

Invoicing_Option

An Entity with ids: option_no and enum (deprecated). "option_no" and "enum" each independently identify the same Invoicing_Option entity.

Field name	Datatype
option_no	Int

option_no	Label
1	Full Invoice
2	Prorated Invoice
3	Client default
4	No Invoice

Invoice_Usage_Record_Status

An Entity with ids: status_cd. "status_cd" each independently identify the same Invoice_Usage_Record_Status entity.

Field name	Datatype
status_cd	String

status_cd	Label
null	Usage Billed
U	Usage Unbilled
D	Usage Discarded

Locale

An Entity with id: locale_no

Specification of fields in this entity is TBA.

Notice_Balance_Type

An Entity with ids: type_cd.

Notice_Destination_Type

An Entity with ids: type_cd.

Notify_Method

An Entity with ids: method_no and enum (deprecated). "method_no" and "enum" each independently identify the same Notify_Method entity.

Field name	Datatype
method_no	Int

method_no	Label
0	None
1	HTML Email
2	Text Email
3	Text Email w/link to HTML
4	Data export
5	Printable with Surcharge
6	Printable & Text Email
7	Printable & HTML Email with Surcharge
8	Printable
9	PDF (Printing Required)
10	PDF Delivered via Email
11	PDF (Printing req & Email)w/surcharge
12	PDF (Printing req, no Email)w/surcharge
13	XML Master File
14	PDF Master File
15	XML Master File and HTML Email
16	XML Master File and Text Email
17	PDF Master File and HTML Email

Object_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Object_Type entity.

Field name	Datatype
type_no	Int

type_no	Label
1	Plan
2	Nonsubscription Offering
3	Service Code
4	Usage Type

Object_Type_Configuration

Specification of fields in this entity is TBA.

Order_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Order_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-2	Order Cancelled
-1	Order Rejected
0	Order Entry in Progress
1	Order Entered
2	Order Placed
3	Order Filled
4	Order Billed
5	Order Held

Payment_Method_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Payment_Method_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Inactive
1	Active
2	One Time

Payment_Method_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Payment_Method_Type entity.

Field name	Datatype
type_no	Int

type_no	Label
-1	External Payment
0	Other/None
1	Credit Card
2	Electronic Check (ACH)
3	Pre-Paid
11	PayPal Express Checkout
13	Tokenized Credit Card
14	Purchase Power
20	NETS
21	FIK
26	Direct Debit
27	Direct Debit - IBAN
28	Direct Debit - BBAN
29	Reserve Account
30	Boleto Bancario
32	iDEAL
33	WebMoney
34	Yandex
35	PaySafeCard
36	SOFORT
37	Tokenized Direct Debit
38	ApplePay - Indirect
39	PayPal Express Checkout - Indirect
40	Merchant Specific Gift Card

Payment_Processor

An Entity with ids: processor_no and enum (deprecated). "processor_no" and "enum" each independently identify the same Payment_Processor entity.

Field name	Datatype
processor_no	Int

processor_no	Label
0	Other
1	Chase Paymentech
2	PayPal Payflow Pro
4	CyberSource
5	Authorize.Net
15	PayPal Express Checkout
16	GlobalCollect (to be deprecated)
19	PayJunction
20	DIBS Payment Services
21	Vantiv (Litle)
22	PB Purchase Power
24	NETS Collect
25	Generic
26	MercuryPay
27	ModusLink Global Payment System
28	Braintree
29	WorldPay
30	First Data PayPoint
31	Merchant e-Solutions
32	Paymetric
33	TNS
34	Adyen
35	First Data Payeezy
36	Ingenico (formerly GlobalCollect)

Plan_Instance_Change_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Plan_Instance_Change_Type entity.

Field name	Datatype
type_no	Int

type_no	Label
0	Assign Plan
1	Assign Mandatory Child Plan
2	Replace Plan
3	Rollover Plan
4	Cancel Plan
5	Update Plan
6	Update Plan Status

Plan_Instance_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Plan_Instance_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-3	Terminated
-2	Cancelled
-1	Suspended
0	Inactive
1	Active
2	Pending Cancellation
3	Pending Termination
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-Billable

Plan_Unit_Instance_Status

An Entity with ids: enum and enum (deprecated). "status_no" and "enum" each independently identify the same Plan_Unit_Instance_Status entity.

Field name	Datatype
status_no	Int

Enum	Label
0	Inactive
1	Active

Product_Field_Assignment_Directive

An Entity with ids: directive_no and enum (deprecated). "directive_no" and "enum" each independently identify the same Product_Field_Assignment_Directive entity.

Field name	Datatype
directive_no	Int

directive_no	Label
1	New
2	Replace value
3	Remove specific Value
4	Remove name and value (clear field)

Proration_Directive

An Entity with ids: directive_no and enum (deprecated). "directive_no" and "enum" each independently identify the same Proration_Directive entity.

Field name	Datatype
directive_no	Int

directive_no	Label
1	Anniversary assignment
2	Immediate with default prorate
3	Immediate with no proration
4	immediate with prorate all
5	immediate with prorate charge
6	Immediate with prorate credit
7	queued with default prorate
8	queued with no proration
9	queued with prorate all
10	queued with prorate charge
11	queued with prorate credit

Proration_Invoice_Timing_Option

An Entity with ids: option_no and enum (deprecated). "option_no" and "enum" each independently identify the same Proration_Invoice_Timing_Option entity.

Field name	Datatype
option_no	Int

option_no	Label
`null`	Product catalog configuration
0	Immediate
1	Anniversary

Proration_Operation_Type

An Entity with ids: type_no. "type_no" independently identify the same Proration_Operation_Type entity.

Field name	Datatype
type_no	Int

option_no	Label
10	plan instance assignment
20	plan instance replacement
31	plan instance activation
32	plan unit change
33	(reserved for future use)
40	plan instance cancellation

Queue_Activation_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Queue_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Activate after date
1	Deactivate after date

Queue_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Queue_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
0	Deleted
1	Queued
2	Executed successfully
3	Failed to execute

Rate_Calculation_Type

An Entity with ids: type_cd and enum (deprecated). "type_cd" and "enum" each independently identify the same Rate_Calculation_Type entity.

Field name	Datatype
type_cd	Text

type_cd	Label
F	Fixed Amount
S	Standard Percentage (Multiple Tiers)
V	Volume Percentage (Single Tier)

Rebill_Reason

An Entity with ids: reason_no and enum (deprecated). "reason_no" and "enum" each independently identify the same Rebill_Reason entity.

Field name	Datatype
reason_no	Int

These values are client configurable and different for each client

Recurring_Credit_Expiration_Type

An Entity with ids: type_cd and code (deprecated). "type_cd" and "code" each independently identify the same Recurring_Credit_Expiration_Type entity.

Field name	Datatype
type_cd	String

type_cd	Label
M	Month
D	Days
W	Week
Y	Year

Recurring_Credit_Reason

An Entity with ids: reason_no and enum (deprecated). "reason_no" and "enum" each independently identify the same Recurring_Credit_Reason entity.

Field name	Datatype
reason_no	Int

These values are client configurable and different for each client

Recurring_Credit_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Recurring_Credit_Status entity.

Field name	Datatype
status_no	Int

status_no	Label
-2	Cancelled, Some Credits Created
-1	Cancelled, No Credits Created
1	Entered, No Credits Created
2	Credits Created, Incomplete
3	Credits Created, Complete

Recurring_Credit_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Recurring_Credit_Type entity.

Field name	Datatype
type_no	Int

type_no	Label
1	Flat
2	Percentage

Refund_Reason

An Entity with ids: reason_no and enum (deprecated). "reason_no" and "enum" each independently identify the same Refund_Reason entity.

Field name	Datatype
reason_no	Int

reason_no	Label
1	Account charged in error
2	Goods/services not delivered
3	Customer dissatisfaction
4	Cancellation of pre-paid service
5	Good Will
6	Overpayment / Duplicate payment
7	Wrong/undesired payment source charged
99999999	Other

Responsibility_Level

An Entity with ids: level_no and enum (deprecated). "level_no" and "enum" each independently identify the same Responsibility_Level entity.

Field name	Datatype
level_no	Int

level_no	Label
1	Standard Self-Pay
2	Parent Pay
3	Parent Usage & Pay

Service_Type

An Entity with ids: type_cd and code (deprecated). "type_cd" and "code" each independently identify the same Service_Type entity.

Field name	Datatype
type_cd	String

type_cd	Name
RC	Recurring
SC	Surcharge
US	Usage
AC	Activation
MS	Miscellaneous
CN	Cancellation
OR	Order Based
TX	Tax
MN	Minimum Fee
RA	Recurring Arrears

Statement_Status

An Entity with ids: status_no and enum (deprecated). "status_no" and "enum" each independently identify the same Statement_Status entity.

Field name	Datatype
status_no	Int

status_no	Label	Description
0	New	Statement has been generated.
1	Sent	Statement has been delivered.
2	Paid	Full Payment has been received.
3	Late	Statement is unpaid and past due.
5	Late OK	This statement is late, but falls below the minimum balance criteria for active dunning to occur.
6	Late Electronic	This statement is late, but this account is processed via electronic methods.
7	Payment Reversed	The payment for the statement reversed

Surcharge_Directive

An Entity with ids: directive_no and enum (deprecated). "directive_no" and "enum" each independently identify the same Surcharge_Directive entity.

Field name	Datatype
directive_no	Int

directive_no	Label
1	Add
2	Remove

Tax_Authority_Level

An Entity with ids: level_no and enum (deprecated). "level_no" and "enum" each independently identify the same Tax_Authority_Level entity.

Field name	Datatype
level_no	Int

level_no	Label
0	country
1	state
2	county
3	city
4	unincorporated
5	district

Tax_Exempt_Level

An Entity with ids: level_no and enum (deprecated). "level_no" and "enum" each independently identify the same Tax_Exempt_Level entity.

Field name	Datatype
level_no	Int

level_no	Label
0	No tax exemption
1	State/Province Tax Exempt
2	Federal/National Tax Exempt
3	State/Province and Federal/National Tax Exempt

Tax_Service_Group

An Entity with ids: group_no and enum (deprecated). "group_no" and "enum" each independently identify the same Tax_Service_Group entity.

Field name	Datatype
group_no	Int
client_group_id	String

These values are client configurable and different for each client

Template_Class

An Entity with ids: class_cd and code (deprecated). "class_cd" and "code" each independently identify the same Template_Class entity.

Field name	Datatype
class_cd	String

class_cd	Label
A	Account Activation
B	Broadcast
BJA	Batch Job Alert Email Template
C	Credit Card Expiry
C2	Electronic Collection Attempt
C3	Credit Card Update Required
CCN	Copy Config Notification
CEC	Contract End: Continue existing service without contract
CECS	Contract End: Continue existing service without contract
CECSS	Contract End: Continue existing service (standard rates)
CER	Contract End: Renew automatically
CERA	Contract End: Renew automatically
CERO	Contract End: Rollover automatically
CES	Contract End: Suspend service and billing
CESP	Contract End: Suspend service and billing (prorate final invoice)
CET	Contract End: Terminate service and billing
CETP	Contract End: Terminate Service and Billing (Proration)
CM	Credit Memo
CN	Credit Note
D	Dunning
I	Invoice/Statement
MPD	Master Plan Instance Deprovisioned
N	Account Comment/Note
NDO	Daily Unit Usage Threshold Over
NDU	Daily Unit Usage Threshold Under
NMO	MTD Unit Usage Threshold Over
NMU	MTD Unit Usage Threshold Under
NPO	PTD Unit Usage Threshold Over
NPU	PTD Unit Usage Threshold Under
NSP	Non Electronic Payment
O	Other
P	Password Reminder/Reset
PMR	Payment Method Removal
PMTR01	Payment Reminder 01
PMTR02	Payment Reminder 02
PMTR03	Payment Reminder 03
PR	Default Payment Reminder
PR1	Payment Reminder 01
PR2	Payment Reminder 02
PR3	Payment Reminder 03
PT1	Payment Terms Reminder 01
PT2	Payment Terms Reminder 02
PT3	Payment Terms Reminder 03
R	Contract Expiry/Renewal
R2	Electronic Refund Processed Notification
RB	Rebill
S	Service Plan Change
S2	Supplemental Service Plan Change
T	Account Termination
U	Unknown
UCO	Unapplied Service Credit Usage Threshold Over
UCU	Unapplied Service Credit Usage Threshold Under
UMO	MTD Usage Threshold Over
UMU	MTD Usage Threshold Under
UPO	PTD Usage Threshold Over
UPU	PTD Usage Threshold Under

Template_Distillation_Behavior

An Entity with ids: behavior_no and enum (deprecated). "behavior_no" and "enum" each independently identify the same Template_Distillation_Behavior entity.

Field name	Datatype
behavior_no	Int

behavior_no	Label
1	Distill and Send Message
2	Distill Message But Do Not Send
3	Produce No Message

Transaction_Type

An Entity with ids: type_no and enum (deprecated). "type_no" and "enum" each independently identify the same Transaction_Type entity.

Field name	Datatype
type_no	Int

type_no	Label	charge/credit
2	External Payment	credit
3	Electronic Payment	credit
4	Balance Transfer To	charge
5	Balance Transfer From	credit
6	Write Off	credit
8	Invoice Reversal Line	credit
9	Balance Forward	charge
10	Cash Credit	credit
12	Electronic Refund Disbursement	charge
13	Check Refund Disbursement	charge
15	Dunning Charge	charge
18	Negative Balance Forward	credit
21	Invoice Charge Line	charge
22	Invoice Credit Line	credit
24	Credit Memo Line	credit

Usage_Accumulation_Renewal_Option

An Entity with ids: option_no and enum (deprecated). "option_no" and "enum" each independently identify the same Usage_Accumulation_Renewal_Option entity.

Field name	Datatype
option_no	Int

option_no	Label
1	Recurring / Auto Renew (Default)
2	Single Use

Write_Off_Reason

An Entity with ids: reason_no and enum (deprecated). "reason_no" and "enum" each independently identify the same Write_Off_Reason entity.

Field name	Datatype
reason_no	Int

reason_no	Label
0	Bad Debt
1	Good Will
2	Billing Error
3	Sales Return
4	Promotional Discount
5	Other
9001	Charge Dispute Hold
9999	System-enforced conversion of dispute to permanent write-off

Data Feed Logical Object Model

Table of contents

Index of Datatypes

Datatype Concepts

Objects

Entities

Arrays

Primitives

General Datatypes

Objects

Ref

Financial Datatypes

Credit_Memo

Invoice

Invoice$Pending_Tax_Detail

Invoice$Discount_Detail

Invoice$Pending_Discount_Detail

Invoice$Surcharge_Detail

Invoice$Pending_Surcharge_Detail

Invoice_Reversal

Order

Order_Line

Pending_Invoice_Line

Recurring_Credit

Recurring_Credit$Eligible_Plan

Recurring_Credit$Eligible_Plan_Instance

Service_Credit

Service_Credit$Eligibility

Statement

Tax_Detail

Transaction

Transaction$Supplemental_Field

Transaction_Application

Account Datatypes

Account

Account$Notification_Override

Account$Field_Value

Account$Surcharge

Account_Coupon_Assignment

Account_Discount_Rule_Assignment

Billing_Group

Comment

Contact

Contract

Contract$Plan_Instance

Dunning_Group

Payment_Method

Plan_Instance

Plan_Instance$Product_Field

Plan_Instance$Service_Detail

Plan_Instance$Surcharge

Plan_Instance$Custom_Rate

Plan_Instance_Coupon_Assignment

Plan_Instance_Discount_Rule_Assignment

Plan_Unit_Instance

Plan_Unit_Instance$Product_Field

Plan_Unit_Instance$Service

Queued_Plan_Instance_Change

Queued_Plan_Instance_Change$Coupon_Change

Queued_Plan_Instance_Change$Nso_Item_Addition

Queued_Plan_Instance_Change$Plan_Instance_Change

Queued_Plan_Instance_Change$Product_Field_Change

Queued_Plan_Instance_Change$Surcharge_Change

Usage_Record

Catalog Datatypes

Account_Field

Account_Field$Allowed_Value

Account_Field$Locale_Detail

Available_NonSubscription_Offering_Scope

Chart_Of_Accounts

Collection_Account_Group

Plan$Contract_Completion_Rollover_Rate_Schedule

Coupon

Coupon$Locale_Detail

Discount_Rule

Discount_Rule$Plan_Service_Detail

Discount_Rule$Locale_Detail

Discount_Rule_Bundle

Legal_Entity

NonSubscription_Offering