bulk_record_usage_m Guide

Last updated
Save as PDF

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.

API Specification:	bulk_record_usage_m
Required Fields:	<client_no> <auth_key> <usage_recs> (array) <acct_no> or <userid> or <client_acct_id> or <plan_instance_no> or <client_plan_instance_id> <usage_units>

Additional Guidance

Input Fields

Field Names

Notes

<usage_type>

When <usage_type> is specified in a call to this API, the "usage_rating_timing" flag value at the usage-type-level will be checked and correctly refer to the value defined at the client parameter setting "Automatically Rate Un-rated Usage Records at Load Time". A usage-type-level setting will override the client parameter.

<usage_field_name>
<usage_field_value>
<precalc_tax_inclusive>
<precalc_tax_amt>
<precalc_tax_rate>

These inputs are not honored unless you are using the following features:

Client-Defined Usage Fields:
If you use this feature, <usage_field_name> and <usage_field_value> are both required.
3rd-Party Pre-Calculated Tax at the Usage Record Level:
If you use this feature and provide a value for <precalc_tax_inclusive>, then the fields <precalc_Tax_amt> and <precalc_tax_rate> are required.

<exclude_from_billing> (<usage_recs> array)

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:

Values	Description
true	true
false	false

<precalc_tax_inclusive>

Allowable Values

Values	Description
false	true
true	true

<precalc_tax_records> (array)

<precalc_tax_authority_level>

Allowable Values

Values	Description
0	Federal
1	State/Province
2	County
3	City
4	Unincorporated Area
5	District

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<auth_key>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <client_acct_id>, <userid>
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo) Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id Alternate Message Output 1010: username is required 1010: first name is required 1010: last name is required 1010: email is required 1010: roles are required Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m Associated Inputs: username, first_name, last_name, email, role_no	<acct_no>, <client_acct_id>, <userid>
1016: invalid input, acct_no: (acct_no) is not a valid long, assignment_directive: (assignment_directive) is not a valid long, “billing_group_no: (billing_group_no) is not a valid long, threshold_billing_rule_no: (threshold_billing_rule_no) is not a valid long Associated Inputs: alt_service_no_to_apply, assignment_directive, auto_skip_to_next_bill_date, client_billing_group_id, custom_rate_service_no/custom_rate_client_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_service_no, eligible_plan_no, eligible_service_no, email, force_master_bill_date_reset, fulfillment_only, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, invoice_no, length_months, end_date, limit, limit_records, modify_directive, contract_plan_instances_update, modify_directive, contract_plan_instances_update, offset, percent_amount, percent_eval_plan_instance_no, client_percent_eval_plan_instance_id, percent_eval_service_no, client_percent_eval_service_id, phone_ext, work_phone_ext, plan_unit_inst_status_cd, plan_units, reason_code, start_date, end_date, start_date, end_date, status_cd, acct_no, assignment_directive, billing_group_no, threshold_billing_rule_no Additional Comments: This error can be caused by the wrong type of input, for example, text in a numbers-only field, an or specifying a value other than one of the documented allowable values. For the get_order_m API, this is the error code returned when the user passes an invalid order value for the <status_filter_cd> input which is other than the allowed values (0/null, 1, 2, 3, 4 and 5). For the bulk_cancel_order_m API, invalid input can occur with the <order_status_directive> argument. Allowed values are 0, 1, 2, 3, 4/null, 5 and 6. For the get_acct_coupon_details_m API, invalid input can occur with the <include_all_active> input parameter (values are 0, 1 or NULL). Alternate Message Output 1016: username cannot be longer than 30 characters 1016: first_name cannot be longer than 30 characters 1016: last_name cannot be longer than 30 characters Associated APIs: create_user_m, update_user_m Associated Inputs: username, first_name, last_name	<precalc_tax_inclusive>, <precalc_tax_auhority_level>
1024: invalid date format Associated Inputs: bill_birthdate, birthdate, degrade_date, initial_credit_date, invoice_line_reversing_date, service_fulfillment_date, queue_date, start_bill_date, end_bill_date, start_date, end_date, stmt_birthdate, bill_birthdate Additional Comments: All date inputs must be in yyyy-mm-dd format.	<usage_date>
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id". Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.	<plan_instance_no>, <client_plan_instance_id>
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id". Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id	<client_plan_instance_id>, <client_master_plan_instance_id>
14053: Invalid Master Plan Instance number Associated Inputs: master_plan_instance_no	<master_plan_instance_no>
14054: Invalid client Master Plan Instance identifier Associated Inputs: client_master_plan_instance_id	<client_master_plan_instance_id>
14071: Master Plan Instance information is missing Associated Inputs: plan_instance_no, client_plan_instance_id, master_plan_instance_no, client_master_plan_instance_id Additional Comments: Both plan_no and plan_id must be entered. Master Plan Instance is required if the invoice_no is not provided.	<master_plan_instance_no>, <client_master_plan_instance_id>
14125: Negative Usage not allowed for Usage-based services in which Usage Pooling is enabled unless pre-rated.
14126: Rate field cannot be negative if amt, billable_units, or usage_units are negative values.
14127: Amount cannot be positive if the billable/usage unit is negative.
14401: Negative Usage Records, unless pre-rated, are not allowed when the Rating Model rates usage on a ‘per record’ basis.
14402: Usage Pooling is not allowed when the Rating Model rates usage on a ‘per record’ basis.
20002: Usage Type or Usage Type Code must be entered
20002: Usage Type or Usage Type Code must be entered
20002: Usage Type or Usage Type Code must be entered
20002: Usage Type or Usage Type Code must be entered
20003: Invalid Usage Type Associated Inputs: specified_usage_type_no	<usage_type>
20004: Invalid Usage Type Code Associated Inputs: specified_usage_type_code	<usage_type_code>
20006: usage code or type not on active Plan
23020: Usage unit value is too large.
23021: Client record id cannot be blank Associated Inputs: client_record_id	<client_record_id>
23022: Client record id already exists Associated Inputs: client_record_id	<client_record_id>
23023: Client record id and usage type code already exists Associated Inputs: client_record_id, usage_type_code	<client_record_id>, <usage_type_code>
24381: Bulk errors Additional Comments: This message may be returned because of an internal system error. Please contact Aria Customer Support for assistance.
25000: Bulk usage loader completed with some error(s)