Jump to

• Request
• Response
• Examples

Delete an invoice installment

delete

/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}

Request

Path Parameters

• invoiceInstallmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Invoice Installments resource and used to uniquely identify an instance of Invoice Installments. The client should not generate the hash key value. Instead, the client should query on the Invoice Installments collection resource in order to navigate to a specific instance of Invoice Installments to get the hash key.
• invoicesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.

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.

There's no request body for this operation.

Back to Top

Response

Default Response

No Content. This task does not return elements in the response body.

Back to Top

Examples

The following example shows how to retrieve and delete an invoice installment.

Get all the invoice installments of an invoice and use the self URI of the specific invoice installment. Then, submit a DELETE request on the REST resource using cURL.

Here's the cURL command to retrieve all the invoice installments:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments

Example Response Body

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

{
    "items": [
        {
            "InstallmentNumber": 1,
            "UnpaidAmount": 0,
            "FirstDiscountAmount": null,...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001",
                    "name": "invoiceInstallments",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
                                  }
                },
                ...
           ]
        },
        ...
    ],
    "count": 10,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments",
            "name": "invoiceInstallments",
            "kind": "collection"
        }
    ]
}

A hash key of InvoiceId and InstallmentNumber identifies an invoice installment.

Here's the cURL command that uses the hash key in the self URI to delete the invoice installment:

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X DELETE https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001

Example of Response Body

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

204 Response
 
No content. The server successfully processed the request, but is not returning any content.

Back to Top