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

 

Home > Aria Crescendo core api > gen_rb_m

gen_rb_m

Executes the rebill process against the specified invoice. It creates a credit memo to offset the charges in the original invoice. Then it creates a new rebill invoice using the changes specified in the rb_line_items array.

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.
orig_invoice_no long 22 Original invoice number for rebilling purposes.
reason_cd long 22 Reason code for rebill.
rb_line_items array   Array of rebill invoice line items.
line_no long 22 Invoice line number reference.
service_no long 22 Aria assigned service number.
  OR      
  client_service_id string 100 Client defined unique id for the service.
  rb_rate_per_unit double   Rate per unit. Leave this field blank if the rate per unit on the referenced invoice line should be used to calculate the line amount.
  rb_units double   Units for the line item.
  rb_amount double   Amount of the line item.
  rb_line_comments string 200 Explanatory text for the line item.
  po_num string 1000 PO number for the invoice line item.
  bill_from_location_no long 22 Address sent as the bill-from address to the tax engine for tax calculations. This is the Aria assigned unique identifier of the service location for the invoice line.
  ship_from_location_no long 22 Address sent as the ship-from address to the tax engine for tax calculations. This is the Aria assigned unique identifier of the service location for the invoice line.
  bill_to_address_seq long 22 Address sent as the bill-to address to the tax engine for tax calculations. This is the Aria assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
  ship_to_address_seq long 22 Address sent as the bill-to address to the tax engine for tax calculations. This is the Aria assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.
  alt_statement_address_seq long 22 An alternative statement contact for statement generation.
  rb_comments string 3000 Explanatory text for rebill.
  do_collect long 1 Indicates whether to collect from the account holder as part of the rebill process. Allowable values are 1= yes, 0 = no. If no value is passed then the client parameter "autocollect on rebill" dictates the behavior.   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.
invoice_no long The unique Aria-generated number for the rebill.
collection_error_cd long Collection error code.
collection_error_msg string Invoicing error message.
statement_error_cd long Statement error code.
statement_error_msg string Statement error message.
proc_cvv_response string Processor return code from CVV validation.
proc_avs_response string Processor return code from address validation.
proc_cavv_response string Process return code from security validation.
proc_status_code string Processor status code.
proc_status_text string Processor status description.
proc_payment_id string Processor payment id.
proc_auth_code string Processor authorization code.
created_by string User ID that created the rebill.
created_date string Date the rebill was created in the system.
amount double Amount of the rebill.
reason_code long Reason code for the rebill.

You must to post a comment.
Last modified
10:43, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.