Home > Aria Crescendo Documentation > Aria Crescendo core api > update_acct_plan_multi_m

update_acct_plan_multi_m

Input Arguments
Output Arguments
1. Allowable values for plan_operation
2. Allowable values for line_type

Assigns, replaces, updates, and/or cancels multiple plans (both master and Supplemental Plans) for a specified account.

In addition to Plan assignment, you can also make the following Plan changes:

Assign billing groups, dunning groups and collection groups
Assign a promotion code or a coupon
Change the number of Plan unit instances assigned to an account
Assign services
Change the plan's fulfillment date
Assign standard and custom rate schedules
Assign surcharges
Assign a dunning state
Assign the responsibility level (parent, self-pay, etc.)
Assign proration and invoicing options
Reset billing dates
Enable usage pooling
Assign NSO items and their billing options
Assign payment terms or methods

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

You can assign, update, modify, and cancel multiple plans in a single API call. However, each Plan instance can only be given one operation per call, i.e., you cannot update and cancel the same Plan instance within the same call.

If you want to add new Master Plans to an existing account, and align the new plan's anniversary date with the existing plans, you can use the override_dates_mp_instance_no field.

When adding or replacing supplemental fields on an existing account, you can align the anniversary date to its Master Plan Instance with the auto_offset_months field.

When adding, replacing and canceling a Plan, you can use the <alt_proration_start_date> field to align the start dates of all the affected plans on the account.

Any field on a Plan can be updated. You can clear the value in any field with a type of "string", provided that the field is nullable for a Plan, by entering a '~' in that field.

For information on various scenarios involving date options in this API, see update_acct_plan_multi_m Use Cases.

Notes:

If you assign a Supplemental Plan at the same time as its Master Plan and provide an override bill through date, the bill through date for the supplemental is determined based on your setting for the parameter Override Bill Thru Date Supp Plan Behavior.

To see a description of the parameter, click Configuration > Billing > Invoice Settings.
To determine the Master Plan's bill day when the update_acct_plan_multi_m API is called, Aria considers the following inputs in the order listed below:
1. <override_bill_thru_date>;
2. then whichever of these you passed in: <alt_start_date> or <alt_bill_day>;
3. then whichever of these you passed in: <retroactive_start_date> or <effective_date>.
This API performs a maximum of 100 Plan updates in a single call.

For information on error messages generated by this API, see update_acct_plan_multi_m Error Messages.

Input Arguments

Req

Field Name

Field Type

Max Length

Description

client_no

long

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

auth_key

string

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

acct_no

long

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

client_acct_id

string

Client(or user)-assigned account identifier. If "acct_no" is not provided, must correctly identify the account to which the given usage record is to be assigned. All usage records must identify either an "acct_no" or a "userid".

auto_assign_mandatory_supp_plans

string

Governs the behavior of mandatory Supplemental Plans. If set to true, it will include all the mandatory Supplemental Plans belonging to the parent Plan without having to explicitly set them. If set to false, you must enter each of those mandatory Supplemental Plans. Defaults to 'True'. This will override the "Included by Default" setting in the Product Catalog for a given Supplemental Plan.

Allowable values for auto_assign_mandatory_supp_plans

Values	Description
true	Automatically assign mandatory Supplemental Plans. (default)
false	Do not automatically assign mandatory Supplemental Plans.

Start plan_updates array

plan_updates

array

Field Name

Field Type

Max Length

Description

plan_directive

long

Indicates what operation to perform on each Plan or Plan instance specified.

Allowable values for plan_directive

Values	Description
1	Assign Plan as new Plan instance
2	Replace the Plan on the specified Plan instance
3	Update specified attributes on the given Plan instance
4	Cancel the specified Plan instance

existing_plan_instance_no

long

The unique identifier of the Plan instance (can be either a master or Supplemental Plan). Either this field, or existing_client_plan_instance_id is required when updating Plan units or a rate schedule on this instance.

existing_client_plan_instance_id

string

100

The client-defined identifier of the Plan instance (can be either a master or Supplemental Plan).

new_client_plan_instance_id

string

100

Updates the client-defined identifier associated with the Plan instance.

plan_instance_idx

long

For non-persistent referencing of a Plan instance within the API request.

plan_instance_description

string

1000

Description for the Plan instance.

new_plan_no

long

The unique identifier of the new Plan being assigned or replacing the existing Plan on the instance. Either this field, or new_client_plan_id is required when replacing a Plan on a Plan instance.

new_client_plan_id

string

100

The client-defined identifier of the new Plan being assigned or replacing the existing Plan on the instance.

promo_cd

string

For Master Plan Instances only. Ignore if submitted for a Supplemental Plan.For promo code removal, use the alpha erase indicator value '~' (tilde).

plan_units

double

Number of units purchased of the specified Plan.

bill_lag_days

long

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

Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net terms), for which you would like to send out invoices to your customers well in advance of the real invoice date. This gives your customers time to receive a paper or email invoice (statement) and send a payment before the actual invoice date.

Positive bill lag days typically apply to usage-based services.

Examples:

If you want an invoice to be generated 14 days before the billing date, pass -14 into this field.
If you want an invoice to be generated 10 days after the billing date, pass 10 into this field.

By default, bill lag days are restricted to +/- the (minimum number of days in a recurring billing period – 1 day). However, if your Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle parameter is set to True (in the Aria application under Configuration > Billing> Invoice Settings), then the negative value can go beyond a single billing period.

Bill lag days can be removed via APIs update_acct_plan_m, replace_acct_plan_m, update_acct_plan_multi_m and update_acct_complete_m). To remove the MPI bill lag days, pass the standard "numeric erase" indicator of a tilde (~) for <bill_lag_days> input.

Note:

Although ‘-999’ happens to be a valid bill_lag_days value when the your parameter “_Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle_” is “True”, it is obviously not practical as a real value on the APIs as there are not many plausible scenarios where a customer would be invoiced that far in advance.

Aria will set the bill lag days for plans using this order of precedence:

Master plan instance (for a given account)
Collection group setting
Payment terms/payment method setting
Client setting (Configuration > Billing > Bill Lag Days)

Notes:

You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
<bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.

Start of assign_plan_unit_instances array

assign_plan_unit_instances

array

Array of Plan unit instances to be assigned for this account. This array is relevant only when assigning a new Plan to an account (plan_directive = 1) or when increasing the number of units purchased for a given Plan instance (plan_directive = 3 and plan_units specified in this API request is greater than what is currently on the account). Any existing Plan unit instances for a given Plan instance can be updated using the update_plan_unit_instances array. In all other scenarios, the inputs provided in this array will be ignored. Plan unit instances in this array should be applied using a first-in-first-associated methodology. 1) If for example fewer Plan unit instances are specified than the number of Plan units being assigned, then the remaining Plan unit instances will not have a client-defined Plan unit instance ID. 2) If for example the number of Plan unit instances exceeds the number of Plan units being assigned, then the extra client-defined Plan unit instance ids will be ignored.

Field Name

Field Type

Max Length

Description

client_plan_unit_inst_id

string

100

Client-assigned identifier for the Plan unit instance.

plan_unit_inst_idx

long

Non-persistent reference for a Plan unit instance (being created within the API request) to cross-reference for Plan unit instance fields.

End of assign_plan_unit_instances array

Start of plan_unit_instance_services array

plan_unit_instance_services

array

Array of Plan unit instance services.

Field Name

Field Type

Max Length

Description

service_no

