create_writeoff_or_dispute_m Guide

Last updated
Save as PDF

Creates writeoff 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>

Error Codes:

Error Code/Description	Associated inputs
1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<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) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no>
1024: invalid date format Associated Inputs: 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 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 Associated Input: invoice_no	<invoice_no>
3024: Invalid reason code Associated Input: reason_code	<reason_code>
25020: Illegal characters entered Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.	All character field inputs like firstname lastname, dunning_group_name, comments, etc.
29013: Client Parameter, Dispute Hold Expiration Override Maximum Days, is invalid. Associated Input: expire_hold_days	<expire_hold_days>
29014: The value of Dispute hold override (Expire_Hold_Days) is invalid. Associated Input: expire_hold_days	<expire_hold_days>

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

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