Skip to main content
Aria Knowledge Central


Creates writeoff or dispute-hold for a given invoice.

For information on error messages generated by this API, see create_writeoff_or_dispute_m Error Messages.

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.
  client_acct_id string 50 Client-defined account identifier.
required-icon.png invoice_no long 22 The Aria-assigned unique identifier of a given invoice.
required-icon.png reason_code long 4

Reason code to writeoff/dispute.

Allowable values for reason_code:

comments string 300 Comments to writeoff/dispute.
  writeoff_date string 10 Date of writeoff/dispute
  do_dispute long 1

Specifies whether to dispute or not.

Allowable values for do_dispute:

  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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value 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.

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.
writeoff_transactions hash  
writeoff_transaction_id long Aria generated ID for the reversal transaction
invoice_no long The Aria-assigned unique identifier of a given invoice.
service_no long Aria generated unique service number
client_service_id string Client-defined Identifier for the service
original_amount double Original amount of the invoice transaction
amount double Writeoff/dispute amount for this transaction
date string Date of the writeoff/dispute
writeoff_reasoncode long Reason code, if any, on this writeoff
dispute_creation_date string Date of dispute creation
dispute_expiry_date string Dispute expiration date
dispute_ind long

Indicates whether a dispute or a writeoff

Allowable values for dispute_ind:

can_unsettle string

Specifies if this dispute can be unsettled.

Allowable values for can_unsettle:

  • Was this article helpful?