Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_details_all_m

get_acct_details_all_m

This API returns a detailed set of information about an account. In addition to contact, demographic, and basic billing configuration information, you can optionally retrieve plan information, billing group information, and payment method information.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
required-icon.png client_acct_id string 50 Client-defined account identifier.
  include_master_plans long 1 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.  

Allowable values for include_master_plans:

Values Description
1 Yes (default)
0 No
  include_supp_plans long 1 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.  

Allowable values for include_supp_plans:

Values Description
1 Yes
0 No (default)
  include_billing_groups long 1 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.  

Allowable values for include_billing_groups:

Values Description
1 Yes
0 No (default)
  include_payment_methods long 1 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.  

Allowable values for include_payment_methods:

Values Description
1 Yes
0 No (default)
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  plan_limit long 3

Restricts the number of records returned in the <master_plans_info> output array to a minimum of 1 and a maximum of 999.

The records will be returned in ascending order by master plan instance (MPI) ID.

Example: You have an account that has 4 MPIs with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only MPIs 123 and 234 will be returned in the <master_plans_info> output array.

If you don't pass a value into this field, then all records that match your input parameters will be returned.
  plan_offset long 30

Specifies the number of records to skip in the <master_plans_info> output array.

The records will be skipped in ascending order by MPI ID.

Example: You have an account that has 4 MPIs with ID numbers: 123, 234, 456, and 567. If you pass 2 into this field, only MPIs 456 and 567 will be returned in the <master_plans_info> output array.

If you don't pass a value into this field, then it will default to 0.
  filter_mpi_status hash   Array with MPI status filter value that can be associated with an API call. 
     brd_arrow.gif filter_mpi_status_cd  long 8

Array of master_plan_instance_status. This is a filter based on the status of the master plans for the current API call. This input helps to filter out the MPIs based on the given statuses, thus improve the response time of the API. For example, an account might have four MPIs with different statuses, such as, Active, Pending Activation, Pending Termination and Suspended. If you pass the array to filter statuses of values "1" and "2", then only those MPIs that are in Active and Pending Activation are returned.

If you do not pass any values in this input, then the default behavior is that the API will return all the MPIs irrespective of MPI status.

Allowable values for filter_mpi_status_cd:    

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
  filter_spi_status hash   Array with SPI status filter value that can be associated with an API call.
    brd_arrow.gif filter_spi_status_cd long 8

Array of supp_plan_instance_status. 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.

For example, an account might have four MPIs and four SPIs with different statuses, such as, Active, Pending Activation, Suspended and Active. If you pass the array to filter MPI statuses (filter_mpi_status_cd) with values "1" and "2" and similarly if you pass the array to filter SPI statuses (filter_spi_status_cd) with values "3" and "1", then the API will return the MPI/SPI based on the given combination of status filters. The SPI alone will not be returned if the corresponding MPI is not returned, that is, if the MPI status code used does not return the MPI.

If you do not pass any values in this input, then the default behavior is that the API will return all the SPIs irrespective of their status for the corresponding MPI.

Note: The invalid status validation for SPIs will be considered only when you pass "include_supp_plans" as with the value "1".

Allowable values for filter_spi_status_cd:    

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated

Output Arguments

Field Name Field Type Description
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts. DEPRECATED
acct_no_2 long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
userid string The users unique identifier.
first_name string Contact First name
middle_initial string Middle initial of the contact
last_name string Contact last name
company_name string Company name of the contact
address1 string First address line of the contact.
address2 string 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 The third line of the address
city string City of the contact
locality string 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 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 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
postal_cd string Postal/Zip code for the contact address.
addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the account contact.
phone string The phone number of the contact
phone_ext string The extension for the contact phone
cell_phone string The contact cell phone.
work_phone string The full work phone number
work_phone_ext string The office/desk extension of the contact's work phone, if any.
fax string The FAX phone number for the contact.
email string Alternate email address for contact.
birthdate string Birthdate of the contact in yyyy-mm-dd format.
status_cd long This is the status of the object in question for the current API call.  

Allowable values status_cd:

Values Description
0 Inactive
1 Active
32 Registered Pending Activation
51 Temporary Service Ban
99 Permanent
-99 Archived
notify_method long How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  

