create_cm_m

Input Arguments
1. Allowable values for do_write
Output Arguments

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

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.

For information on error messages generated by this API, see create_cm_m Error Messages.

Input Arguments

Req

Field Name

Field Type

Max Length

Description

client_no

long

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

acct_no

long

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

client_acct_id

string

Client-defined account identifier.

cm_comments

string

1000

Explanatory text for the credit memo.

Start of cm_line_items array

cm_line_items

array

Array of credit memo lines.

Note: If sending multiple line items, you must send the line items in ascending order using the cm_line_no field in the cm_details array for the tax line items to be calculated correctly.

Field Name

Field Type

Max Length

Description

line_no

long

Sequence number of the original invoice line associated with the credit memo line.

cm_reason_cd_det

long

The reason for providing the credit memo.

master_plan_instance_no

long

The unique identifier of the master plan instance.

client_master_plan_instance_id

string

100

Client-defined Master plan Subscription plan instance ID.

supp_plan_instance_no

long

The unique identifier of the master plan instance.

client_supp_plan_instance_id

string

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

service_no

long

The unique ID for the service this line represents.

client_service_id

string

100

Client-defined unique for Master plan

cm_line_amount

double

Amount to be credited against the transaction ID (this is tax-inclusive for a tax-inclusive service).

cm_line_comments

string

3000

Explanatory text for the credit memo line.

End of cm_line_items array

cm_reason_cd

long

The reason for providing the credit memo.

customer_facing_comments

string

1000

Customer facing text for the credit memo.

orig_invoice_no

long

Original invoice number reference.

credit_ref_type

long

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

do_write

string

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'

Allowable values for do_write

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

alt_caller_id

string

Person or process that submitted the API call. This can be someone's user ID, or the name of an application.

Start of optional_transaction_qualifiers array

optional_transaction_qualifiers

array

Array of additional values you can associate with this API call.

Field Name

Field Type

Max Length

Description

qualifier_name

string

100

Name of the field you want to associate with this API call.

qualifier_value

string

100

Corresponding value of the field you want to associate with this API call.

End of optional_transaction_qualifiers array

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.

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	long	The unique Aria-generated number for the credit memo.
client_cm_seq_id	string	Client-defined credit memo sequence ID. DEPRECATED
client_cm_seq_id_2	string	Client-defined credit memo sequence ID.
created_by	string	User ID that created the credit memo.
created_date	string	Date the credit memo was created in the system.
credit_ref_type_out	string	Date the credit memo was created in the system.
cm_total	double	Amount of the credit memo.
cm_reason_cd_out	long	Reason code.
cm_comments_out	string	Explanatory text for the credit memo.
customer_facing_comments_out	string	Customer facing text for the credit memo.
cm_details	hash	Array of credit transaction details.
cm_line_no	long	The unique Aria-generated number for the credit memo.
applied_invoice_no	long	For a linked CM. the details of about the reference doc.
applied_invoice_line_no	long	For a linked CM. the details of about the reference doc.
master_plan_instance_no_out	long
supp_plan_instance_no_out	long	The unique identifier of the master plan instance.
cm_reason_cd_det_out	long	Reason code.
orig_transaction_id	long	Transaction ID of the original invoice line for the credit.
service_no_out	long	Service number.
client_service_id_out	string	Client-defined service ID.
cm_transaction_id	long	Transaction ID for the credit memo line.
item_no_out	long	Item Number.
sku_out	string	Client SKU .
cm_line_amount_out	double	Amount of the credit memo line.
reason_code_2	long	Reason code.
cm_tax_details	hash	Array of tax details.
tax_detail_line	long	Invoice line number associated with the detail tax record.
taxed_cm_line_no	long	Taxed invoice line number related to this tax record.
tax_credit_amount	double	Amount of the tax credited for the given tax type.
tax_authority_level	long	Tax jurisdiction code: 0=federal, 1=state/province.
orig_was_tax_inclusive	long	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	Identifier of the tax type returned by the tax engine.
tax_srv_tax_type_desc	string	Description of the tax type returned by the tax engine.
tax_serv_cat_text	string	Category of the tax type returned by the tax engine.
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."
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."
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."
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."
tax_rate	double	Rate at which the tax is calculated for the tax type used by the tax engine.

create_cm_m

Table of contents

Input Arguments

Allowable values for do_write

Output Arguments

Tags

Classifications

create_cm_m

Table of contents

Input Arguments

Allowable values for do_write

Output Arguments

Related articles

Tags

Classifications