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. |
![]() | usage_recs | array | ||
![]() | long | An array containing acct_no(s) | ||
![]() | string | An array containing userid(s) | ||
![]() | long | The Master Subscription plan instance number. | ||
![]() | string | Client defined Master plan Subscription plan instance ID. | ||
![]() | long | The unique identifier of the plan instance. | ||
![]() | long | 38 | An array containing usage_type(s). Either this array OR 'usage_type_code' must be passed into the API to denote which usage type(s) to record. | |
OR | ||||
![]() | string | An array containing usage_type_code(s). Either this array OR 'usage_type' must be passed into the API to denote which usage type(s) to record. | ||
![]() | ![]() | double | An array containing usage_type(s) | |
![]() | string | An array containing usage_date(s) | ||
![]() | double | An array containing billable_units | ||
![]() | double | An array containing amounts | ||
![]() | double | An array containing rates | ||
![]() | string | An array containing telco_from(s) | ||
![]() | string | An array containing telco_to(s) | ||
![]() | string | An array containing comments | ||
![]() | string | An array containing exclude_from_billing(s) Allowable Values | ||
![]() | string | An array containing exclusion_comments | ||
![]() | long | An array containing parent_usage_rec_no(s) | ||
![]() | string | An array containing qualifier_1(s) | ||
![]() | string | An array containing qualifier_2(s) | ||
![]() | string | An array containing qualifier_3(s) | ||
![]() | string | An array containing qualifier_4(s) | ||
![]() | string | An array containing client_record_id(s) | ||
![]() | string | An array containing caller_id(s) | ||
client_receipt_id | string | 50 | Client defined unique identifier used to track related system actions | |
alt_caller_id | string | 100 | ||
optional_transaction_qualifiers | array | |||
![]() | string | 100 | ||
![]() | string | 100 |
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. |
error_records | hash | If client record IDs are provided, an array of error codes and error messages for individual records |
![]() | string | If a record ID was provided in the input, this is that same ID for every record which had an error |
![]() | long | The error code for the specific record provided |
![]() | string | The error message for the specific record provided |
Fill out the required input parameter to execute API Live. A Live call will be made against the URL you specify to give you actual results formatted.