Skip to main content
Aria Knowledge Central

create_cm_m Guide

  1. Last updated
  2. Save as PDF

The create_cm_m API 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>

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

<qualifier_list> (array)

  • <cm_qualifier_name>, <cm_qualifier_value>
 If you provide a value for one of these fields, the other field is required.
Output Fields
Field Name Notes
<client_appended_cm_seq_id> This value is the client-specified sequence ID created for the credit memo with the client-defined prefix prepended, or suffix appended.

This prefix or suffix, which you can specify in your Aria client instance, distinguishes the value of this output field from the output field <client_cm_seq_id>.
<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."

Error Codes

Error Code/Description Associated Inputs

1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)

<cm_qualifier_name>, <cm_qualifier_value>, <client_no>, <auth_key>, <acct_no> or <client_acct_id>, <cm_comments>, <cm_line_items>

Note: If you provide a value for <cm_qualifier_name> or <cm_qualifier_value>, the other field is required.

1024: invalid date format

Additional Comments: All date inputs must be in yyyy-mm-dd format.

<cm_period_start_date>, <cm_period_end_date>

1109: The number of qualifiers supplied, exceeds the maximum of 9 qualifiers.

 <cm_qualifier_list>

1016: invalid input

Additional Comments:  This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.

<cm_qualifier_name>, <cm_qualifier_value>

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.

 <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.

 <cm_details> > [master_plan_instance_no_out, client_service_id_out]

3117: A ($action) cannot be performed since this invoice contains usage with either, precalculated taxes, or taxes calculated at the individual record level.

  

29007: Missing Credit Memo Comments

 <cm_comments_out>

29008: Invalid Supplemental Plan instance number

 <cm_details> > [master_plan_instance_no_out, client_service_id_out]
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. core api