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 | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
assignment_directive | long | 8 | Rule to apply to this assignment/de-assignment request, specifying: the date the assignment takes place (immediately or on the account's anniversary date), and the proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request). 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. Allowable Values | |
existing_supp_plan_no | long | 22 | Supplemental Plan number to be replaced by this action. | |
OR | ||||
client_existing_supp_plan_id | string | 100 | Client-defined Supplemental Plan ID to be replaced from this action. | |
new_supp_plan_no | long | 22 | New Supplemental Plan number that replaces the existing supplemental plan. | |
OR | ||||
client_new_supp_plan_id | string | 100 | Client-defined new Supplemental ID number to use as the replacement supplemental plan. | |
alt_rate_schedule_no | long | 22 | Alternative Rate Schedule Number. Unique identifier for an alternative rate schedule that can be assigned to the account in place of the default rate schedule. Used by CSR's to provide special compensation or discounts as incentives to account holders. | |
OR | ||||
client_alt_rate_schedule_id | string | 100 | Client-defined alternate rate schedule number to assign (if any). If none is specified, the default rate schedule number is used. | |
num_plan_units | long | 22 | Factor by which recurring fees for this plan are multiplied on future invoices. For example, a supplemental plan titled "Seats of XYZ Application" has a monthly flat cost of $10.00 per seat. To assign 5 seats, resulting in a monthly charge of $50.00 to the account, enter a value of 5 in this field. | |
coupon_code | string | 30 | Code of the coupon to which to apply the discount. If code is not valid for any reason, an appropriate error code is returned and the entire transaction (including the supplemental plan assignment and any possible invoice creation) is rolled back. | |
comments | string | 300 | Additional explanatory text relating to this API call. | |
do_write | string | 5 | Indicates whether to perform the requested plan assignment/de-assignment. If 'false' Aria will, if applicable, calculate any potential proration effect that would result and return that value in the output field 'proration_result_amount' without actually performing the requested operation or charging/crediting the account. Used for interfaces that return a 'confirmation page' informing of the effects of the requested operation before actually performing it. Allowable Values | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
offset_months | long | 8 | Number of months to add to the prorated period. | |
auto_offset_months_option | long | 1 | Automatically set offset months Allowable Values | |
alt_client_acct_group_id | string | 100 | One-time collections account group to use for this specific call. Default collections group on the account is not changed. | |
new_acct_custom_rates | array | Array of new custom rates. | ||
![]() |
long | Unique identifier for the plan to which this custom rate is to be applied for this account. | ||
OR | ||||
![]() |
string | 100 | Unique, client-defined identifier for the plan to which this custom rate is to be applied for this account. | |
![]() |
long | Unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account. | ||
OR | ||||
![]() |
string | 100 | Unique client-defined identifier for the service ID to determine which custom rate is to be applied for this account. | |
![]() |
long | Rate tier number to which this custom rate is to be applied. | ||
![]() |
long | 38 | Starting unit of a range of units to which this custom rate is to be applied. | |
![]() |
long | 38 | Ending unit of a range of units to which this custom rate is to be applied. | |
![]() |
double | 38 | Custom rate per unit. | |
effective_date | string | If the assignment directive is for a future date assignment, this is the date, in yyyy-mm-dd format, on which the plan change will be executed. If this field is NULL, then the plan change will not happen until it is manually executed or until the effective_date is updated. | ||
offset_interval | long | 1000 | If assigning a change on an anniversary day, the number of billing periods by which to delay that change | |
invoice_unbilled_usage | string | 5 | Specifies whether unbilled usage is invoiced. Allowable Values | |
sync_mstr_bill_dates_override | long | 4 | Overrides the client-level setting that determines whether master plan billing dates are reset when assigning a new supplemental plan. If this value is left empty, the client-level setting takes effect. Allowable Values | |
surcharge_no | array | |||
![]() |
long | Surcharge number to be attached to the plan | ||
![]() |
long | Schedule number for this surcharge | ||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. | |
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 | |
Start of proc_field_override array | ||||
![]() |
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 | |
![]() ![]() |
string | 2 |
If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information. This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).
Notes:
Aria will use this order of precedence to determine the transaction type:
|
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. | ||||||||||||||||||||
proration_result_amount | double | Currency amount of any proration action resulting from the requested plan change. For plan assignments with an assignment directive of '1' (perform on anniversary date), or '2' (honor client default proration action) when the default is no proration, or '3' (force no proration), this field always returns '0'. If proration is performed, the value r eturned is either a positive currency value (for a charge) or a negative currency value (for a credit). If do_write is false, then any positive or negative value returned in this field is notational only, showing the proration effect if the requested plan assignment/de-assignment was actually performed. | ||||||||||||||||||||
invoice_no | long | Unique identifier of a given invoice. | ||||||||||||||||||||
supp_plan_line_items | hash | |||||||||||||||||||||
![]() |
long | Specifies the sequential line number of this line item. Initial record value is always 1. | ||||||||||||||||||||
![]() |
long | Specifies the type of charge or credit associated with this line item.
|
||||||||||||||||||||
![]() |
long | Specifies the Aria-assigned unique service identifier. | ||||||||||||||||||||
![]() |
string | Specifies the name corresponding to this line item's service code. | ||||||||||||||||||||
![]() |
double | Specifies the number of units of this service code billed on this line item. On a prorated invoice, line_units = line_base_units X proration_factor. | ||||||||||||||||||||
![]() |
double | Specifies the rate per unit billed. | ||||||||||||||||||||
![]() |
double | Specifies the total charge associated with this line item. | ||||||||||||||||||||
![]() |
double | Specifies the full, non-prorated number of units of the service code. | ||||||||||||||||||||
![]() |
double | Specifies the percentage of the line_base_units billed. | ||||||||||||||||||||
![]() |
string | Specifies the description of this line item. | ||||||||||||||||||||
![]() |
string | Specifies the start date of the date range covered by this line item in yyyy-mm-dd format. | ||||||||||||||||||||
![]() |
string | Specifies the end date of the date range covered by this line item in yyyy-mm-dd format. | ||||||||||||||||||||
![]() |
string | Specifies the coupon code applied to the invoice. | ||||||||||||||||||||
![]() |
long | Specifies the Aria-assigned service plan number under which this line item was billed. | ||||||||||||||||||||
![]() |
string | Specifies the name of the service plan associated with the plan_no. | ||||||||||||||||||||
![]() |
string | A multidimensional array of client defiend Service id for this plan. | ||||||||||||||||||||
![]() |
string | Client defined Plan ID for which to query available child plans | ||||||||||||||||||||
total_charges_before_tax | double | Total amount to be charged to the account before taxes have been calculated. | ||||||||||||||||||||
total_tax_charges | double | Total taxes as calculated for the amount of the transaction. | ||||||||||||||||||||
total_charges_after_tax | double | Total amount to be charged to the account after taxes have been calculated. | ||||||||||||||||||||
total_credit | double | The total amount of the credit to be applied to the account | ||||||||||||||||||||
total_tax_credit | double | The tax amount of the credit to be applies | ||||||||||||||||||||
total_credit_before_tax | double | The credit to be applied before tax is taken into account | ||||||||||||||||||||
total | double | The grand total of this invoice | ||||||||||||||||||||
proration_credit_result_amount | double | The pro-rated credit amount for this invoice | ||||||||||||||||||||
proration_credit_amount | double | The pro-rated credit amount for this invoice | ||||||||||||||||||||
proration_tax_amount | double | The pro-rated tax credit amount for this invoice | ||||||||||||||||||||
expectd_activation_fee | double | The predicted activation fee based on activation fee charges on supplemental plans on this invoice | ||||||||||||||||||||
expectd_mthly_recurring_cost | double | The predicted monthly recurring cost of the items and plans on this invoice | ||||||||||||||||||||
expectd_annu_recurring_cost | double | The predicted annual recurring cost of the items and plans on this invoice | ||||||||||||||||||||
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. | ||||||||||||||||||||
![]() |
string | Type of error code being represented, such as taxation | ||||||||||||||||||||
![]() |
string | Aria-assigned error identifier. 0 indicates no error. | ||||||||||||||||||||
![]() |
string | Description of any error that occurred. "OK" if there was no error. | ||||||||||||||||||||
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. |