long

Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. Either this field, or client_service_id is required when updating fulfillment details.

client_service_id

string

100

Client-assigned identifier for the service (only for fulfillment based service).

service_fulfillment_date

string

It is a Fulfillment completion date. It can be in past, today or future date.

fulfillment_directive

long

This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the Plan unit instance.

Allowable values for fulfillment_directive

Values	Description
1	Complete fulfillment with immediate effect. This would be accomplished by specifying fulfillment date in past or today or without any fulfillment date. (default)
2	Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3	Remove the already assigned fulfillment date.

End of plan_unit_instance_services array

Start of update_plan_unit_instances array

update_plan_unit_instances

array

Array of Plan unit instances to be updated. This array is relevant only for updating existing Plan unit instances.

Field Name

Field Type

Max Length

Description

plan_unit_inst_no

long

Aria-assigned identifier for the Plan unit instance to specify an existing Plan unit instance. Either this field, or client_plan_unit_inst_id is required when updating a Plan unit.

client_plan_unit_inst_id

string

100

Client-defined identifier for the Plan unit instance to specify an existing Plan unit instance. This field is required when updating a Plan unit.

new_client_plan_unit_inst_id

string

100

New client-defined identifier to be saved on the Plan unit instance.

Start of plan_unit_instance_services array

plan_unit_instance_services

array

Array of Plan unit instance services.

Field Name

Field Type

Max Length

Description

service_no

long

client_service_id

string

100

Client-assigned identifier for the service (only for fulfillment based service).

service_fulfillment_date

string

It is a Fulfillment completion date. It can be in past, today or future date.

fulfillment_directive

long

This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the Plan unit instance.

Allowable values for fulfillment_directive

Values	Description
1	Complete fulfillment with immediate effect. This would be accomplished by specifying fulfillment date in past or today or without any fulfillment date. (default)
2	Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3	Remove the already assigned fulfillment date.

End of plan_unit_instance_services array

Start of remove_plan_unit_instances array

remove_plan_unit_instances

array

Array of Plan unit instances to be removed from this account. This array is relevant only decreasing the number of units purchased for a given Plan instance (plan_directive = 3 and plan_units specified in this API request is less than what is currently on the account). Note that as part of a downgrade scenario, no new Plan unit instances can be assigned for this Plan instance, and no fulfillment-based services associated with an existing Plan unit instance can be fulfilled. If Plan unit instances are provided in the remove_plan_unit_instances array, inputs provided in the assign_plan_unit_instances and update_plan_unit_instances arrays will be ignored. The plan_units parameter in this API request will take precedence over Plan unit instances provided in this array. If fewer Plan unit instances are specified in this array than the number of Plan units being removed from the account (defined by the plan_units parameter), then the remaining Plan unit instances will be removed from the Plan instance using a last-in-first-out methodology. If the number of Plan unit instances specified in this array exceeds the number of Plan units being removed from the account (defined by the plan_units parameter), then the extra Plan unit instances will be ignored and will remain on the account.

Field Name

Field Type

Max Length

Description

plan_unit_inst_no

long

Aria-assigned identifier for the Plan unit instance to specify an existing Plan unit instance.

client_plan_unit_inst_id

string

100

Client-defined identifier for the Plan unit instance to specify an existing Plan unit instance.

End of remove_plan_unit_instances array

Start of plan_unit_inst_field_details array

plan_unit_inst_field_details

array

Array of client-defined Plan unit instance fields.

Field Name

Field Type

Max Length

Description

plan_unit_inst_no

long

Aria-assigned identifier for the Plan unit instance to specify an existing Plan unit instance.

client_plan_unit_inst_id

string

100

Client-defined identifier for the Plan unit instance to specify an existing Plan unit instance.

plan_unit_inst_idx

long

Non-persistent reference for a Plan unit instance (being created within the API request) to cross-reference for Plan unit instance fields.

Start of plan_unit_inst_field_list array

plan_unit_inst_field_list

array

Array of client-defined Plan unit instance fields.

Field Name

Field Type

Max Length

Description

field_name

string

300

Field name of Plan unit instance field.

Start of plan_unit_inst_field_values array

plan_unit_inst_field_values

array

Array of client-defined Plan unit instance fields.

Field Name

Field Type

Max Length

Description

field_value

string

1000

The value stored under this field.

plan_unit_inst_field_val_directive

long

The directive is mandatory if field name/value pair are specified.

Allowable values for plan_unit_inst_field_val_directive

Values	Description
1	Add Value
2	Replace Value
3	Remove Value

End of plan_unit_inst_field_values array

End of plan_unit_inst_field_list array

alt_rate_schedule_no

long

Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders.

client_alt_rate_schedule_id

string

100

Client-defined alternate rate schedule identifier to assign (if any). If none is specified, the default rate schedule number is used.

proration_invoice_timing

long

Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this overrides the Proration Invoice Timing configuration saved with the Plan in the product catalog. This field is ignored on Master Plan assignment actions.

Allowable values for proration_invoice_timing

Values	Description
	Honor Proration Invoice Timing configuration saved with the Plan in the product catalog
0	Invoice immediately
1	Invoice on next anniversary date

Start of custom_rates array

custom_rates

array

An array of custom rates for the specified account number

Field Name

Field Type

Max Length

Description

custom_rate_service_no

long

Required when applying custom rates to an account's Plan. The service number the corresponds to the service associated with the Plan specified by custom_rate_plan_no, to which this custom rate is to be applied for this account.

custom_rate_client_service_id

string

100

Client-defined alternate rate schedule number to assign (if any). If none is specified, the default rate schedule number will be used.

custom_rate_seq_no

long

Rate tier number to which this custom rate is to be applied.

custom_rate_from_unit

long

Starting unit of a range of units to which this custom rate is to be applied.

custom_rate_to_unit

long

Ending unit of a range of units to which this custom rate is to be applied.

custom_rate_per_unit

double

The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.

End of custom_rates array

Start of coupon_code_updates array

coupon_code_updates

array

Field Name

Field Type

Max Length

Description

coupon_cd

string

Note that only those coupons with Coupon Applicablity Scope of Master Plan Instance or Account and Master Plan Instance should be accepted.

coupon_directive

long

Indicates what operation to perform on each coupon specified.

Allowable values for coupon_directive

Values	Description
0	Remove coupon from Master Plan Instance
1	Add coupon to Master Plan Instance

End of coupon_code_updates array

Start of surcharge_updatesarray

surcharge_updates

array

Field Name

Field Type

Max Length

Description

surcharge_no

long

Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance are acceptable input. Either this field, or client_surcharge_id is required when assigning/removing/updating surcharge for this Plan instance.

client_surcharge_id

string

100

Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted.

rate_schedule_no

long

If not specified, the default rate schedule matching the currency on the account will be used.

surcharge_directive

long

Required for each surcharge specified in this array.

Allowable values for surcharge_directive

Values	Description
0	Remove surcharge from Plan instance
1	Add surcharge to Plan instance

End of surcharge_updates array

balance_forward

double

Balance forward should be applied against the corresponding Master Plan Instance balance.

parent_plan_instance_no

long

Unique identifier of a Plan in the Plan instance hierarchy under which the new Plan will be assigned. Applicable only for Plan assignments.

parent_client_plan_instance_id

string

100

Unique identifier of a Plan in the Plan instance hierarchy under which the new Plan will be assigned. Applicable only for Plan assignments.

parent_plan_instance_idx

long

