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


Home > Aria Crescendo core api > get_cm_list_m


Returns information about the specified credit memo.

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.
client_acct_id string 50 Client-defined account identifier.
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_details_all hash Array of returned credit memo numbers and relevand details for each credit memo
cm_no long The unique Aria-generated number for the credit memo
created_by string User ID that created the credit memo.
created_date string Date the credit memo was created.
cm_total double Amount of the credit memo
cm_tax_total double Total amount of tax credit with the Credit Memo. This is a aum of the tax lines for a given CM.
cm_reason_code long Reason code
invoice_no long The Aria-assigned unique identifier of a given invoice.
is_voided long Returns whether or not the invoice was voided.

Last modified


This page has no custom tags.


This page has no classifications.