Skip to main content
Aria Knowledge Central

get_acct_details_all_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_details_all_m
Class account_services_m
Update Version 56

Description

Retrieves comprehensive information about a specified account in a single API call. Returns contact details, demographic data, billing configuration, account status, locale, currency, and supplemental fields. Optionally includes detailed plan information (master and supplemental plan assignments with services and rates), billing group details (payment methods, statement configuration, dunning settings), and payment method information. This is the primary API for building an account detail/overview screen. Use the include_master_plans, include_billing_groups, and include_payment_methods flags to control the scope of data returned and optimize response size.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
include_master_plans long 1 No

Indicates whether to include master plan info. If set to the default value of 1 (true), it will return the full array of master plan info. If set to 0 (false), it will return no master plan info.

Allowed values:

Value Description
1 Yes (default)
0 No
include_supp_plans long 1 No

Indicates whether to include supplemental plan info. The field "include_master_plans" must be set to 1 to retrieve this information. If set to 1 (true), it will return a full array of supplemental plan info. If set to the default value of 0 (false), it will return no supplemental plan info.

Allowed values:

Value Description
1 Yes
0 No (default)
include_billing_groups long 1 No

Indicates whether to include billing group info. If set to 1 (true), it will return a full array of billing group info. If set to the default value of 0 (false), it will return no billing group info.

Allowed values:

Value Description
1 Yes
0 No (default)
include_payment_methods long 1 No

Indicates whether to include payment method info. The field "include_billing_groups" must be set to 1 to retrieve this information. If set to 1 (true), it will return a full array of payment method info. If set to the default value of 0 (false), it will return no payment method info.

Allowed values:

Value Description
1 Yes
0 No (default)
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
plan_limit long 30 No

Limits the number of records returned in the master_plans_info array. Min of 1 and Max 999. If no value is specified all possible records will be returned.
plan_offset long 30 No

The number of records to skip in the master_plans_info array. Min of 0 with no maximum value. If no value specified the default is 0.
Start of filter_mpi_status object
filter_mpi_status object   No

Array of master plan instance status.
Name Type Length Required Description
▶filter_mpi_status_cd long 8 No

This is a filter based on the status of the master plans for the current API call.

Allowed values:

Value Description
-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
End of filter_mpi_status object
Start of filter_spi_status object
filter_spi_status object   No

Array of supplemental plan instance status.
Name Type Length Required Description
▶filter_spi_status_cd long 8 No

This is a filter based on the status of the supplemental plans for the current API call. Some plans may not be returned if the mpi status code used does not return the MPI. If a status is inherited due to pending action on MPI, it will not be reflected in the output array.

Allowed values:

Value Description
-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
End of filter_spi_status object
include_acct_past_due_balance long 1 No

Indicates whether to include outstanding balance on the account that has passed its due date.

Allowed values:

Value Description
0 No (default)
1 Yes

Outputs

Name Type Length Required Description
acct_no long   No

Note: This field is deprecated. Aria no longer supports acct_no.
client_acct_id string 50 No

Client-defined account identifier.
userid string   No

The users unique identifier.
first_name string   No

Contact First name
middle_initial string   No

Middle initial of the contact
last_name string   No

Contact last name
company_name string   No

Company name of the contact
address1 string   No

First address line of the contact.
address2 string   No

Second address line of the contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
address3 string   No

The third line of the address
city string   No

City of the contact
locality string 32 No

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
state_prov string   No

State or Province of the contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
country_cd string   No

Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
postal_cd string   No

Postal/Zip code for the contact address.
phone string   No

The phone number of the contact
phone_ext string   No

The extension for the contact phone
cell_phone string   No

The contact cell phone.
work_phone string   No

The full work phone number
work_phone_ext string   No

The office/desk extension of the contact's work phone, if any.
fax string   No

The FAX phone number for the contact.
email string   No

Alternate email address for contact.
birthdate string 10 No

Birthdate of the contact in yyyy-mm-dd format.
status_cd long   No

This is the status of the object in question for the current API call.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
32 REGISTERED PENDING ACTIVATION
99 PERMANENT
-99 ARCHIVED
notify_method long 2 No

How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).

Allowed values:

Value Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by 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
senior_acct_no long   No

The senior_acct_no is the unique account number for the parent account and is used in establishing parent-child billing relationships.
senior_acct_user_id string   No

