void_credit_memo_m Sample Call and Response
This example shows a call to void_credit_memo_m, which voids a previously created credit memo, provided that the credit memo has not already been voided and was not created as the result of a rebill on an invoice. This example is based on the plsql_m_r73.yml definition file.
This example voids one credit memo by its Aria-assigned number and supplies explanatory comments for the void. It does not cover identifying the account by client_acct_id or the credit memo by client_cm_seq_id, both of which are alternatives to the identifiers used here.
Sample call
{
"rest_call": "void_credit_memo_m",
"output_format": "json",
"client_no": 66123,
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"acct_no": 5017732,
"cm_no": 903214,
"comments": "Credit memo issued in error against the wrong invoice; voiding and reissuing correctly."
}
The rest_call and output_format fields are added by the REST layer and do not appear in the method's own argument list. acct_no and client_acct_id are alternatives; this example uses acct_no, the Aria-assigned account identifier. cm_no and client_cm_seq_id are also alternatives; this example uses cm_no, the Aria-generated credit memo number. comments is optional and is included here to give a clear audit trail for the void.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"cm_void_transactions": [
{
"cm_transaction_id": 74412209,
"cm_void_transaction_id": 74412538
}
],
"created_by": "svc_billingops",
"created_date": "06/02/2026 11:47:19",
"comments_out": "Credit memo issued in error against the wrong invoice; voiding and reissuing correctly."
}
error_code 0 and error_msg "OK" indicate that the credit memo was voided successfully. cm_void_transactions is an array of the transactions voided as part of this call; this example shows one representative entry, but a credit memo composed of multiple transaction lines would return one entry per line. created_by and created_date describe who originally created the credit memo and when, and comments_out echoes back the explanatory text supplied in comments. error_details, which is nullable and used only when an error occurs, is left out of this example.