Home > Aria Crescendo Documentation > Aria Crescendo core api > get_cm_details_m

get_cm_details_m

Returns information about the specified credit memo.

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 cm_no long 22 The Aria-generated credit memo number.
  OR      
  client_cm_seq_id_in string 50 Client-defined 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.
  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_no_out long The Aria generated credit memo number.
client_cm_seq_id string The user specified sequence ID created for the credit memo.
credit_ref_type string Credit Memo Type Flag. 0 or NULl - Invoice Based Credit memo, 1 - General, 2 - Price Change, 3 - Cancelation
created_by string User ID that created the credit memo.
created_date string Date the credit memo was created in the system.
credit_reason_code long

Reason code for the credit memo.

Allowable values for credit_reason_code: 

Values Description
0 Internal Overpayment
1 General credit/other
2 Inadequate service delivery
3 Billing / pricing issue
4 Service no longer desired
5 Customer dissatisfaction
6 Installation issue
7 Duplicate/erroneous usage
8 Shipping error
9 Customer return
11 System testing
12 Prepay Code Redemption
21 Billing Issue
22 Demo/Partner Account
23 Duplicate Charge
24 Employee Account
25 Pricing Issue
26 Return (RMA) Broken
27 Return (RMA) Cancel
28 Return (RMA) Wrong Product
29 Service Issue
30 Shipping credit
31 Testing Account
32 Refer-a-Friend
33 Referral Program
97 New Service Plan Proration
98 Prepay Credit Reconciliation
99 Balance Forward Conversion
1004 Pricing
1005 Service Error
1006 Hardware malfunction
1007 Goodwill
1008 Billing Error
1009 Development
1010 Shipping Error
1011 Promotion
1012 System Testing
1013 Sales Rep Error
1014 Commission
1015 Operations Error
9999 Coupon Application
credit_comments string Credit memo comments.
orig_invoice_no long The invoice the credit memo was created against and applied to. DEPRECATED
orig_invoice_no_2 long The invoice the credit memo was created against and applied to.
cm_total double Total amount of the credit memo.
customer_note string Customer note
cm_line_details hash Array of credit transaction details.
brd_arrow.gif cm_line_no long Invoice line number.
brd_arrow.gif cm_transaction_id long Aria generated transaction ID for the credit memo line.
brd_arrow.gif cm_void_transaction_id long Aria generated transaction ID for the void credit memo line, if the credit memo has been voided.
brd_arrow.gif cm_line_amount double Amount of the credit memo line.
brd_arrow.gif master_plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gif client_master_plan_instance_id string Client-defined Master plan Subscription plan instance ID.
brd_arrow.gif service_no long Aria-assigned unique identifier of the service associated with the invoice line item.
brd_arrow.gif client_service_id string Client-defined identifier of the service associated with the invoice line item.
brd_arrow.gif item_no long The unique ID of the item being retrieved.
brd_arrow.gif client_sku string The client-defined item identifier.
brd_arrow.gif reason_code long Reason code. DEPRECATED
brd_arrow.gif reason_code_2 long Reason code.
cm_tax_details hash Array of tax details.
brd_arrow.gif tax_detail_line long Invoice line number associated with the detail tax record.
brd_arrow.gif taxed_cm_line_no long Taxed invoice line number related to this tax record.
brd_arrow.gif tax_credit_amount double Amount of the tax credited for the given tax type.
brd_arrow.gif tax_authority_level long Tax jurisdiction code: 0=federal, 1=state/province.
brd_arrow.gif orig_was_tax_inclusive long Indicates whether or not the invoice line amount associated with the credit memo line was tax inclusive or not.
brd_arrow.gif tax_srv_tax_type_id string Identifier of the tax type returned by the tax engine.
brd_arrow.gif tax_srv_tax_type_desc string Description of the tax type returned by the tax engine.
brd_arrow.gif tax_serv_cat_text string Category of the tax type returned by the tax engine.
brd_arrow.gif unrounded_tax_amt double

The amount multiplied by tax rate before rounding precision. Also referred to as "raw tax amount."

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
brd_arrow.gif carryover_from_prev_amt double

The amount carried over from previous <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative (based on the previous remainder).

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
brd_arrow.gif before_round_adjusted_tax_amt double

The amount of adjusted tax before rounding precision, calculated as the sum of <unrounded_tax_amt> and <carryover_from_prev_amt>.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
brd_arrow.gif carryover_from_current_amt double

The amount carried over from current <unrounded_tax_amt>. It is a remainder, and its value can be positive or negative based on the previous remainder.

Note: Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
brd_arrow.gif tax_rate double Rate at which the tax is calculated for the tax type used by the tax engine.
cm_applied_details hash Array of charges where the Credit Memo is applied.
brd_arrow.gif cm_line_no_applied long Credit memo line number.
brd_arrow.gif cm_applied_date string Credit memo charge applied date.
brd_arrow.gif cm_applied_charge_id long Charge event number to which the credit memo is applied.
brd_arrow.gif cm_applied_tax_event_id long Tax event number to which the credit memo is applied.
brd_arrow.gif cm_applied_invoice_no long Invoice number to which the credit memo is appplied
brd_arrow.gif cm_applied_charge_seq_num long Invoice sequence number.
brd_arrow.gif cm_applied_service_no long Service numner to which the credit memo is applied.
brd_arrow.gif cm_applied_service_cdid string Client defined identifier for the Service.
brd_arrow.gif cm_applied_service_name string Service name.
brd_arrow.gif cm_applied_amount double Applied amount from the credit memo on the charge
brd_arrow.gif cm_applied_plan_instance_no long Plan instance number.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®