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

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

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

Alternative required field: client_acct_id

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

Alternative required field: acct_no

See fields below

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.

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.

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

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.

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.

Alternative field: override_dates_client_mp_instance_id

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.

Alternative field: override_dates_mp_instance_no

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.

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

See fields below

See fields below

See fields below

Determines whether to automatically perform a collection attempt after an invoice is generated as a result of an immediate plan addition, modification or replacement. (This also applies when only an order is billed immediately while plan changes are queued for future).

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.

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. (This also applies when only an order is billed immediately while plan changes are queued for future).

Additional explanatory text relating to this API call.

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'

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

Client-defined unique identifier used to track related system actions

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.

See fields below

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.

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. A null value will default to 0 - Cardholder-Initiated Transaction - Credentials on File.

Boolean indicator to return the queues created on this api call.

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.

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'. "auto_assign_mandatory_supp_plans" can only be used for "assign" and "replace" directives and not for plan "update" and "cancel" directives. This will override the "Included by Default" setting in the Product Catalog for a given supplemental plan.

The processor-specific fields passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are highlighted in blue below.

See allowable proc_field_names

See fields below

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.

Alternative field: client_service_id

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

Alternative field: service_no

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

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

Client-assigned identifier for the plan unit instance.

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

Array of plan unit instance services.

See fields below

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

Alternative field: client_service_id

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

Alternative field: service_no

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

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

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.

Alternative field: client_plan_unit_inst_id

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

Alternative field: plan_unit_inst_no

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

Array of plan unit instance services.

See fields below

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

Alternative field: client_plan_unit_inst_id

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

Alternative field: plan_unit_inst_no

The value stored under this field.

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

Field name of plan unit instance field.

Array of client-defined plan unit instance fields.

See fields below

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

Alternative field: client_plan_unit_inst_id or plan_unit_inst_idx

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

Alternative field: plan_unit_inst_no or plan_unit_inst_idx

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

Alternative field: plan_unit_inst_no or client_plan_unit_inst_id

Array of client-defined plan unit instance fields.

See fields below

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.

Alternative field: custom_rate_client_service_id

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

Alternative field: custom_rate_service_no

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

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

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

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.

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

Indicates what operation to perform on each coupon specified.

Determines whether the coupon should be assigned at MPI stack level, or to the PI passed as input or if it is also to be assigned to the mandatory child plans of the PI.

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.

Alternative field: client_surcharge_id

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

Alternative field: surcharge_no

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

Required for each surcharge specified in this array.

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

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

Required for each plan instance field provided.

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

Alternative field: client_sku

Alternative field: item_no

Quantity of the NSO / inventory item being purchased.

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

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.

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.

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.

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.

Alternative field: client_service_id

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

Alternative field: service_no

The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

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.

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.

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.

Aria assigned installment schedule no

Installment directive governs what needs to be done with an installment when a master plan instance is cancelled or replaced. Allowable values are: 1 - Cancelled and due immediately; 2 - Map installment to a different master plan instance. If NULL, no update will be done to installment.

The unique identifier of the existing master plan instance that will be associated with the installment. Applicable only when installment_directive = 2 (map installment to a different master plan instance).

Alternative field: installment_client_master_plan_instance_id or installment_master_plan_instance_idx

The client-defined identifier of the existing master plan instance that will be associated with installment. Applicable only when installment_directive = 2 (map installment to a different master plan instance).

Alternative field: installment_master_plan_instance_no or installment_master_plan_instance_idx

A non-persistent reference of a master plan instance associated with installment within the API request.

Alternative field: installment_master_plan_instance_no or installment_client_master_plan_instance_id

Governs which fields will be updated. Currently supports Plan Instance and Plan Instance Services, with the flexibility to include additional object types in the future. If multiple fields need to be updated, all corresponding object types can be included in the array.

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

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.

Alternative field: existing_client_plan_instance_id

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

Alternative field: existing_plan_instance_no

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

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

Description for the plan instance.

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.

Alternative field: new_client_plan_id

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

Alternative field: new_plan_no

For master plan instances only. Ignore if submitted for a supplemental plan.

Number of units purchased of the specified plan.

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.

See fields below

Applicable only for plan instance that is of daily/weekly billing interval type. It is for supplemental plan only in assigning and for both master plan and supplemental plan in replacing. The date, in yyyy-mm-dd format, should never be before the alt_proration_start_date if specified, the retroactive_start_date if specified, or the current date.

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