The senior account user ID of the account.
senior_client_acct_id string   No

The client senior account ID of the account.
legal_entity_no long   No

Note: This field is deprecated. Aria no longer supports legal_entity_no.
legal_entity_name string   No

Client-assigned descriptor of the legal entity.
client_legal_entity_id string   No

Client-assigned unique identifier for the legal entity.
test_acct_ind long   No

This argument indicates the account is a test account and is treated as such in the system.

Allowed values:

Value Description
1 test
0 live
taxpayer_id string   No

Taxpayer Identification number.
acct_start_date string   No

Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
alt_msg_template_no long   No

Email template number assigned to this account.
seq_func_group_no long   No

Functional account group number specifically designated for statement sequence number assignment.
tax_exemption_level long   No

To provide Tax Exemption Level for the account

Allowed values:

Value Description
0 Account is not exempt from taxation (default).
1 Account is exempt from state/province taxation.
2 Account is exempt from federal/national taxation.
3 Account is exempt from both federal/national and state/province taxation.
list_start_master_file long 1 No

Indicates whether the account is listed at the start of a master file.

Allowed values:

Value Description
0  
1 When value=1, account is listed at the top of the master file when generated.
client_alt_msg_template_id string   No

Client-defined email template ID assigned to this account.
client_cn_alt_msg_template_id string   No

The client-defined alternate email template ID to use for this account
revrec_profile_no long   No

Rev profile ID of the account
client_revrec_id string   No

Client-defined ID of the revrec profile that is on the account
invoice_approval_required long 5 No

Boolean indicator to override client's default configured behavior for creating a pending invoice requiring explicit approval, or a Real invoice

Allowed values:

Value Description
0 not required
1 required
Start of functional_acct_group object
functional_acct_group object   No

Array of functional account groups.
Name Type Length Required Description
▶functional_acct_group_no long   No

The Aria-assigned identifier of the functional account group in which to place this account. A functional account group allows you to categorize your customers based on some common element such as geography, product, or channel.
▶client_functional_acct_group_id string   No

Array of functional account group IDs to which this account should be assigned
End of functional_acct_group object
Start of collection_acct_group object
collection_acct_group object   No

Array of collections account groups.
Name Type Length Required Description
▶collections_acct_group_no long   No Group ID for the collections account groups in which to place this account. You can create collections account groups to specify that financial transactions conducted with specific groups of accounts are completed with a specific payment gateway or combination of payment gateways and merchant accounts.

If you created a collections group for a specific payment gateway, be sure to add the account to that collections group during the account registration process or soon afterward. This ensures that collections for accounts in that collections group are completed successfully.
▶client_collections_acct_group_id string   No

Array of collections account group IDs to which this account should be assigned
End of collection_acct_group object
Start of supp_field object
supp_field object   No

Assigns one or more supplemental field values to the account
Name Type Length Required Description
▶supp_field_name     No  
▶supp_field_value     No  
End of supp_field object
Start of acct_surcharges_info object
acct_surcharges_info object   No  
Name Type Length Required Description
▶surcharge_no long   No

The Surcharge number to be attached to the account
▶rate_schedule_no long   No

The Rate Schedule Number for the Surcharge
End of acct_surcharges_info object
acct_currency string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used for this account
acct_balance double   No

Specifies the balance for this account.
address_verification_code string   No

Note: This field is deprecated. Aria no longer supports address_verification_code.
address_match_score double   No

The score of match for account contact address verification code
acct_create_client_receipt_id string   No

The client-specified receipt ID, assigned during this account creation. Useful for auditing and tracking.
status_client_receipt_id string   No

The client-specified receipt ID, assigned for account status change. Useful for auditing and tracking.
Start of acct_coupons object
acct_coupons object   No  
Name Type Length Required Description
▶acct_coupon_cd string   No

The coupon codes to assign to this account, if any
End of acct_coupons object
po_num string 100 No

Purchase order number assigned to the account.
Start of billing_groups_info object
billing_groups_info object   No  
Name Type Length Required Description
▶billing_group_no long 22 No

Aria-assigned billing group identifier.
▶notify_method long 2 No

How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).

Allowed values:

Value Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by 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
▶primary_payment_method_name     No  
▶primary_payment_method_no     No  
▶backup_payment_method_name     No  
▶backup_payment_method_no long 22 No

