bulk_record_usage_m

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

To specify the account to which a usage record is associated, you can specify a value for either account- or plan-instance-specific fields. That is, you can either:

• send the account-specific fields acct_no, user_id, or client_acct_id to associate the usage record with a specific account; OR
• send the plan-instance-specific fields plan_instance_no or client_plan_instance_id to associate the usage record with a specific account.

Sending both an account- and a plan-instance-specific field value is also supported, provided the combination is valid.

For information on error messages generated by this API, see bulk_record_usage_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.
Start of usage_recs array
	usage_recs	array
	Field Name	Field Type	Max Length	Description
	acct_no	long	22	Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
	OR
	userid	string	32	The user id of the account holder for whom this API call is reporting usage.
	OR
	client_acct_id	string	50	Client-defined account identifier.
	OR
	plan_instance_no	long	22	The Aria-assigned unique identifier of the plan instance.
	OR
	client_plan_instance_id	string	100	Unique client-defined identifier for the plan instance.
	master_plan_instance_no	long	22	The Master Subscription plan instance number.
	client_master_plan_instance_id	string	100	Client-defined Master plan Subscription plan instance ID.
	usage_type	long	22	The Aria-assigned usage type to be recorded. A value for either this field or 'usage_type_code' must be passed into the API to denote which usage type to record.
	OR
	usage_type_code	string	30	A value for either this field or 'usage_type' must be passed into the API to denote which usage type to record.
	usage_units	double	10	The number of usage units that are being recorded.
	usage_date	string	19	The date that the recorded usage was consumed, in yyyy-mm-dd hh24:mi:ss format. Timestamp is optional and, if not included, will default to 00:00 hrs.
	billable_units	double	10	The number of usage units being recorded that are billable.
	amt	double	12	A pre-specified amount to charge for the usage record reported. If specified, Aria will use this amount to charge for the usage, rather than calculating a charge based on the rate schedule associated with the usage-based service associated with the usage type.
	rate	double	12	The rate per unit of the usage reported. If specified, this rate will override rates based on the rate schedule associated with the usage_based service associated with the usage type.
	telco_from	string	100	A string representing a descriptive data field for the usage record. Originally used to specify the phone number of a caller.
	telco_to	string	100	A string representing a descriptive data field for the usage record. Originally used to specify the phone number called.
	comments	string	300	A string with comments about this usage record.
	exclude_from_billing	string	5	A flag that specifies whether or not this usage record should be excluded from billing (neither generating a charge nor appearing on a statement).   Allowable Values Allowable values for exclude_from_billing Values Description true true false false
	exclusion_comments	string	300	A string with comments about why this usage record was excluded from billing.
	parent_usage_rec_no	long	22	The Aria-assigned parent usage record identifier for a child account.
	qualifier_1	string	300	Client-defined string of any value meant for internal use and/or display to customers in statements.
	qualifier_2	string	300	Client-defined string of any value meant for internal use and/or display to customers in statements.
	qualifier_3	string	300	Client-defined string of any value meant for internal use and/or display to customers in statements.
	qualifier_4	string	300	Client-defined string of any value meant for internal use and/or display to customers in statements.
	client_record_id	string	50	Client-provided identifier for a given usage record.
	caller_id	string	50	Client-provided unique identifier for the calling user or system.
End of usage_recs array
	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.
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
	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.
End of optional_transaction_qualifiers array

 

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