See fields below

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.

See fields below

Array of client-defined plan unit instance fields.

See fields below

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.

Alternative field: client_alt_rate_schedule_id

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

Alternative field: alt_rate_schedule_no

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.

An array of custom rates for the specified account number

See fields below

See fields below

See fields below

Balance forward should be applied against the corresponding master plan instance balance.

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

Alternative field: parent_client_plan_instance_id or parent_plan_instance_idx

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

Alternative field: parent_plan_instance_no or parent_plan_instance_idx

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.

Alternative field: parent_client_plan_instance_id or parent_plan_instance_no

The status of this plan instance

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.

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.

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.

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

Alternative field: client_billing_group_id or billing_group_idx

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

Alternative field: billing_group_no or billing_group_idx

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

Alternative field: billing_group_no or client_billing_group_id

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

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

Alternative field: client_dunning_group_id or dunning_group_idx

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

Alternative field: dunning_group_no or dunning_group_idx

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

Alternative field: client_dunning_group_id or dunning_group_no

See fields below

Applicable only for supplemental plans. Ignore if submitted for a master plan.

For plan recurring intervals of longer than one month, the number of months to offset proration and first bill date. For 'update', this is only applicable when there is a pullback of the recurring bill thru date either due to change in rate schedule with a change in billing interval or when the plan instance is being activated/re-activated. Additionally, when this is given for a parent plan instance being activated, then the auto-activated child plan instances will be automatically applied with auto_offset_months_option = 1 so that they remain synchronized with the parent plan instance.

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.

Automatically set the offset for the billing anniversary month. For 'update', this is only applicable when there is a pullback of the recurring bill thru date either due to change in rate schedule with a change in billing interval or when the plan instance is being activated/re-activated.

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

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

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.

Specifies whether to invoice the unbilled usage.

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.

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

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 current period.

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

Usage tracking options on the specified plan.

Determines when the NSO order is fulfilled and then billed.

See fields below

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

See fields below

Purchase order number assigned to the plan instance.

Purchase order number assigned to the one-time order.

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

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.

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

Determines the behavior when changing the rate schedule of a plan instance that is using custom rates. The default value is false and will leave the custom rates in place. A value of true will remove the custom rates and use the default rates of the new rate schedule.

Determines which dunning step to place the MPI into if you are placing this MPI into dunning or for moving the step of a MPI that is already in dunning. The default is 1 (step 1).

Determines whether or not to use the dunning configuration setting to charge a late fee applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting.

Determines whether or not to use the dunning configuration setting to send an email applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting.

The unique identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_client_master_plan_instance_id

The client-defined identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_master_plan_instance_no

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

Array of installment updates

See fields below

Limit updates to specific objects only if a plan instance is already queued for a future assignment.

See fields below

Collection Group Number to which this billing group should be assigned.

Alternative field: client_collections_group_bg_id

Collection Group ID to which this billing group should be assigned.

Alternative field: collections_group_bg_no

Whether to add or remove the collection group to or from the specified billing group.

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name. Required when bg_einvoicing_field_directive is 1 (save); ignored when it is 2 (delete).

Action for this entry. Defaults to 1 (save) when omitted.

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

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.

Alternative field: existing_client_billing_group_id

The client-defined identifier of the billing group.

Alternative field: existing_billing_group_no

Name of the billing group.

Description of the billing group.

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.

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

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

Aria-assigned unique identifier for the notification template group to be associated with the billing group.

Alternative field: client_notification_template_group_id

Statement template No.

Credit note template No.

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'

Unique identifier associated with an existing payment method for the specified account to be used as the primary payment method on the billing group

Alternative field: primary_client_payment_method_id or primary_payment_method_idx

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

Alternative field: primary_payment_method_no or primary_payment_method_idx

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

Alternative field: primary_payment_method_no or primary_client_payment_method_id

Unique identifier associated with an existing payment method for the specified account to be used as the backup payment method on the billing group.

Alternative field: backup_client_payment_method_id or backup_payment_method_idx

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.

Alternative field: backup_payment_method_no or backup_payment_method_idx

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

Alternative field: backup_payment_method_no or backup_client_payment_method_id

Statement contact first name

The Middle Initial of the statement contact.

Company name of the statement contact

First address line of the statement contact

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.

Third address line of the statement contact

City of the statement contact

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

State or Province of the 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.

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

Postal/Zip code for the statement contact address.

The phone number of the statement contact

