Jump to

• Request
• Response
• Examples

Unapply a prepayment from an invoice

post

/fscmRestApi/resources/11.13.18.05/invoices/action/unapplyPrepayments

Unapplies a prepayment from an invoice. When you unapply a prepayment, the prepayment is then available for application to another invoice.

Request

Header Parameters

• 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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• BusinessUnit: string
  The business unit name on the invoice.
• InvoiceNumber: string
  The unique number of the supplier invoice.
• PrepaymentApplicationAccountingDate: string (date)
  The accounting date used for the prepayment application. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.
• PrepaymentAppliedAmount: number
  The amount of prepayment applied to the standard invoice. This amount must be positive. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.
• PrepaymentInvoiceNumber: string
  The unique number of the prepayment invoice for the supplier.
• PrepaymentLineNumber: number
  The unique line number of the prepayment invoice.
• PrepaymentUnapplicationAccountingDate: string (date)
  The accounting date to be used when unapplying a prepayment from an invoice. The value can be provided while unapplying a prepayment or populated by default to the system date. When passing the attribute value in the payload, ensure the accounting date is later than the accounting date of the standard invoice and the prepayment distributions.
• PurchaseOrder: string
  The purchase order document number that is matched to the prepayment invoice. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.
• Supplier: string
  The supplier name on the invoice.

{
    "type":"object",
    "properties":{
        "PrepaymentUnapplicationAccountingDate":{
            "type":"string",
            "description":"The accounting date to be used when unapplying a prepayment from an invoice. The value can be provided while unapplying a prepayment or populated by default to the system date. When passing the attribute value in the payload, ensure the accounting date is later than the accounting date of the standard invoice and the prepayment distributions.",
            "format":"date",
            "nullable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"The business unit name on the invoice.",
            "nullable":true
        },
        "PrepaymentLineNumber":{
            "type":"number",
            "description":"The unique line number of the prepayment invoice.",
            "nullable":true
        },
        "PrepaymentInvoiceNumber":{
            "type":"string",
            "description":"The unique number of the prepayment invoice for the supplier.",
            "nullable":true
        },
        "PurchaseOrder":{
            "type":"string",
            "description":"The purchase order document number that is matched to the prepayment invoice. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.",
            "nullable":true
        },
        "PrepaymentAppliedAmount":{
            "type":"number",
            "description":"The amount of prepayment applied to the standard invoice. This amount must be positive. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.",
            "nullable":true
        },
        "Supplier":{
            "type":"string",
            "description":"The supplier name on the invoice.",
            "nullable":true
        },
        "InvoiceNumber":{
            "type":"string",
            "description":"The unique number of the supplier invoice.",
            "nullable":true
        },
        "PrepaymentApplicationAccountingDate":{
            "type":"string",
            "description":"The accounting date used for the prepayment application. This is an optional attribute and helps to uniquely identify a prepayment record that needs to be unapplied.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Returns "The current action Unapply Prepayment has completed successfully." if the action completes successfully.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns \"The current action Unapply Prepayment has completed successfully.\" if the action completes successfully."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

Example 1

The following example shows how to unapply a prepayment with basic information 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/unapplyPrepayments

Example Request body

The following example shows the contents of the request body in JSON format:

	{
		"InvoiceNumber": "AND-SI-1",
	       "PrepaymentInvoiceNumber": "SK_Prepay_1",
		"PrepaymentLineNumber": "1"
	}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "result": "The current action Unapply Prepayments has completed successfully."
}

Example 2

The following example shows how to unapply a prepayment that was applied multiple times on the standard invoice.

Add additional attributes in the payload until a unique prepayment is found for unapplication.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/action/unapplyPrepayments

Example Request body

The following example shows the contents of the request body in JSON format:

	{
		"InvoiceNumber": "AND-SI-PO-1000183",
		"PrepaymentInvoiceNumber": "AND-PP-PO-1000183",
		"PrepaymentLineNumber": "1",
		"PurchaseOrder": "1000183",
		"PrepaymentApplicationAccountingDate": "2020-02-11",
		"PrepaymentAppliedAmount": 5500,
		"PrepaymentUnapplicationAccountingDate": "2020-02-12"
	}
  

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "result": "The current action Unapply Prepayments has completed successfully."
}

Back to Top