Summary

API Name	modify_acct_supp_fields_m
Class	account_services_m
Update Version	34

Description

Updates or deletes one or more supplemental fields and/or values associated with a specified account. This call honors any requirements for minimum and maximum number of values. In addition, this call does not delete required supplemental fields.

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
acct_supp_fields	object		No	Array of supplemental field values to be updated. This array contains three sub-arrays: supp_field_names, supp_field_values, and supp_field_directives. The first value in each sub-array is automatically associated with the first values in the other sub-arrays, as are the second values, third values and so on. Each sub-array must contain the same number of values, or the API fails. See fields below
client_acct_id	string	50	Yes	Client-defined account identifier. Alternative required field: acct_no

acct_supp_fields fields

Name

Type

Length

Required

Description

supp_field_name

string

100

Yes

Pipe-delimited array of supplemental field names. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.

supp_field_value

string

300

No

Pipe-delimited array of supplemental field values.

supp_field_directive

long

1000

No

Pipe-delimited array of supplemental field directives.

Allowed values:

Value	Description
1	Add the supplemental field and value to the account.
2	Replace all instances of the supplemental field with the given value.
3	Remove the supplemental field and value. If the supplemental field exists with values other than the one given, those will remain untouched.
4	Remove all instances of the supplemental field. Any given value is ignored.

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.