The extension for the statement contact phone

The contact cell phone of the statement contact.

Work phone number of the statement contact.

The extension for the statement contact work phone

The fax number for the statement contact.

Email of the statement contact

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

Indicates whether or not the account shall be listed at the start of a master file.

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.

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

Payment terms number assigned to the account.

Payment terms name assigned to the account.

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

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

'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 one of the input parameters payment terms number/payment terms name/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 template No.

Rebill template No.

Update Array for collection groups for billing group.

See fields below

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

Alternative field: notify_template_group

A unique ID number defined in a taxation provider (like Avalara) to identify your different company's or business units.

Array of e-invoicing fields associated with the billing group.

See fields below

Payment method name.

Client-defined unique identifier for the payment method.

Payment method description

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.

This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.

Credit card number.

Expiration month for the credit card payment instrument.

Expiration year for the credit card payment instrument.

The bank account number.

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

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.

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

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

Unique ID of the bill agreement (also referred to as a token).

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

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.

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.

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.

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.

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.

First name of the billing contact.

Middle initial of the billing contact

Last name of the billing contact.

Company name of the billing contact.

First address line of the billing contact.

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.

The third line of the billing address.

City of the billing contact.

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

State or Province of the 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.

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

Postal code for the billing contact.

Phone number of the billing contact.

Phone extension of the billing contact.

Cell phone number of the billing contact.

Work phone number of the billing contact.

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

Fax number of the billing contact.

Email of the billing contact.

Birthdate of the billing contact.

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

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.

Bank name for the account payment method

Bank city for the account payment method

The type of bank account being used.

This field denotes the bank account holder type. The value can be either individual or company.

The date, in yyyy-mm-dd format, on which the mandate was signed.

The code provided by the account validator.

This is the electronic signature returned after successfully completing an e-mandate request through an e-Mandate service.

Indicates what operation to perform on each dunning group specified.

The dunning group number mapped against each master plan.

Alternative field: existing_client_dunning_group_id

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

Alternative field: existing_dunning_group_no

Name of the dunning group.

Description of the dunning group.

Client-defined dunning group identifier.

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

Alternative field: client_dunning_process_id

Client-defined dunning process identifier.

Alternative field: dunning_process_no

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

The first name of the contact.

The middle initial of the contact.

The last name of the contact.

The company name of the contact.

The first address line of the contact.

The second address line of the contact.

The third address line of the contact.

The city of the contact.

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

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.

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

The postal/zip code of the contact.

The phone number of the contact.

The phone number extension of the contact.

The cell phone number of the contact.

The work phone number of the contact.

The work phone number extension of the contact.

The fax number of the contact.

The email address of the contact.

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

Defines a transaction type for Credit Cards and Tokenized Credit Cards. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of transaction types, please read our documentation.

The transaction mode identifies the channel from which the transactions are originated of Cybersource 3ds 2.0.

Use this field to specify how the customer will authorize the mandate for direct debit collection. It is required for ACH, SEPA, and BACS. If the the mandate is collected online, the customer IP address and useragent must be collected and passed in the collection API. If offline, you must collect and maintain the authorization in your records. This is applicable for Stripe Payment Processor.

The type of entity that holds the account. This is applicable for Stripe Payment Processor.

Name of the field you want to associate with order.

Corresponding value of the field you want to associate with order.

Name of the field you want to associate with order line item

Corresponding value of the field you want to associate with order line item

The number of units indicated for this SKU on the line item.

The amount for this line item.

Any client-defined comments, from a CSR or automated system, for this particular line item. Note: The field size limit is less than 3000 characters or 4000 bytes.

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.

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.

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.

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.

Aria-assigned unique identifier for the rate schedule.

Alternative field: client_nso_rate_schedule_id

Client-defined unique identifier for the rate schedule.

Alternative field: nso_rate_schedule_no

Client-defined unique identifier for order line item.

Array of additional values you can associate with each order line item

See fields below

Installment no on product catalog. If null, then it selects installment default.

Alternative field: client_installment_term_id

Specifies client installment id. If null, then it selects the installment default.

Alternative field: installment_term_no

Defines the start date of independent installment, needs to be the same or greater than the current date. If passed, the associated "days_to_start" and "lump_sum_days" value will be ignored.

Specifies the individual installment amount, inclusive of tax. For example, if a purchase is taxed at 15%, a $20 installment amount will be split into $17.39 (charge) and $2.61 (tax). The total tax-inclusive purchase amount will be divided by this amount to calculate the length of installment. Note: If this field is provided, the installment_term_length field will be ignored.

