Skip to main content
Aria Knowledge Central

get_cm_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_cm_details_m
Class transaction_services_m
Update Version 62

Description

Returns information about the specified credit memo.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
cm_no long 22 Yes

The Aria-generated credit memo number.

Alternative required field: client_cm_seq_id_in
client_cm_seq_id_in string 50 Yes

Client-defined credit memo sequence ID.

Alternative required field: cm_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
cm_no_out long   No

The Aria generated credit memo number.
client_cm_seq_id string   No

The user specified sequence ID created for the credit memo.
credit_ref_type string   No

Credit Memo Type Flag. 0 or NULl - Invoice Based Credit memo, 1 - General, 2 - Price Change, 3 - Cancelation
created_by string   No

User ID that created the credit memo.
created_date string   No

Date the credit memo was created in the system.
credit_reason_code long 8 No

Reason code for the credit memo.

Allowed values:

Value 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   No

Credit memo comments.
orig_invoice_no long   No

Note: This field is deprecated. Aria no longer supports orig_invoice_no.
cm_total double   No

Total amount of the credit memo.
customer_note string   No

Customer note
cm_line_details object   No

Array of credit transaction details.

See fields below
cm_tax_details object   No

Array of tax details.

See fields below
cm_applied_details object   No

Array of charges where the Credit Memo is applied.

See fields below
orig_invoice_no_2 long   No

The invoice the credit memo was created against and applied to.
client_appended_cm_seq_id string   No

The client specified sequence ID created for the credit memo with client defined prefix or suffix appended.
cm_period_start_date string   No

Period start date of the credit memo. Used to indicate the period that the credit memo covers.
cm_period_end_date string   No

Period end date of the credit memo. Used to indicate the period that the credit memo covers.
cm_qualifiers object   No

Returns array of credit memo qualifiers associated with the credit memo number.

See fields below

cm_line_details fields

Name Type Length Required Description
cm_line_no long   No

Note: This field is deprecated. Aria no longer supports cm_line_no.
cm_transaction_id long   No

Aria generated transaction ID for the credit memo line.
cm_void_transaction_id long   No

Aria generated transaction ID for the void credit memo line, if the credit memo has been voided.
cm_line_amount double   No

Amount of the credit memo line.
master_plan_instance_no long 22 No

The Master Subscription plan instance number.
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.
service_no long   No

Aria-assigned unique identifier of the service associated with the invoice line item.
client_service_id string   No

Client-defined identifier of the service associated with the invoice line item.
item_no long   No

The unique ID of the item being retrieved.
client_item_id string   No

Note: This field is deprecated. Aria no longer supports client_item_id.
client_sku string   No

The client-defined item identifier.
reason_code long   No

Note: This field is deprecated. Aria no longer supports reason_code.
reason_code_2 long   No

Reason code.
credit_memo_line_no long   No

Credit memo line no.
credit_memo_invoice_line_no long   No

Invoice based credit memo invoice line no.
service_name string   No

Service name associated to the service no in the credit memo line item.

cm_tax_details fields

Name Type Length Required Description
tax_detail_line long   No

Invoice line number associated with the detail tax record.
taxed_cm_line_no long   No

Taxed invoice line number related to this tax record.
tax_credit_amount double   No

Amount of the tax credited for the given tax type.
tax_authority_level long   No

Tax jurisdiction code: 0=federal, 1=state/province.
orig_was_tax_inclusive long   No

Indicates whether or not the invoice line amount associated with the credit memo line was tax inclusive or not.
tax_srv_tax_type_id string   No

Identifier of the tax type returned by the tax engine.
tax_srv_tax_type_desc string   No

Description of the tax type returned by the tax engine.
tax_serv_cat_text string   No

Category of the tax type returned by the tax engine.
unrounded_tax_amt double   No

The amount multiplied by tax rate before rounding precision. Also referred to as raw tax amount. *Note: Aria internal tax rounding method set to invoice.
carryover_from_prev_amt double   No

The amount that is a carryover from previous unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.
before_round_adjusted_tax_amt double   No

The amount adjusted Tax before rounding precision. i.e. Sum of unrounded_tax_amt, and carryover_from_prev_amt. *Note: Aria internal tax rounding method set to invoice.
carryover_from_current_amt double   No

The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.
tax_rate double   No

Rate at which tax is calculated for the tax type used by the tax engine.
tax_nominal_rate double   No

Nominal Rate returned by the tax engine.

cm_applied_details fields

Name Type Length Required Description
cm_line_no_applied long   No

Credit memo line number.
cm_applied_date string   No

Credit memo charge applied date.
cm_applied_charge_id long   No

Charge event number to which the credit memo is applied.
cm_applied_tax_event_id long   No

Tax event number to which the credit memo is applied.
cm_applied_invoice_no long   No

Invoice number to which the credit memo is appplied
cm_applied_charge_seq_num long   No

Invoice sequence number.
cm_applied_service_no long   No

Service numner to which the credit memo is applied.
cm_applied_service_cdid string   No

Client defined identifier for the Service.
cm_applied_service_name string   No

Service name.
cm_applied_amount double   No

Applied amount from the credit memo on the charge
cm_applied_plan_instance_no long   No

Plan instance number.

cm_qualifiers fields

Name Type Length Required Description
cm_qualifier_name string   No

Returns the qualifier name associated with the credit memo number.
cm_qualifier_value string   No

Returns the qualifier value associated with the credit memo number.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.