Allowable values for notify_method:

Values 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 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 The senior account user ID of the account.
senior_client_acct_id string The client senior account ID of the account.
legal_entity_no long Aria-assigned legal entity identification number. DEPRECATED
legal_entity_no_2 long Aria-assigned legal entity identification number.
legal_entity_name string Client-assigned descriptor of the legal entity.
client_legal_entity_id string Client-assigned unique identifier for the legal entity.
test_acct_ind long This argument indicates the account is a test account and is treated as such in the system.  

Allowable values for test_acct_ind:

Values Description
1 test
0 live
taxpayer_id string Taxpayer Identification number.
acct_start_date string Date, in yyyy-mm-dd format, on which the account was first created outside of Aria
alt_msg_template_no long Email template number assigned to this account.
seq_func_group_no long Functional account group number specifically designated for statement sequence number assignment.
tax_exemption_level long To provide Tax Exemption Level for the account  

Allowable values for tax_exemption_level:

Values 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 Indicates whether the account is listed at the start of a master file.  

Allowable values list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
client_alt_msg_template_id string Client-defined email template ID assigned to this account.
client_cn_alt_msg_template_id string The client-defined alternate email template ID to use for this account
revrec_profile_no long Rev profile ID of the account
client_revrec_id string Client-defined ID of the revrec profile that is on the account
invoice_approval_required long Boolean indicator to override client's default configured behavior for creating a pending invoice requiring explicit approval, or a Real invoice  

Allowable values for invoice_approval_required:

Values Description
0 not required
1 required
functional_acct_group hash Array of functional account groups.
brd_arrow.gif functional_acct_group_no long 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.
brd_arrow.gif client_functional_acct_group_id string Array of functional account group IDs to which this account should be assigned
collection_acct_group hash Array of collections account groups.
brd_arrow.gif collections_acct_group_no long 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. <p>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.</p>
brd_arrow.gif client_collections_acct_group_id string Array of collections account group IDs to which this account should be assigned
supp_field hash  
brd_arrow.gif supp_field_name string Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
brd_arrow.gif supp_field_value string The values for the supplemental field names given in supp_field_names
acct_surcharges_info hash  
brd_arrow.gif surcharge_no long The Surcharge number to be attached to the account
brd_arrow.gif rate_schedule_no long The Rate Schedule Number for the Surcharge
acct_currency string The 3-character ISO-compliant currency code in lowercase for monetary values used for this account (a list of codes can be accessed here).
acct_balance double Specifies the balance for this account.
address_verification_cd string The address verification code for account contact address. DEPRECATED
address_verification_cd_2 string The address verification code for account contact address.
address_match_score double The score of match for account contact address verification code
acct_create_client_receipt_id string The client-specified receipt ID, assigned during this account creation. Useful for auditing and tracking.
status_client_receipt_id string The client-specified receipt ID, assigned for account status change. Useful for auditing and tracking.
acct_coupons hash  
brd_arrow.gif acct_coupon_cd string The coupon codes to assign to this account, if any
po_num string Purchase order number assigned to the account.
billing_groups_info hash  
brd_arrow.gif billing_group_no long The billing group number mapped against each master plan.
brd_arrow.gif billing_group_name string Billing group name
brd_arrow.gif billing_group_description string Billing group description
brd_arrow.gif client_def_billing_group_id string Client-defined billing group ID.
brd_arrow.gif notify_method long How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  

Allowable values for notify_method:

Values 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
brd_arrow.gif notify_template_group long Notify template No.
brd_arrow.gif statement_template long Statement template No.
brd_arrow.gif credit_note_template long Credit note template No.
brd_arrow.gif payment_option string This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'  

Allowable values for payment_option:

Values Description
Methods Methods
Terms Terms
brd_arrow.gif primary_payment_method_name string Pay Method Name from Pay Methods configuration.
brd_arrow.gif primary_payment_method_id long The primary payment_method_no of the billing group.
brd_arrow.gif primary_payment_method_no long Pay Method Number from Pay Methods configuration.
brd_arrow.gif backup_payment_method_name string Pay Method Name from Pay Methods configuration.
brd_arrow.gif backup_payment_method_id long The secondary payment_method_no of billing group.
brd_arrow.gif backup_payment_method_no long Pay Method Number from Pay Methods configuration.
brd_arrow.gif client_payment_term_id string Client Payment Term ID from Payment Terms configuration.
brd_arrow.gif payment_terms_name string Payment Terms Name from Payment Terms configuration.
brd_arrow.gif payment_terms_no long Payment Terms Number from Payment Terms configuration.
brd_arrow.gif payment_terms_type string Payment Terms Type from Payment Terms configuration.
brd_arrow.gif ean_gln_num string 'EAN or GLN Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
brd_arrow.gif ean_gln_requisition_num string 'EAN or GLN Requisition Number from billing group that is only applicable if payment_option="Terms" and pmt_terms_type="EAN/GLN"'
brd_arrow.gif stmt_first_name string First name of the billing contact
brd_arrow.gif stmt_mi string Middle Initial of the billing contact
brd_arrow.gif stmt_last_name string Last name of the billing contact
brd_arrow.gif stmt_company_name string Company name of the billing contact
brd_arrow.gif stmt_address1 string First address line of the billing contact
brd_arrow.gif stmt_address2 string Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
brd_arrow.gif stmt_address3 string Third address line of the billing contact
brd_arrow.gif stmt_city string City of the billing contact
brd_arrow.gif stmt_locality string 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.
brd_arrow.gif stmt_state_prov string State or Province of the billing 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.
brd_arrow.gif stmt_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif stmt_postal_cd string This is the postal code for the billing contact address.
brd_arrow.gif stmt_addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the statement contact.
brd_arrow.gif stmt_phone string Phone of the billing contact
brd_arrow.gif stmt_phone_ext string This is the billing contacts extension for the phone given.
brd_arrow.gif stmt_cell_phone string Cell phone of the billing contact
brd_arrow.gif stmt_work_phone string Work phone of the billing contact
brd_arrow.gif stmt_work_phone_ext string This is the work phone extension for the billing contact work phone.
brd_arrow.gif stmt_fax string Specifies the FAX phone number for the billing contact.
brd_arrow.gif stmt_email string Email of the billing contact
brd_arrow.gif stmt_birthdate string The birthdate, in yyyy-mm-dd format, of the statement contact.
brd_arrow.gif bg_list_start_master_file long Indicates whether or not the account shall be listed at the start of a master file.  

Allowable values for bg_list_start_master_file:

Values Description
0 0
1 When value=1, account is listed at the top of the master file when generated.
brd_arrow.gif stmt_address_verification_code string The address verification code for billing contact.
brd_arrow.gif stmt_address_match_score double The score of match for billing contact verification code
brd_arrow.gif client_primary_payment_method_id string Client-defined ID of primary payment method on the billing group
brd_arrow.gif client_backup_payment_method_id string Client-defined ID of backup payment method on the billing group
brd_arrow.gif stmt_contact_no long The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
brd_arrow.gif credit_memo_template long Credit memo template No.
brd_arrow.gif rebill_template long Rebill template No.
brd_arrow.gif stmt_email_list_cc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently cc'd (carbon copied).
brd_arrow.gif stmt_email_list_bcc string Comma-delimited list of email addresses to which the statements associated with the billing group are currently bcc'd (blind carbon copied).
brd_arrow.gif collections_group_bg_no long Aria-assigned identifier of the collection group assigned to a billing group.
brd_arrow.gif client_collections_group_bg_id string Client-defined identifier of the collection group assigned to a billing group.
brd_arrow.gif collections_group_name string Collection group name.
brd_arrow.gif collections_group_description string Collection group description
payment_methods_info hash List of primary and secondary payment methods of billing groups on this account.
brd_arrow.gif billing_group_no long The billing group number mapped against each master plan.
brd_arrow.gif client_def_billing_group_id string Client-defined billing group ID
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif bill_first_name string First name of the billing contact.
brd_arrow.gif bill_middle_initial string Middle initial of the billing contact.
brd_arrow.gif bill_last_name string Last name of the billing contact.
brd_arrow.gif bill_company_name string Company name of the billing contact.
brd_arrow.gif bill_address1 string First address line of the billing contact.
brd_arrow.gif bill_address2 string Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
brd_arrow.gif bill_address3 string The third line of the billing address.
brd_arrow.gif bill_city string City of the billing contact.
brd_arrow.gif bill_locality string 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.
brd_arrow.gif bill_state_prov string State or Province of the billing 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.
brd_arrow.gif bill_country string Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif bill_postal_cd string Postal code for the billing contact.
brd_arrow.gif bill_addr_method_cd string This field denotes the tax address method code which was used to generate the geo code of the billing contact.
brd_arrow.gif bill_address_verification_code string The address verification code for account billing address
brd_arrow.gif bill_address_match_score double The score of match for account billing address verification code
brd_arrow.gif bill_phone string Phone number of the billing contact.
brd_arrow.gif bill_phone_ext string Phone extension of the billing contact.
brd_arrow.gif bill_cell_phone string Cell phone number of the billing contact.
brd_arrow.gif bill_work_phone string Work phone number of the billing contact.
brd_arrow.gif bill_work_phone_ext string This is the work phone extension for the billing contact work phone.
brd_arrow.gif bill_fax string Fax number of the billing contact.
brd_arrow.gif bill_email string Email of the billing contact.
brd_arrow.gif bill_birthdate string Birthdate of the billing contact.
brd_arrow.gif pay_method_name string The human-readable name of the payment method.
brd_arrow.gif client_payment_method_id string The client-defined billing primary payment method ID.
brd_arrow.gif pay_method_description string Description for the primary payment method.'
brd_arrow.gif pay_method_type long This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.  

