Aria-assigned unique identifier indicating the Aria client providing service to this account.

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

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

Alternative required field: client_acct_id

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.

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.

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.

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.

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

Alternative field: locale_name

Name of the locale.

Alternative field: locale_no

Client-defined account identifier.

Alternative required field: acct_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.

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.

Array of master plan instance status.

See fields below

Array of supplemental plan instance status.

See fields below

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

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

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.

Client-defined account identifier.

The users unique identifier.

Contact First name

Middle initial of the contact

Contact last name

Company name of the contact

First address line of the contact.

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.

The third line of the address

City of the contact

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 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 of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.

Postal/Zip code for the contact address.

The phone number of the contact

The extension for the contact phone

The contact cell phone.

The full work phone number

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

The FAX phone number for the contact.

Alternate email address for contact.

Birthdate of the contact in yyyy-mm-dd format.

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

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

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

The senior account user ID of the account.

The client senior account ID of the account.

Client-assigned descriptor of the legal entity.

Client-assigned unique identifier for the legal entity.

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

Taxpayer Identification number.

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

Email template number assigned to this account.

Functional account group number specifically designated for statement sequence number assignment.

To provide Tax Exemption Level for the account

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

Client-defined email template ID assigned to this account.

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

Rev profile ID of the account

Client-defined ID of the revrec profile that is on the account

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

Array of functional account groups.

See fields below

Array of collections account groups.

See fields below

Assigns one or more supplemental field values to the account

See fields below

See fields below

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

Specifies the balance for this account.

The score of match for account contact address verification code

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

The client-specified receipt ID, assigned for account status change. Useful for auditing and tracking.

See fields below

Purchase order number assigned to the account.

See fields below

List of primary and secondary payment methods of billing groups on this account.

See fields below

Count of the number of master plans for the account.

Count of the number of supplemental plans for the account.

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.

See fields below

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.

Name of the account level locale.

An array containing the list of additional cc email addresses

An array containing the list of additional bcc email addresses

Aria-assigned error identifier. 0 indicates no error.

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

The address verification code for account contact address

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

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

Aria-assigned legal entity identification number.

These are the contacts that are NOT linked to any entity on account like payment method bill contacts, billing group statement contacts, account contact.

See fields below

Information of the Chief account in the account hierarchy.

See fields below

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

The outstanding balance on the account that has passed its due date.

Array of e-invoicing fields associated with the account.

See fields below

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.

Array of functional account group IDs to which this account should be assigned

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.

Array of collections account group IDs to which this account should be assigned

The Surcharge number to be attached to the account

The Rate Schedule Number for the Surcharge

The coupon codes to assign to this account, if any

Aria-assigned billing group identifier.

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

Backup payment method ID.

Aria-assigned billing group identifier.

Aria-assigned sequence number for this payment method.

The American Banking Association (ABA) routing number for the financial institution.

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.

The coupon codes to assign to this plan instance, if any

The product field number

The product field value

Field name associated with each plan instance field on master plan instance.

Field value associated with each plan instance field on master plan instance.

The Aria-assigned unique identifier for the service associated with the plan.

The client-defined identifier for the service associated with the plan.

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.

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.

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.

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.

The product field number

The product field value

The plan instance field name

The plan instance field value

The Aria-assigned unique identifier for the service associated with the plan.

The client-defined identifier for the service associated with the plan.

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.

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.

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.

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.

The coupon codes to assign to this specific plan instance.

Unique plan instance number for each assigned supplemental plan.

Client-defined plan instance ID for each assigned supplemental plan.

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

Client-defined supplemental plan ID.

Description for each assigned supplemental plan instance

The units of each plan in the above supp_plan_instance array to assign to this account

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

The client alternate rate schedule ID for the supplementary subscription plan being considered.

The most recent date at which the account was fully billed in arrears

The last date the account was billed

The date through which the account has been billed.

The next bill date for the account.

The date the plan assigned to the account.

This is the date the status on the account was set.

Status code associated with supplemental plan instance status.

Supplemental Plan Instance Status

Aria internal ID of parent plan instance

Client-defined ID of parent plan instance no

Recurring billing interval associated with the assigned rate schedule.

Usage billing interval associated with the assigned rate schedule.

Period type for billing cycles for recurring.

Period type for billing cycles for usage.

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

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).

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).

The date on which the current plan on this plan instance was suspended, cancelled or terminated.

See fields below

See fields below

Purchase order number assigned to the supplemental plan instance.

See fields below

The date through which the account recurring in arrears has been billed for the supplementary plan.

An array of coupon details for this specific plan instance.

See fields below

The coupon codes to assign to this specific plan instance.

Unique plan instance number for each assigned master plan.

Client-defined plan instance ID for each assigned master plan.

The client-defined unique ID for plan this line represents

The Master Subscription plan number.

Description for each assigned master plan

The dunning group number mapped against each master plan.

The client-defined dunning group ID mapped against each master plan.

Name of the dunning group.

Description of the dunning group.

Dunning process.

Client-defined dunning process identifier.

The billing group number mapped against each master plan.

The client-defined billing group ID mapped against each master plan.

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

Status label associated with master plan instance status code.

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.

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

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

The alternate rate schedule number for the master subscription plan being considered.

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

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.

Day of the month that the account is billed.

The most recent date at which the account was fully billed in arrears

The last date the account was billed

The date through which the account has been billed.

The next bill date for the account.

The date the plan assigned to the account.

This is the date the status on the account was set.

Stack balance of each master plan

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

Recurring billing interval associated with the assigned rate schedule.

Usage billing interval associated with the assigned rate schedule.

Period type for billing cycles for recurring.

Period type for billing cycles for usage.

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

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

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).

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).

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

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

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.

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

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

The date on which the current plan on this plan instance was suspended, cancelled or terminated.

An array of coupon details for each master plan instance.

See fields below

See fields below

See fields below

Purchase order number assigned to the master plan instance.

See fields below

See fields below

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.

The date through which the account recurring in arrears has been billed for the master plan.

An array of coupon details for this specific plan instance.

See fields below

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

Aria-assigned account identifier. This is the Chief of all accounts in hierarchy.

The User ID of the Chief account in account hierarchy.

Client-assigned identifier for the Chief account in account hierarchy.

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name.