Non-persistent reference for a Plan instance (being created within the API request, under which the new Plan will be assigned. Applicable only for Plan assignments.

plan_status_cd

long

The status of this Plan instance

Allowable values for plan_status_cd

Values	Description
0	INACTIVE
1	ACTIVE
2	CANCELLATION PENDING
3	TERMINATION PENDING
31	INSTALLATION PENDING
32	REGISTERED PENDING ACTIVATION
41	ACTIVE TRIAL
61	ACTIVE NON-BILLABLE
-1	SUSPENDED
-2	CANCELLED
-3	TERMINATED

status_until_alt_start_cd

long

Status of the Master Plan Instance prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided. If an alternate starting date or alternate bill day is provided, the Master Plan Instance remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored.

Allowable values for status_until_alt_start_cd

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

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. Note that Master Plans cannot be canceled via update_acct_plan_multi_m when dunning is in progress.

If you set this field to 1 (in progress), then you can specify one or more of the following dunning options available in these fields:

<degrade_date>;
<new_dunning_step>;
<config_dunning_late_fee_option>; and/or
<config_dunning_email_option>.

Note 1:

When you change the <dunning_state> to 0 (none), you should also pass in your chosen <plan_status_cd> for the MPI (Master Plan Instance).

Example: you may want to change the MPI's status from
-1 (suspended) to 1 (active).
If you set this field to 1 (in progress) but the MPI does not have a balance due, then Aria will move the MPI out of dunning on the date on which the next dunning step begins.This applies to MPIs associated with either payment type: net terms or electronic.

Note 2:

In addition to self-pay MPIs, dunning input arguments can now also now be used for parent-pay MPIs. Also note that when self-pay MPI manually enters dunning via this API, all of their parent-pay MPIs will enter dunning. This is only applicable when entering the dunning. During this special process of entering parent-pay MPI, the “config_dunning_late_fee_option and config_dunning_email_option” will only be applicable for self-pay MPIs and NOT to the parent-pay MPI.

Allowable values for dunning_state

Values	Description
0	None
1	In Progress

degrade_date

string

Date on which the Dunning Manager evaluates whether the Master Plan should be advanced to the next step of the dunning process.

Applicable only for Master Plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

billing_group_no

long

Unique identifier associated with an existing billing group for the specified account (Note: This is mandatory when converting an MPI from parent-pay to self-pay).

client_billing_group_id

string

100

Unique client-defined identifier associated with an existing billing group for the specified account (Note: The is mandatory when converting an MPI from parent-pay to self-pay).

billing_group_idx

long

For non-persistent referencing of a billing group within the API request (Note: This is mandatory when converting an MPI from parent-pay to self-pay).

resp_level_cd

long

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

Allowable values for resp_level_cd

Values	Description
1	Standard Self-Pay: default
2	Parent Pay: Usage accrues under self, invoices are generated per self's Plan rules BUT are presented for payment against parent account'
3	Parent Usage & Pay: Usage accrues under parent and applied only to parent's Plan rules and presented to parent for payment'

parent_acct_mp_inst_no (DEPRECATED)

long

Unique identifier of the Master Plan Instance on the parent account that will be responsible for payment. Required when the Master Plan on a child account is designated as parent-pay (i.e., resp_level_cd is 2 or 3); otherwise this input will be ignored.

parent_acct_client_mp_inst_id (DEPRECATED)

string

100

Client-defined identifier of the Master Plan Instance on the parent account that will be responsible for payment. Required when the Master Plan on a child account is designated as parent-pay (i.e., resp_level_cd is 2 or 3); otherwise this input will be ignored.

dunning_group_no

long

Unique identifier associated with an existing dunning group for the specified account.

Note: It is now required that dunning groups are associated with parent-pay Master Plan Instances, so even if a dunning group is not specified by the client upon MPI assignment, an empty dunning group (i.e., without any values in the attributes) will be created and assigned to that MPI automatically, without issuing an error or warning.

client_dunning_group_id

string

100

Unique client-defined identifier associated with an existing dunning group for the specified account.

dunning_group_idx

long

For non-persistent referencing of a dunning group within the API request.

Start of plan_instance_field_update array

plan_instance_field_update

array

Field Name

Field Type

Max Length

Description

plan_instance_field_name

string

300

Required based on the definition of each Plan instance field associated with the new Plan.

plan_instance_field_value

string

1000

Required based on the definition of each Plan instance field associated with the new Plan.

plan_instance_field_directive

long

Required for each Plan instance field provided.

Allowable values for plan_instance_field_directive

Values	Description
1	Add name and value for a new Plan instance field (default).
2	Replace value of an existing Plan instance field.
3	Remove the value of an existing Plan instance field, note that if the Plan instance field is required based on the field definition, the Replace directive should be used.
4	Remove the name and value of an existing Plan instance field from the Plan instance.

End of plan_instance_field_update array

effective_date

string

Applicable only for Supplemental Plans. Ignore if submitted for a Master Plan.

offset_months

long

For Plan recurring intervals of longer than one month, the number of months to offset proration and first bill date.

alt_proration_start_date

string

The date, in yyyy-mm-dd format, from which the proration calculations begin. If this field is NULL, then the proration calculations begin from the current date. This date cannot be before the beginning of the current billing period.

Notes:

If you assign a Supplemental Plan using this API, the <alt_proration_start_date> must be between the Master Plan’s provision date and the next occurrence of a bill day.
The <alt_proration_start_date> can also go back more than one billing period into the past as long as it is after the Master Plan’s provision date.
If you replace a Master Plan using this API:

When the replaced Master Plan’s billing interval is the same as the new Master Plan’s, the <alt_proration_start_date> must be within the date range of the recurring billing period that was last invoiced.
When the replaced Master Plan’s billing interval is different from the new Master Plan’s, the <alt_proration_start_date> must be between the start date of the recurring billing period that was last invoiced and the next occurrence of a bill day.

If you cancel a master or Supplemental Plan using this API, the <alt_proration_start_date> must be within the date range of the recurring billing period that was last invoiced.

auto_offset_months_option

long

Automatically set the offset for the billing anniversary month.

Allowable values for auto_offset_months_option

Values	Description
1	sync to Master Plan recurring bill thru date
2	sync to old Supplemental Plan recurring bill thru date (only applies to Supplemental Plan)

alt_collect_group_no

long

The one-time collections account group for this account for this API call only. Available only for Plan assignments and Plan replacements

alt_client_collect_group_id

string

100

The one-time collections account group for this account for this API call only.

offset_interval

long

If assigning a change on an anniversary day, the number of billing periods by which to delay that change. If the new Plan is different from the old Plan, and this value is greater than 0, then the billing date continues to be the annniversary date.

invoice_unbilled_usage

string

Specifies whether to invoice the unbilled usage.

Allowable values for invoice_unbilled_usage

Values	Description
false	Do not allow invoicing the unbilled usage during mid-term Plan termination.
true	Allow invoicing the unbilled usage during mid-term Plan termination.

force_supp_bill_date_reset

long

Deprecated(Deprecated) This input is not operational. Use 'force_master_bill_date_reset' to perform this input's activity.

force_master_bill_date_reset

long

Overrides the "Sync_mstr_bill_dates_on_1st_supp" client-level setting that determines whether or not no-charge Master Plan billing dates should be reset when assigning a new Supplemental Plan or when the Supplemental Plan instance status is updated to a billable status. If this value is left empty, the client-level setting will take effect.

Allowable values for force_master_bill_date_reset

Values	Description
	If this value is left empty, the client-level setting (Sync_mstr_bill_dates_on_1st_supp) will take effect.
1	Do not reset Master Plan billing dates.
2	Reset Master Plan billing dates if Master Plan is "free", the account has no "billable" Supplemental Plans, and the newly-assigned Supplemental Plan is "billable.
3	Reset Master Plan billing dates if Master Plan is "free" and the account has no active Supplemental Plans.

usage_accumulation_reset_months

string

For the Plan specified, the number of months to accumulate before being reset.

usage_accumulation_reset_months_renewal_option

long

Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of of current period.

Allowable values for usage_accumulation_reset_months_ renewal_option

Values	Description
NULL or 1	Recurring / Auto Renew.(Default)
2	Single Use.

usage_pooling

string

Indicates whether usage pooling is enabled for this Plan instance. Allowable values are 'true' and 'false'.

Allowable values for usage_pooling

Values	Description
true	Usage pooling is enabled for this Plan instance.
false	Usage pooling is not enabled for this Plan instance. (default)

usage_threshold_applicability

string

Usage tracking options on the specified Plan.

nso_bill_immediately

long

Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date.

Allowable values for nso_bill_immediately

Values	Description
0	Fulfill immediately. Bill on next anniversary. (default)
1	Fulfill immediately. Bill immediately.
2	Order Held.
3	Fulfill on fulfillment date. Bill on the next anniversary bill after the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment will happen in API itself as in nso_bill_immediately = 0.
4	Fulfill on fulfillment date. Bill on the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment and billing will happen in API itself as in nso_bill_immediately = 1.
5	Fulfill on fulfillment date. Bill on the next anniversary bill that bills arrears services through the fulfillment date. Note that if the fulfilled date is in the past/current day, then the fulfillment will happen in API itself as in nso_bill_immediately = 0.

Start of nso_item_array array

nso_item_array

array

Field Name

Field Type

Max Length

Description

item_no

long

NSO / inventory item number. This field is required when creating an NSO bundling orde

client_sku

string

100

Client SKU of the NSO/Inventory item.

item_units

long

Quantity of the NSO / inventory item being purchased.

item_svc_location_no

long

The Aria-assigned unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence..

client_item_svc_location_id

string

100

The client-defined unique identifier for the origin location for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

item_dest_contact_idx

long

item_dest_contact_no

long

The Aria-assigned unique identifier for the destination contact for the item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations. If both item_dest_contact_idx and item_dest_contact_no are provided, item_dest_contact_no will take precedence.

End of nso_item_array array

Start of plan_service_updates array

plan_service_updates

array

List of services associated with the Plan being assigned or updated on the account.

Field Name

Field Type

Max Length

Description

service_no

long

The Aria-assigned unique identifier for the service associated with the Plan instance. Either this field, or client_service_id is required to map Plan services to the Plan instance.

client_service_id

string

100

The client-defined identifier for the service associated with the Plan instance.

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. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

client_svc_location_id

string

100

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. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

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. If both dest_contact_idx and dest_contact_no are provided, dest_contact_no will take precedence.

dest_contact_idx

long

For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations. If both dest_contact_idx and dest_contact_no are provided, dest_contact_no will take precedence.

End of plan_service_updates array

po_num

string

100

Purchase order number assigned to the Plan instance.

nso_po_num

string

100

Purchase order number assigned to the one-time order.

plan_instance_supp_field_update_only

long

This field controls the ability to update Plan instance fields on a Plan that is in non-provisioned status.

Allowable values for plan_instance_supp_field_update_only

Values	Description
	This input will not allow Plan instance fields to be update for plans that are in a non-provisioned status
0	This input will not allow Plan instance fields to be update for plans that are in a non-provisioned status
1	This input will allow Plan instance fields to be update for plans that are in a non-provisioned status

force_bill_date_reset

long

When a Master Plan's status changes from non-billable to billable, this input will determine what the billing dates of the specific Master Plan and all associated Supplemental Plans anniversary date will be.

Allowable values for force_bill_date_reset

Values	Description
	Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
0	Do not reset the billing dates for this Plan.
1	Reset the billing anniversary date to coincide with the status change date.
2	Reset the billing anniversary date to coincide with the current anniversary date.

End of plan_updates array

Start of acct_billing_groups array

acct_billing_groups

array

Field Name

Field Type

Max Length

Description

billing_group_directive

long

Indicates what operation to perform on each billing group specified. This field is required when performing any action on a billing group.

Allowable values for billing_group_directive

Values	Description
1	Create new billing group
2	Update billing group

existing_billing_group_no

long

The unique identifier of the billing group. Either this field, or existing_client_billing_group_id is required when updating or removing the billing group.

existing_client_billing_group_id

string

100

The client-defined identifier of the billing group.

billing_group_name

string

100

Name of the billing group.

billing_group_description

string

1000

Description of the billing group.

new_client_billing_group_id

string

100

Unique client-defined identifier of the billing group. If provided for an existing billing group, this value will overwrite the existing client-defined ID for that billing group.

billing_group_idx

long

For non-persistent referencing of a billing group within the API request.

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

notification_template_group_no

long

Notify template No. Aria-assigned unique identifier for the notification template group to be associated with the account.

client_notification_template_group_id

string

Client-defined unique identifier for the notification template group to be associated with the account.

statement_template

long

Statement template No.

credit_note_template

long

Credit note template No.

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

primary_payment_method_no

long

Unique identifier associated with an existing payment method for the specified account to be used as the primary payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

primary_client_payment_method_id

string

100

Unique client-defined identifier associated with an existing payment method for the specified account to be used as the primary payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

primary_payment_method_idx

long

For non-persistent referencing of a payment method within the API request to be used as the primary payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

backup_payment_method_no

long

Unique identifier associated with an existing payment method for the specified account to be used as the backup payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

backup_client_payment_method_id

long

100

Unique client-defined identifier associated with an existing payment method for the specified account to be used as the backup payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

backup_payment_method_idx

long

For non-persistent referencing of a payment method within the API request to be used as the backup payment method on the billing group (Note:The same pay method sequence number cannot be used for a primary and secondary payment method).

stmt_first_name

string

300

Statement contact first name

stmt_mi

string

The Middle Initial of the statement contact.

stmt_last_name

string

300

Last name of the billing contact

stmt_company_name

string

100

Company name of the statement contact

stmt_address1

string

300

First address line of the statement contact

stmt_address2

string

300

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

stmt_address3

string

300

Third address line of the statement contact

stmt_city

string

300

City of the statement contact

stmt_locality

string

300

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.

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.

stmt_country

string

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

stmt_postal_cd

string

Postal/Zip code for the statement contact address.

stmt_phone

string

The phone number of the statement contact

stmt_phone_ext

string

The extension for the statement contact phone

stmt_cell_phone

string

The contact cell phone of the statement contact.

stmt_work_phone

string

Work phone number of the statement contact.

stmt_work_phone_ext

string

The extension for the statement contact work phone

stmt_fax

string

The fax number for the statement contact.

stmt_email

string

320

Email of the statement contact

stmt_birthdate

string

The birthdate, in yyyy-mm-dd format, of the statement contact.

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.

stmt_contact_idx

long

For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other statement contact fields will be ignored.

stmt_contact_no

long

The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.

payment_terms_no

long

Payment terms number assigned to the account.

payment_terms_name

string

Payment terms name assigned to the account.

client_payment_term_id

string

Client-defined identifier for the billing group's payment term

ean_gln_num

string

'This is the European Article Number or Global Location Number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is unique to each customer (account).'

ean_gln_requisition_num

string

'This is the European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party'

credit_memo_template

long

Credit template No.

rebill_template

long

Rebill template No.

collection_group_bg_row

array

Array of collection groups that should be added to or removed from the specified billing groups.

For cost savings or for other reasons, you may choose to have payments made with a particular payment method (associated with a billing group) processed by a specific payment gateway. To do so, you can assign a collection group to a billing group by passing values into the collection_group_bg_row array.

Notes:

Aria will use this order of precedence when selecting the payment gateway to use for processing a payment:

Collection group assigned to the billing group associated with the master plan instance being invoiced;
Collection group to which the customer is assigned at the account level.

Aria now will allow accounts to have multiple billing groups with different collection groups when using tokenized credit cards that were tokenized outside of Aria. To facilitate multiple payment methods, the billing agreement ID (token) is validated against the specific collection group. When there is no collection group specified, then the agreement ID will be validated against the account level collection group. When no collection group at account level or billing group level is specified, then the agreement ID will be validated against the last processor mapped to that client.

collections_group_bg_no

long

Aria-assigned identifier of the collection group to assign to the specified billing group.

client_collections_group_bg_id

string

100

Client-defined identifier of the collection group to assign to the specified billing group.

collections_grp_directive

long

Indicates whether the identified collection group should be assigned to or removed from the specified billing group.

Allowable values for collections_grp_directive

Values	Description
1	Assign the collection group to the billing group.
2	Remove the collection group from the billing group.

End of acct_billing_groups array

assignment_directive

long

The rule to be applied to this assignment request, governing the proration rule is applied. Default behavior is to make the Plan change (assign/deassign a Plan to an account, change units on an existing Plan, etc.) immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit. Usage-arrears charges, recurring-in-arrears charges, and any Plan cancellation fees (if applicable) will be invoiced during Plan cancellation, as these charges are independent of assignment directive. If plan_directive = 1 (assign case), then assignment_directive field is honored only for Supplemental Plan, and not for Master Plan.

Allowable values for assignment_directive

Values	Description
1	(Default) Perform the requested Plan change on the account's next scheduled billing anniversary date. The account does receive service under this Plan (for Plan assignments) or have it removed (for de-assignments) until that date. If a Plan is being assigned, initial billing for a full period of the given Plan is performed on the account's next scheduled anniversary date. No charge or credit proration effect. No new recurring charges or credits are generated when no proration occurs. Applicable when plan_directive = 1, 2, 3, 4.
2	Perform the requested Plan change immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period Plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs. Applicable when plan_directive = 1, 2, 3, 4.
3	Perform the requested Plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs. Applicable when plan_directive = 1, 2, 3, 4.
4	Perform the requested Plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION. Applicable when plan_directive = 1, 2, 3, 4.
5	Perform the requested Plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling Supplemental Plans.Applicable when plan_directive = 1, 2, 3.
6	Perform the requested Plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning Supplemental Plans. Applicable when plan_directive = 2, 3, 4.
7	Perform the requested Plan change on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period Plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs. Applicable when plan_directive = 1, 2, 3, 4.
8	Perform the requested Plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs. Applicable when plan_directive = 1, 2, 3, 4.
9	Perform the requested Plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION. Applicable when plan_directive = 1, 2, 3, 4.
10	Perform the requested Plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling a Supplemental Plan. Applicable when plan_directive = 1, 2, 3.
11	Perform the requested Plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning a Supplemental Plan. Applicable when plan_directive = 2, 3, 4.

alt_start_date

string

Alternative start date, in yyyy-mm-dd format, for the Master Plan Instance being assigned on the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the Plan being assigned.

retroactive_start_date

string

Date, in yyyy-mm-dd format, to set for retroactive start.

override_bill_thru_date

string

Applicable only for Master Plan assignment. When provided, this date will be used as the bill thru date for the Master Plan Instance. The alt_start_date or retroactive_start_date input will be honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing. The override_dates_mp_instance_no or override_dates_client_mp_instance_id parameters take precedence over this input parameter, and if provided together the override_bill_thru_date input will be ignored. The date provided must be in the future, must be after the alt_start_date (if provided), and cannot exceed one recurring billing interval. This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice will be generated for recurring services from the effective start date of the Plan instance through the override_bill_thru_date provided. If the Plan being assigned has no usage services, the next_bill_date (aka anniversary date) will be the override_bill_thru_date + 1 day. If the Plan has usage services, then the next_bill_date will be calculated based on the usage interval to be the earliest date in the future that will ensure usage and recurring services will be invoiced together on the override_bill_thru_date + 1 day.

override_dates_mp_instance_no

long

100

Applicable only for Master Plan assignment. When provided, the billing dates for the new Master Plan being assigned will be aligned with the billing dates of the existing Master Plan Instance specified (honoring the bill day of the existing Master Plan Instance). The alt_start_date or retroactive_start_date input will be honored with the override_dates_mp_instance_no or the override_dates_client_mp_instance_id, but invoicing_option must be set to Perform Prorated Invoicing. These parameters take precedence over the override_bill_thru_date parameter, and cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). If the recurring interval of the new Master Plan Instance will be the same as or longer than the existing Master Plan Instance, a prorated invoice for the Master Plan being assigned will be generated for recurring services from the effective start date of the Plan instance through the bill_thru_date of the existing Master Plan Instance. If the recurring interval of the new Master Plan Instance will be shorter than the existing Master Plan Instance, the bill_thru_date for the new Master Plan Instance will be calculated based on its recurring interval to be the earliest date in the future that will ensure the recurring services for both Master Plan Instances will be invoiced together on the existing Master Plan Instance's bill_thru_date + 1 day. In the above scenarios, if the new Master Plan Instance has no usage services, the next_bill_date (aka anniversary date) will be the bill_thru_date + 1 day. If the new Master Plan Instance has usage services, then the next_bill_date will be calculated based on the usage interval to be the earliest date in the future that will ensure usage and recurring services will be invoiced together on the bill_thru_date + 1 day.

