Credit Memo Application API User Notes 4-5
Parameter Type Data-type Required
* Description
p_customer_trx_id IN NUMBER Yes Customer transaction identifier of the on account credit memo to be applied.
Default: None Validation:
Must be a completed on-account credit memo (not a regular credit memo related to an invoice where previous_customer_trx_id has a value).
Must have a receipt method.
Receipt method must belong to a receipt class that allows remittance.
Receipt method must have a remittance bank account.
Must have customer bank account details.
Must have a negative original amount due.
Must not be negative due to overpayment.
Errors:
AR_REF_NO_PAYMENT_METHODAR_REF_N O_CUST_BANK AR_REF_NOT_OACM AR_REF_CM_INCOMPLETE
AR_REF_CM_POSITIVE
AR_REF_MORE_THAN_CM_AMT AR_REF_RCT_CLASS_REMIT AR_REF_NO_REMIT_BANK
4-6 Oracle Receivables Reference Guide
Parameter Type Data-type Required
* Description
p_amount_applied IN NUMBER Yes The amount of the credit memo to apply to an activity.
Default: None Validation:
Must be greater than zero.
Must not cause the credit memo to be overapplied.
Total applied to Electronic Refund, including this application and other applications on the same credit memo, must not fall outside the approval limits or Credit Memo refunds specified for the user/currency.
Errors:
AR_CKAP_OVERAPP AR_REF_CM_APP_NEG AR_REF_USR_LMT_OUT_OF_RANGE
p_applied_payment_sc hedule_id
IN NUMBER Yes The payment_schedule_id of the activity being applied to.
Default: None Validation:
Only 1 value is currently allowed: -8 (Electronic Refund)
Error:AR_RAPI_APP_PS_ID_INVALID
p_receivable_trx_id IN NUMBER Yes Receivables Transacation Identifier of the activity being applied to.
Default: None
Validation: Must be of type Credit Memo Refund.
Error: AR_RAPI_ACTIVITY_X_INVALID
Credit Memo Application API User Notes 4-7
Parameter Type Data-type Required
* Description
p_apply_date IN DATE No The date the credit memo is applied to the activity.
Default: The greater of system date and transaction date.
Validation: Must not precede the transaction date of the credit memo.
Error: AR_APPLY_BEFORE_TRANSACTION
p_apply_gl_date IN DATE No Date that this application will be posted to the General Ledger.
Default: Gets defaulted to the system date if it is in an open or future enterable period, otherwise:
•
If the most recent open period is prior to the transaction date: last date of that period•
If there is a period open after the transaction date: first date of the last open periodValidation:
It is valid if the following conditions are true:
•
The date is in an Open or Future period•
The period cannot be an Adjustment period•
Must not precede the credit memo GL date Error: AR_INVALID_APP_GL_DATEAR_VAL_GL_INV_GL
p_ussgl_transaction_co de
IN VARCHAR2(3 0)
No Code defined by public sector accounting.
Default: None Validation: None Error: None
4-8 Oracle Receivables Reference Guide
Parameter Type Data-type Required
* Description
p_called_from IN VARCHAR2(2
0)
No This parameter is used to identify the calling routine.
Default: Null Validation: None Error: None
p_attribute_record IN attribute_rec_t ype
No This is a record type which contains all 15 descriptive flexfield segments and one descriptive flexfield structure defining column. It represents the Receivable Application Information flexfield.
Default: DFF APIs used to do the defaulting Validation: DFF APIs used to do the validation depending on setup
Error: AR_RAPI_DESC_FLEX_INVALID
p_global_attribute_rec ord
IN global_attribut e_rec_type
No This is a record type which contains all 20 global descriptive flexfield segments and one global descriptive flexfield structure defining column.
Default: None Validation: None
p_comments IN VARCHAR2(2
40)
No User's comments
p_chk_approval_limit_
flag
IN VARCHAR2(1) No Flag used to optionally override user approval limits for Credit Memo refunds.
Values: 'Y' = Yes (check limits), 'N' = No (do not check limits)
Default: 'Y' Validation: None
Credit Memo Application API User Notes 4-9
Parameter Type Data-type Required
* Description
p_application_ref_type IN OUT
VARCHAR2(3 0)
No The context of application ref num/id is passed back in this parameter. For Electronic refunds this will be MISC_RECEIPT
Default: None Validation: None Error: None
P_application_ref_id IN OUT
NUMBER No For Electronic Refunds, the cash_receipt_id of the negative miscellaneous receipt created for the refund is passed back in this parameter.
Default: None
No For Electronic Refunds, the receipt number for the resulting miscellaneous receipt will be passed back in this parameter.
Default: None Validation: None Error: None
p_receivable_applicati on_id
OUT NUMBER(15) No The receivable application identifier of the activity application.