Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo core api > update_acct_plan_multi_m

update_acct_plan_multi_m

Table of contents
  1. Input Arguments
  2. Allowable values for auto_assign_mandatory_supp_plans
  3. Allowable values for plan_directive
  4. Allowable values for fulfillment_directive
  5. Allowable values for fulfillment_directive
  6. Allowable values for plan_unit_inst_field_val_directive
  7. Allowable values for proration_invoice_timing
  8. Allowable values for coupon_directive
  9. Allowable values for surcharge_directive
  10. Allowable values for plan_status_cd
  11. Allowable values for status_until_alt_start_cd
  12. Allowable values for dunning_state
  13. Allowable values for resp_level_cd
  14. Allowable values for plan_instance_field_directive
  15. Allowable values for auto_offset_months_option
  16. Allowable values for invoice_unbilled_usage
  17. Allowable values for force_master_bill_date_reset
  18. Allowable values for usage_accumulation_reset_months_ renewal_option
  19. Allowable values for usage_pooling
  20. Allowable values for nso_bill_immediately
  21. Allowable values for plan_instance_supp_field_update_only
  22. Allowable values for force_bill_date_reset
  23. Allowable values for billing_group_directive
  24. Allowable values for notify_method
  25. Allowable values for payment_option
  26. Allowable values for bg_list_start_master_file
  27. Allowable values for collections_grp_directive
  28. Allowable values for assignment_directive
  29. Allowable values for invoicing_option
  30. Allowable values for payment_method_type
  31. Allowable values for dunning_group_directive
  32. Allowable values for auto_collect_on_plan_chng
  33. Allowable values for rollback_plan_chng_collect_fail
  34. Allowable values for auto_send_stmt_on_plan_chng
  35. Allowable values for do_write
  36. Allowable values for list_start_master_file
  37. Allowable values for combine_invoices
  38. Allowable values for remove_pi_custom_rates
  39. Allowable values for recurring_processing_model_ind
  40. Allowable values for include_plan_instance_queue
  41. Allowable values for force_currency_change
  42. Allowable values for transaction_type
  43. Output Arguments
  44. Allowable values for plan_operation
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

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

 

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 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 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.
  OR      
  client_acct_id string 50 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 5

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

Start plan_updates array
 
plan_updates array    
  Field Name Field Type Max Length Description
brd_arrow.gifplan_directive long   Indicates what operation to perform on each plan or plan instance specified.   Allowable Values
  brd_arrow.gifexisting_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.
  OR      
  brd_arrow.gifexisting_client_plan_instance_id string 100 The client-defined identifier of the plan instance (can be either a master or supplemental plan).
  brd_arrow.gifnew_client_plan_instance_id string 100 Updates the client-defined identifier associated with the plan instance.
  brd_arrow.gifplan_instance_idx long 22 For non-persistent referencing of a plan instance within the API request.
  brd_arrow.gifplan_instance_description string 1000 Description for the plan instance.
  brd_arrow.gifnew_plan_no long 22 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.
  OR      
  brd_arrow.gifnew_client_plan_id string 100 The client-defined identifier of the new plan being assigned or replacing the existing plan on the instance.
  brd_arrow.gifpromo_cd string 30 For master plan instances only. Ignore if submitted for a supplemental plan.
  brd_arrow.gifplan_units double 8 Number of units purchased of the specified plan.
 

brd_arrow.gifbill_lag_days

long 10

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

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

  1. Master plan instance (for a given account)
  2. Collection group setting
  3. Payment terms/payment method setting
  4. 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
  brd_arrow.gifassign_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
  brd_arrow.gifbrd_arrow.gifclient_plan_unit_inst_id string 100 Client-assigned identifier for the plan unit instance.
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_idx long 8 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
  brd_arrow.gifbrd_arrow.gifplan_unit_instance_services array   Array of plan unit instance services.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service).
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_fulfillment_date string 10 It is a Fulfillment completion date. It can be in past, today or future date.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffulfillment_directive long 8 This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the plan unit instance.   Allowable Values
End of plan_unit_instance_services array
 
Start of update_plan_unit_instances array
  brd_arrow.gifupdate_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
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifnew_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
  brd_arrow.gifbrd_arrow.gifplan_unit_instance_services array   Array of plan unit instance services.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifclient_service_id string 100 Client-assigned identifier for the service (only for fulfillment based service).
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifservice_fulfillment_date string 10 It is a Fulfillment completion date. It can be in past, today or future date.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffulfillment_directive long 8 This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on the plan unit instance.   Allowable Values
End of plan_unit_instance_services array
 