override_dates_client_mp_instance_id

string

100

alt_bill_day

long

Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1.

invoicing_option

long

Indicator for performing full invoicing, and Perform Prorated Invoicing or client-defined on this account as part of this call.

Allowable values for invoicing_option

Values	Description
1	Perform full invoicing
2	Perform Prorated invoicing
3	Use client default configuration setting
4	None

Start of acct_payment_methods array

acct_payment_methods

array

Field Name

Field Type

Max Length

Description

payment_method_name

string

100

Payment method name.

client_payment_method_id

string

100

Client-defined unique identifier for the payment method.

payment_method_description

string

1000

Payment method description

payment_method_idx

long

For non-persistent referencing of a payment method within the API request to be used as the primary or backup payment method on the billing group.

payment_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 payment_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
37	Tokenized Direct Debit
48	Tokenized ACH

cc_num

string

Credit card number.

cc_expire_mm

long

Expiration month for the credit card payment instrument.

cc_expire_yyyy

long

Expiration year for the credit card payment instrument.

bank_acct_num

string

The bank account number. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.

bank_routing_num

string

The American Banking Association (ABA) routing number for the financial institution. The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.

cvv

string

Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.

track_data1

string

300

Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request

track_data2

string

300

Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request

bill_agreement_id

string

Unique ID of the bill agreement (also referred to as a token). The <bank_acct_num>, <bank_routing_num> or <bill_agreement_id> is needed for the Tokenized ACH payment method - 48.

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.

