Skip to main content
Aria Knowledge Central

create_cm_m

  1. Last updated
  2. Save as PDF

Summary

API Name create_cm_m
Class transaction_services_m
Update Version 62

Description

Creates a credit memo to adjust the line item charges on the specified invoice.

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_reason_cd long 22 No

The reason for providing the credit memo.
cm_comments string 3000 Yes

Explanatory text for the credit memo.
customer_facing_comments string 1000 No

Customer facing text for the credit memo.
orig_invoice_no long 22 No

Original invoice number reference.
credit_ref_type long 22 No

CM type.Invoice-based=null,General=1, price-change=2, cancellation-=3
cm_line_items object   Yes

Array of credit memo lines.

See fields below
do_write string 5 No

Boolean indicator informing Aria whether or not to actually perform the requested operation. If 'false' is passed in this field Aria will, if applicable, calculate any potential effects stemming from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it. Do_write defaults to 'true'

Allowed values:

Value Description
True The requested operation will be performed
False The requested operation will not be performed
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_qualifier_list object   No

Array of additional values you can associate with the credit memo.

See fields below

cm_line_items fields

Name Type Length Required Description
line_no long 22 No

Sequence number of the original invoice line associated with the credit memo line.
cm_reason_cd_det long 22 No

The reason for providing the credit memo.
master_plan_instance_no long 22 No

The unique identifier of the master plan instance.

Alternative field: client_master_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no
supp_plan_instance_no long 22 No

The unique identifier of the master plan instance.

Alternative field: client_supp_plan_instance_id
client_supp_plan_instance_id string   No

Client-defined plan instance ID for each assigned supplemental plan.

Alternative field: supp_plan_instance_no
service_no long   No

The unique ID for the service this line represents.

Alternative field: client_service_id
client_service_id string   No

Client-defined unique for Master plan

Alternative field: service_no
cm_line_amount double 12 No

Amount to be credited against the transaction ID.
cm_line_comments string 3000 No

Explanatory text for the credit memo line.

cm_qualifier_list fields

Name Type Length Required Description
cm_qualifier_name string 100 No

Name of the field you want to associate with the credit memo.
cm_qualifier_value string 100 No

Corresponding value of the field you want to associate with the credit memo.

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

The unique Aria-generated number for the credit memo.
client_cm_seq_id string 50 No

Note: This field is deprecated. Aria no longer supports client_cm_seq_id.
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_ref_type_out string   No

Date the credit memo was created in the system.
cm_total double   No

Amount of the credit memo.
cm_reason_cd_out long   No

Reason code.
cm_comments_out string 3000 No

Explanatory text for the credit memo.
customer_facing_comments_out string 1000 No

Customer facing text for the credit memo.
cm_details object   No

Array of credit transaction details.

See fields below
cm_tax_details object   No

Array of tax details.

See fields below
client_cm_seq_id_2 string 50 No

Client-defined credit memo sequence ID.
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_details fields

Name Type Length Required Description
cm_line_no long   No

The unique Aria-generated number for the credit memo.
applied_invoice_no long   No

For a linked CM. the details of about the reference doc.
applied_invoice_line_no long   No

For a linked CM. the details of about the reference doc.
master_plan_instance_no_out long   No  
supp_plan_instance_no_out long 22 No

The unique identifier of the master plan instance.
cm_reason_cd_det_out long   No

Reason code.
orig_transaction_id long   No

Transaction ID of the original invoice line for the credit.
service_no_out long   No

Service number.
client_service_id_out string   No

Client-defined service ID.
cm_transaction_id long   No

Transaction ID for the credit memo line.
item_no_out long   No

Item Number.
client_item_id_out string   No

Note: This field is deprecated. Aria no longer supports client_item_id_out.
sku_out string   No

Client SKU .
cm_line_amount_out double   No

Amount of the credit memo line.

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.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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