Apply prepayments to an invoice
/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Request
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/vnd.oracle.adf.action+json
object
-
BusinessUnit: string
The business unit name on the invoice.
-
InvoiceIncludesPrepaymentFlag: boolean
Indicates that the prepayment is referenced on the supplier invoice and the invoice amount includes the amount of the prepayment and any associated tax. The default value is false.
-
InvoiceNumber: string
The unique number of the supplier invoice.
-
PrepaymentAccountingDate: string
(date)
The accounting date to be used for the prepayment application. The prepayment accounting date must be later than the accounting date of the standard invoice and the prepayment distributions.
-
PrepaymentApplicationAmount: number
The amount of prepayment to be applied to the invoice. This amount must be positive.
-
PrepaymentInvoiceNumber: string
The unique number of the prepayment invoice for the supplier.
-
PrepaymentLineNumber: number
The unique line number of the prepayment invoice.
-
Supplier: string
The supplier name on the invoice.
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
object
-
result(required): string
Returns "The current action Apply Prepayments has completed successfully." if the action completes successfully.
Examples
Example 1
The following example shows how to apply multiple prepayments to an invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InvoiceNumber": "AND-SI-1" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{"result": "The current action Apply Prepayments has completed successfully."}
Example 2
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InvoiceNumber": "AND-SI-1", "PrepaymentInvoiceNumber": "AND-PP-1" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{"result": "The current action Apply Prepayments has completed successfully."}
Example 3
The following example shows how to apply a specific prepayment invoice line to an invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InvoiceNumber": "AND-SI-1", "PrepaymentInvoiceNumber": "AND-PP-1", "PrepaymentLineNumber": "1" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{"result": "The current action Apply Prepayments has completed successfully."}
Example 4
The following example shows how to apply a specific prepayment amount from an identified prepayment invoice and line to an invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InvoiceNumber": "AND-SI-1", "PrepaymentInvoiceNumber": "AND-PP-1", "PrepaymentLineNumber": "1", "PrepaymentApplicationAmount": 125, "PrepaymentAccountingDate": "2019-11-04" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{"result": "The current action Apply Prepayments has completed successfully."}
Example 5
The following example shows how to apply a specific prepayment amount from an identified prepayment invoice and line with additional attributes such as Supplier Unit and Business Unit to an invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InvoiceNumber": "AND-SI-1", "Supplier": "Advanced Network Devices", "BusinessUnit": "Vision Operations", "PrepaymentInvoiceNumber": "AND-PP-1", "PrepaymentLineNumber": "1", "PrepaymentApplicationAmount": 125, "PrepaymentAccountingDate": "2019-11-04" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{"result": "The current action Apply Prepayments has completed successfully."}