bank_check_digit

long

Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.

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.

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.

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.

bank_id_cd

string

Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.

bank_branch_cd

string

Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.

bank_name

string

100

Bank name for the account payment method.

bank_city

string

100

Bank city for the account payment method.

bank_acct_type

string

The type of bank account being used (for payment_method_type 2).

Allowable values for bank_acct_type:

Values	Description
savings	savings
checking	checking
business	business

bill_first_name

string

300

First name of the billing contact.

bill_mi

string

Middle initial of the billing contact

bill_last_name

string

300

Last name of the billing contact.

bill_company_name

string

100

Company name of the billing contact.

bill_address1

string

100

First address line of the billing contact.

bill_address2

string

300

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.

bill_address3

string

300

The third line of the billing address.

bill_city

string

300

City of the billing contact.

bill_locality

string

300

bill_state_prov

string

bill_country

string

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

bill_postal_cd

string

Postal code for the billing contact.

bill_phone

string

Phone number of the billing contact.

bill_phone_ext

string

Phone extension of the billing contact.

bill_cell_phone

string

Cell phone number of the billing contact.

bill_work_phone

string

Work phone number of the billing contact.

bill_work_phone_ext

string

This is the work phone extension for the billing contact work phone.

bill_fax

string

Fax number of the billing contact.

bill_email

