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

 

Home > Aria Crescendo core api > apply_cash_credit_m

apply_cash_credit_m

Apply a cash credit to an account, account-level charge, invoice, or invoice charge.

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.
credit_reason_cd long The reason for providing the cash credit.
comments string 3000 Additional explanatory text relating to this API call.
credit_amount double 12 The amount of cash credit applied against FIFO charges.
specific_invoices array Array of transaction details.
invoice_no long 22 The invoice number is used to identify object to which credit are applied.
invoice_credit_amount double 12 The amount of credit to be applied against the invoice_no.
specific_transactions array Array of transaction details.
transaction_id long The transaction ID is used to identify object to which credit will be applied.
trans_credit_amount double 12 The amount of credit to be applied aginst the transaction_id.
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.
credit_no long The cash credit number.
created_by string User ID that created the transaction.
created_date string Specifies the date that credit was created.
amount double The amount of the cash credit.
reason_code long Reason code for the cash credit.
reason_text string Text description for the reason.
applied_cash_credits hash Array that contains cash credit application details.
service_no long The service number for the cash credit application.
service_name string The service name for the cash credit application.
client_service_id string The Client-defined service number for the cash credit application.
transaction_type long Transaciton type to search account history for.   Allowable Values
transaction_name string The transaction type for account level application of the cash credit.
applied_transaction_id long The transaction number for account level application of the cash credit.
applied_amount double The amount of the cash credit applied to the above.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.