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

 

Home > Aria6 core api > bulk_record_usage

bulk_record_usage

Creates bulk usage records for a specified client for inclusion in a future invoice. This API should not be used unless there are more than 100 records being inserted for performance reasons.

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.
usage_records array
acct_no long An array containing acct_no(s)
userid string 100 An array containing userid(s)
usage_type 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
usage_type_code string 30 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.
usage_units double 10 An array containing usage_type(s)
usage_date string An array containing usage_date(s)
billable_units double 10 An array containing billable_units
amt double 38 An array containing amounts
rate double 38 An array containing rates
telco_from string 100 An array containing telco_from(s)
telco_to string 1000 An array containing telco_to(s)
comments string An array containing comments
exclude_from_billing string 5 An array containing exclude_from_billing(s)   Allowable Values
exclusion_comments string 300 An array containing exclusion_comments
parent_usage_rec_no long 1000 An array containing parent_usage_rec_no(s)
qualifier_1 string 300 An array containing qualifier_1(s)
qualifier_2 string 300 An array containing qualifier_2(s)
qualifier_3 string 300 An array containing qualifier_3(s)
qualifier_4 string 300 An array containing qualifier_4(s)
client_record_id string 50 An array containing client_record_id(s)
caller_id string 50 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 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.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

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.
error_records hash If client record IDs are provided, an array of error codes and error messages for individual records
out_client_record_id string If a record ID was provided in the input, this is that same ID for every record which had an error
acct_no long Aria-assigned account identifier specific to the usage record which had an error.
record_error_code long The error code for the specific record provided
record_error_msg string The error message for the specific record provided

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.