string

320

Email of the billing contact.

bill_birthdate

string

Birthdate of the billing contact.

bill_contact_idx

long

For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other billing contact fields will be ignored..

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.

End of acct_payment_methods array

Start of acct_dunning_groups array

acct_dunning_groups

array

Field Name

Field Type

Max Length

Description

dunning_group_directive

long

Indicates what operation to perform on each dunning group specified.

Allowable values for dunning_group_directive

Values	Description
1	Create new dunning group
2	Update dunning group

existing_dunning_group_no

long

The dunning group number mapped against each Master Plan.

existing_client_dunning_group_id

string

The client-defined dunning group ID mapped against each Master Plan.

dunning_group_name

string

100

Name of the dunning group.

dunning_group_description

string

1000

Description of the dunning group.

new_client_dunning_group_id

string

100

Client-defined dunning group identifier.

dunning_group_idx

long

Overrides the client-level setting that determines whether or not Master Plan billing dates should be reset when assigning a new Supplemental Plan. If this value is left empty, the client-level setting will take effect.

dunning_process_no

long

Dunning process code.

client_dunning_process_id

string

100

Client-defined dunning process identifier.

End of acct_dunning_groups array

auto_collect_on_plan_chng

long

Determines whether to automatically perform a collection attempt after an invoice is generated as a result of an immediate Plan addition, modification or replacement.

Allowable values for auto_collect_on_plan_chng

Values	Description
	Collect based on the value in the client parameter "auto collect on Master Plan change" and / or "auto collect on Supplemental Plan change". If both a master and Supplemental Plan are updated and invoiced in the same call, the Master Plan setting will override the Supplemental Plan setting.
0	Do not collect automatically when the Plan in changed.
1	Collect automatically when the Plan is changed.

rollback_plan_chng_collect_fail

long

When a collection failure occurs, determines whether the Plan changes associated with that collection attempt are automatically rolled back. Note that if this API call results in multiple collection attempts, only those Plan changes associated with collection failures are rolled back. All Plan changes for which collection is successful are not rolled back.

Allowable values for rollback_plan_chng_collect_fail

Values	Description
1	Roll back Plan change when collection fails (default).
0	Do not roll back the Plan change when the collection fails.

auto_send_stmt_on_plan_chng

long

When an immediate Plan addition, modification or replacement results in an invoice, determines whether a statement is immediately generated for that invoice and sent to the appropriate contact on the account.

Allowable values for auto_send_stmt_on_plan_chng

Values	Description
	Statement will be sent based on the value in the client parameter "send statement on Master Plan change" and / or "send statement on Supplemental Plan change". If both a master and Supplemental Plan are updated and invoiced in the same call, the Master Plan setting will override the Supplemental Plan setting.
0	Do not send a statement automatically when the Plan in changed.
1	Send a statment automatically when the Plan is changed.

comments

string

500

Additional explanatory text relating to this API call.

do_write

string

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, Plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'

Allowable values for do_write

Values	Description
true	true
false	false

list_start_master_file

long

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

Allowable values for 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_receipt_id

string

Client-defined unique identifier used to track related system actions

Start of contacts array

contacts

array

List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.

Field Name

Field Type

Max Length

Description

contact_idx

long

A caller-defined numeric value is required if you wish to add a new contact as an account contact, billing contact, statement contact, or destination contact. This value can then be used to reference this new contact within the context of this API request (and is not stored in Aria).

first_name

string

The first name of the contact.

middle_initial

string

The middle initial of the contact.

last_name

string

The last name of the contact.

company_name

string

100

The company name of the contact.

address1

string

100

The first address line of the contact.

address2

string

100

The second address line of the contact.

address3

string

100

The third address line of the contact.

city

string

The city of the contact.

locality

string

state_prov

string

The state or province of the contact. Note that only the official postal-service codes for states, provinces, and territories in the United States, Australia and Canada are supported. Use the other_locality field for states, provinces, or territories in other countries.

country

string

The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.

postal_cd

string

The postal/zip code of the contact.

phone

string

The phone number of the contact.

phone_ext

string

The phone number extension of the contact.

cell_phone

string

The cell phone number of the contact.

work_phone

string

The work phone number of the contact.

work_phone_ext

string

The work phone number extension of the contact.

fax

string

The fax number of the contact.

string

320

The email address of the contact.

birthdate

string

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

End of contacts array

combine_invoices

long

Indicator for combining invoices when retroactive start dates, negative bill lag days, or Plan changes just prior to the next billing date would otherwise have generated multiple invoices. The allowable values are 1, 2, or 3.

Allowable values for combine_invoices

Values	Description
1	Combine Invoices (long cycle)
2	Do Not Combine Invoices (short cycle)
3	Use client default configuration setting

alt_caller_id

string

Person or process that submitted the API call. This can be someone's user ID, or the name of an application.

Start of optional_transaction_qualifiers array

optional_transaction_qualifiers

array

Array of additional values you can associate with this API call.

Field Name

Field Type

Max Length

Description

qualifier_name

string

100

Name of the field you want to associate with this API call.

qualifier_value

string

100

Corresponding value of the field you want to associate with this API call.

End of optional_transaction_qualifiers array

remove_pi_custom_rates

string

Determines whether to keep or remove any custom rates assigned to a Plan instance when you change the rate schedule of that Plan instance.

Allowable values for remove_pi_custom_rates

Values	Description
true	Remove the custom rates and use the default rates of the new rate schedule that you assigned.
false (default)	Keep the custom rates currently assigned to the Plan instance.

new_dunning_step

long

Pass in the step in the dunning process that the MPI should move to.

Applicable only for Master Plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

config_dunning_late_fee_option

long

If the dunning step that you passed into the <new_dunning_step> field includes a late fee, specify whether to charge or suppress it.

Applicable only for Master Plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately charge the customer the late fee.

Allowable values for config_dunning_late_fee_option

