Skip to main content
Aria Knowledge Central

create_writeoff_or_dispute_m

  1. Last updated
  2. Save as PDF

Summary

API Name create_writeoff_or_dispute_m
Class transaction_services_m
Update Version 65

Description

Creates writeoff or dispute-hold for a given invoice.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
invoice_no long   Yes

The Aria-assigned unique identifier of a given invoice.
writeoff_date string 10 No

Date of writeoff/dispute
reason_code long 4 Yes

Reason code to writeoff/dispute.
do_dispute long 1 No

Specifies whether to dispute or not.

Allowed values:

Value Description
0 Do write-off
1 Do dispute
comments string 300 Yes

Comments to writeoff/dispute.
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions.
expire_hold_days long   No

This optional parameter, specified in days, is used to set the dispute expiry date. It will only be effective if the client parameter Dispute Hold Expiration Override Maximum Days has been set with a valid value and the value or expire_hold_days is between 2 and the number of days specified in Dispute Hold Expiration Override Maximum Days.
writeoff_dispute_amount double   No

Amount to be written off or disputed, inclusive of tax. Applicable only for self-pay account.
writeoff_invoice_line object   No

Array of invoice line of specified invoice number to be written off or disputed.

See fields below

writeoff_invoice_line fields

Name Type Length Required Description
line_no long   No

The sequential invoice line number that is disputed or written off.
writeoff_invoice_line_amount double   No

The invoice line amount to be written off or disputed, inclusive of tax.

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
writeoff_transactions object   No

See fields below

writeoff_transactions fields

Name Type Length Required Description
writeoff_transaction_id long   No

Aria generated ID for the reversal transaction
invoice_no long   No

The Aria-assigned unique identifier of a given invoice.
service_no long 22 No

Aria generated unique service number
client_service_id string   No

Client-defined Identifier for the service
original_amount double 22 No

Original amount of the invoice transaction
amount double 22 No

Writeoff/dispute amount for this transaction
date string   No

Date of the writeoff/dispute
writeoff_reasoncode long   No

Reason code, if any, on this writeoff
dispute_creation_date string   No

Date of dispute creation
dispute_expiry_date string   No

Dispute expiration date
dispute_ind long   No

Indicates whether a dispute or a writeoff

Allowed values:

Value Description
0 Specifies it is write-off
1 Specifies it is dispute
can_unsettle string   No

Note: This field is deprecated. Aria no longer supports can_unsettle.
account_no long   No

For parent pay invoices this will be child account number, for self-pay invoice this will be the self-pay account number.
line_no long   No

The sequential invoice line number that is disputed or written off.
original_line_amount double   No

Original amount of the invoice line after service credit and discount, exclusive of tax.
writeoff_dispute_line_amount double   No

The amount of write-off or dispute of invoice line, exclusive of tax.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.