void_credit_memo_m
Summary
| API Name | void_credit_memo_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.50 |
Description
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.
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 |
| cm_no | long | 22 | Yes |
The Aria generated credit memo number to void. Alternative required field: client_cm_seq_id |
| client_cm_seq_id | string | 50 | Yes |
Client-define credit memo sequence ID. Alternative required field: cm_no |
| comments | string | 3000 | No |
Explanatory text for the void. |
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. |
|
| cm_void_transactions | object | No |
Array of voided transactions. |
|
| created_by | string | No |
User ID that created the credit memo. |
|
| created_date | string | No |
Date the credit memo was created in the system. |
|
| comments_out | string | 3000 | No |
Explanatory text for the void. |
cm_void_transactions fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| cm_transaction_id | long | No |
Aria generated transaction ID for the credit memo line. |
|
| cm_void_transaction_id | long | No |
The void transaction ID generated by the void. |