Specifies installment type for the account, whether installment should be aligned with master plan instance or independent. Allowable values are: Yes (Y) - Aligned with existing master plan instance OR No (N) - Independent, its own installment schedule and due dates.

Specifies the installment term type for the assigned installment, applicable only for independent. Allowable values are: M (Months), W (Weeks), D (Days).

Specifies the installment term length for the assigned installment. For installment_type = 2, the input will be used jointly with the interval type. For installment_type = 1, this will be the number of statements that the installment amount will be part of.

Specifies the installment interval for the assigned installment, applicable only for independent installment. It works jointly with terms type. If defined, must be less than terms length.

Specifies the number of days until due for the independent installment. Applicable only when installment_type = 2 or installment term defined on product catalog is aligned_installment =N. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.

Specifies the installment lump sum type for the assigned installment. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only.

Specifies the lump sum amount, mandatory when lump sump type is proportionately split (lump_sum_type = P).

Applicable only for aligned installment. Determines when to notify customers of the lump sum. Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment

Specifies the lump sum days. Applicable only for independent installment (update_installment_type = 2 or installment term defined on product catalog is aligned_installment = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers.

Specifies the lump sum days until due, applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due.

Specifies the percentage used to calculate the allowable additional amount for the last installment's threshold. For example: If the installment amount is $50 and the remainder is $80, with 0%, the remainder is split into $50 and $30 (last installment). With 90%, the allowable additional amount is $45, making the last installment threshold $95. In this case, the last installment amount will be $80. If set to NULL, it defaults to 0%. Valid values are 0 to 99.

The unique identifier of the master plan instance. The master_plan_instance_no passed here should be present in plan updates array.

Alternative required field: master_plan_instance_idx or client_master_plan_instance_id

The client-defined identifier of the master plan instance.

Alternative required field: master_plan_instance_idx or master_plan_instance_no

Used for non-persistent referencing of a plan instance within the API request. This field will map the order to the master plan instance by linking it to the plan_instance_idx in the plan_updates array. Either this field, client_master_plan_instance_id, or master_plan_instance_no must be provided to create the order.

Alternative required field: master_plan_instance_no or client_master_plan_instance_id

Determines when the order is fulfilled and then billed. If no value is defined (the field is null), then billing timing is determined by the client parameter AUTO BILL ORDERS. Contact Customer Support for more information about the AUTO BILL ORDERS parameter.

Client assigned ID for this order

Comments for this order

Purchase order number assigned to the one-time order.

Date on which order is fulfilled.

Array of additional values you can associate with each order.

See fields below

This is an array of line items appearing on the order. The array elements for this argument immediately follow and are indicated as elements with a right-arrow icon.

See fields below

Aria-assigned error identifier. 0 indicates no error.

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

Aria generated unique identifier for the account.

Client-assigned identifier for the account.

See fields below

See fields below

See fields below

See fields below

See fields below

This array contains a list of queued plans, their identifier, and type.

See fields below

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.

See fields below

See fields below

See fields below

See fields below

Collection group and processor details when there is a cc auth or validation failure.

See fields below

Array of results of installment updates.

See fields below

The processor returned response fields at the time of payment method creation failure

See fields below

Array of the orders created with this request.

See fields below

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

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

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

The error message associated with collection_error_code.

The error code if statement generation fails.

The text message associated with 'statement_error_code'

The billing group number mapped against each master plan.

Client-defined billing group ID

Aria unique Plan Unit Instance Number

Client-assigned identifier for the plan unit instance.

Aria-assigned unique plan identifier

Client-defined Plan ID for the plan.

Specifies the Aria-assigned unique service identifier.

A client-defined Service ID for this service

plan proration total amount.

Proration amount.

Proration tax charges.

Tax credits applied as a result of proration.

Surcharge amount applied as a result of proration.

The non-tax pro-rated credit amount

Start date of the time period used for calculating proration.

End date of the time period used for calculating proration.

Unique plan instance number for each assigned plan.

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

Aria-assigned unique plan identifier.

Client-defined Plan ID for the plan.

Name of the plan.

Indicates what operation was performed on each plan instance.

Array of plan unit instances.

See fields below

The total pro-rated credit amount

The non-tax pro-rated credit amount

The pro-rated tax credit amount

See fields below

The unique identifier of the billing group.

The client-defined identifier of the billing group.

Primary payment method ID.

Client-defined unique identifier of the primary payment method.

Backup payment method ID.

Client-defined unique identifier of the backup payment method'

The billing group number mapped against each master plan.

The dunning group number mapped against each master plan.

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

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

The line number on the invoice

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

The unique ID plan this line represents.

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

the name of the service plan this line represents.

The unique ID for the service this line represents.

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

The name of the service this line represents

Whether or not this line item represents a tax charge.

The unique identifier of the plan instance this line represents.

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

Number of units for the specified invoice line.

The monetary rate per unit of service.

The total line amount for this invoice line.

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

Specifies the percentage of the line_base_units billed.

Specifies the description of this line item

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

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

The usage type code associated with this line item.

The usage type code of the usage type specified.

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

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

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

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

Status label for this order

The inventory item number for this line item.

Specifies the coupon code applied to the invoice.

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

The manually-entered CSR comments, if any

Total days of period in this invoice

Aria-assigned unique identifier for the rate schedule used to generate this invoice line item. Either the catalog rate of this rate schedule is used for this line item or the account custom rate against this underlying rate schedule is used. Please note that there are cases in which the custom_rate_ind is null/0 but rate_schedule_no is also null. These special cases include rebill rate changes and multi-plan contract early cancellation fees where the charges are neither from regular rate schedule nor from custom rates. Another such case is the dummy zero amount line formed when net usage is negative for a usage service.

Sequential number in the rate schedule for determining tiers

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.

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.

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.

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.

Specifies the prorated days in total days.

Prorated days of period in this invoice.

Prorated invoice description.

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. Please note that there are cases in which the custom_rate_ind is null/0 but rate_schedule_no is also null. These special cases include rebill rate changes and multi-plan contract early cancellation fees where the charges are neither from regular rate schedule nor from custom rates. Another such case is the dummy zero amount line formed when net usage is negative for a usage service.

Specifies the total credit associated with this line item.

Line number associated with each tax detail record.

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

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

Amount of tax applied for the given tax type.

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

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

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

Identifier of the tax type returned by the tax engine.

Description of the tax type returned by the tax engine.

Category of the tax type returned by the tax engine.

Jurisdiction name returned by the tax engine.

Invoice summary text returned by the tax engine.

The amount multiplied by tax rate before rounding precision. Also referred to as raw tax amount. *Note: Aria internal tax rounding method set to invoice.

The amount that is a carryover from previous unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.

The amount adjusted Tax before rounding precision. i.e. Sum of unrounded_tax_amt, and carryover_from_prev_amt. *Note: Aria internal tax rounding method set to invoice.

The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.

Nominal Rate returned by the tax engine.

Field name of various response returned by the processor, example: micro_deposit_verify_url.

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.

The unique identifier of the billing group.

The client-defined identifier of the billing group.

The Aria-assigned unique identifier of a given invoice.

The processor return code from CVV validation.

Processor return code from address validation.

The processors return code for security validation.

The processor status code

The processors status description.

The processor payment ID.

Authorization code provided by the issuing bank.

Additional information passed to payment processor.

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.

Total charges on this invoice before taxes are applied.

Total amount of taxes charged.

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

Credit to be applied before tax is taken into account.

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

Credit to be applied after tax is taken into account.

The total owed on the initial invoice for this account.

Predicted activation fee based on activation fee charges on supplemental plans on this invoice.

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

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

See fields below

See fields below

Payment response fields returned by the processor for further actions if any.

See fields below

The payment method sequence no for the payment attempted during collection.

Aria queue_id for future plan changes that can be used for follow on actions.

This designates the type of queued action.

Aria plan instance number

Type of error code being represented, such as taxation

Error code returned by the third party system

Error message returned by the third party system

Aria-assigned sequence number for this payment method.

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.

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

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

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

Value provided for the idx parameter in the API request.

Collection Group number.

Collection Group Name.

Payment Processor Id.

Payment Processor Name.

Aria assigned installment schedule no.

Indicates what operation was performed on each installment.

Describes the operation detail done on each installment.

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

The error message associated with installment_collection_error_code.

Collected amount upon cancelled installment.

Payment transaction ID related to collected amount upon cancelled installment.

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.

Client-defined unique identifier for the payment method.

The processor status code

The processors status description

The Master Subscription plan instance number.

Client-defined Master plan Subscription plan instance ID.

The unique identifier for an order in the context of an client_no and account_no.

Status label for this order