Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo core api > create_cm_m

create_cm_m

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

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png cm_comments string 1000 Explanatory text for the credit memo.
Start of cm_line_items array
required-icon.png 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
  brd_arrow.gifline_no long 22 Sequence number of the original invoice line associated with the credit memo line.
  brd_arrow.gifcm_reason_cd_det long 22 The reason for providing the credit memo.
  brd_arrow.gifmaster_plan_instance_no long 22 The unique identifier of the master plan instance.
  OR      
  brd_arrow.gifclient_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  brd_arrow.gifsupp_plan_instance_no long 22 The unique identifier of the master plan instance.
  OR      
  brd_arrow.gifclient_supp_plan_instance_id string   Client-defined plan instance ID for each assigned supplemental plan.
  brd_arrow.gifservice_no long 22 The unique ID for the service this line represents.
  OR      
  brd_arrow.gifclient_service_id string 100 Client-defined unique for Master plan
  brd_arrow.gifcm_line_amount double 12 Amount to be credited against the transaction ID.
  brd_arrow.gifcm_line_comments string 3000 Explanatory text for the credit memo line.
End of cm_line_items array
 
  cm_reason_cd long 22 The reason for providing the credit memo.
  customer_facing_comments string 1000 Customer facing text for the credit memo.
  orig_invoice_no long 22 Original invoice number reference.
  credit_ref_type long 22 CM type.Invoice-based=null,General=1, price-change=2, cancellation-=3
  do_write string 5 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
  alt_caller_id string 30 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
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
 

Output Arguments

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.
brd_arrow.gif cm_line_no long The unique Aria-generated number for the credit memo.
brd_arrow.gif applied_invoice_no long For a linked CM. the details of about the reference doc.
brd_arrow.gif applied_invoice_line_no long For a linked CM. the details of about the reference doc.
brd_arrow.gif master_plan_instance_no_out long  
brd_arrow.gif supp_plan_instance_no_out long The unique identifier of the master plan instance.
brd_arrow.gif cm_reason_cd_det_out long Reason code.
brd_arrow.gif orig_transaction_id long Transaction ID of the original invoice line for the credit.
brd_arrow.gif service_no_out long Service number.
brd_arrow.gif client_service_id_out string Client-defined service ID.
brd_arrow.gif cm_transaction_id long Transaction ID for the credit memo line.
brd_arrow.gif item_no_out long Item Number.
brd_arrow.gif client_item_id_out string Client item id.
brd_arrow.gif sku_out string Client SKU .
brd_arrow.gif cm_line_amount_out double Amount of the credit memo line.
cm_tax_details hash Array of tax details.
brd_arrow.gif tax_detail_line long Invoice line number associated with the detail tax record.
brd_arrow.gif taxed_cm_line_no long Taxed invoice line number related to this tax record.
brd_arrow.gif tax_credit_amount double Amount of the tax credited for the given tax type.
brd_arrow.gif tax_authority_level long Tax jurisdiction code: 0=federal, 1=state/province.
brd_arrow.gif orig_was_tax_inclusive long Indicates whether or not the invoice line amount associated with the credit memo line was tax inclusive or not.
brd_arrow.gif tax_srv_tax_type_id string Identifier of the tax type returned by the tax engine.
brd_arrow.gif tax_srv_tax_type_desc string Description of the tax type returned by the tax engine.
brd_arrow.gif tax_serv_cat_text string Category of the tax type returned by the tax engine.
brd_arrow.gif 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."

brd_arrow.gif 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."

brd_arrow.gif 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."

brd_arrow.gif 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."

 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.