Home > Aria6 User Documentation > Aria6 core api > get_recurring_credit_info

get_recurring_credit_info

Returns a list of recurring credits associated with a specified account.

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.
filter_credit_no long 22 The recurring credit number to use in order to filter results.
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.
recurring_credit_info hash
recurring_credit_no long The identifier for the recurring credit.
create_date string The date the recurring credit record was created.
create_user string The user who created the recurring credit record.
update_date string The date the recurring credit record was last updated.
update_user string The user who last updated the recurring credit record
first_credit_date string The first date that recurring credit was applied to the account.
last_credit_date string The last date that recurring credit will be applied to the account.
next_credit_date string The next date that a recurring credit will be applied to the account (assuming the last_credit_date has not passed)
credit_amount double The monetary amount of the credit to be applied for each iteration of the recurring credit sequence.
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
credits_completed long The number of credits that have been applied to the account
credits_remaining long The number of remaining credits to apply to the account
credit_interval_months long The interval (in months) between credits to the account
eligible_plan_no long The plan number that is eligible to apply recurring credit.
eligible_plan_name string The name of the eligible plan number.
eligible_service_no long The service number eligible for recurring credit
eligible_service_name string The name of the eligible service.
service_no_to_apply long The service number to apply the recurring credit to.
service_name_to_apply string The name of the service to apply the recurring credit to.
credit_status_cd long The status code for the recurring credit.
credit_status_label string The label for the recurring credit status code.
credit_reason_cd long The reason code for the application of credit toward the account specified  Allowable Values
credit_reason_text string The text description of the credit reason code.
comments string Free-form comments for the credit applied to the specified account.
cancel_date string The date the credit was cancelled (if any)
cancel_user string The user who cancelled the credit.
cancel_comments string Comments from the user who cancelled the credit
client_eligible_plan_id string The client-defined plan ID that is eligible to apply recurring credit.
client_eligible_service_id string The client-defined service ID eligible for recurring credit
client_service_id_to_apply string The client-defined service ID to apply the recurring credit to.
eligible_service_types hash A list of eligible service types
eligible_service_types string Service type code for which the credit is applicable.  Allowable Values
eligible_service_plan_details hash
plan_no long The plan numbers that is eligible to apply recurring credit.
plan_name string The name of the eligible plan number.
service_no long The service numbers eligible for recurring credit
service_name string The name of the eligible service.
client_plan_id string The client-defined plan IDs that is eligible to apply recurring credit.
client_service_id string The client-defined service ids eligible for recurring credit

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®