Start of remove_plan_unit_instances array
  brd_arrow.gifremove_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
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_no long 22 Aria-assigned identifier for the plan unit instance to specify an existing plan unit instance.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_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
  brd_arrow.gifplan_unit_inst_field_details array   Array of client-defined plan unit instance fields.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_no long 22 Aria-assigned identifier for the plan unit instance to specify an existing plan unit instance.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_plan_unit_inst_id string 100 Client-defined identifier for the plan unit instance to specify an existing plan unit instance.
  OR      
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_idx long 8 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
  brd_arrow.gifbrd_arrow.gifplan_unit_inst_field_list array   Array of client-defined plan unit instance fields.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_name string 300 Field name of plan unit instance field.
Start of plan_unit_inst_field_values array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_field_values array   Array of client-defined plan unit instance fields.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.giffield_value string 1000 The value stored under this field.
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifplan_unit_inst_field_val_directive long 8 The directive is mandatory if field name/value pair are specified.   Allowable Values
End of plan_unit_inst_field_values array
End of plan_unit_inst_field_list array
 
  brd_arrow.gifalt_rate_schedule_no long 1 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.
  OR      
  brd_arrow.gifclient_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.
  brd_arrow.gifproration_invoice_timing long 1 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
Start of custom_rates array
  brd_arrow.gifcustom_rates array   An array of custom rates for the specified account number
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifcustom_rate_service_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifcustom_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.
  brd_arrow.gifbrd_arrow.gifcustom_rate_seq_no long 22 Rate tier number to which this custom rate is to be applied.
  brd_arrow.gifbrd_arrow.gifcustom_rate_from_unit long 22 Starting unit of a range of units to which this custom rate is to be applied.
  brd_arrow.gifbrd_arrow.gifcustom_rate_to_unit long 22 Ending unit of a range of units to which this custom rate is to be applied.
  brd_arrow.gifbrd_arrow.gifcustom_rate_per_unit double 22 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
  brd_arrow.gifcoupon_code_updates array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifcoupon_cd string 30 Note that only those coupons with Coupon Applicablity Scope of Master Plan Instance or Account and Master Plan Instance should be accepted.
  brd_arrow.gifbrd_arrow.gifcoupon_directive long 1 Indicates what operation to perform on each coupon specified.   Allowable Values
End of coupon_code_updates array
 
Start of surcharge_updatesarray
  brd_arrow.gifsurcharge_updates array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifsurcharge_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_surcharge_id string 100 Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted.
  brd_arrow.gifbrd_arrow.gifrate_schedule_no long 22 If not specified, the default rate schedule matching the currency on the account will be used.
  brd_arrow.gifbrd_arrow.gifsurcharge_directive long 1 Required for each surcharge specified in this array.   Allowable Values
End of surcharge_updates array
 
  brd_arrow.gifbalance_forward double 22 Balance forward should be applied against the corresponding master plan instance balance.
  brd_arrow.gifparent_plan_instance_no long 22 Unique identifier of a plan in the plan instance hierarchy under which the new plan will be assigned. Applicable only for plan assignments.
  OR      
  brd_arrow.gifparent_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.
  OR      
  brd_arrow.gifparent_plan_instance_idx long 22 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.
  brd_arrow.gifplan_status_cd long   The status of this plan instance   Allowable Values
  brd_arrow.gifstatus_until_alt_start_cd long 22 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
  brd_arrow.gifdunning_state long 1 Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.   Allowable Values
  brd_arrow.gifdegrade_date string 10 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.
  brd_arrow.gifbilling_group_no long 22 Unique identifier associated with an existing billing group for the specified account.
  OR      
  brd_arrow.gifclient_billing_group_id string 100 Unique client-defined identifier associated with an existing billing group for the specified account.
  OR      
  brd_arrow.gifbilling_group_idx long 22 For non-persistent referencing of a billing group within the API request.
  brd_arrow.gifresp_level_cd long 1 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.   Allowable Values
  brd_arrow.gifparent_acct_mp_inst_no long 22 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.
  OR      
  brd_arrow.gifparent_acct_client_mp_inst_id 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.
  brd_arrow.gifdunning_group_no long 22 Unique identifier associated with an existing dunning group for the specified account.
  OR      
  brd_arrow.gifclient_dunning_group_id string 100 Unique client-defined identifier associated with an existing dunning group for the specified account.
  OR      
  brd_arrow.gifdunning_group_idx long 22 For non-persistent referencing of a dunning group within the API request.
Start of plan_instance_field_update array
  brd_arrow.gifplan_instance_field_update array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifplan_instance_field_name string 300 Required based on the definition of each plan instance field associated with the new plan.
  brd_arrow.gifbrd_arrow.gifplan_instance_field_value string 1000 Required based on the definition of each plan instance field associated with the new plan.
  brd_arrow.gifbrd_arrow.gifplan_instance_field_directive long 8 Required for each plan instance field provided.   Allowable Values
