Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_writeoff_or_disputes_m


Retrieve the write-offs and disputes made on the account or master plan instance.

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.
  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.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  dispute_or_writeoff_flag long 22 Specifies if the API should return write off details or dispute details or both  

Allowable values for dispute_or_writeoff_flag:

Values Description
0 Return both write-off and dispute details
1 Return write-off details only
2 Return dispute details only
  details_flag long 22 Flag to indicate whether the API will return writeoff invoices or not.  

Allowable values for details_flag:

Values Description
0 Will not return writeoff invoices
1 Will return writeoff invoices
  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.
writeoff_dispute_info hash  
brd_arrow.gif rec_no long Write-off/dispute record number.
brd_arrow.gif created_by string Write-off/dispute creator name.
brd_arrow.gif created_date string write-off/dispute created date and format is yyyy-mm-dd hh24:mi:ss.
brd_arrow.gif amount double Write-off/dispute amount.
brd_arrow.gif invoice_no long The Aria-assigned unique identifier of a given invoice.
brd_arrow.gif invoice_date string Invoice date.
brd_arrow.gif invoice_amt double Invoice amount.
brd_arrow.gif writeoff_detail hash A multidimensional array containing the details of all writeoffs applied to an Aria account.
brd_arrow.gif invoice_no long The unique identifier of a given invoice.
brd_arrow.gif invoice_bill_date string The date the invoice was originally billed. The date is in the format yyyy-mm-dd.
brd_arrow.gif invoice_transaction_id long The line number that is written off.
brd_arrow.gif original_transaction_amount double The total invoice line item value that was originally billed.
brd_arrow.gif writeoff_transaction_amount double The amount written off from this specific line item.
brd_arrow.gif writeoff_transaction_start_date string The effective start date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd.
brd_arrow.gif writeoff_transaction_end_date string The effective end date of the original line item that is written off if it was a recurring fee service. The date is in the format yyyy-mm-dd.
brd_arrow.gif dispute_creation_date string Dispute create date
brd_arrow.gif dispute_exp_date string Dispute expiration date.
brd_arrow.gif reason_code long Write-off/dispute reason code.
brd_arrow.gif secondary_reason_code long Dispute reason code.
brd_arrow.gif comments string Write-off/dispute comments
brd_arrow.gif dispute_ind long Specifies Write-off or dispute.  

Allowable values for dispute_ind:

Values Description
0 Specifies it is write-off
1 Specifies it is dispute
brd_arrow.gif can_unsettle string Specifies if this dispute can be unsettled.
Last modified


This page has no custom tags.


This page has no classifications.