Req | Field Name | Field Type | Max Length | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||
![]() |
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. | |||||||
![]() |
dunning_group_no | long | 22 | The unique identifier of the dunning group. | ||||||
OR | ||||||||||
client_dunning_group_id | string | 100 | The client-defined identifier of the dunning group. | |||||||
new_client_dunning_group_id | string | 100 | Client-defined unique identifier for dunning group | |||||||
dunning_group_name | string | 100 | Dunning Group name | |||||||
dunning_group_description | string | 1000 | Dunning group description | |||||||
dunning_process_no | long | 22 | Dunning Process code
Note:This input field can be updated to null when running this API. |
|||||||
OR | ||||||||||
client_dunning_process_id | string | 100 | Client-defined dunning process identifier. | |||||||
dunning_group_directive | long | 1 | Directive to update / disable the specified dunning group \
|
|||||||
Start of master_plans_summary array | ||||||||||
master_plans_summary | array | Array of master plan numbers associated with the input dunning group or plan instance | ||||||||
Field Name | Field Type | Max Length | Description | |||||||
![]() |
long | 22 | List of master plan instances to be associated with the dunning group. | |||||||
OR | ||||||||||
![]() |
string | 100 | Note that if any master plan in the specified dunning group is in dunning, new master plans cannot be added to the dunning group. Similarly, if a master plan associated with a different dunning group is in dunning, it cannot be moved into a different dunning group. | |||||||
End of master_plans_summary 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 | |||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||
![]() |
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. |
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. |