End of plan_instance_field_update array
 
  brd_arrow.gifeffective_date string 10 Applicable only for supplemental plans. Ignore if submitted for a master plan.
  brd_arrow.gifoffset_months long 4 For plan recurring intervals of longer than one month, the number of months to offset proration and first bill date.
  brd_arrow.gifalt_proration_start_date string 10

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:

  1. 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.
  2. 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.
  3. 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.
  1. 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.
  brd_arrow.gifauto_offset_months_option long 1 Automatically set the offset for the billing anniversary month.   Allowable Values
  brd_arrow.gifalt_collect_group_no long 22 The one-time collections account group for this account for this API call only. Available only for plan assignments and plan replacements
  brd_arrow.gifalt_client_collect_group_id string 100 The one-time collections account group for this account for this API call only.
  brd_arrow.gifoffset_interval long 4 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.
  brd_arrow.gifinvoice_unbilled_usage string 5 Specifies whether to invoice the unbilled usage.   Allowable Values
  brd_arrow.gifforce_supp_bill_date_reset long 1 Deprecated(Deprecated) This input is not operational. Use 'force_master_bill_date_reset' to perform this input's activity.
  brd_arrow.gifforce_master_bill_date_reset long 1 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
  brd_arrow.gifusage_accumulation_reset_months string 4 For the plan specified, the number of months to accumulate before being reset.
  brd_arrow.gifusage_accumulation_reset_months_renewal_option long 1 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
  brd_arrow.gifusage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.   Allowable Values
  brd_arrow.gifusage_threshold_applicability string 2 Usage tracking options on the specified plan.
  brd_arrow.gifnso_bill_immediately long 1 Indicates whether to bill the NSO items immediately or, if not, to set bill on next billing anniversary date.   Allowable Values
Start of nso_item_array array
  brd_arrow.gifnso_item_array array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifitem_no long 22 NSO / inventory item number. This field is required when creating an NSO bundling orde
  OR      
  brd_arrow.gifbrd_arrow.gifclient_sku string 100 Client SKU of the NSO/Inventory item.
  brd_arrow.gifbrd_arrow.gifitem_units long 22 Quantity of the NSO / inventory item being purchased.
  brd_arrow.gifbrd_arrow.gifitem_svc_location_no long 22 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..
  brd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifitem_dest_contact_idx long 2 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.
  brd_arrow.gifbrd_arrow.gifitem_dest_contact_no long 22 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
  brd_arrow.gifplan_service_updates array   List of services associated with the plan being assigned or updated on the account.
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifservice_no long 22 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.
  OR      
  brd_arrow.gifbrd_arrow.gifclient_service_id string 100 The client-defined identifier for the service associated with the plan instance.
  brd_arrow.gifbrd_arrow.gifsvc_location_no long 22 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.
  brd_arrow.gifbrd_arrow.gifclient_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.
  brd_arrow.gifbrd_arrow.gifdest_contact_no long 22 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.
  brd_arrow.gifbrd_arrow.gifdest_contact_idx long 32 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
 
  brd_arrow.gifpo_num string 100 Purchase order number assigned to the plan instance.
  brd_arrow.gifnso_po_num string 100 Purchase order number assigned to the one-time order.
  brd_arrow.gifplan_instance_supp_field_update_only long 1 This field controls the ability to update plan instance fields on a plan that is in non-provisioned status.   Allowable Values
  brd_arrow.gifforce_bill_date_reset long 1 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
End of plan_updates array
 
