Home > Aria Crescendo core api > void_credit_memo_m
void_credit_memo_m
void_credit_memo_m
Table of contents
Voids a previously created credit memo if the credit memo has not already been voided or it was not created due to an issue of a rebill on an invoice.
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. | |
| cm_no | long | 22 | The Aria generated credit memo number to void. |
| OR | ||||
| client_cm_seq_id | string | 50 | Client-define credit memo sequence ID. | |
| comments | string | 3000 | Explanatory text for the void. | |
| 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. |
| cm_void_transactions | hash | Array of voided transactions. |
| cm_transaction_id | long | Aria generated transaction ID for the credit memo line. |
| cm_void_transaction_id | long | The void transaction ID generated by the void. |
| created_by | string | User ID that created the credit memo. |
| created_date | string | Date the credit memo was created in the system. |
| comments_out | string | Explanatory text for the void. |
- © Copyright 2017 Aria Developer Central