Home > Aria6 User Documentation > Aria6 core api > get_acct_credits

get_acct_credits

Returns an array of all credits associated with the given account. Also provide option to limit number of records.

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.
  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.
  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.
acct_credits hash  
brd_arrow.gif credit_no long Aria-assigned unique identifier.
brd_arrow.gif created_by string Specifies the user ID that created the transaction.
brd_arrow.gif created_date string Specifies the date the credit was created.
brd_arrow.gif amount double The amount of service credit to create on the account.
brd_arrow.gif credit_type string The type of credit: e.g. service or cash.
brd_arrow.gif applied_amount double The amount of credit to be applied to the account.
brd_arrow.gif unapplied_amount double Amount remaining of the total credit to apply to account.
brd_arrow.gif reason_code long Reason code for why the credit was created.
brd_arrow.gif reason_text string The text description of the credit reason code.
brd_arrow.gif transaction_id long Unique transaction ID for this cash credit.
brd_arrow.gif void_transaction_id long Unique transaction ID if cash credit was voided.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.