Start of acct_billing_groups array
acct_billing_groups array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbilling_group_directive long 4 Indicates what operation to perform on each billing group specified. This field is required when performing any action on a billing group.   Allowable Values
  brd_arrow.gifexisting_billing_group_no long 22 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.
  OR      
  brd_arrow.gifexisting_client_billing_group_id string 100 The client-defined identifier of the billing group.
  brd_arrow.gifbilling_group_name string 100 Name of the billing group.
  brd_arrow.gifbilling_group_description string 1000 Description of the billing group.
  brd_arrow.gifnew_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.
  brd_arrow.gifbilling_group_idx long 22 For non-persistent referencing of a billing group within the API request.
  brd_arrow.gifnotify_method long 2 How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).   Allowable Values
  brd_arrow.gifnotification_template_group_no long 22 Notify template No. Aria-assigned unique identifier for the notification template group to be associated with the account.
  brd_arrow.gifclient_notification_template_group_id string 50

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

  brd_arrow.gifstatement_template long 22 Statement template No.
  brd_arrow.gifcredit_note_template long 22 Credit note template No.
  brd_arrow.gifpayment_option string 7 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
  brd_arrow.gifprimary_payment_method_no long 22 Unique identifier associated with an existing payment method for the specified account to be used as the primary payment method on the billing group
  OR      
  brd_arrow.gifprimary_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
  OR      
  brd_arrow.gifprimary_payment_method_idx long 4 For non-persistent referencing of a payment method within the API request to be used as the primary payment method on the billing group.
  brd_arrow.gifbackup_payment_method_no long 22 Unique identifier associated with an existing payment method for the specified account to be used as the backup payment method on the billing group.
  OR      
  brd_arrow.gifbackup_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.
  OR      
  brd_arrow.gifbackup_payment_method_idx long 32 For non-persistent referencing of a payment method within the API request to be used as the backup payment method on the billing group.
  brd_arrow.gifstmt_first_name string 300 Statement contact first name
  brd_arrow.gifstmt_mi string 2 The Middle Initial of the statement contact.
  brd_arrow.gifstmt_last_name string 300 Last name of the billing contact
  brd_arrow.gifstmt_company_name string 100 Company name of the statement contact
  brd_arrow.gifstmt_address1 string 300 First address line of the statement contact
  brd_arrow.gifstmt_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.
  brd_arrow.gifstmt_address3 string 300 Third address line of the statement contact
  brd_arrow.gifstmt_city string 300 City of the statement contact
  brd_arrow.gifstmt_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.
  brd_arrow.gifstmt_state_prov string 10 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  brd_arrow.gifstmt_country string 25 Country of the contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifstmt_postal_cd string 15 Postal/Zip code for the statement contact address.
  brd_arrow.gifstmt_phone string 25 The phone number of the statement contact
  brd_arrow.gifstmt_phone_ext string 10 The extension for the statement contact phone
  brd_arrow.gifstmt_cell_phone string 20 The contact cell phone of the statement contact.
  brd_arrow.gifstmt_work_phone string 25 Work phone number of the statement contact.
  brd_arrow.gifstmt_work_phone_ext string 10 The extension for the statement contact work phone
  brd_arrow.gifstmt_fax string 25 The fax number for the statement contact.
  brd_arrow.gifstmt_email string 320 Email of the statement contact
  brd_arrow.gifstmt_birthdate string 10 The birthdate, in yyyy-mm-dd format, of the statement contact.
  brd_arrow.gifbg_list_start_master_file long 1 Indicates whether or not the account shall be listed at the start of a master file.   Allowable Values
  brd_arrow.gifstmt_contact_idx long 2 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.
  brd_arrow.gifstmt_contact_no long 22 The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.
  brd_arrow.gifpayment_terms_no long 22 Payment terms number assigned to the account.
  brd_arrow.gifpayment_terms_name string 50 Payment terms name assigned to the account.
  brd_arrow.gifclient_payment_term_id string 32 Client-defined identifier for the billing group's payment term
  brd_arrow.gifean_gln_num string 50 '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).'
  brd_arrow.gifean_gln_requisition_num string 50 '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'
  brd_arrow.gifcredit_memo_template long 22 Credit template No.
  brd_arrow.gifrebill_template long 22 Rebill template No.
  brd_arrow.gifcollection_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:
  1. Collection group assigned to the billing group associated with the master plan instance being invoiced;
  2. Collection group to which the customer is assigned at the account level.
  • Aria does not currently support using collection groups at the billing group level when the tokenized credit card payment method is used. For this payment method, Aria will make collections using the payment gateway associated with the collection group at the account level.
    brd_arrow.gifbrd_arrow.gifcollections_group_bg_no long 22 Aria-assigned identifier of the collection group to assign to the specified billing group.
    brd_arrow.gifbrd_arrow.gifclient_collections_group_bg_id string 100 Client-defined identifier of the collection group to assign to the specified billing group.
    brd_arrow.gifbrd_arrow.gifcollections_grp_directive long 1

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

Allowable Values

End of acct_billing_groups array
 
  assignment_directive long 8 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
  alt_start_date string 10 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 10 Date, in yyyy-mm-dd format, to set for retroactive start.
  override_bill_thru_date string 14 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.
  OR      
  override_dates_client_mp_instance_id string 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.
  alt_bill_day long 2 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 1 Indicator for performing full invoicing, and Perform Prorated Invoicing or client-defined on this account as part of this call.   Allowable Values