Allowable values for pay_method_type:

Values Description
-1 External Payment
0 Other
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
brd_arrow.gif suffix string The last 4 digits of the credit card number
brd_arrow.gif cc_expire_mm long Expiration month for the credit card payment instrument.
brd_arrow.gif cc_expire_yyyy long Expiration year for the credit card payment instrument.
brd_arrow.gif cc_type string The type of credit card used for the original payment.
brd_arrow.gif bank_routing_num string The American Banking Association (ABA) routing number for the financial institution.
brd_arrow.gif bill_agreement_id string Unique ID of the bill agreement (also referred to as a token).
brd_arrow.gif iban string 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.
brd_arrow.gif bank_swift_cd string SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
brd_arrow.gif bank_country_cd string Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
brd_arrow.gif mandate_id string Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
brd_arrow.gif bank_id_cd string Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
brd_arrow.gif bank_branch_cd string Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
brd_arrow.gif bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
master_plan_count long Count of the number of master plans for the account.
supp_plan_count long Count of the number of supplemental plans for the account.
master_plans_info hash 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.
brd_arrow.gif master_plan_instance_no long Unique plan instance number for each assigned master plan.
brd_arrow.gif client_master_plan_instance_id string Client-defined plan instance ID for each assigned master plan.
brd_arrow.gif client_master_plan_id string The client-defined unique ID for plan this line represents
brd_arrow.gif master_plan_no long The Master Subscription plan number.
brd_arrow.gif master_plan_instance_description string Description for each assigned master plan
brd_arrow.gif dunning_group_no long The dunning group number mapped against each master plan.
brd_arrow.gif client_dunning_group_id string The client-defined dunning group ID mapped against each master plan.
brd_arrow.gif dunning_group_name string Name of the dunning group.
brd_arrow.gif dunning_group_description string Description of the dunning group.
brd_arrow.gif dunning_process_no long Dunning process.
brd_arrow.gif client_dunning_process_id string Client-defined dunning process identifier.
brd_arrow.gif billing_group_no long The billing group number mapped against each master plan.
brd_arrow.gif client_billing_group_id string The client-defined billing group ID mapped against each master plan.
brd_arrow.gif master_plan_instance_status long This is the status of the object in question for the current API call.
brd_arrow.gif mp_instance_status_label string Status label associated with master plan instance status code.
brd_arrow.gif master_plan_units long 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.
brd_arrow.gif resp_level_cd long

The responsibility level code. These are values 1 through 3 as described in the legend for this argument.

