create_advanced_service_credit_m Guide

Last updated
Save as PDF

This API creates service credit in advance on an account or master plan instance.

API Specification:	create_advanced_service_credit_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>
Error Messages:	create_advanced_service_credit_m Error Messages

Additional Guidance:

Input Fields

Field Name:

Notes:

<reason_code>

Allowable values

Values	Description
1	General Credit/Other
2	Inadequate Service Delivery
3	Billing / Pricing Issue
4	Service no longer desired
5	Customer Dissatisfaction
6	Installation Issue
9	Customer Return
11	System Testing

<eligible_service_types>

Allowable values

Values	Description
RC	Recurring Service
US	Usage Service
TX	Tax Service
AC	Activation Service
MS	(DEPRECATED) Miscellaneous Service
CN	Cancellation Service
OR	Order Based Service
MN	Minimum Fee Service
RA	Recurring Arrears Service
SC	Surcharge Service

<credit_expiry_type_ind>

If you pass in a <credit_expiry_type_ind>, then <credit_expiry_period> is required.

Allowable values

Values	Description
M	Service credit expiration in months
W	Service credit expiration in weeks
Y	Service credit expiration in days
D	Service credit expiration on specific date

<credit_expiry_months>

You can pass in frequency_no, credit_expiry_months or credit_expiry_date (based on credit_expiry_type_ind), and frequency_interval_type to create a recurring service credit with an expiration month/date.

<credit_expiry_date>

You can pass in frequency_no, credit_expiry_months or credit_expiry_date (based on credit_expiry_type_ind), and frequency_interval_type to create a recurring service credit with an expiration month/date.

The expiration date must be after the application date of the last service credit applied based on your specified frequency_no. Example: If you create a service credit to be applied in the next 2 months, the expiration date must be more than 2 months away.

<frequency_interval_type>

You can pass in <frequency_no>, <credit_expiry_months>, or <credit_expiry_date> (based on <credit_expiry_type_ind>), and <frequency_interval_type> to create a recurring service credit with an expiration month/date.

If you pass 6 (weekly) or 7 (daily) into this field, then you must also pass in a <frequency_interval_length>.

Allowable values

Values	Description
1	Monthly
2	Bi-monthly
3	Quarterly
4	Semi-annually
5	Annually
6	Weekly
7	Daily

<credit_expiry_period>

To specify the credit expiration, pass a value into this field and the <credit_expiry_type_ind> field.

Example: If you pass Y (days) into the <credit_expiry_type_ind> field and 5 into the <credit_expiry_period> field, it means that the credit will expire 5 days after it is applied to an account.

This field is required if you passed in a <credit_expiry_type_ind>.
A specific date is not supported in this field. To specify the date on which a credit expires, use the <credit_expiry_date> field.

<frequency_interval_length>

Example: If you pass 4 into this field and 6 (weekly) into the <frequency_interval_type> field, then the service credit will be applied every 4 weeks.

This field is required if you passed 6 (weekly) or 7 (daily) into the <frequency_interval_type> field.

<service_code_option>

Allowable values

Values	Description
	If no value is entered in this field, the universal service will be used unless a value is entered in the alt_service_no_to_apply or client_alt_service_id_to_apply field. Then the referenced service will be used instead.
0	Aria's universal service will be used to apply this service credit which excludes taxes.
1	The service associated with this service credit can be selected using the alt_service_no_to_apply or client_alt_service_id_to_apply input fields. Tax handling for the service credit will reflect the settings for the service selected.
2	The service associated with this service credit will match the charge line item. This will result in tax handling that matches the original charge.