Skip to main content
Aria Knowledge Central

cancel_unapplied_service_credits_m Guide

This API cancels all the unapplied service credits and any partially used recurring credits on an account or master plan instance.

API Specification:

cancel_unapplied_service_credits_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <credit_ids>
  • <acct_no> or <client_acct_id>

Error Codes:

Error Code/Description Associated Inputs

1001: unexpected error


 

1004: authentication error

Associated Inputs: auth_key, client_id, client_no


<auth_key>, <client_no>

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no


<acct_no>, <client_acct_id>

14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".

Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id

Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.


<master_plan_instance_no>, <client_master_plan_instance_id>

14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".

Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id


<client_master_plan_instance_id>

20028: Inputted credit id doesn't belong to Master Plan Instance

Associated Inputs:i credit_ids


<credit_ids>

20029: Inputted credit doesn't belong to account

Associated Inputs: credit_ids


<credit_ids>

20030: Provided credit id is invalid

Associated Inputs:i credit_ids


<credit_ids>

 

  • Was this article helpful?