Skip to main content
Aria Knowledge Central

get_unapplied_service_credits_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_unapplied_service_credits_m
Class account_services_m
Update Version 23

Description

For a specified account or master plan instance, this call returns all service credits whose credit amounts have not yet been fully applied.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
master_plan_instance_no long 22 No

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
unapplied_service_credits_details object   No

A multidimensional array of service credit records for the given account

See fields below

unapplied_service_credits_details.eligible_service_types fields

Name Type Length Required Description
eligible_service_types string 2 No

Service type code for which the credit is applicable.

Allowed values:

Value Description
RC Recurring Service
US Usage Service
TX Tax Service
AC Activation Service
MS Miscellaneous Service
CN Cancellation Service
OR Order Based Service
MN Minimum Fee Service

unapplied_service_credits_details.eligible_plan_instance_details fields

Name Type Length Required Description
plan_instance_no long 22 No

The plan instance number that is eligible to apply this credit.
client_plan_instance_id string 100 No

The client defined plan instance identifier.
plan_instance_service_no long 22 No

The service number associated with the plan instance that is eligible to apply this credit.
client_plan_instance_service_id string 100 No

The client defined identifier for the service associated with this plan instance.

unapplied_service_credits_details.eligible_service_plan_details fields

Name Type Length Required Description
plan_no long 22 No

The plan numbers that is eligible to apply this credit.
plan_name string 100 No

The name of the eligible plan.
service_no long 22 No

The service number associated with the plan that is eligible to apply this credit
service_name string 100 No

The name of the eligible service.
client_plan_id string 100 No

The client defined plan identifier.
client_service_id string 100 No

The client defined identifier for the service associated with this plan

unapplied_service_credits_details fields

Name Type Length Required Description
credit_id long   No

Note: This field is deprecated. Aria no longer supports credit_id.
create_date string   No

Date the credit was created
create_user string   No

User who created the credit
initial_amount double   No

Full starting amount of the credit
amount_left_to_apply double   No

Amount remaining of the total credit to apply
reason_cd long   No

Reason code for why the credit was created

Allowed values:

Value 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
12 Prepay Code Redemption
21 Billing Issue
22 Demo/Partner Account
23 Duplicate Charge
24 Employee Account
25 Pricing Issue
26 Return (RMA) Broken
27 Return (RMA) Cancel
28 Return (RMA) Wrong Product
29 Service Issue
30 Shipping Credit
31 Test Account
32 Refer-a-Friend
95 Client-defined automatic "form of payment discount"
96 Order Item Unit Credit
97 New Service Plan Proration
98 Prepay Credit Reconciliation
99 Balance Forward Conversion
1004 Pricing
1005 Service Error
1006 Hardware Malfunction
1007 Goodwill
1008 Billing Error
1009 Development
1010 Shipping Error
1011 Promotion
1012 System Testing
1013 Sales Rep Error
1014 Commission
1015 Operations Error
9999 Coupon Application
reason_text string   No

Text description for why the credit was created
comments string   No

Comments from the create_user when the credit was created.
currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
service_no_to_apply long   No

The service_no that will be used to represent the credit when it is applied.
service_name_to_apply string   No

The name/description for "/service_no_to_apply/".
eligible_plan_no long   No

Note: This field is deprecated. Aria no longer supports eligible_plan_no.
eligible_plan_name string   No

Note: This field is deprecated. Aria no longer supports eligible_plan_name.
eligible_service_no long   No

Note: This field is deprecated. Aria no longer supports eligible_service_no.
eligible_service_name string   No

Note: This field is deprecated. Aria no longer supports eligible_service_name.
client_service_id_to_apply string 100 No

The client_service_id that will be used to represent the credit when it is applied.
client_eligible_plan_id string 100 No

Note: This field is deprecated. Aria no longer supports client_eligible_plan_id.
client_eligible_service_id string 100 No

Note: This field is deprecated. Aria no longer supports client_eligible_service_id.
amount_reserved_for_anniversary double   No

Amount reserved for anniversary invoice
eligible_service_types object   No

A list of eligible service types

See fields below
out_acct_no long 22 No

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_master_plan_instance_no long 22 No

The Master Subscription plan instance number.
out_client_mp_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.
credit_id_2 long   No

Aria-assigned unique identifier
eligible_plan_instance_details object   No

See fields below
eligible_service_plan_details object   No

See fields below
svc_credit_source_invoice_no long   No

The invoice number where the original charge (against which service credit is being created) was billed.
svc_credit_source_line_no long   No

The sequence number of the original line item against which service credit is created.
svc_credit_source_trans_id long   No

TThe transaction number of the original line item against which service credit is created.
svc_credit_source_service_type string 2 No

The transaction type of the original line item against which service credit is created. This is to to indicate whether the original line was a tax line item or any other charge (e.g., recurring/ usage etc.) i.e RC, TX etc.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.