bulk_record_usage_m
Summary
| API Name | bulk_record_usage_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 57 |
Description
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.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| usage_recs | object | Yes | ||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions. |
usage_recs.precalc_tax_records fields
| Name | Type | Length | Required | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| precalc_tax_amt | double | 20 | Yes |
precalc_tax_amt |
||||||||||||||
| precalc_tax_rate | double | 20 | Yes |
precalc_tax_rate |
||||||||||||||
| precalc_taxable_amt | double | 20 | No |
precalc_taxable_amt |
||||||||||||||
| precalc_tax_jurisdiction_name | string | 100 | No |
precalc_tax_jurisdiction_name |
||||||||||||||
| precalc_tax_authority_level | long | 2 | No |
precalc_tax_authority_level Allowed values:
|
||||||||||||||
| precalc_tax_type_id | string | 100 | No |
precalc_tax_type_id |
||||||||||||||
| precalc_tax_type_desc | string | 1000 | No |
precalc_tax_type_desc |
||||||||||||||
| precalc_tax_category | string | 100 | No |
precalc_tax_category |
||||||||||||||
| precalc_tax_summary | string | 100 | No |
precalc_tax_summary |
usage_recs fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| acct_no | long | 22 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative field: userid or client_acct_id |
||||||
| userid | string | 32 | No |
The user id of the account holder for whom this API call is reporting usage. Alternative field: acct_no or client_acct_id |
||||||
| master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id |
||||||
| client_master_plan_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. Alternative field: master_plan_instance_no |
||||||
| plan_instance_no | long | 22 | No |
The Aria-assigned unique identifier of the plan instance. Alternative field: client_plan_instance_id |
||||||
| client_plan_instance_id | string | 100 | No |
Unique client-defined identifier for the plan instance. Alternative field: plan_instance_no |
||||||
| usage_type | long | 22 | No |
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. Alternative field: usage_type_code |
||||||
| usage_units | double | 10 | No |
The number of usage units that are being recorded. |
||||||
| usage_date | string | 19 | No |
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 | No |
The number of usage units being recorded that are billable. |
||||||
| amt | double | 12 | No |
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 | No |
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 | No |
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 | No |
A string representing a descriptive data field for the usage record. Originally used to specify the phone number called. |
||||||
| comments | string | 300 | No |
A string with comments about this usage record. |
||||||
| exclude_from_billing | string | 5 | No |
A flag that specifies whether or not this usage record should be excluded from billing (neither generating a charge nor appearing on a statement). Allowed values:
|
||||||
| exclusion_comments | string | 300 | No |
A string with comments about why this usage record was excluded from billing. |
||||||
| parent_usage_rec_no | long | 22 | No |
The Aria-assigned parent usage record identifier for a child account. |
||||||
| qualifier_1 | string | 300 | No |
Client-defined string of any value meant for internal use and/or display to customers in statements. |
||||||
| qualifier_2 | string | 300 | No |
Client-defined string of any value meant for internal use and/or display to customers in statements. |
||||||
| qualifier_3 | string | 300 | No |
Client-defined string of any value meant for internal use and/or display to customers in statements. |
||||||
| qualifier_4 | string | 300 | No |
Client-defined string of any value meant for internal use and/or display to customers in statements. |
||||||
| usage_type_code | string | 30 | No |
A value for either this field or 'usage_type' must be passed into the API to denote which usage type to record. Alternative field: usage_type |
||||||
| client_record_id | string | 100 | No |
Client-provided identifier for a given usage record. |
||||||
| caller_id | string | 50 | No |
Client-provided unique identifier for the calling user or system. |
||||||
| client_acct_id | string | 50 | No |
Client-defined account identifier. Alternative field: acct_no or userid |
||||||
| precalc_tax_inclusive | string | 5 | No |
Determines whether or not the usage amt includes the precalc tax amt. Setting this value to "true" means that the usage amt includes the pretax amt. Allowed values:
|
||||||
| precalc_tax_records | object | No |
Precalc tax records specific to usage records |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| error_records | object | No |
If client record IDs are provided, an array of error codes and error messages for individual records |
error_records fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| out_client_record_id | string | No |
If a record ID was provided in the input, this is that same ID for every record which had an error |
|
| acct_no | long | No |
Aria-assigned account identifier specific to the usage record which had an error. |
|
| record_error_code | long | No |
The error code for the specific record provided |
|
| record_error_msg | string | No |
The error message for the specific record provided |