Values	Description
1	Use dunning process configuration settings (default).
0	Do not use dunning process configuration/do not charge late fee.

config_dunning_email_option

long

If the dunning step that you passed into the <new_dunning_step> field includes an email notification, specify whether to send or suppress it.

Applicable only for Master Plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately email the notification to the customer.

Allowable values for config_dunning_email_option

Values	Description
1	Use dunning process configuration settings (default).
0	Do not use dunning process configuration/do not send email notification.

resp_master_plan_instance_no

resp_client_master_plan_instance_id

long

string

100

The Aria-assigned identifier of the Master Plan Instance that will have payment responsibility for the assigned Plan.

Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.

The client-defined identifier of the Master Plan Instance that will have payment responsibility for the assigned Plan.

Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.

nso_fulfillment_date

string

The date the Non Subscription Offering is fulfilled. A date in the past, present, or future can be specified.

application_id

string

300

The application identifier in which the API is being used in. (Example: “Sales Force”)

application_date

string

300

The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

recurring_processing_model_ind

long

Defines a recurring payment type for Credit Card and Tokenized Credit Cards.

Allowable values for recurring_processing_model_ind

Values	Description
0	Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a Plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1	Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2	Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3	Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or Plan upgrade) that uses a credit card that is currently stored in Aria.

include_plan_instance_queue

string

Use this field to obtain the list of Plan changes that you scheduled using this API.

Allowable values for include_plan_instance_queue

Values	Description
false	Scheduled Plan changes will not be returned in the plan_instance_queue array (default).
true	Scheduled Plan changes will be returned in the plan_instance_queue array.

force_currency_change

string

Force currency change during update. Generally this is necessary when the update is taking place to accommodate for an account holder moving from one area to another where the local currency is different.

Allowable values for force_currency_change

Values	Description
false (Default)	When the Plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.
true	When the Plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.

Start of proc_field_override array

proc_field_override

array

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.

Field Name

Field Type

Max Length

Description

transaction_type

string

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

Notes:

The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv> Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.

Aria will use this order of precedence to determine the transaction type:

value passed into this field
collection group configuration
payment gateway configuration
transaction type that you specified in the <recurring_processing_model_ind> field

Allowable values for transaction_type

