Home > Aria Crescendo Documentation > Aria Crescendo core api > void_invoice_m
void_invoice_m
void_invoice_m
Table of contents
Voids a given invoice object and all its associated transactions. Voiding an invoice is permanent and cannot be undone.
For a list of error messages generated by this API, see void_invoice_m error messages.
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. | |
|
invoice_no | long | 22 | The Aria-assigned unique identifier of a given invoice. |
|
reason_code | long | 8 | The reason this invoice is voided Allowable Values |
| client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
| comments | string | 500 | Additional explanatory text relating to this API call. | |
| 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. | |
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
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. |
| void_transactions | hash | Array of voided transactions. |
| invoice_transaction_id |
long | Aria generated ID for the invoice transaction |
| void_transaction_id |
long | When the invoice transaction is voided, this new void transaction is created. |
- © Copyright 2021 Aria Developer Central