Backup payment method ID.
▶stmt_address_verification_code     No  
▶client_primary_payment_method_id     No  
▶client_backup_payment_method_id     No  
End of billing_groups_info object
Start of payment_methods_info object
payment_methods_info object   No

List of primary and secondary payment methods of billing groups on this account.
Name Type Length Required Description
▶billing_group_no long 22 No

Aria-assigned billing group identifier.
▶client_def_billing_group_id     No  
▶payment_method_no long 22 No

Aria-assigned sequence number for this payment method.
▶bill_address_verification_code     No  
▶client_payment_method_id     No  
▶bank_routing_num string   No

The American Banking Association (ABA) routing number for the financial institution.
▶iban string 50 No

International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
End of payment_methods_info object
master_plan_count long   No

Count of the number of master plans for the account.
supp_plan_count long   No

Count of the number of supplemental plans for the account.
Start of master_plans_info object
master_plans_info object   No

If billing groups are not excluded, then this array returns all the associated master plan instances for each billing group (provided this is a self-pay account). If billing groups are excluded (or if this is a parent-pay account), then this array returns all the master plan instances on this account.
Name Type Length Required Description
▶master_plan_instance_no long 22 No

Unique plan instance number for each assigned master plan.
▶client_master_plan_instance_id string 100 No

Client-defined plan instance ID for each assigned master plan.
▶client_master_plan_id string   No

The client-defined unique ID for plan this line represents
▶master_plan_no long   No

The Master Subscription plan number.
▶master_plan_instance_description string   No

Description for each assigned master plan
▶dunning_group_no long   No

The dunning group number mapped against each master plan.
▶client_dunning_group_id string 100 No

The client-defined dunning group ID mapped against each master plan.
▶dunning_group_name string 100 No

Name of the dunning group.
▶dunning_group_description string 1000 No

Description of the dunning group.
▶dunning_process_no long 22 No

Dunning process.
▶client_dunning_process_id string 100 No

Client-defined dunning process identifier.
▶billing_group_no long 22 No

The billing group number mapped against each master plan.
▶client_billing_group_id string 100 No

The client-defined billing group ID mapped against each master plan.
▶master_plan_instance_status long   No

This is the status of the object in question for the current API call.
▶mp_instance_status_label string   No

Status label associated with master plan instance status code.
▶master_plan_units long   No

This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.
▶resp_level_cd long 1 No

The responsibility level code. These are values 1 through 4 as described in the legend for this argument.
▶parent_master_plan_inst_no long   No

Note: This field is deprecated. Aria no longer supports parent_master_plan_inst_no.
▶resp_master_plan_instance_no long   No

The system-defined master plan instance number of the responsible account. This field is required if the resp_level_cd is not equal to 1
▶alt_rate_schedule_no long   No

The alternate rate schedule number for the master subscription plan being considered.
▶client_alt_rate_schedule_id string   No

The client-defined alternate rate schedule ID for the master subscription plan being considered.
▶promo_cd string   No

This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
▶bill_day long   No

Day of the month that the account is billed.
▶last_arrears_bill_thru_date string   No

The most recent date at which the account was fully billed in arrears
▶last_bill_date string   No

The last date the account was billed
▶last_bill_thru_date string   No

The date through which the account has been billed.
▶next_bill_date string   No

The next bill date for the account.
▶plan_date string   No

The date the plan assigned to the account.
▶status_date string   No

This is the date the status on the account was set.
▶master_plan_instance_balance double   No

Stack balance of each master plan
▶status_degrade_date string 10 No

Specifies the date, in yyyy-mm-dd format, when the plan instance status was degraded.
▶recurring_billing_interval long   No

Recurring billing interval associated with the assigned rate schedule.
▶usage_billing_interval long   No

Usage billing interval associated with the assigned rate schedule.
▶recurring_billing_period_type long   No

Period type for billing cycles for recurring.
▶usage_billing_period_type long   No

Period type for billing cycles for usage.
▶initial_plan_status long   No

Default status used when master plan is initially assigned on an account.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
▶rollover_plan_status long   No

Status used for the master plan instance at the completion of the rollover period.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
▶rollover_plan_status_duration long   No

Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
▶rollover_plan_status_uom_cd long   No

Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶init_free_period_duration long   No

Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
▶init_free_period_uom_cd long   No

Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶dunning_state long 1 No

Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.