Please see Parent-child Account Best Practices for more information.
brd_arrow.gif resp_master_plan_instance_no long The system-defined master plan instance (MPI) number of the MPI responsible for a particular plan. This field returns a value if the  <resp_level_cd> field) is set to one of the two parent pay options.
brd_arrow.gif parent_master_plan_inst_no (DEPRECATED) long The system-defined master plan instance number of the parent account. This field is required if the resp_level_cd is not equal to 1
brd_arrow.gif alt_rate_schedule_no long The alternate rate schedule number for the master subscription plan being considered.
brd_arrow.gif client_alt_rate_schedule_id string The client-defined alternate rate schedule ID for the master subscription plan being considered.
brd_arrow.gif promo_cd string 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.
brd_arrow.gif bill_day long Day of the month that the account is billed.
brd_arrow.gif last_arrears_bill_thru_date string The most recent date at which the account was fully billed in arrears
brd_arrow.gif last_bill_date string The last date the account was billed
brd_arrow.gif last_bill_thru_date string The date through which the account has been billed.
brd_arrow.gif next_bill_date string The next bill date for the account.
brd_arrow.gif plan_date string The date the plan assigned to the account.
brd_arrow.gif status_date string This is the date the status on the account was set.
brd_arrow.gif master_plan_instance_balance double Stack balance of each master plan
brd_arrow.gif status_degrade_date string Specifies the date, in yyyy-mm-dd format, when the plan instance status was degraded.
brd_arrow.gif recurring_billing_interval long Recurring billing interval associated with the assigned rate schedule.
brd_arrow.gif usage_billing_interval long Usage billing interval associated with the assigned rate schedule.
brd_arrow.gif recurring_billing_period_type long Period type for billing cycles for recurring.
brd_arrow.gif usage_billing_period_type long Period type for billing cycles for usage.
brd_arrow.gif initial_plan_status long Default status used when master plan is initially assigned on an account.  

Allowable values for initial_plan_status:

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
brd_arrow.gif rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.  

Allowable values for rollover_plan_status:

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
brd_arrow.gif rollover_plan_status_duration long 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_uom_cd).
brd_arrow.gif rollover_plan_status_uom_cd long 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).  

Allowable values for rollover_plan_status_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
brd_arrow.gif init_free_period_uom_cd long Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).  

Allowable values for init_free_period_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif dunning_state long 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.  

Allowable values for dunning_state:

Values Description
0 None
1 In Progress
brd_arrow.gif dunning_step long Current dunning step of the plan instance (applicable only for master plans currently in dunning).
brd_arrow.gif dunning_degrade_date string Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
brd_arrow.gif plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
brd_arrow.gif coupon_codes hash An array of coupon details for each master plan instance.
brd_arrow.gif coupon_codes string The coupon codes to assign to this plan instance, if any
brd_arrow.gif master_plan_product_fields hash  
brd_arrow.gif field_name string The product field number
brd_arrow.gif field_value string The product field value
brd_arrow.gif mp_plan_inst_fields hash  
brd_arrow.gif plan_instance_field_name string Field name associated with each plan instance field on master plan instance.
brd_arrow.gif plan_instance_field_value string Field value associated with each plan instance field on master plan instance.
brd_arrow.gif po_num string Purchase order number assigned to the master plan instance.
brd_arrow.gif master_plans_services hash  
brd_arrow.gif service_no long The Aria-assigned unique identifier for the service associated with the plan.
brd_arrow.gif client_service_id string The client-defined identifier for the service associated with the plan.
brd_arrow.gif svc_location_no long 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.
brd_arrow.gif client_svc_location_id string 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.
brd_arrow.gif dest_contact_no long 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.
brd_arrow.gif supp_plans_info hash  
brd_arrow.gif supp_plan_instance_no long Unique plan instance number for each assigned supplemental plan.
brd_arrow.gif client_supp_plan_instance_id string Client-defined plan instance ID for each assigned supplemental plan.
brd_arrow.gif supp_plan_no long The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client.
brd_arrow.gif client_supp_plan_id string Client-defined supplemental plan ID.
brd_arrow.gif supp_plan_instance_description string Description for each assigned supplemental plan instance
brd_arrow.gif supp_plan_units long The units of each plan in the above supp_plan_instance array to assign to this account
brd_arrow.gif alt_rate_schedule_no long The unique ID for the alternate rate schedules to assign to this account, by supplemental plan above
brd_arrow.gif client_alt_rate_schedule_id string The client alternate rate schedule ID for the supplementary subscription plan being considered.
brd_arrow.gif last_arrears_bill_thru_date string The most recent date at which the account was fully billed in arrears
brd_arrow.gif last_bill_date string The last date the account was billed
brd_arrow.gif last_bill_thru_date string The date through which the account has been billed.
brd_arrow.gif next_bill_date string The next bill date for the account.
brd_arrow.gif plan_date string The date the plan assigned to the account.
brd_arrow.gif status_date string This is the date the status on the account was set.
brd_arrow.gif supp_plan_instance_status_cd long Status code associated with supplemental plan instance status. 
brd_arrow.gif supp_plan_instance_status string Supplemental Plan Instance Status
brd_arrow.gif parent_plan_instance_no long Aria internal ID of parent plan instance
brd_arrow.gif client_parent_plan_instance_id string Client-defined ID of parent plan instance no
brd_arrow.gif recurring_billing_interval long Recurring billing interval associated with the assigned rate schedule.
brd_arrow.gif usage_billing_interval long Usage billing interval associated with the assigned rate schedule.
brd_arrow.gif rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.  

