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

get_invoice_cm_details_m

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

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

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.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png invoice_no long 22 Aria generated invoice number.
  OR      
  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 for restriction_reason

Values Description
a Unable to apply credit memo to a voided invoice.
b Unable to apply credit memo to a pending invoice.
c Unable to apply credit memo to an invoice that is in dispute hold.
d Unable to apply credit memo to an invoice that has been written off.
e Unable to apply credit memo to an invoice that has been fully paid.
f Unable to apply credit memo to a child invoice when parent pay responsibility is used.
g Unable to apply credit memo to an invoice that has refund-related reversals applied.
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 amount double Amount.
brd_arrow.gif max_credit_amount double Maximum Credit Amount (this amount appears as tax-inclusive for a tax-inclusive service).
brd_arrow.gif max_on_charge_credit_amount double Maximum Credit Amount on Net Charge Only, Excluding Taxes.
brd_arrow.gif orig_charge_tax_inclusive_indicator long

Indicating if the charge is tax inclusive or not.

Allowable values for orig_charge_tax_inclusive_indicator

Values Description
1 Original charge line is tax inclusive.
0 Original charge line is not tax inclusive.
brd_arrow.gif max_on_tax_credit_amount double Maximum Credit Amount on Taxes.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®