Allowed values:

Value Description
0 None
1 In Progress
2 Complete
▶dunning_step long   No

Current dunning step of the plan instance (applicable only for master plans currently in dunning).
▶dunning_degrade_date string   No

Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
▶plan_deprovisioned_date string   No

The date on which the current plan on this plan instance was suspended, cancelled or terminated.
Start of coupon_codes object
▶coupon_codes object   No

An array of coupon details for each master plan instance.
Name Type Length Required Description
▶▶coupon_codes string   No

The coupon codes to assign to this plan instance, if any
End of coupon_codes object
Start of master_plan_product_fields object
▶master_plan_product_fields object   No  
Name Type Length Required Description
▶▶field_name string   No

The product field number
▶▶field_value string   No

The product field value
End of master_plan_product_fields object
Start of mp_plan_inst_fields object
▶mp_plan_inst_fields object   No  
Name Type Length Required Description
▶▶plan_instance_field_name string   No

Field name associated with each plan instance field on master plan instance.
▶▶plan_instance_field_value string   No

Field value associated with each plan instance field on master plan instance.
End of mp_plan_inst_fields object
▶po_num string 100 No

Purchase order number assigned to the master plan instance.
Start of master_plans_services object
▶master_plans_services object   No  
Name Type Length Required Description
▶▶service_no long   No

The Aria-assigned unique identifier for the service associated with the plan.
▶▶client_service_id string   No

The client-defined identifier for the service associated with the plan.
▶▶svc_location_no long 22 No

The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶client_svc_location_id string 100 No

The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶dest_contact_no long   No

The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶tax_inclusive_ind long   No

This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates.

Allowed values:

Value Description
0 The plan services rates are Tax Exclusive.
1 The plan services rates are Tax Inclusive.
End of master_plans_services object
Start of supp_plans_info object
▶supp_plans_info object   No  
Name Type Length Required Description
▶▶supp_plan_instance_no long   No

Unique plan instance number for each assigned supplemental plan.
▶▶client_supp_plan_instance_id string   No

Client-defined plan instance ID for each assigned supplemental plan.
▶▶supp_plan_no long   No

The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client.
▶▶client_supp_plan_id string   No

Client-defined supplemental plan ID.
▶▶supp_plan_instance_description string   No

Description for each assigned supplemental plan instance
▶▶supp_plan_units double   No

The units of each plan in the above supp_plan_instance array to assign to this account
▶▶alt_rate_schedule_no long   No

The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
▶▶client_alt_rate_schedule_id string   No

The client alternate rate schedule ID for the supplementary subscription plan being considered.
▶▶last_arrears_bill_thru_date string   No

The most recent date at which the account was fully billed in arrears
▶▶last_bill_date string   No

The last date the account was billed
▶▶last_bill_thru_date string   No

The date through which the account has been billed.
▶▶next_bill_date string   No

The next bill date for the account.
▶▶plan_date string   No

The date the plan assigned to the account.
▶▶status_date string   No

This is the date the status on the account was set.
▶▶supp_plan_instance_status_cd long   No

Status code associated with supplemental plan instance status.
▶▶supp_plan_instance_status string   No

Supplemental Plan Instance Status
▶▶parent_plan_instance_no long 22 No

Aria internal ID of parent plan instance
▶▶client_parent_plan_instance_id string   No

Client-defined ID of parent plan instance no
▶▶recurring_billing_interval long   No

Recurring billing interval associated with the assigned rate schedule.
▶▶usage_billing_interval long   No

Usage billing interval associated with the assigned rate schedule.
▶▶recurring_billing_period_type long   No

Period type for billing cycles for recurring.
▶▶usage_billing_period_type long   No

Period type for billing cycles for usage.
▶▶rollover_plan_status long   No

Status used for the master plan instance at the completion of the rollover period.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
▶▶rollover_plan_status_duration long   No

Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
▶▶rollover_plan_status_uom_cd long   No

Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶▶plan_deprovisioned_date string   No

The date on which the current plan on this plan instance was suspended, cancelled or terminated.
Start of supp_plan_product_fields object
▶▶supp_plan_product_fields object   No  
Name Type Length Required Description
▶▶▶field_name string   No

The product field number
▶▶▶field_value string   No

