Home > Aria6 User Documentation > Aria6 core api > get_invoices_to_writeoff_or_dispute


Get eligible invoices to write-off or dispute. Return results include self-pay invoices with any balance due and child invoices with full balance due (only).

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

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.
invoice_details hash  
brd_arrow.gif invoice_no long The unique identifier of a given invoice.
brd_arrow.gif bill_date string Invoice bill date
brd_arrow.gif due_date string Invoice due date
brd_arrow.gif days_past_due long Number of days for due
brd_arrow.gif invoice_amount double Invoice amount
brd_arrow.gif total_paid double Total paid amount
brd_arrow.gif balance_due double Balance due amount
brd_arrow.gif invoice_type_cd string This field identifies the type of the invoice generated 

Allowable values for invoice_type_cd

Values Description
C Combined Invoice
F Anniversary Period Invoice
H Hybrid Invoice
O Order based Invoice
P Non-anniversary Subscription Invoice
R Rebill Invoice
Last modified


This page has no custom tags.


This page has no classifications.