create_writeoff_or_dispute_m Guide
- Last updated
-
-
Save as PDF
The create_writeoff_or_dispute_m API creates write-off or dispute-hold for a given invoice.
| API Specification: |
create_writeoff_or_dispute_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <invoice_no>
- <reason_code>
- <comments>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <reason_code> |
Allowable Values
| Values |
Descriptions |
| 1 |
Good Will |
| 2 |
Billing Error |
| 3 |
Sales Return |
| 4 |
Promotional Discount |
| 0 |
Bad Debt |
| 5 |
Other |
| 9001 |
Charge Dispute Hold |
| 9999 |
System-enforced conversion of dispute to permanent write-off |
|
| <do_dispute> |
Allowable Values
| Values |
Description |
| 0 |
Do write-off |
| 1 |
Do dispute |
|
| <writeoff_dispute_amount> |
- If omitted, the API defaults to writing off the full open amount.
- If provided, the amount is allocated down to the charge line level using bulk payment application logic. If the amount exceeds the maximum, Aria returns Error 3119 (see below).
- The maximum allowable amount (MAA) is defined as the net charge (NC)—calculated after Aria applies discounts and service credits to the original charge—minus any applied credit memos (CM).
MAA = NC − CM
- Dispute Allocation Logic: If the input amount exceeds the balance due, the dispute is applied first to unpaid lines, then triggers payment un-application based on FIFO order.
|
Output Fields
| Field Name |
Notes |
| <dispute_ind> |
Allowable Values
| Values |
Description |
| 0 |
Specifies it is write-off |
| 1 |
Specifies it is dispute |
|
| <can_unsettle> |
Allowable Values
| Values |
Description |
| True |
True |
| False |
False |
|
Error Codes
| Error Code/Description |
Associated inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_id>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
|
<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no> |
1015: duplicate record found
|
<line_no> |
1024: invalid date format
Additional Comments: All date inputs must be in yyyy-mm-dd format.
|
<bill_birthdate>, <birthdate>, <degrade_date>, <initial_credit_date>, <invoice_line_reversing_date>, <service_fulfillment_date>, <queue_date>, <start_bill_date>, <end_bill_date>, <start_date>, <end_date>, <stmt_birthdate>, <bill_birthdate> |
3004: Invoice does not exist
|
<invoice_no> |
3119: The input value in writeoff_dispute_amount field exceeds the invoice_disputable_amount.
|
<writeoff_dispute_amount> |
3024: Invalid reason code
|
<reason_code> |
29010: Invalid responsible acct_no or client_acct_id
|
<acct_no>, <client_acct_id> |
25020: Illegal characters entered
|
All character field inputs like firstname lastname, dunning_group_name, comments, etc. |
29013: Client Parameter, Dispute Hold Expiration Override Maximum Days, is invalid.
|
<expire_hold_days> |
29014: The value of Dispute hold override (Expire_Hold_Days) is invalid.
|
<expire_hold_days> |
