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
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
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.
cm_reason_cd long 22 The reason for providing the credit memo.
orig_invoice_no long 22 Original invoice number reference.
cm_line_items array   Array of credit memo lines.
line_no long 22 Sequence number of the original invoice line associated with the credit memo line.
cm_line_amount double 12 Amount to be credited against the transaction ID.
  cm_line_comments string 3000 Explanatory text for the credit memo line.
  cm_comments string 3000 Explanatory text for the credit memo.
  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.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  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.
  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.
created_by string User ID that created the credit memo.
created_date string Date the credit memo was created in the system.
cm_total double Amount of the credit memo.
cm_reason_code long Reason code.
applied_cm_details hash Array of credit transaction details.
orig_transaction_id long Transaction ID of the original invoice line for the credit.
cm_line_no long Invoice line number.
service_no long Service number.
client_service_id string Client-defined service ID.
cm_transaction_id long Transaction ID for the credit memo line.
line_amount double Amount of the credit memo line.
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.

You must to post a comment.
Last modified
09:46, 27 Jul 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.