Summary

API Name	edit_payment_plan_term_status_m
Class	administration_services_m
Update Version	73

Description

Updates the status (active/inactive) of one or more client-level payment plan terms

Inputs

Name

Type

Length

Required

Description

client_no

long

12

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

32

Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

payment_plan_term_no

long

No

One or more Aria-assigned unique identifiers for the payment plan terms to update. Required if client_payment_plan_term_id is not provided; cannot be combined with client_payment_plan_term_id. REST input arrays should be passed in the following format: payment_plan_term_no[]=101&payment_plan_term_no[]=102. In API Live, enter multiple values in a single field delimited by a pipe, e.g. 101|102.

Alternative field: client_payment_plan_term_id

client_payment_plan_term_id

string

100

No

One or more client-defined unique identifiers for the payment plan terms to update. Required if payment_plan_term_no is not provided; cannot be combined with payment_plan_term_no. REST input arrays should be passed in the following format: client_payment_plan_term_id[]=GOLD&client_payment_plan_term_id[]=SILVER. In API Live, enter multiple values in a single field delimited by a pipe, e.g. GOLD|SILVER.

Alternative field: payment_plan_term_no

status

int

Yes

The new status to set for the specified payment plan terms. Allowable values: 1 - active, 0 - inactive.

Allowed values:

Value	Description
1	Active
0	Inactive

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error
error_msg	string		No	Textual description of any error that occurred. "OK" if there was no error.