Values	Description
-1	Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1	(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment Plan.
2	(Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.

Output Arguments

Field Name

Field Type

Description

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.

out_acct_no

long

Aria generated unique identifier for the account.

out_client_acct_id

string

Client-assigned identifier for the account.

billing_errors

hash

invoicing_error_code

long

Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call.

invoicing_error_msg

string

The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".

collection_error_code

long

If a collection is attempted, returns the error code associated with the collection.

collection_error_msg

string

The error message associated with collection_error_code.

statement_error_code

long

The error code if statement generation fails.

statement_error_msg

string

The text message associated with 'statement_error_code'

billing_group_no

long

The billing group number mapped against each Master Plan.

client_billing_group_id

string

Client-defined billing group ID

plans_updated

hash

plan_instance_no

long

Unique Plan instance number for each assigned Plan.

client_plan_instance_id

string

Client-defined Plan instance ID for each assigned Master Plan.

plan_no

long

Aria-assigned unique Plan identifier.

client_plan_id

string

Client-defined Plan ID for the Plan.

plan_name

string

Name of the Plan.

plan_operation

long

Indicates what operation was performed on each Plan instance.

Allowable values for plan_operation

Values	Description
1	Plan assigned and Plan instance created
2	Plan replaced on existing Plan instance
3	Plan instance updated
4	Plan cancelled

plan_unit_instance_details

hash

Array of Plan unit instances.

out_plan_unit_inst_no

long

Aria unique Plan Unit Instance Number

out_client_plan_unit_inst_id

string

Client-assigned identifier for the Plan unit instance.

proration_credit_result_amount

double

The total prorated credit amount resulting from any proration action that takes place when you cancel, update, or replace a Plan. This total includes taxes credited.

proration_credit_amount

double

The prorated credit amount resulting from any proration action that takes place when you cancel, update, or replace a Plan. This total excludes taxes credited.

proration_tax_amount

double

The prorated tax credit amount resulting from any proration action that takes place when you cancel, update, or replace a Plan.

plan_service_proration_results

hash

plan_no

long

Aria-assigned unique Plan identifier

client_plan_id

string

Client-defined Plan ID for the Plan.

service_no

long

Specifies the Aria-assigned unique service identifier.

client_service_id

string

A client-defined Service ID for this service

proration_text

string

Deprecated (Deprecated) Specifies the prorated days in total days.

proration_remaining_days

long

Deprecated (Deprecated) Prorated days of period in this invoice.

proration_description

string

Deprecated (Deprecated) Prorated invoice description.

proration_result_total

double

plan proration total amount.

proration_amount

double

Proration amount.

proration_tax_charges

double

Proration tax charges.

proration_tax_credits

double

Tax credits applied as a result of proration.

proration_surcharge_amount

double

Surcharge amount applied as a result of proration.

proration_credit_amount

double

The non-tax pro-rated credit amount

proration_start_date

string

Start date of the time period used for calculating proration.

proration_end_date

string

End date of the time period used for calculating proration.

billing_groups_updated

hash

billing_group_no

long

The unique identifier of the billing group.

client_billing_groups_id

string

The client-defined identifier of the billing group.

primary_payment_method_no

long

Primary payment method ID.

primary_client_payment_method_id

string

Client-defined unique identifier of the primary payment method.

backup_payment_method_no

long

Backup payment method ID.

backup_client_payment_method_id

string

Client-defined unique identifier of the backup payment method'

billing_group_operation

long

The billing group number mapped against each Master Plan.

dunning_groups_updated

hash

dunning_group_no

long

The dunning group number mapped against each Master Plan.

client_dunning_groups_id

string

The client-defined dunning group ID mapped against each Master Plan.

dunning_group_operation

long

If a collection is attempted, returns the error code associated with the collection.

multi_plan_invoice_details

hash

billing_group_no

long

The unique identifier of the billing group.

client_billing_group_id

string

The client-defined identifier of the billing group.

invoice_no

long

The Aria-assigned unique identifier of a given invoice.

proc_cvv_response

string

The processor return code from CVV validation.

proc_avs_response

string

Processor return code from address validation.

proc_cavv_response

string

The processors return code for security validation.

proc_status_code

string

The processor status code

proc_status_text

string

The processors status description.

proc_payment_id

string

The processor payment ID.

proc_auth_code

string

Authorization code provided by the issuing bank.

proc_merch_comments

string

Additional information passed to payment processor.

invoice_charges_before_tax

double

Total charges on this invoice before taxes are applied.

invoice_tax_charges

double

Total amount of taxes charged.

invoice_charges_after_tax

double

Subtotal combining the total pre-tax charges and the total taxes charged.

invoice_credit_before_tax

double

Credit to be applied before tax is taken into account.

invoice_tax_credits

double

Tax amount of the credit to be applied to the account.

invoice_credits

double

Credit to be applied after tax is taken into account.

invoice_total_amount

double

The total owed on the initial invoice for this account.

expectd_activation_fee

double

Predicted activation fee based on activation fee charges on Supplemental Plans on this invoice.

expectd_mthly_recurring_cost

double

Predicted monthly recurring cost of the items and plans on this invoice.

expectd_annu_recurring_cost

double

Predicted annual recurring cost of the items and plans on this invoice.

invoice_item_details

hash

invoice_line_no

long

The line number on the invoice

line_type

long

Specifies the type of charge or credit associated with this line item.

Allowable values for line_type

Values	Description
1	Recurring Charge
2	Tax Charge
3	Service Credit
4	Coupon Credit
5	Activation Charge
6	Usage Charge
7	Recurring Arrears
8	Order Charge
9	Surcharge

plan_no

long

The unique ID Plan this line represents.

client_plan_id

string

The client-defined unique ID for Plan this line represents.

plan_name

string

the name of the service Plan this line represents.

service_no

long

The unique ID for the service this line represents.

client_service_id

string

The client-defined unique ID for the service this line represents.

service_name

string

The name of the service this line represents

service_is_tax_ind

long

Whether or not this line item represents a tax charge.

plan_instance_no

long

The unique identifier of the Plan instance this line represents.

client_plan_instance_id

string

The client-defined identifier of the Plan instance this line represents.

line_units

double

Number of units for the specified invoice line.

rate_per_unit

double

The monetary rate per unit of service.

line_amount

double

The total line amount for this invoice line.

line_base_units

double

Specifies the full, non-prorated number of units of the service code.

proration_factor

double

Specifies the percentage of the line_base_units billed.

line_description

string

Specifies the description of this line item

start_date_range

string

Specifies the start date of the date range covered by this line item.

end_date_range

string

Specifies the end date of the date range covered by this line item.

usage_type_no

long

The usage type code associated with this line item.

usage_type_cd

string

The usage type code of the usage type specified.

service_coa_id

long

The Chart of Accounts ID for the service this line represents.

client_service_coa_code

string

The client-defined Chart of Accounts code for the service this line represents

ref_charge_line_no

long

The reference charge line number to indicate the item to which the discount applies.

nso_order_no

long

The unique identifier for an order that is created for bundled NSOs.

nso_order_status_label

string

Status label for this order

client_sku

string

Client SKU of the NSO/Inventory item.

item_no

long

The inventory item number for this line item.

credit_coupon_code

string

Specifies the coupon code applied to the invoice.

credit_reason_code_description

string

The long description of the credit reason code which was applied, if any.

csr_comments

string

The manually-entered CSR comments, if any

adv_billing_period_total_days

long

Total days of period in this invoice

rate_schedule_no

long

Aria-assigned unique rate schedule number

rate_schedule_tier_no

long

Sequential number in the rate schedule for determining tiers

bill_from_address_no

long

Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given Plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.

ship_from_address_no

long

Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given Plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.

bill_to_address_no

long

Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.

ship_to_address_no

long

Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.

proration_text

string

Specifies the prorated days in total days.

proration_remaining_days

long

Prorated days of period in this invoice.

proration_description

string

Prorated invoice description.

custom_rate_ind

long

Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate. A value of 0 indicates that it is a standard rate.

tax_details

hash

tax_detail_line

long

Line number associated with each tax detail record.

seq_num

long

The tax line on the invoice which includes the tax amount associated with this tax_detail_line.

taxed_seq_num

long

The invoice line item for which the tax for this tax_detail_line was calculated.

debit

double

Amount of tax applied for the given tax type.

tax_authority_level

long

Tax jurisdiction code: 0 = Federal, 1 = State / Province.

tax_rate

double

Rate at which tax is calculated for the tax type used by the tax engine.

orig_was_tax_inclusive

long

Indicates whether or not the invoice line amount was tax inclusive.

tax_srv_tax_type_id

string

Identifier of the tax type returned by the tax engine.

tax_srv_tax_type_desc

string

Description of the tax type returned by the tax engine.

tax_srv_cat_text

string

Category of the tax type returned by the tax engine.

tax_srv_juris_nm

string

Jurisdiction name returned by the tax engine.

tax_srv_tax_sum_text

string

Invoice summary text returned by the tax engine.

unrounded_tax_amt

double

The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount."

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

carryover_from_prev_amt

double

The amount carried over from previous <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative (based on the previous remainder).

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

before_round_adjusted_tax_amt

double

The amount of adjusted tax before rounding precision, calculated as the sum of <unrounded_tax_amt> and <carryover_from_prev_amt>.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

carryover_from_current_amt

double

The amount carried over from current <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative based on the previous remainder.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."

billing_contact_details

hash

DEPRECATED

payment_method_no

long

Aria-assigned sequence number for this payment method. (DEPRECATED ARRAY)

bill_contact_no

long

billing_contact_details_2

hash

payment_method_no

long

Aria-assigned sequence number for this payment method.

bill_contact_no

long

statement_contact_details

hash

DEPRECATED

billing_group_no

long

The Aria-assigned unique identifier for the billing group on the account. (DEPRECATED ARRAY)

stmt_contact_no

long

The Aria-assigned unique identifier for the statement contact associated with a billing group on the account. (DEPRECATED ARRAY)

statement_contact_details_2

hash

billing_group_no

long

The Aria-assigned unique identifier for the billing group on the account.

stmt_contact_no

long

The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.

other_contact_details

hash

DEPRECATED

other_contact_no

long

The Aria-assigned unique identifier for the contact saved on the account. (DEPRECATED ARRAY)

other_contact_idx

long

Value provided for the idx parameter in the API request. (DEPRECATED ARRAY)

other_contact_details_2

hash

other_contact_no

long

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

other_contact_idx

long

Value provided for the idx parameter in the API request.

third_party_errors

hash

Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.

error_class

string

Type of error code being represented, such as taxation

error_code

string

Error code returned by the third party system

error_msg

string

Error message returned by the third party system

proc_initial_auth_txn_id

string

Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.

update_acct_plan_multi_m

Table of contents

Input Arguments

Allowable values for auto_assign_mandatory_supp_plans

Allowable values for plan_directive

Allowable values for fulfillment_directive

Allowable values for fulfillment_directive

Allowable values for plan_unit_inst_field_val_directive

Allowable values for proration_invoice_timing

Allowable values for coupon_directive

Allowable values for surcharge_directive

Allowable values for plan_status_cd

Allowable values for status_until_alt_start_cd

Allowable values for dunning_state

Allowable values for resp_level_cd

Allowable values for plan_instance_field_directive

Allowable values for auto_offset_months_option

Allowable values for invoice_unbilled_usage

Allowable values for force_master_bill_date_reset

Allowable values for usage_accumulation_reset_months_ renewal_option

Allowable values for usage_pooling

Allowable values for nso_bill_immediately

Allowable values for plan_instance_supp_field_update_only

Allowable values for force_bill_date_reset

Allowable values for billing_group_directive

Allowable values for notify_method

Allowable values for payment_option

Allowable values for bg_list_start_master_file

Allowable values for collections_grp_directive

Allowable values for assignment_directive

Allowable values for invoicing_option

Allowable values for payment_method_type

Allowable values for bank_acct_type:

Allowable values for dunning_group_directive

Allowable values for auto_collect_on_plan_chng

Allowable values for rollback_plan_chng_collect_fail

Allowable values for auto_send_stmt_on_plan_chng

Allowable values for do_write

Allowable values for list_start_master_file

Allowable values for combine_invoices

Allowable values for remove_pi_custom_rates

Allowable values for config_dunning_late_fee_option

Allowable values for config_dunning_email_option

Allowable values for recurring_processing_model_ind

Allowable values for include_plan_instance_queue

Allowable values for force_currency_change

Allowable values for transaction_type

Output Arguments

Allowable values for plan_operation

Allowable values for line_type

Related articles

Tags

Classifications