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. |
![]() | invoice_no | long | 22 | The unique identifier of a given invoice. |
![]() | amount | double | 22 | The amount to writeoff/dispute. |
![]() | reason_code | long | 22 | Reason code to writeoff/dispute. |
![]() | comments | string | 22 | Comments to writeoff/dispute. |
do_dispute | long | 22 | Specifies whether to dispute or not. Allowable Values | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions. | |
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. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
![]() | 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. | |
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. |
rec_no | long | Write-off/dispute record number. |
created_by | string | Write-off/dispute creator name. |
amount | double | Write-off/dispute amount. |
invoice_no | long | The unique identifier of a given invoice. |
invoice_date | string | Invoice date. |
invoice_amt | double | Invoice amount. |
dispute_creation_date | string | Dispute created date. |
dispute_exp_date | string | Dispute expiration date. |
comments | string | Write-off/dispute comments. |
reason_code | long | Write-off/dispute reason code. |
secondary_reason_code | long | Dispute reason code. |
dispute_ind | long | Specifies Write-off or dispute. Allowable Values |
can_unsettle | string | Specifies if this dispute can be unsettled. |