Start of acct_payment_methods array
  acct_payment_methods array    
  Field Name Field Type Max Length Description
  brd_arrow.gifpayment_method_name string 100 Payment method name.
  brd_arrow.gifclient_payment_method_id string 100 Client-defined unique identifier for the payment method.
  brd_arrow.gifpayment_method_description string 1000 Payment method description
  brd_arrow.gifpayment_method_idx long 4 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.
  brd_arrow.gifpayment_method_type long 8 This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.   Allowable Values
  brd_arrow.gifcc_num string 20 Credit card number.
  brd_arrow.gifcc_expire_mm long 2 Expiration month for the credit card payment instrument.
  brd_arrow.gifcc_expire_yyyy long 4 Expiration year for the credit card payment instrument.
  brd_arrow.gifbank_acct_num string 19 The bank account number.
  brd_arrow.gifbank_routing_num string 9 The American Banking Association (ABA) routing number for the financial institution.
  brd_arrow.gifcvv string 6 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.
  brd_arrow.giftrack_data1 string 300 Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request
  brd_arrow.giftrack_data2 string 300 Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request
  brd_arrow.gifbill_agreement_id string 32 Unique ID of the bill agreement (also referred to as a token).
  brd_arrow.gifiban string 50 International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.
  brd_arrow.gifbank_check_digit long 2 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.
  brd_arrow.gifbank_swift_cd string 15 SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.
  brd_arrow.gifbank_country_cd string 2 Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.
  brd_arrow.gifmandate_id string 35 Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.
  brd_arrow.gifbank_id_cd string 15 Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.
  brd_arrow.gifbank_branch_cd string 15 Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code.
  brd_arrow.gifbill_first_name string 300 First name of the billing contact.
  brd_arrow.gifbill_mi string 2 Middle initial of the billing contact
  brd_arrow.gifbill_last_name string 300 Last name of the billing contact.
  brd_arrow.gifbill_company_name string 100 Company name of the billing contact.
  brd_arrow.gifbill_address1 string 100 First address line of the billing contact.
  brd_arrow.gifbill_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.
  brd_arrow.gifbill_address3 string 300 The third line of the billing address.
  brd_arrow.gifbill_city string 300 City of the billing contact.
  brd_arrow.gifbill_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.
  brd_arrow.gifbill_state_prov string 10 State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
  brd_arrow.gifbill_country string 25 Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifbill_postal_cd string 15 Postal code for the billing contact.
  brd_arrow.gifbill_phone string 25 Phone number of the billing contact.
  brd_arrow.gifbill_phone_ext string 10 Phone extension of the billing contact.
  brd_arrow.gifbill_cell_phone string 20 Cell phone number of the billing contact.
  brd_arrow.gifbill_work_phone string 25 Work phone number of the billing contact.
  brd_arrow.gifbill_work_phone_ext string 10 This is the work phone extension for the billing contact work phone.
  brd_arrow.gifbill_fax string 25 Fax number of the billing contact.
  brd_arrow.gifbill_email string 320 Email of the billing contact.
  brd_arrow.gifbill_birthdate string 10 Birthdate of the billing contact.
  brd_arrow.gifbill_contact_idx long 32 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..
  brd_arrow.gifbill_contact_no long 22 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
  brd_arrow.gifdunning_group_directive long 4 Indicates what operation to perform on each dunning group specified.   Allowable Values
  brd_arrow.gifexisting_dunning_group_no long 22 The dunning group number mapped against each master plan.
  OR      
  brd_arrow.gifexisting_client_dunning_group_id string   The client-defined dunning group ID mapped against each master plan.
  brd_arrow.gifdunning_group_name string 100 Name of the dunning group.
  brd_arrow.gifdunning_group_description string 1000 Description of the dunning group.
  brd_arrow.gifnew_client_dunning_group_id string 100 Client-defined dunning group identifier.
  brd_arrow.gifdunning_group_idx long 22 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.
  brd_arrow.gifdunning_process_no long 22 Dunning process code.
  OR      
  brd_arrow.gifclient_dunning_process_id string 100 Client-defined dunning process identifier.
End of acct_dunning_groups array
 
  auto_collect_on_plan_chng long 1 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
  rollback_plan_chng_collect_fail long 1 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
  auto_send_stmt_on_plan_chng long 1 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
  comments string 500 Additional explanatory text relating to this API call.
  do_write string 5 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
  list_start_master_file long 1 Indicates whether the account is listed at the start of a master file.   Allowable Values
  client_receipt_id string 50 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
  brd_arrow.gifcontact_idx long 32 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).
  brd_arrow.giffirst_name string 32 The first name of the contact.
  brd_arrow.gifmiddle_initial string 2 The middle initial of the contact.
  brd_arrow.giflast_name string 32 The last name of the contact.
  brd_arrow.gifcompany_name string 100 The company name of the contact.
  brd_arrow.gifaddress1 string 100 The first address line of the contact.
  brd_arrow.gifaddress2 string 100 The second address line of the contact.
  brd_arrow.gifaddress3 string 100 The third address line of the contact.
  brd_arrow.gifcity string 32 The city of the contact.
  brd_arrow.giflocality string 32 Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.
  brd_arrow.gifstate_prov string 10 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.
  brd_arrow.gifcountry string 2 The country of the contact. Provide the ISO-compliant 2-character country code abbreviation in uppercase.
  brd_arrow.gifpostal_cd string 14 The postal/zip code of the contact.
  brd_arrow.gifphone string 25 The phone number of the contact.
  brd_arrow.gifphone_ext string 10 The phone number extension of the contact.
  brd_arrow.gifcell_phone string 20 The cell phone number of the contact.
  brd_arrow.gifwork_phone string 25 The work phone number of the contact.
  brd_arrow.gifwork_phone_ext string 10 The work phone number extension of the contact.
  brd_arrow.giffax string 25 The fax number of the contact.
  brd_arrow.gifemail string 320 The email address of the contact.
  brd_arrow.gifbirthdate string 10 Birthdate of the contact in yyyy-mm-dd format.