The product field value
End of supp_plan_product_fields object
Start of supp_plan_plan_inst_fields object
▶▶supp_plan_plan_inst_fields object   No  
Name Type Length Required Description
▶▶▶plan_instance_field_name string   No

The plan instance field name
▶▶▶plan_instance_field_value string   No

The plan instance field value
End of supp_plan_plan_inst_fields object
▶▶po_num string 100 No

Purchase order number assigned to the supplemental plan instance.
Start of supp_plans_services object
▶▶supp_plans_services object   No  
Name Type Length Required Description
▶▶▶service_no long   No

The Aria-assigned unique identifier for the service associated with the plan.
▶▶▶client_service_id string   No

The client-defined identifier for the service associated with the plan.
▶▶▶svc_location_no long 22 No

The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶▶client_svc_location_id string 100 No

The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶▶dest_contact_no long   No

The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
▶▶▶tax_inclusive_ind long   No

This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates.

Allowed values:

Value Description
0 The plan services rates are Tax Exclusive.
1 The plan services rates are Tax Inclusive.
End of supp_plans_services object
▶▶last_arr_recur_bill_thru_date string   No

The date through which the account recurring in arrears has been billed for the supplementary plan.
Start of assigned_pi_coupon_codes object
▶▶assigned_pi_coupon_codes object   No

An array of coupon details for this specific plan instance.
Name Type Length Required Description
▶▶▶coupon_code string   No

The coupon codes to assign to this specific plan instance.
End of assigned_pi_coupon_codes object
End of supp_plans_info object
▶bill_lag_days long 10 No

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for this Master Plan Instance. Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net-terms), in which the user would like to send out invoices to customers well in advance of the real invoice date. Positive bill lag days are typically used for usage-based services.
▶last_arr_recur_bill_thru_date string   No

The date through which the account recurring in arrears has been billed for the master plan.
Start of assigned_pi_coupon_codes object
▶assigned_pi_coupon_codes object   No

An array of coupon details for this specific plan instance.
Name Type Length Required Description
▶▶coupon_code string   No

The coupon codes to assign to this specific plan instance.
End of assigned_pi_coupon_codes object
End of master_plans_info object
consumer_acct_ind long   No

Indicates that the Account represents a single individual, used primarily in Business-to-Consumer (B2C) business models. The primary purpose of this field is to support Person Accounts objects in Salesforce via the SFDC Connector.
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
acct_contact_no long 100 No

Note: This field is deprecated. Aria no longer supports acct_contact_no.
other_contact_details object   No

Note: This field is deprecated. Aria no longer supports other_contact_details.
acct_email_list_cc string 3000 No

An array containing the list of additional cc email addresses
acct_email_list_bcc string 3000 No

An array containing the list of additional bcc email addresses
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
address_verification_cd_2 string   No

The address verification code for account contact address
acct_no_2 long   No  
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_contact_no_2 long 100 No

The Aria-assigned unique identifier for the account contact saved on the account.
legal_entity_no_2 long   No

Aria-assigned legal entity identification number.
Start of other_unmapped_contact_details object
other_unmapped_contact_details object   No

These are the contacts that are NOT linked to any entity on account like payment method bill contacts, billing group statement contacts, account contact.
Name Type Length Required Description
▶other_contact_no long   No

The Aria-assigned unique identifier for the contact saved on the account.
End of other_unmapped_contact_details object
Start of chief_acct_info object
chief_acct_info object   No

Information of the Chief account in the account hierarchy.
Name Type Length Required Description
▶chief_acct_no long   No

Aria-assigned account identifier. This is the Chief of all accounts in hierarchy.
▶chief_acct_user_id string   No

The User ID of the Chief account in account hierarchy.
▶chief_client_acct_id string   No

Client-assigned identifier for the Chief account in account hierarchy.
End of chief_acct_info object
addr_method_cd long   No

This field denotes the tax address method code which was used to generate the geo code of the account contact.
acct_past_due_balance double   No

The outstanding balance on the account that has passed its due date.
Start of acct_einvoicing_field_list object
acct_einvoicing_field_list object   No

Array of e-invoicing fields associated with the account.
Name Type Length Required Description
▶acct_einvoicing_field_name string 100 No

Name of the e-invoicing field.
▶acct_einvoicing_field_value string 100 No

The value corresponding to the e-invoicing field name.
End of acct_einvoicing_field_list object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.