get_writeoff_details_m
Summary
| API Name | get_writeoff_details_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 64 |
Description
Returns the writeoff details of an account.
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 | Yes |
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 |
| writeoff_transaction_id | long | Yes |
The transaction ID of the write-off. |
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_detail | object | No |
A multidimensional array containing the details of all writeoffs applied to an account. |
writeoff_detail fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| invoice_no | long | No |
The Aria-assigned unique identifier of a given invoice. |
|
| invoice_bill_date | string | No |
The date the invoice was originally billed. The date is in the format yyyy-mm-dd. |
|
| invoice_transaction_id | long | No |
The line number that is written off. |
|
| original_transaction_amount | double | No |
The total invoice line item value that was originally billed. |
|
| writeoff_transaction_amount | double | No |
The amount written off from this specific line item. |
|
| writeoff_transaction_start_date | string | No |
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 | No |
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. |