create_cm_m Guide

Last updated
Save as PDF

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

API Specification:	create_cm_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <cm_comments> <cm_line_items>

Error Codes

Error Code/Description	Associated Inputs
3061: Unable to apply credit memo to a child invoice when parent pay responsibility is used.
3101: Allowed credit-ref-type are 0 or null for Invoice based CM and 1 or 2 or 3 for on-account CM. Associated Inputs: credit_ref_type	<credit_ref_type_out>
3107: On-account credit memos are created with one Master Plan Instance each. Please re-submit with a single Master Plan Instance. Associated Inputs: cm_line_items > [master_plan_instance_no, client_master_plan_instance_id]	<cm_details> > [master_plan_instance_no_out, client_service_id_out]
29007: Missing Credit Memo Comments Associated Input: cm_comments	<cm_comments_out>
29008: Invalid Supplemental Plan instance number Associated Inputs: cm_line_items > [supp_plan_instance_no, client_supp_plan_instance_id]	<cm_details> > [master_plan_instance_no_out, client_service_id_out]

Additional Guidance:

Input Fields

Field Name:

Notes:

<cm_line_items

If sending multiple line items, you must send the line items in ascending order using the cm_line_nofield in the cm_detailsarray for the tax line items to be calculated correctly.

<do_write>

Allowable values

Values	Description
true	The requested operation will be performed
false	The requested operation will not be performed

Output Fields

Field Name:	Notes:
<unrounded_tax_amt>	Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
<carryover_from_prev_amt>	Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
<before_round_adjusted_tax_amt>	Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."
<carryover_from_current_amt>	Assuming that the client setting Aria Internal Tax Rounding Method is set to "Per invoice."