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



 

Home > Aria Crescendo core api > calc_credit_reference_line_m

calc_credit_reference_line_m

Calculates credit reference over invoice line items in the past.

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 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
OR
client_acct_id string 50 This is the client-assigned identifier for the account.
plan_instance_no long Unique plan instance number for each assigned master or supplemental plan.
OR
client_plan_instance_id string Client-defined plan instance ID for each assigned master or supplemental plan.
service_no long 22 Service number.
OR
client_service_id string 100 Client defined service id.
credit_ref_type long Credit reference type.   Allowable Values
credit_reference_start_date string The start date, in yyyy-mm-dd format, from which the credit reference calculation begins.
monthly_price double Monthly price for specified plan instance / service.
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.
plan_instance_no_out long Unique plan instance number for each assigned supplemental plan.
service_no_out long Service number.
client_service_id_out string Client defined service id.
credit_reference_amount double Total credit reference amount.
charge_reference_amount double Total charge reference amount.
amount double Total amount: credit_reference_amount - charge_reference_amount.
invoice_reference_details hash Array of invoice reference details.
invoice_no long The invoice number.
invoice_line_no long The invoice line number.
invoice_ref_line_amount double The invoice reference line's gross amount.
invoice_line_charge_amt double The invoice reference line's charge amount.
invoice_line_surcharge_amt double The invoice reference line's surcharge gross amount.
invoice_line_credit_amt double The invoice reference line's service credit amount.
invoice_line_discount_amt double The invoice reference line's off-line discount amount.
invoice_line_tax_amt double The invoice reference line's gross tax amount.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.