End of contacts array
 
  combine_invoices long 1 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
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
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
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  remove_pi_custom_rates string 5

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

  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 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards.  Allowable Values
  include_plan_instance_queue string 5

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

Allowable Values
  force_currency_change string 5

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
Start of proc_field_override array
  brd_arrow.gif 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
    brd_arrow.gifbrd_arrow.gif transaction_type string 2

If you use Chase Paymentech, 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 > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech > Collection Group Options.
  • Currently, only Chase Paymentech supports 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:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. transaction type that you specified in the <recurring_processing_model_ind> field
Allowable Values

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  
brd_arrow.gif 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.
brd_arrow.gif invoicing_error_msg string The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code".
brd_arrow.gif collection_error_code long If a collection is attempted, returns the error code associated with the collection.
brd_arrow.gif collection_error_msg string The error message associated with collection_error_code.
brd_arrow.gif statement_error_code long The error code if statement generation fails.
brd_arrow.gif statement_error_msg string The text message associated with 'statement_error_code'
brd_arrow.gif billing_group_no long The billing group number mapped against each master plan.
brd_arrow.gif client_billing_group_id string Client-defined billing group ID
plans_updated hash  
brd_arrow.gif plan_instance_no long Unique plan instance number for each assigned plan.
brd_arrow.gif client_plan_instance_id string Client-defined plan instance ID for each assigned master plan.
brd_arrow.gif plan_no long Aria-assigned unique plan identifier.
brd_arrow.gif client_plan_id string Client-defined Plan ID for the plan.
brd_arrow.gif plan_name string Name of the plan.
brd_arrow.gif plan_operation long Indicates what operation was performed on each plan instance.   Allowable Values
brd_arrow.gif plan_unit_instance_details hash Array of plan unit instances.
brd_arrow.gifbrd_arrow.gif out_plan_unit_inst_no long Aria unique Plan Unit Instance Number
brd_arrow.gifbrd_arrow.gif out_client_plan_unit_inst_id string Client-assigned identifier for the plan unit instance.
brd_arrow.gif plan_service_proration_results hash  
brd_arrow.gifbrd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gifbrd_arrow.gif client_plan_id string Client-defined Plan ID for the plan.
brd_arrow.gifbrd_arrow.gif service_no long Specifies the Aria-assigned unique service identifier.
brd_arrow.gifbrd_arrow.gif client_service_id string A client-defined Service ID for this service
brd_arrow.gifbrd_arrow.gif proration_text string Deprecated (Deprecated) Specifies the prorated days in total days.
brd_arrow.gifbrd_arrow.gif proration_remaining_days long Deprecated (Deprecated) Prorated days of period in this invoice.
brd_arrow.gifbrd_arrow.gif proration_description string Deprecated (Deprecated) Prorated invoice description.
brd_arrow.gifbrd_arrow.gif proration_result_total double plan proration total amount.
brd_arrow.gifbrd_arrow.gif proration_amount double Proration amount.
brd_arrow.gifbrd_arrow.gif proration_tax_charges double Proration tax charges.
brd_arrow.gifbrd_arrow.gif proration_tax_credits double Tax credits applied as a result of proration.
brd_arrow.gifbrd_arrow.gif proration_surcharge_amount double Surcharge amount applied as a result of proration.
brd_arrow.gifbrd_arrow.gif proration_credit_amount double The non-tax pro-rated credit amount
brd_arrow.gifbrd_arrow.gif proration_start_date string Start date of the time period used for calculating proration.
brd_arrow.gifbrd_arrow.gif proration_end_date string End date of the time period used for calculating proration.
billing_groups_updated hash  
brd_arrow.gif billing_group_no long The unique identifier of the billing group.
brd_arrow.gif client_billing_groups_id string The client-defined identifier of the billing group.
brd_arrow.gif primary_payment_method_no long Primary payment method ID.
brd_arrow.gif primary_client_payment_method_id string Client-defined unique identifier of the primary payment method.
brd_arrow.gif backup_payment_method_no long Backup payment method ID.
brd_arrow.gif backup_client_payment_method_id string Client-defined unique identifier of the backup payment method'
brd_arrow.gif billing_group_operation long The billing group number mapped against each master plan.
dunning_groups_updated hash  
brd_arrow.gif dunning_group_no long The dunning group number mapped against each master plan.
brd_arrow.gif client_dunning_groups_id string The client-defined dunning group ID mapped against each master plan.
brd_arrow.gif dunning_group_operation long If a collection is attempted, returns the error code associated with the collection.
multi_plan_invoice_details hash  
brd_arrow.gif billing_group_no long The unique identifier of the billing group.
brd_arrow.gif client_billing_group_id string The client-defined identifier of the billing group.
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif proc_cvv_response string The processor return code from CVV validation.
brd_arrow.gif proc_avs_response string Processor return code from address validation.
brd_arrow.gif proc_cavv_response string The processors return code for security validation.
brd_arrow.gif proc_status_code string The processor status code
brd_arrow.gif proc_status_text string The processors status description.
brd_arrow.gif proc_payment_id string The processor payment ID.
brd_arrow.gif proc_auth_code string Authorization code provided by the issuing bank.
brd_arrow.gif proc_merch_comments string Additional information passed to payment processor.
brd_arrow.gif invoice_charges_before_tax double Total charges on this invoice before taxes are applied.
brd_arrow.gif invoice_tax_charges double Total amount of taxes charged.
brd_arrow.gif invoice_charges_after_tax double Subtotal combining the total pre-tax charges and the total taxes charged.
brd_arrow.gif invoice_credit_before_tax double Credit to be applied before tax is taken into account.
brd_arrow.gif invoice_tax_credits double Tax amount of the credit to be applied to the account.
brd_arrow.gif invoice_credits double Credit to be applied after tax is taken into account.
brd_arrow.gif invoice_total_amount double The total owed on the initial invoice for this account.
brd_arrow.gif expectd_activation_fee double Predicted activation fee based on activation fee charges on supplemental plans on this invoice.
brd_arrow.gif expectd_mthly_recurring_cost double Predicted monthly recurring cost of the items and plans on this invoice.
brd_arrow.gif expectd_annu_recurring_cost double Predicted annual recurring cost of the items and plans on this invoice.
brd_arrow.gif invoice_item_details hash  
brd_arrow.gifbrd_arrow.gif invoice_line_no long The line number on the invoice
brd_arrow.gifbrd_arrow.gif line_type long Specifies the type of charge or credit associated with this line item.
brd_arrow.gifbrd_arrow.gif plan_no long The unique ID plan this line represents.
brd_arrow.gifbrd_arrow.gif client_plan_id string The client-defined unique ID for plan this line represents.
brd_arrow.gifbrd_arrow.gif plan_name string the name of the service plan this line represents.
brd_arrow.gifbrd_arrow.gif service_no long The unique ID for the service this line represents.
brd_arrow.gifbrd_arrow.gif client_service_id string The client-defined unique ID for the service this line represents.
brd_arrow.gifbrd_arrow.gif service_name string The name of the service this line represents
brd_arrow.gifbrd_arrow.gif service_is_tax_ind long Whether or not this line item represents a tax charge.
brd_arrow.gifbrd_arrow.gif plan_instance_no long The unique identifier of the plan instance this line represents.
brd_arrow.gifbrd_arrow.gif client_plan_instance_id string The client-defined identifier of the plan instance this line represents.
brd_arrow.gifbrd_arrow.gif line_units double Number of units for the specified invoice line.
brd_arrow.gifbrd_arrow.gif rate_per_unit double The monetary rate per unit of service.
brd_arrow.gifbrd_arrow.gif line_amount double The total line amount for this invoice line.
brd_arrow.gifbrd_arrow.gif line_base_units double Specifies the full, non-prorated number of units of the service code.
brd_arrow.gifbrd_arrow.gif proration_factor double Specifies the percentage of the line_base_units billed.
brd_arrow.gifbrd_arrow.gif line_description string Specifies the description of this line item
brd_arrow.gifbrd_arrow.gif start_date_range string Specifies the start date of the date range covered by this line item.
brd_arrow.gifbrd_arrow.gif end_date_range string Specifies the end date of the date range covered by this line item.
brd_arrow.gifbrd_arrow.gif usage_type_no long The usage type code associated with this line item.
brd_arrow.gifbrd_arrow.gif usage_type_cd string The usage type code of the usage type specified.
brd_arrow.gifbrd_arrow.gif service_coa_id long The Chart of Accounts ID for the service this line represents.
brd_arrow.gifbrd_arrow.gif client_service_coa_code string The client-defined Chart of Accounts code for the service this line represents
brd_arrow.gifbrd_arrow.gif ref_charge_line_no long The reference charge line number to indicate the item to which the discount applies.
brd_arrow.gifbrd_arrow.gif nso_order_no long The unique identifier for an order that is created for bundled NSOs.
brd_arrow.gifbrd_arrow.gif nso_order_status_label string Status label for this order
brd_arrow.gifbrd_arrow.gif client_sku string Client SKU of the NSO/Inventory item.
brd_arrow.gifbrd_arrow.gif item_no long The inventory item number for this line item.
brd_arrow.gifbrd_arrow.gif client_item_id string The client-defined item ID for this line item.
brd_arrow.gifbrd_arrow.gif credit_coupon_code string Specifies the coupon code applied to the invoice.
brd_arrow.gifbrd_arrow.gif credit_reason_code_description string The long description of the credit reason code which was applied, if any.
brd_arrow.gifbrd_arrow.gif csr_comments string The manually-entered CSR comments, if any
brd_arrow.gifbrd_arrow.gif adv_billing_period_total_days long Total days of period in this invoice
brd_arrow.gifbrd_arrow.gif rate_schedule_no long Aria-assigned unique rate schedule number
brd_arrow.gifbrd_arrow.gif rate_schedule_tier_no long Sequential number in the rate schedule for determining tiers
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif 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.
brd_arrow.gifbrd_arrow.gif proration_text string Specifies the prorated days in total days.
brd_arrow.gifbrd_arrow.gif proration_remaining_days long Prorated days of period in this invoice.
brd_arrow.gifbrd_arrow.gif proration_description string Prorated invoice description.
brd_arrow.gif tax_details hash  
brd_arrow.gifbrd_arrow.gif tax_detail_line long Line number associated with each tax detail record.
brd_arrow.gifbrd_arrow.gif seq_num long The tax line on the invoice which includes the tax amount associated with this tax_detail_line.
brd_arrow.gifbrd_arrow.gif taxed_seq_num long The invoice line item for which the tax for this tax_detail_line was calculated.
brd_arrow.gifbrd_arrow.gif debit double Amount of tax applied for the given tax type.
brd_arrow.gifbrd_arrow.gif tax_authority_level long Tax jurisdiction code: 0 = Federal, 1 = State / Province.
brd_arrow.gifbrd_arrow.gif tax_rate double Rate at which tax is calculated for the tax type used by the tax engine.
brd_arrow.gifbrd_arrow.gif orig_was_tax_inclusive long Indicates whether or not the invoice line amount was tax inclusive.
brd_arrow.gifbrd_arrow.gif tax_srv_tax_type_id string Identifier of the tax type returned by the tax engine.
brd_arrow.gifbrd_arrow.gif tax_srv_tax_type_desc string Description of the tax type returned by the tax engine.
brd_arrow.gifbrd_arrow.gif tax_srv_cat_text string Category of the tax type returned by the tax engine.
brd_arrow.gifbrd_arrow.gif tax_srv_juris_nm string Jurisdiction name returned by the tax engine.
brd_arrow.gifbrd_arrow.gif tax_srv_tax_sum_text string Invoice summary text returned by the tax engine.
brd_arrow.gifbrd_arrow.gif 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."

