Home > Aria6 User Documentation > Aria6 core api > create_advanced_service_credit
create_advanced_service_credit
create_advanced_service_credit
Creates a service credit on an account that can be applied to particular plans, services or service types, with a specified frequency, percentage or flat amount, and date range.
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. | ||||||||||||||||||||||
| amount | double | 12 | The amount of service credit to create on the account. | |||||||||||||||||||||||
| reason_code | long | 38 | The reason a given credt was/is to be applied to the account.
Allowable values for reason_code:
|
|||||||||||||||||||||||
| comments | string | 300 | Free form optional text up to 300 characters. For display within AdminTools when viewing all credit records on an account. | |||||||||||||||||||||||
| eligible_plan_no | long | If used, specifies the plan to which the credit is applied. The credit is applied to all services on this plan. If the credit is to be applied to offset ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the eligible_service_no field must be valued. | ||||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||
| client_eligible_plan_id | string | 100 | If used, specifies the plan to which the credit is applied. The credit is applied to all services on this plan. If the credit is to be applied to offset ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the client_eligible_service_id field must be valued.
If the eligible_plan_no field has a value in it, this field is ignored. |
|||||||||||||||||||||||
| eligible_service_no | long | 22 | If used, specifies the service to which the credit is applied. The service must exist in the plan specified in the eligible_plan_no field. If you value this field, you must also value the eligible_plan_no field with the plan ID that contains this service. If the credit to be created is to be applied to offset a specific type of charge, then that specific plan_no and service_no combination referencing that type of charge must be supplied in these two fields. Entering a service number in this field without entering its corresponding plan number causes the API to fail. | |||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||
| client_eligible_service_id | string | 100 | If used, specifies the client-defined service ID to which the credit is applied. The service must exist in the plan specified in the client_eligible_plan_id field. If you value this field, you must also value the client_eligible_plan_id field with the plan ID that contains this service. If the credit to be created is to be applied to offset a specific type of charge, then that specific plan_ID and service_ID combination referencing that type of charge must be supplied in these two fields. Entering a service ID in this field without entering its corresponding plan ID causes the API to fail. | |||||||||||||||||||||||
| alt_service_no_to_apply | long | 22 | Under default conditions, when a service credit on an account is consumed (resulting in negative line items attached to account invoices) the service_no value used by Aria on those invoice line items is the "universal" Aria service_no for service credits, specifically "0". This results in financial reports which group charges by service_no putting all consumed service credits into the same service_no 0 "bucket". If the client wishes for this credit, once consumed, to go into any other service_no "bucket", that service_no must be supplied in this field. Any Aria-standard or custom-to-client service number may be used. A common (but not required) use of this field is in conjunction with the eligible_plan_no/eligible_service_no fields described above, e.g.: Client offers plan_no XXXX with a recurring fee of service_no YYYY. A credit is attached to an account (which has plan XXXX) specifying these two values in the "eligible_" fields described above, which means that the credit will be consumed as an offset against and plan XXXX/service YYYY charges incurred by the account holder. Additionally, the client provides value YYYY in this field, which means that when the service credit is consumed the negative line item it creates on the account holder's invoice will use the same service no as the charge it offsets. If the amount of the recurring fee for plan XXXX/service YYYY is $10 (resulting in a positive line item of $10 with service YYYY on their invoice), and if the amount of the credit line item is $5 (resulting in a negative line item of -$2 with service YYYY on their invoice) the net result in any financial report that groups by service_no will be $8 (as opposed to $10 in service YYYY and -$2 in service 0). | |||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||
| client_alt_service_id_to_apply | string | 100 | Client-defined unique alternate service ID that is to be applied | |||||||||||||||||||||||
| frequency_no | long | 8 | Number of times the service credit should be applied to the account. This field must be blank if credit_expiry_type_ind is valued. | |||||||||||||||||||||||
| frequency_interval_months | long | 8 | Number of months between application of service credit to the account | |||||||||||||||||||||||
| initial_credit_date | string | 14 | Date on which the recurring service credit should start to be applied | |||||||||||||||||||||||
| percent_amount | double | 12 | The percent amount of the credit to be created for the account. For example if the account is to to receive a10% discount. | |||||||||||||||||||||||
| percent_eval_plan_no | long | 22 | The plan number against which to apply the percent discount. | |||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||
| client_percent_eval_plan_id | string | 100 | The client-defined unique plan ID against which to apply the percent discount. | |||||||||||||||||||||||
| percent_eval_service_no | long | The service to which the percent discount is to be applied. | ||||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||
| client_percent_eval_service_id | string | 100 | The service to which the percent discount is to be applied. | |||||||||||||||||||||||
 eligible_service_types |
string array | 2 | Service type code for which the credit is applicable.
Allowable values for eligible_service_types:
|
|||||||||||||||||||||||
| credit_expiry_type_ind | string | 1 | Indicator that determines whether the expiry is based on the number of months or a specific date. This field must be blank if the frequency_no field is valued.
Allowable values for credit_expiry_type_ind:
|
|||||||||||||||||||||||
| credit_expiry_months | long | 2 | Total months after which service credit expires. This field must be valued if the credit_expiry_type_ind contains an "M", otherwise it must be blank. | |||||||||||||||||||||||
| credit_expiry_date | string | 10 | The date on which credit expires. The date is in the format yyyy-mm-dd. This field must be valued if the credit_expiry_type_ind contains a "D", otherwise it must be blank. | |||||||||||||||||||||||
| eligible_service_plans | array | |||||||||||||||||||||||||
| plan_no |
long | If used, specifies the plan to which the credit is applied. The credit is applied to all services on this plan. If the credit is to be applied to offset ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the service_no field must be valued. | ||||||||||||||||||||||||
| service_no |
long | If used, specifies the service(s) to which the credit is applied. If you value this field, you must also value the corresponding plan_no field. If the credit to be created is to be applied to offset a specific type of charge, then that specific plan_no and service_no combination referencing that type of charge must be supplied in these two fields. | ||||||||||||||||||||||||
| client_eligible_service_plan_ids | array | |||||||||||||||||||||||||
| client_plan_id |
string | 100 | If used, specifies the plan(s) to which the credit is applied. If the credit is to be applied as an offset to ANY charge incurred by the account holder, leave this field empty. If the credit is to be applied to offset a specific type of charge, then this field and the client_service_id field must be valued. If you have entered any values in the plan_no field of the eligible_service_plans array, then this field and the client_service_id field in this array are ignored. | |||||||||||||||||||||||
| client_service_id |
string | 100 | If used, specifies the service to which the credit is applied. If you value this field, you must also value the client_plan_id field. If the credit to be created is to be applied to offset a specific type of charge, then that specific client_plan_id and client_service_id combination referencing that type of charge must be supplied in these two fields. | |||||||||||||||||||||||
| 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. | |||||||||||||||||||||||
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||||||||||||||||||
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
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. |
- © Copyright 2022 Aria Developer Central