1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Invoices
  4. Invoice Installments

Update an invoice installment

patch

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

Request

Path Parameters
  • 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.
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    The supplier bank account number to which the payment will be remitted. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. You can also update the value for the bank account.
  • Title: Due Date
    The date when the invoice installment is due for payment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the due date.
  • Title: Bank Account
    The unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Bank Account and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Bank Account is ignored. You can also update the value for the bank account.
  • Title: First Discount Amount
    The discount amount available at first discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Date attribute. You can also update the value for the first discount amount.
  • Title: First Discount Date
    The date when the first discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Amount attribute. You can also update the value for the first discount date.
  • Title: Gross Amount
    The gross amount due for the invoice installment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the gross amount.
  • Maximum Length: 255
    Indicates whether a scheduled payment is on hold. The value can either be provided while creating an invoice installment or proactive system holds are applied if there are validation failures. The default value is false. You can also update the value for the hold flag.
  • Maximum Length: 2000
    An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason.
  • Invoice Installments Descriptive Flexfields
    Title: Invoice Installments Descriptive Flexfields
    The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
  • Invoice Installments Global Descriptive Flexfields
    Title: Invoice Installments Global Descriptive Flexfields
    The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
  • Title: Name
    Maximum Length: 100
    Indicates how the first party payer is going to make the payment for the invoice. Examples include check, cash, and credit. The value can either be provided while creating an invoice installment or populated by default based on the Payment Method Default Basis setup in the Manage Disbursement System Options. You can also update the value for the payment method.
  • Title: Payment Method
    Maximum Length: 30
    The user-entered payment method code that helps to uniquely identify a payment method.
  • Title: Payment Priority
    The number (1 to 99) representing the payment priority of an invoice installment. The value can either be provided while creating an invoice or populated by default from the Supplier Site or from the Manage Invoice Options for the invoicing business unit. You can also update the value for the payment priority.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 240
    The third-party payment related remit-to address where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to address.
  • Maximum Length: 240
    The third-party payment related remit-to supplier where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to supplier.
  • Title: Second Discount Amount
    The discount amount available at second discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Date attribute. You can also update the value for the second discount amount.
  • Title: Second Discount Date
    The date when the second discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Amount attribute. You can also update the value for the second discount date.
  • Title: Third Discount Amount
    The discount amount available at third discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Date attribute. You can also update the value for the third discount amount.
  • Title: Third Discount Date
    The date when the third discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Amount attribute. You can also update the value for the third discount date.
Nested Schema : Invoice Installments Descriptive Flexfields
Type: array
Title: Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
Show Source
Nested Schema : Invoice Installments Global Descriptive Flexfields
Type: array
Title: Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_APXINWKB_AP_PAY_SCHED":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-patch-request", "JLxMXPaymentSchedules":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-patch-request" } }
Nested Schema : schema
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-patch-request
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : invoices-invoiceInstallments-item-response
Type: object
Show Source
  • Maximum Length: 255
    The supplier bank account number to which the payment will be remitted. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. You can also update the value for the bank account.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Due Date
    The date when the invoice installment is due for payment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the due date.
  • Title: Bank Account
    The unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Bank Account and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Bank Account is ignored. You can also update the value for the bank account.
  • Title: First Discount Amount
    The discount amount available at first discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Date attribute. You can also update the value for the first discount amount.
  • Title: First Discount Date
    The date when the first discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Amount attribute. You can also update the value for the first discount date.
  • Title: Gross Amount
    The gross amount due for the invoice installment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the gross amount.
  • Read Only: true
    Maximum Length: 64
    The user who placed or requested the hold.
  • Read Only: true
    The date when the hold was placed.
  • Maximum Length: 255
    Indicates whether a scheduled payment is on hold. The value can either be provided while creating an invoice installment or proactive system holds are applied if there are validation failures. The default value is false. You can also update the value for the hold flag.
  • Maximum Length: 2000
    An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason.
  • Read Only: true
    Indicates if the installment hold applied is by system or manually by the user.
  • Title: Payment Number
    The number used to identify an invoice installment. The value must be provided while creating the installment. It cannot be updated once the invoice installment is created.
  • Invoice Installments Descriptive Flexfields
    Title: Invoice Installments Descriptive Flexfields
    The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
  • Invoice Installments Global Descriptive Flexfields
    Title: Invoice Installments Global Descriptive Flexfields
    The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the record.
  • Links
  • Read Only: true
    The net installment amount after deducting the first discount amount.
  • Read Only: true
    The net installment amount after deducting the third discount amount.
  • Read Only: true
    The net installment amount after deducting the second discount amount.
  • Title: Name
    Maximum Length: 100
    Indicates how the first party payer is going to make the payment for the invoice. Examples include check, cash, and credit. The value can either be provided while creating an invoice installment or populated by default based on the Payment Method Default Basis setup in the Manage Disbursement System Options. You can also update the value for the payment method.
  • Title: Payment Method
    Maximum Length: 30
    The user-entered payment method code that helps to uniquely identify a payment method.
  • Title: Payment Priority
    The number (1 to 99) representing the payment priority of an invoice installment. The value can either be provided while creating an invoice or populated by default from the Supplier Site or from the Manage Invoice Options for the invoicing business unit. You can also update the value for the payment priority.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 150
    Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage.
  • Maximum Length: 240
    The third-party payment related remit-to address where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to address.
  • Maximum Length: 240
    The third-party payment related remit-to supplier where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to supplier.
  • Title: Second Discount Amount
    The discount amount available at second discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Date attribute. You can also update the value for the second discount amount.
  • Title: Second Discount Date
    The date when the second discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Amount attribute. You can also update the value for the second discount date.
  • Title: Third Discount Amount
    The discount amount available at third discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Date attribute. You can also update the value for the third discount amount.
  • Title: Third Discount Date
    The date when the third discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Amount attribute. You can also update the value for the third discount date.
  • Read Only: true
    The invoice installment amount remaining for payment.
Nested Schema : Invoice Installments Descriptive Flexfields
Type: array
Title: Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
Show Source
Nested Schema : Invoice Installments Global Descriptive Flexfields
Type: array
Title: Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_APXINWKB_AP_PAY_SCHED":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response", "JLxMXPaymentSchedules":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response" } }
Nested Schema : invoices-invoiceInstallments-invoiceInstallmentDff-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Links
invoiceInstallmentDff
Parameters:
  • invoiceInstallmentsUniqID: $request.path.invoiceInstallmentsUniqID
  • invoicesUniqID: $request.path.invoicesUniqID
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
invoiceInstallmentGdf
Parameters:
  • invoiceInstallmentsUniqID: $request.path.invoiceInstallmentsUniqID
  • invoicesUniqID: $request.path.invoicesUniqID
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Back to Top

Examples

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

Get all the invoice installments of an invoice and use the self URI of the specific invoice installment. Then, submit a PATCH 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/300100177545967/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 retrieve the specific invoice installment.

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/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001

Example Request Payload

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

{
"DueDate":  "2018-09-15",
"HoldFlag": true,
"HoldReason": "Hold installment",
"PaymentMethod": "Check"
}

Example Response Body

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

{
    "InstallmentNumber": 1,
    "UnpaidAmount": 2212.75,
    "DueDate": "2018-09-15",
    "GrossAmount": 2212.75,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001",
            "name": "invoiceInstallments",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001/child/invoiceInstallmentDff",
            "name": "invoiceInstallmentDff",
            "kind": "collection"
        },
        ...
    ]
}
Back to Top