Skip to main content
Aria Knowledge Central

bulk_record_usage_m Guide

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>

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>

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.


 

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)


 

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
  • Was this article helpful?