Home > Aria6 User Documentation > Aria6 core api > record_usage

record_usage

Creates a usage record for for a specified account for inclusion in a future invoice.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  userid string 32 Client(or user)-assigned account identifier. If "acct_no" is not provided, must correctly identify the account to which the given usage record is to be assigned. All usage records must identify either an "acct_no" or a "userid".
required-icon.png usage_type long 38 Aria-assigned identifier for the type of usage being recorded. Either this field OR "usage_type_code" must be passed into the API to denote which usage type to record. Please consult Aria support representatives for a list of allowable usage_type values for the given client.
  OR      
  usage_type_code string 22 Client-assigned identifier for the type of usage being recorded. Either this field OR "usage_type" must be passed into the API to denote which usage type to record.
required-icon.png usage_units double 10 The volume of usage consumed by the account holder.
  usage_date string 24 The date the usage was consumed by the account holder.
  billable_units double 10 If the number of units of usage incurred differs from the number of units to be accrued for billing purposes, this fields provides for the optional designation of the billable units. If null, the number of units provided in "usage_units" will be billed.
  amt double 12 Optional currency value (with up to 2 positions after the decimal) denoting a specific total amount for which the account holder should be charged for this specific usage record. If this field (and field ""rate"") are null (the standard case) the system will aggregate the number of units on this usage record with all other usage records of the same type on this account within the same billing period at invoicing time and bill the account holder for the aggregate total per the rate structures defined by their applicable service plans.This field should not be used under normal circumstances."
  rate double 12 Optional currency value (with up to 5 positions after the decimal) denoting a specific amount per unit for which the account holder should be charged for each unit of usage denoted on this specific usage record. This field is ignored if a value is provided in field ""amt"". If this field (and field ""amt"") are null (the standard case) the system will aggregate the number of units on this usage record with all other usage records of the same type on this account within the same billing period at invoicing time and bill the account holder for the aggregate total per the rate structures defined by their applicable service plans. This field should not be used under normal circumstances."
  telco_from string 100 The unconstrained string identifying the "sender" of the message represented by this usage record. Intended for usage records that represent a telecom-based form of usage whereby the sender/originator and the recipient/terminator of the message/usage record are desired to be recorded as notational-only elements (e.g. a phone call whereby the "from" telephone number and the "to" telephone number are desired as notational elements). Does not effect assignment, categorization, rating, or billing/invoicing in any way.
  telco_to string 100 The unconstrained string identifying the "recipient" of the message represented by this usage record. Intended for usage records that represent a telecom-based form of usage whereby the sender/originator and the recipient/terminator of the message/usage record are desired to be recorded as notational-only elements (e.g. a phone call whereby the "from" telephone number and the "to" telephone number are desired as notational elements). Does not effect assignment, categorization, rating, or billing/invoicing in any way.
  comments string 300 Additional explanatory text relating to this API call.
  exclude_from_billing string 300 Determines whether or not the given usage record should be entirely and permanently excluded from inclusion in any future billing (invoicing) process. Setting this value to "true" results in the usage record being recorded for notational purposes only.  
Values Description
false false
true true
  exclusion_comments string 300 Free text comments intended to explain the decision to exclude this record from billing. Only honored/recorded if value passed to "exclude_from_billing" = "true".
  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.
  parent_usage_rec_no long 22 The Aria-assigned parent usage record identifier for a child account.
  client_record_id string 50 Client-provided identifier for a given usage record
  caller_id string 50 Client-provided unique identifier for a given account
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
usage_rec_no long Aria-assigned usage record identifier
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®