Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > get_writeoff_details

get_writeoff_details

Returns the writeoff details of an account.

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 unique identifier indicating each email template created in Aria.
aria_event_no long 22 Aria Event number of the writeoff event
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_details hash A multidimensional array containing the details of all writeoffs applied to an 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_line_no long The line number that is written off.
total_line_debit double The total invoice line item value that was originally billed.
writeoff_line_amount double The amount written off from this specific line item.
writeoff_line_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_line_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.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.