Home > Aria Crescendo Documentation > Aria Crescendo core api > modify_acct_supp_fields_m

modify_acct_supp_fields_m

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.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
Start of acct_supp_fields array
  acct_supp_fields array   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.
  Field Name Field Type Max Length Description
required-icon.png brd_arrow.gif supp_field_name string 100 List 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.
  brd_arrow.gif supp_field_value string 300 List of supplemental field values.
  brd_arrow.gif supp_field_directive long 1000

List of supplemental field directives.  

Allowable values for supp_field_directive: 

Values Description
1 Add the supplemental field and value to the account (default).
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.
End of acct_supp_fields array
 
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®