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

Get all installments for an invoice

get

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

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the invoice installment with the specified primary key.
      Finder Variables:
      • InstallmentNumber; integer; The unique invoice installment number for the invoice.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BankAccount; string; 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.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • DueDate; string; 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.
    • ExternalBankAccountId; integer; 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.
    • FirstDiscountAmount; number; 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.
    • FirstDiscountDate; string; 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.
    • GrossAmount; number; 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.
    • HeldBy; string; The user who placed or requested the hold.
    • HoldDate; string; The date when the hold was placed.
    • HoldFlag; boolean; 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.
    • HoldReason; string; An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason.
    • HoldType; string; Indicates if the installment hold applied is by system or manually by the user.
    • InstallmentNumber; integer; 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.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The session login associated to the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • NetAmountOne; number; The net installment amount after deducting the first discount amount.
    • NetAmountThree; number; The net installment amount after deducting the third discount amount.
    • NetAmountTwo; number; The net installment amount after deducting the second discount amount.
    • PaymentMethod; string; 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.
    • PaymentMethodCode; string; The user-entered payment method code that helps to uniquely identify a payment method.
    • PaymentPriority; integer; 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.
    • RemitToAddressName; string; 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.
    • RemitToSupplier; string; 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.
    • RemittanceMessageOne; string; 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.
    • RemittanceMessageThree; string; 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.
    • RemittanceMessageTwo; string; 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.
    • SecondDiscountAmount; number; 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.
    • SecondDiscountDate; string; 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.
    • ThirdDiscountAmount; number; 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.
    • ThirdDiscountDate; string; 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.
    • UnpaidAmount; number; The invoice installment amount remaining for payment.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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
Back to Top

Examples

The following example shows how to retrieve all the installments for an invoice by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+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,
            "FirstDiscountDate": null,
            "DueDate": "2018-02-15",
            "GrossAmount": 31,
            "HoldReason": null,
            "PaymentPriority": 99,
            "SecondDiscountAmount": null,
            "SecondDiscountDate": null,
            "ThirdDiscountAmount": null,
            "ThirdDiscountDate": null,
            "NetAmountOne": null,
            "NetAmountTwo": null,
            "NetAmountThree": null,
            "HoldFlag": false,
            "HeldBy": null,
            "HoldType": null,
            "PaymentMethod": "Check",
            "PaymentMethodCode": "CHECK",
            "HoldDate": null,
            "BankAccount": "XX3884",
            "ExternalBankAccountId": 422,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2018-01-16T20:53:26+00:00",
            "LastUpdateDate": "2018-01-16T20:59:09+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdateLogin": "62E6A9F0368F0B13E0534280F50AB382",
            "RemitToAddressName": null,
            "RemitToSupplier": 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"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001",
                    "name": "invoiceInstallments",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001",
                    "name": "invoices",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/lov/DisbursementPaymentMethodPVO1",
                    "name": "DisbursementPaymentMethodPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/lov/ThirdPartyRelationshipsPVO1ForLOV",
                    "name": "ThirdPartyRelationshipsPVO1ForLOV",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/lov/RemitToSupplierPVO1",
                    "name": "RemitToSupplierPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001/child/invoiceInstallmentDff",
                    "name": "invoiceInstallmentDff",
                    "kind": "collection"
                }
            ]
        },
        ...
    ],
    "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"
        }
    ]
}
Back to Top