Jump to

• Request
• Response
• Examples

Release of a single approved invoice

post

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

Use this action to release invoices that have been approved and are ready to be released.

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

• creditMemoReasonCode: string
  Indicates the reason code for the creation of a standard invoice. If the Credit Memo Reason Code is provided it will override any value provided for the Credit Memo Reason Code attribute. Valid values must match a Lookup Code in the Manage Receivables Lookups task for the lookup type CREDIT_MEMO_REASON. For all credit invoices this attribute is optional unless the Require credit memo reason is selected for the related business unit as required in the setup task Specify Customer Contract Management Business Function Properties in the task list Define Project Billing Business Unit Options.
• creditMemoReasonMeaning: string
  Indicates the reason code meaning for the creation of a standard invoice. Valid values must match a Meaning in the Manage Receivables Lookups task for the lookup type CREDIT_MEMO_REASON. For all credit invoices this attribute is optional unless the Require credit memo reason is selected for the related business unit as required in the setup task Specify Customer Contract Management Business Function Properties in the task list Define Project Billing Business Unit Options.
• invoiceDate: string (date)
  The invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release.
• receivablesNumber: string
  The Oracle Receivables invoice number that is determined upon release of the invoice and passed to Oracle Receivables upon transfer. This number can be user-entered in the application or system-generated as defined in the Define Project Billing Business Unit task implementation options. If the invoice numbering method is set to Automatic, this attribute is automatically set, if it is set to Manual then a value is required when releasing an invoice.

{
    "type":"object",
    "properties":{
        "receivablesNumber":{
            "type":"string",
            "description":"The Oracle Receivables invoice number that is determined upon release of the invoice and passed to Oracle Receivables upon transfer. This number can be user-entered in the application or system-generated as defined in the Define Project Billing Business Unit task implementation options. If the invoice numbering method is set to Automatic, this attribute is automatically set, if it is set to Manual then a value is required when releasing an invoice.",
            "nullable":true
        },
        "creditMemoReasonCode":{
            "type":"string",
            "description":"Indicates the reason code for the creation of a standard invoice. If the Credit Memo Reason Code is provided it will override any value provided for the Credit Memo Reason Code attribute. Valid values must match a Lookup Code in the Manage Receivables Lookups task for the lookup type CREDIT_MEMO_REASON. For all credit invoices this attribute is optional unless the Require credit memo reason is selected for the related business unit as required in the setup task Specify Customer Contract Management Business Function Properties in the task list Define Project Billing Business Unit Options.",
            "nullable":true
        },
        "invoiceDate":{
            "type":"string",
            "description":"The invoice date passed to Oracle Receivables, which is used to calculate the invoice due date. Upon release of the invoice, the default value is the released date. You can override the invoice date at the time of release.",
            "format":"date",
            "nullable":true
        },
        "creditMemoReasonMeaning":{
            "type":"string",
            "description":"Indicates the reason code meaning for the creation of a standard invoice. Valid values must match a Meaning in the Manage Receivables Lookups task for the lookup type CREDIT_MEMO_REASON. For all credit invoices this attribute is optional unless the Require credit memo reason is selected for the related business unit as required in the setup task Specify Customer Contract Management Business Function Properties in the task list Define Project Billing Business Unit Options.",
            "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 released with the Invoice Date: , Receivables Number: , and Credit Memo Reason:

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The invoice has been successfully released with the Invoice Date: <Date>, Receivables Number: <Receivables Number>, and Credit Memo Reason: <Credit Memo Reason>"
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to release of a single approved 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/releaseProjectContractInvoice

Request Body Example

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

{
    "invoiceDate": "2018-12-25",
    "receivablesNumber": "IV80334",
    "creditMemoReasonMeaning":"Discount",
    "creditMemoReasonCode":"DISCOUNT"
}

Response Body Example

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

{
    "result": "The invoice has been successfully released with the Invoice Date: 2018-12-25, Receivables Number: IV80334, and Credit Memo Reason: Discount."
}

Back to Top