Jump to

• Request
• Response
• Examples

Cancel an invoice

post

/fscmRestApi/resources/11.13.18.05/invoices/action/cancelInvoice

Cancels an invoice. When you cancel an invoice, all invoice amounts are set to zero, and the invoice can't be edited or submitted for processing.

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.
• Party: string
  The party name on the invoice.
• PartyId: number
  The unique identifier assigned to the party on the invoice.
• Supplier: string
  The supplier name on the invoice.

{
    "type":"object",
    "properties":{
        "Party":{
            "type":"string",
            "description":"The party name on the invoice.",
            "nullable":true
        },
        "PartyId":{
            "type":"number",
            "description":"The unique identifier assigned to the party on the invoice.",
            "nullable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"The business unit name on the invoice.",
            "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
        }
    },
    "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 Cancel Invoice has completed successfully." if the action completes successfully.

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

Back to Top

Examples

Example 1

The following example shows how to cancel 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/cancelInvoice

Example Request Payload

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

	{
		"InvoiceNumber": "REST_Invoice",
		"BusinessUnit": "Vision Operations",
		"Supplier": "Advanced Network Devices"
	}

Example Response Body

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

{
    "result": "The current action Cancel Invoice has completed successfully."
}

Example 2

The following example shows how to cancel a payment request invoice by submitting a POST request on the REST resource using cURL.

Note:

You can't cancel the payment request invoice of an expense report that includes a split invoice expense report.

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/cancelInvoice

Example Request Payload

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

	{
	 "InvoiceNumber": "OTP-P1-IBY2-18"
        "Party":  "OTP-P1-IBY2-Party 3"		
        "BusinessUnit": "Vision Operations",
        "PartyId": 100100139746837

	}

Example Response Body

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

{
    "result": "The current action Cancel Invoice has completed successfully."
}

Example 3

The following example shows error response when you request cancellation of a payment request invoice that includes a split invoice expense report.

Note:

You can't cancel the payment request invoice of an expense report that includes a split invoice expense report.

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/cancelInvoice

Example Request Payload

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

	{
	 "InvoiceNumber": "VO:10017158"
        "BusinessUnit": "Vision Operations"
        "Party":  "Kerry Jones, Kerry"
        "PartyId": 100100004958376
	}

Example Response Body

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

{
    "result": "You can't cancel the payment request invoice of an expense report that includes a split invoice expense report. (AP-811196)"
}

Back to Top