This table lists and describes parameters that specifically pertain to the Create_
Request routine:
See Legend on page 2-11 for this table’s legend.
Parameter Type Data-type Required
Default
Value Description
p_api_version IN NUMBER Yes Used to compare version numbers
of incoming calls to current version number.
p_init_msg_list IN VARCHAR2 FND_API.G_
FALSE
Set to TRUE to have the API automatically initialize the message list.
p_commit IN VARCHAR2 FND_API.G_
FALSE
Set to TRUE to have the API commit automatically.
x_return_status OUT VARCHAR2 Overall return status of the API.
x_msg_count OUT NUMBER Number of messages in the API
message list.
x_msg_data OUT VARCHAR2 Message in encoded format if x_
msg_count=1.
API Usage
Parameter Type Data-type Required Description p_customer_trx_id IN ra_customer_
trx.customer_trx_
id%type
Yes Customer_trx_id of the disputed invoice.
p_line_credit_flag IN ra_cm_
request.line_credit_
flag
Yes This value should be set to Y if the dispute is at the line level.
p_line_amount IN ra_cm_
request.line_
amount%type
Yes/No Amount of the line dispute at the header level.
If the dispute is at the header level, you should enter either the line_amount, tax_amount or freight_amount.
p_tax_amount IN ra_cm_request.tax_
amount
Yes/No Amount of the tax dispute at the header level.
p_freight_amount IN ra_cm_
request.freight_
amount
Yes/No Amount of the freight dispute at header level.
p_cm_reason_code IN ra_cm_
requests.cm_
reason_code%type
YES User defined lookup code that represents the reason for the invoice dispute. Should be a valid lookup_code for the lookup_type CREDIT_
MEMO_REASON.
p_comments IN ra_cm_
requests.comments
%type
No Comments about the credit memo request, entered if required. These comments appear in the notes region of the Transaction window.
p_orig_trx_number IN VARCHAR2 No Enter the duplicate invoice number if using the
"Duplicate Billing" reason code.
p_tax_ex_cert_num IN VARCHAR2 No Tax exemption certificate number.
p_request_url* IN VARCHAR2 No** URL that displays the information of the actual credit memo dispute request.*
See Legend on page 2-11 for this table’s legend.
p_transaction_url IN VARCHAR2 No** URL that displays the information of the original transaction.
See Legend on page 2-11 for this table’s legend.
p_trans_act_url IN VARCHAR2 No** URL that displays information about the original transaction activities.
See Legend on page 2-11 for this table’s legend.
API Usage
Yes/No This value must be entered only if the dispute is at the line level. This value indicates the line_id that is in dispute.
Note: Where p_cm_line_tbl(x), x indicates the index. The dispute can be for multiple lines.
p_cm_line_
Yes/No This value must be entered only if the dispute is at the line level. This value indicates the amount that is in dispute for the line.
p_cm_line_
tbl(x).quantity_
credited
IN NUMBER Yes/No This value must be entered only if the dispute is at the line level. This value indicates the quantity that is in dispute for the line.
p_cm_line_
tbl(x).price
IN NUMBER Yes/No This value must be entered only if the dispute is at the line level. This value indicates the price that is in dispute for the line.
p_skip_workflow_
flag
IN VARCHAR2 No Defaults to N. If this value is set to Y, the entire workflow is skipped for that particular request and the credit memo is directly created.
p_credit_method_
installments
IN VARCHAR2 No The p_credit_method_installments is the credit method that is used for crediting a transaction that uses split payment terms. Choices include PRORATE, LIFO, FIFO, or NULL.
This value may be required if the p_skip_
workflow_flag is set to Y.
■ This parameter is mandatory if the credit memo is against a transaction that uses split payment terms and LINE_TYPE = LINE or CHARGES, or you are passing header freight.
■ Do not enter a value for this parameter if LINE_TYPE = TAX, or if you are passing freight for a specific line.
Parameter Type Data-type Required Description
API Usage
Legend
* The request confirmation page might need the request_id as a parameter to query the information. This will not be available to the calling program when creating the p_request_url parameter because the request_id is the out parameter of the API.
Calling programs should leave the request_id value blank and the table handler will add the request_id value and pass it to Workflow. The code searches for the "req_
id=" string and replaces it with req_id="req_id". The parameter name must be req_
id.
For example: For the old technology stack (PL/SQL), the following represents the request URL in iReceivables to call the "Request Confirmation" page. Note that no value has been entered for the req_id.
'arw_single_trx.single_cm_page?req_id='||'req_id='||'`&component='||glb_inv_
part||'`&pct_change='||glb_percent_change;
** If the calling application does not enter the request, transaction, and transaction activities URLs, then you will see a default page reading "Unavailable" when you click on these links in the notifications screen. It is strongly recommended that the p_credit_method_
rules
IN VARCHAR2 No The p_credit_method_rules is the credit method for crediting a transaction which uses an accounting rule. Choices include PRORATE, LIFO, UNIT, or NULL.
This value may be required if the p_skip_
workflow_flag is set to Y.
■ This parameter is mandatory if the credit memo is against a transaction which uses an accounting rule and LINE_TYPE = LINE or CHARGES, or you are passing header freight.
■ Do not enter a value for this parameter if LINE_TYPE = TAX, or if you are passing freight for a specific line.
p_batch_source_
name
IN VARHCAR2 No This value is required if the p_skip_workflow_
flag is set to Y.
x_request_id OUT VARCHAR2 Yes Request_id of the credit memo that is returned if the data passed is valid and the credit memo request is created.
Parameter Type Data-type Required Description
API Usage
calling application have the UI (user interface) display these pages and pass these URLs to the API.