Jump to

• Request
• Response
• Examples

Unrelease of a single released or transfer rejected invoice

post

/fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/unreleaseProjectContractInvoice

Use this action to unrelease invoices that are either in released status or transfer rejected status. To unrelease an invoice that isn???t the last in sequence, you must first unrelease and delete all subsequent invoices. Invoices that are in transferred or accepted statuses cannot be unreleased.

Request

Path Parameters

• InvoiceId(required): integer(int64)
  Unique identifier of the invoice.

Header Parameters

• 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

• unreleaseComments: string
  Comments entered by the person who unreleased the invoice.

{
    "type":"object",
    "properties":{
        "unreleaseComments":{
            "type":"string",
            "description":"Comments entered by the person who unreleased the 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
  The invoice has been successfully unreleased.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The invoice has been successfully unreleased."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to unrelease a single released or transfer rejected invoice by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/vnd.oracle.adf.action+json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectContractInvoices/{InvoiceId}/action/unreleaseProjectContractInvoice

Request Body Example

The following shows an example of the request body in JSON format.

{
    "unreleaseComments": "Unrelease action example"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "result": "The invoice has been successfully unreleased."
}

Back to Top