Home > Aria Crescendo Documentation > Aria Crescendo core api > get_cash_credits_details_m

get_cash_credits_details_m

This API is used to return details of the cash credits on an account, or just for a given cash credit "transaction_id". This API also returns the charge details on which the cash credit is applied.

For error messages generated by this API. see get_cash_credits_details_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
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.
  transaction_id long 22 Unique transaction identifier for the cash credit.
  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.
cash_credits hash Array that contains cash credits.
brd_arrow.gif credit_no long the cash credit number
brd_arrow.gif created_by string User ID that created the transaction.
brd_arrow.gif created_date string Specifies the date that credit was created.
brd_arrow.gif amount double The amount of the cash credit.
brd_arrow.gif reason_code long Reason code for the cash credit.
brd_arrow.gif reason_text string Text description for the reason.
brd_arrow.gif origin_master_plan_instance_no long Master subscription plan instance number from which cash credit is originated.
brd_arrow.gif origin_client_mp_instance_id string The client defined MPI identifier.
brd_arrow.gif origin_plan_instance_no long Plan instance number from which cash credit is originated.
brd_arrow.gif origin_client_plan_instance_id string The client defined plan instance identifier.
brd_arrow.gif origin_plan_name string The name of the plan from which cash credit is originated.
brd_arrow.gif origin_proration_remaining_days string Days of unconsumed period that resulted in cash credit.
brd_arrow.gif origin_adv_billing_period_total_days string Proration period total days.
brd_arrow.gif origin_invoice_no long Aria-assigned unique identifier of a given invoice from which cash credit is originated.
brd_arrow.gif origin_service_no long Service number on an invoice from which cash credit is originated.
brd_arrow.gif origin_service_name string The name of the service. This also includes taxe service.
brd_arrow.gif origin_client_service_id string Client-defined unique identifier for service number.
brd_arrow.gif origin_plan_action_details string Plan changes (status (active to cancelled) or units downgrade) that resulted in cash credits.
brd_arrow.gif applied_cash_credits hash Array that contains cash credit application details.
brd_arrow.gif service_no long The service number for the cash credit application.
brd_arrow.gif service_name string The service name for the cash credit application.
brd_arrow.gif client_service_id string The Client-defined service number for the cash credit application.
brd_arrow.gif transaction_type long Transaction type to search account history for.   Allowable Values
brd_arrow.gif transaction_name string The transaction type for account level application of the cash credit.
brd_arrow.gif applied_transaction_id long The transaction number for account level application of the cash credit.
brd_arrow.gif applied_amount double The amount of the cash credit applied to the above.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.