Home > Aria Crescendo Documentation > Aria Crescendo core api > get_invoice_cm_details_m


Provides the allowable credit memo line values for a given invoice.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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.
required-icon.png invoice_no long 22 Aria generated invoice number.
  client_cm_seq_id string 50 Client credit memo sequence id.
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

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.
restriction_reason string If the invoice cannot be credited using a credit memo, the reason for the restriction.   Allowable Values
invoice_cm_line_details hash Array of invoice line items.
brd_arrow.gif line_no long Invoice line number.
brd_arrow.gif service_no long Aria generated service number.
brd_arrow.gif service_name string Service name.
brd_arrow.gif client_sku string Client-defined SKU.
brd_arrow.gif item_no long Aria generated unique item ID.
brd_arrow.gif client_service_id string Unique Client-defined service ID.
brd_arrow.gif client_item_id string Unique client-defined item ID.
brd_arrow.gif amount double Amount.
brd_arrow.gif max_credit_amount double Maximum Credit Amount (this amount appears as tax-inclusive for a tax-inclusive service).
Last modified


This page has no custom tags.


This page has no classifications.