Home > Aria Crescendo Documentation > 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.

For information on error messages generated by this API, see apply_cash_credit_m Error Messages.

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 credit_reason_cd long 22 The reason for providing the cash credit. Refer to reason codes developed by the client for cash credits via the > Finance > Reason Codes tabs in the Aria UI.
  comments string 300 Additional explanatory text relating to this API call.
  credit_amount double 12 The amount of cash credit applied against FIFO charges. This input is used only when <specific_invoices>, or <specific_transactions> input fields are not specified.
Start of specific_invoices array
  specific_invoices array   Array of transaction details.
  Field Name Field Type Max Length Description
  brd_arrow.gifinvoice_no long 22 The invoice number is used to identify object to which credit are applied.
  brd_arrow.gifinvoice_credit_amount double 12 The amount of credit to be applied against the invoice_no.
End of specific_invoices array
 
Start of specific_transactions array
  specific_transactions array   Array of transaction details.
  Field Name Field Type Max Length Description
  brd_arrow.giftransaction_id long 22 The transaction ID is used to identify object to which credit will be applied.
  brd_arrow.giftrans_credit_amount double 12 The amount of credit to be applied aginst the transaction_id.
End of specific_transactions array
 
  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 Descriptions
  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.
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. This includes timestamp in "yyyy-mm-dd HH24:MI:SS" format.
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.
brd_arrow.gif service_no long The service number for the cash credit application.
brd_arrow.gif service_name string The service name for the cash credit application.
brd_arrow.gif client_service_id string The Client-defined service number for the cash credit application.
brd_arrow.gif transaction_type long Transaction type to search account history for.  

Allowable values for transaction_type:

Values Description
1 Invoice
-1 Voided Invoice
2 Check
-2 Voided Check
3 Electronic Payment
-3 Voided Electronic Payment
4 Balance Transfer To Account
-4 Voided Balance Transfer To Account
5 Balance Transfer From Account
-5 Voided Balance Transfer From Account
6 Write Off
-6 Voided Write Off
7 (Deprecated) Out-of-band Electronic Credit
-7 (Deprecated) Voided Out-of-band Electronic Credit
8 Refund Request
-8 Voided Refund Request
9 Balance Forward
-9 Voided Balance Forward
10 Cash Credit
-10 Voided Cash Credit
11 Credit From Overpayment
-11 Voided Credit From Overpayment
12 Electronic Refund Disbursement
-12 Voided Electronic Refund Disbursement
13 Check Refund Disbursementt
-13 Voided Check Refund Disbursement
14 External charge
-14 Voided External Charge
15 Dunning Charge
-15 Voided Dunning Charge
16 reinstated Charge transaction
-16 voided reinstated Charge transaction
17 reinstated Payment transaction
-17 voided reinstated payment transaction
18 Negative Balance Forward
-18 Voided Negative Balance Forward
19 3rd party payment
-19 voided 3rd party payment
20 3rd party payment refund
-20 voided 3rd party payment refund
21 Invoice charge line item
-21 Voided Invoice charge line item
22 Invoice credit line item
-22 Voided Invoice credit line item
24 Credit memo line
-24 Voided credit memo line
brd_arrow.gif transaction_name string The transaction type for account level application of the cash credit.
brd_arrow.gif applied_transaction_id long The transaction number for account level application of the cash credit.
brd_arrow.gif applied_amount double The amount of the cash credit applied to the above.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®