Allowable values for rollover_plan_status:

Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
brd_arrow.gif rollover_plan_status_duration long 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_uom_cd).
brd_arrow.gif rollover_plan_status_uom_cd long 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).  

Allowable values for rollover_plan_status_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif plan_deprovisioned_date string The date on which the current plan on this plan instance was suspended, cancelled or terminated.
brd_arrow.gif supp_plan_product_fields hash  
brd_arrow.gif field_name string The product field number
brd_arrow.gif field_value string The product field value
brd_arrow.gif supp_plan_plan_inst_fields hash  
brd_arrow.gif plan_instance_field_name string The plan instance field name
brd_arrow.gif plan_instance_field_value string The plan instance field value
brd_arrow.gif po_num string Purchase order number assigned to the supplemental plan instance.
brd_arrow.gif supp_plans_services hash  
brd_arrow.gif service_no long The Aria-assigned unique identifier for the service associated with the plan.
brd_arrow.gif client_service_id string The client-defined identifier for the service associated with the plan.
brd_arrow.gif svc_location_no long 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.
brd_arrow.gif client_svc_location_id string 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.
brd_arrow.gif dest_contact_no long 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.
  brd_arrow.gif bill_lag_days long

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which you specified that an invoice should be generated for a master plan instance. 

Examples:

  • -14 means that an invoice is generated 14 days before the billing date.
  • 10 means that an invoice is generated 10 days after the billing date.
consumer_acct_ind long 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 Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
acct_contact_no long The Aria-assigned unique identifier for the account contact saved on the account. DEPRECATED
acct_contact_no_2 long The Aria-assigned unique identifier for the account contact saved on the account.
other_contact_details  hash These are the contacts that are NOT linked to any entity on account like payment method bill contacts, billing group statement contacts, account contact. DEPRECATED
brd_arrow.gif other_contact_no  long The Aria-assigned unique identifier for the contact saved on the account. DEPRECATED
other_unmapped_contact_details hash These are the contacts that are NOT linked to any entity on account like payment method bill contacts, billing group statement contacts, account contact.
 brd_arrow.gif other_contact_no long The Aria-assigned unique identifier for the contact saved on the account.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
acct_email_list_cc string Comma-delimited list of email addresses to which the account holder's statements are currently cc'd (carbon copied).
acct_email_list_bcc string Comma-delimited list of email addresses to which the account holder's statements are currently bcc'd (blind carbon copied) .
chief_acct_info hash

Array of information about the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy. Example: if you have a child account with a parent and "grandparent", this array will identify the "grandparent" account as the “chief” account.

This array will return values even if the queried account is not part of an account hierarchy. If the account is not part of account hierarchy, this array will return the queried account details in this output parameter.
  brd_arrow.gif chief_acct_no long Account number of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
  brd_arrow.gif chief_acct_user_id string User ID of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
  brd_arrow.gif chief_client_acct_id string Client-defined identifier of the “chief” account, which is the ancestor at the highest level in a parent-child account hierarchy.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®