Account Datatypes
Account Datatypes
The section covers datatypes that represent accounts and account related details.
Account Overview Diagram
Account Object Model Diagram (Including APIs)
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 ID: 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 ID: 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 ID: 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 | |
| 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 |