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 generated unique identifier for the account | |
OR | ||||
client_acct_id | string | 50 | This is the client-assigned identifier for the account. | |
plan_unit_inst_no | long | 22 | Aria unique Plan Unit Instance Number. | |
OR | ||||
client_plan_unit_inst_id | string | 22 | Client-assigned identifier for the plan unit instance. | |
new_client_plan_unit_inst_id | string | 22 | New client-assigned identifier for the plan unit instance, which will replace the existing client-assigned identifier currently on the plan unit instance.' | |
plan_unit_inst_services | array | This return value of array of plan unit instance. | ||
![]() | long | Aria service number (only for fulfillment based service) for which the fulfillment information needs to be modified. | ||
OR | ||||
![]() | string | 100 | Client-assigned identifier for the service. | |
![]() | string | It is a Fulfillment completion date. It can be in past, today or future date. | ||
![]() | long | 8 | This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on then plan unit instance. Allowable Values | |
plan_unit_inst_fields | array | Array of client-defined plan unit instance fields. | ||
![]() | string | Field name of plan unit instance field | ||
![]() | string | The value stored under this field | ||
![]() | long | 8 | The directive is mandatory if field name/value pair are specified. Allowable Values | |
do_write | string | Boolean indicator indicating whether the system should actually perform the fulfillment change. If 'false' is passed in this field then Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. 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. | |
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. |
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 | This is the client-assigned identifier for the account. |
out_plan_unit_inst_no | long | Aria unique Plan Unit Instance Number. |
out_client_plan_unit_inst_id | string | Client-assigned identifier for the plan unit instance. |
proration_result_amount | double | The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field will be a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillement based plan unit instance were to be actually assigned. |
invoice_no | long | The unique identifier of a given invoice. |
invoice_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 client defiend Service id for this plan. |
![]() | string | Client defined Plan ID |
![]() | long | The usage type code associated with this line item |
![]() | string | The long description of the credit reason code which was applied, if any |
![]() | string | The manually-entered CSR comments, if any |
![]() | string | The client-defined item identifier |
![]() | long | The unique identifier for an order in the context of an client_no and account_no. |
![]() | long | The unique ID of the item being retrieved |
![]() | string | An array containing usage_type_cd(s) to denote which usage type(s) to record. |
![]() | string | The unique client-defined item ID being retrieved. |
![]() | string | Specifies the prorated days in total days. |
![]() | long | Total days of period in this invoice. |
![]() | long | Prorated days of period in this invoice. |
![]() | string | Prorated invoice description. |
![]() | long | Aria-assigned unique rate schedule number |
![]() | long | Sequential number in the rate schedule for dertermining tiers |
collection_error_code | long | If a collection is attempted, returns the error code associated with the collection. |
collection_error_msg | string | The error message associated with collection_error_code. |
statement_error_code | long | The error code generated when attempting to create the statement resulting from this call, if any |
statement_error_msg | string | The text message associated with 'statement_error_code' |
proc_cvv_response | string | The processor return code from CVV validation. |
proc_avs_response | string | Processor return code from address validation |
proc_cavv_response | string | The processors return code for security validation. |
proc_status_code | string | The processor status code |
proc_status_text | string | The processors status description |
proc_payment_id | string | The processor payment id |
proc_auth_code | string | Authorization code provided by the issuing bank |
proc_merch_comments | string | Additional information passed to payment processor |
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 |
expectd_monthly_rec_cost | double | The predicted monthly recurring cost of the items and plans on this invoice |
expectd_annual_rec_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, such as taxation. |
![]() | string | Error code returned by the third-party system. |
![]() | string | Error message returned by the third party system. |