Skip to main content
Knowledge Central
Aria Knowledge Central

get_acct_credits_m

  1. Last updated
  2. Save as PDF
This API returns an array of all service and cash credits associated with the given account or all service credits associated with a master plan instance. In addition, this API also provides the option to limit number of records.

For information on error messages generated by this API, see get_acct_credits_m Error Messages.

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      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  limit_records long 22 An input to limit the number of records returning back.
  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  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.
all_credits hash  
out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_master_plan_instance_no long The Master Subscription plan instance number.
out_client_mp_instance_id string Client-defined Master plan Subscription plan instance ID.
credit_no long Aria-assigned unique identifier.
created_by string Specifies the user ID that created the transaction.
created_date string Specifies the date the credit was created.
amount double The amount of service credit to create on the account.
credit_type string

The type of credit: e.g. service or cash.

Allowable values for credit_type:

 
Values Description
S Service
C Cash
applied_amount double The amount of credit to be applied to the account.
unapplied_amount double Amount remaining of the total credit to apply to account.
reason_code long Reason code for why the credit was created.
reason_text string The text description of the credit reason code.
transaction_id long Unique transaction ID for this cash credit.
void_transaction_id long Unique transaction ID if cash credit was voided.
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.