brd_arrow.gifbrd_arrow.gif 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."

brd_arrow.gifbrd_arrow.gif 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."

brd_arrow.gifbrd_arrow.gif 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
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method. (DEPRECATED ARRAY)
brd_arrow.gif bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. (DEPRECATED ARRAY)
billing_contact_details_2 hash  
brd_arrow.gif payment_method_no long Aria-assigned sequence number for this payment method.
brd_arrow.gif bill_contact_no long The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.
statement_contact_details hash DEPRECATED
brd_arrow.gif billing_group_no long The Aria-assigned unique identifier for the billing group on the account. (DEPRECATED ARRAY)
brd_arrow.gif 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  
brd_arrow.gif billing_group_no long The Aria-assigned unique identifier for the billing group on the account.
brd_arrow.gif 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
brd_arrow.gif other_contact_no long The Aria-assigned unique identifier for the contact saved on the account. (DEPRECATED ARRAY)
brd_arrow.gif other_contact_idx long Value provided for the idx parameter in the API request. (DEPRECATED ARRAY)
other_contact_details_2 hash  
brd_arrow.gif other_contact_no long The Aria-assigned unique identifier for the contact saved on the account.
brd_arrow.gif 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.
brd_arrow.gif error_class string Type of error code being represented, such as taxation
brd_arrow.gif error_code string Error code returned by the third party system
brd_arrow.gif 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.