Aria-assigned unique identifier indicating the Aria client providing service to this account.

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative field: userid or client_acct_id

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".

Alternative field: acct_no or client_acct_id

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no

The unique identifier of the plan instance.

Alternative field: client_plan_instance_id

Unique client-defined identifier for the master plan instance.

Alternative field: plan_instance_no

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.

Alternative required field: usage_type_code

The volume of usage consumed by the account holder.

The date the usage was consumed by the account holder in the format yyyy-mm-dd hh24:mi:ss. The timestamp is optional and will default to 00:00 hrs.

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.

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."

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."

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.

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.

Additional explanatory text relating to this API call.

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.

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".

Client-defined string of any value meant for internal use and/or display to customers in statements.

Client-defined string of any value meant for internal use and/or display to customers in statements.

Client-defined string of any value meant for internal use and/or display to customers in statements.

Client-defined string of any value meant for internal use and/or display to customers in statements.

The Aria-assigned parent usage record identifier for a child account.

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.

Alternative required field: usage_type

Client-provided identifier for a given usage record

Client-provided unique identifier for the calling user or system.

Client-defined unique identifier used to track related system actions

Client-defined account identifier.

Alternative field: acct_no or userid

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.

Precalc tax records specific to usage records

See fields below

precalc_tax_amt

precalc_tax_rate

precalc_taxable_amt

precalc_tax_jurisdiction_name

precalc_tax_authority_level

precalc_tax_type_id

precalc_tax_type_desc

precalc_tax_category

precalc_tax_summary

Aria-assigned error identifier. 0 indicates no error.

Description of any error that occurred. "OK" if there was no error.

Aria-assigned usage record identifier