Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_writeoff_or_disputes_m
get_acct_writeoff_or_disputes_m
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||
|
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. | |||||||||
| OR | ||||||||||||
| client_acct_id | string | 50 | Client-defined account identifier. | |||||||||
| master_plan_instance_no | long | 22 | The Master Subscription plan instance number. | |||||||||
| OR | ||||||||||||
| 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:
|
|||||||||
| details_flag | long | 22 | Flag to indicate whether the API will return writeoff invoices or not.
Allowable values for details_flag:
|
|||||||||
| 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. |
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 | |||||||
| rec_no |
long | Write-off/dispute record number. | ||||||
| created_by |
string | Write-off/dispute creator name. | ||||||
| created_date |
string | write-off/dispute created date and format is yyyy-mm-dd hh24:mi:ss. | ||||||
| amount |
double | Write-off/dispute amount. | ||||||
| invoice_no |
long | The Aria-assigned unique identifier of a given invoice. | ||||||
| invoice_date |
string | Invoice date. | ||||||
| invoice_amt |
double | Invoice amount. | ||||||
| writeoff_detail |
hash | A multidimensional array containing the details of all writeoffs applied to an Aria account. | ||||||
| invoice_no |
long | The unique identifier of a given invoice. | ||||||
| invoice_bill_date |
string | The date the invoice was originally billed. The date is in the format yyyy-mm-dd. | ||||||
| invoice_transaction_id |
long | The line number that is written off. | ||||||
| original_transaction_amount |
double | The total invoice line item value that was originally billed. | ||||||
| writeoff_transaction_amount |
double | The amount written off from this specific line item. | ||||||
| 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. | ||||||
| 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. | ||||||
| dispute_creation_date |
string | Dispute create date | ||||||
| dispute_exp_date |
string | Dispute expiration date. | ||||||
| reason_code |
long | Write-off/dispute reason code. | ||||||
| secondary_reason_code |
long | Dispute reason code. | ||||||
| comments |
string | Write-off/dispute comments | ||||||
| dispute_ind |
long | Specifies Write-off or dispute.
Allowable values for dispute_ind:
|
||||||
 can_unsettle |
string | Specifies if this dispute can be unsettled. |
- © Copyright 2023 Aria Developer Central