Jump to

• Request
• Response
• Examples

Get an invoice installment

get

/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.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• BankAccount: string
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• DueDate: string (date)
  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.
• ExternalBankAccountId: integer (int64)
  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.
• FirstDiscountAmount: number
  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.
• FirstDiscountDate: string (date)
  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.
• GrossAmount: number
  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.
• HeldBy: string
  Read Only: true

  Maximum Length: 64

  The user who placed or requested the hold.
• HoldDate: string (date-time)
  Read Only: true

  The date when the hold was placed.
• HoldFlag: boolean
  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.
• HoldReason: string
  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.
• HoldType: string
  Read Only: true

  Indicates if the installment hold applied is by system or manually by the user.
• InstallmentNumber: integer (int64)
  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.
• invoiceInstallmentDff: array 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.
• invoiceInstallmentGdf: array 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetAmountOne: number
  Read Only: true

  The net installment amount after deducting the first discount amount.
• NetAmountThree: number
  Read Only: true

  The net installment amount after deducting the third discount amount.
• NetAmountTwo: number
  Read Only: true

  The net installment amount after deducting the second discount amount.
• PaymentMethod: string
  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.
• PaymentMethodCode: string
  Title: Payment Method

  Maximum Length: 30

  The user-entered payment method code that helps to uniquely identify a payment method.
• PaymentPriority: integer (int32)
  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.
• RemittanceMessageOne: string
  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.
• RemittanceMessageThree: string
  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.
• RemittanceMessageTwo: string
  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.
• RemitToAddressName: string
  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.
• RemitToSupplier: string
  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.
• SecondDiscountAmount: number
  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.
• SecondDiscountDate: string (date)
  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.
• ThirdDiscountAmount: number
  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.
• ThirdDiscountDate: string (date)
  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.
• UnpaidAmount: number
  Read Only: true

  The invoice installment amount remaining for payment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ThirdDiscountDate":{
            "title":"Third Discount Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "UnpaidAmount":{
            "type":"number",
            "description":"The invoice installment amount remaining for payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NetAmountThree":{
            "type":"number",
            "description":"The net installment amount after deducting the third discount amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemittanceMessageTwo":{
            "maxLength":150,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NetAmountOne":{
            "type":"number",
            "description":"The net installment amount after deducting the first discount amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemittanceMessageOne":{
            "maxLength":150,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "HeldBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who placed or requested the hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstDiscountAmount":{
            "title":"First Discount Amount",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RemitToAddressName":{
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "RemitToSupplier"
                ]
            },
            "x-queryable":true
        },
        "InstallmentNumber":{
            "title":"Payment Number",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalBankAccountId":{
            "title":"Bank Account",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ThirdDiscountAmount":{
            "title":"Third Discount Amount",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "GrossAmount":{
            "title":"Gross Amount",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondDiscountDate":{
            "title":"Second Discount Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldType":{
            "type":"string",
            "description":"Indicates if the installment hold applied is by system or manually by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemitToSupplier":{
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RemittanceMessageThree":{
            "maxLength":150,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccount":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExternalBankAccountId",
                    "MaskedBankAccountNum",
                    "RemitToAddressName",
                    "RemitToSupplier"
                ]
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The user-entered payment method code that helps to uniquely identify a payment method.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "HoldReason":{
            "maxLength":2000,
            "type":"string",
            "description":"An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentPriority":{
            "title":"Payment Priority",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "SecondDiscountAmount":{
            "title":"Second Discount Amount",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "NetAmountTwo":{
            "type":"number",
            "description":"The net installment amount after deducting the second discount amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldDate":{
            "type":"string",
            "description":"The date when the hold was placed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentMethodCode"
                ]
            },
            "x-queryable":true
        },
        "invoiceInstallmentGdf":{
            "title":"Invoice Installments Global Descriptive Flexfields",
            "type":"array",
            "description":"The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.",
            "items":{
                "$ref":"#/components/schemas/invoices-invoiceInstallments-invoiceInstallmentGdf-item-response"
            },
            "x-cardinality":"1"
        },
        "FirstDiscountDate":{
            "title":"First Discount Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "invoiceInstallmentDff":{
            "title":"Invoice Installments Descriptive Flexfields",
            "type":"array",
            "description":"The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.",
            "items":{
                "$ref":"#/components/schemas/invoices-invoiceInstallments-invoiceInstallmentDff-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object invoices-invoiceInstallments-invoiceInstallmentDff-item-response

{
    "title":"Invoice Installments Descriptive Flexfields",
    "type":"array",
    "description":"The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.",
    "items":{
        "$ref":"#/components/schemas/invoices-invoiceInstallments-invoiceInstallmentDff-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object 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" } }

{
    "title":"Invoice Installments Global Descriptive Flexfields",
    "type":"array",
    "description":"The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.",
    "items":{
        "$ref":"#/components/schemas/invoices-invoiceInstallments-invoiceInstallmentGdf-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : invoices-invoiceInstallments-invoiceInstallmentDff-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 150

  The descriptive flexfield context name for the invoice installment.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  The descriptive flexfield context display value for the invoice installment.
• InstallmentNumber: integer (int64)
  Title: Payment Number

  The number used to identify an invoice installment to which the descriptive flexfield is associated.
• InvoiceId: integer (int64)
  The unique identifier for the invoice to which the installment descriptive flexfield is associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoiceId":{
            "type":"integer",
            "description":"The unique identifier for the invoice to which the installment descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "InstallmentNumber":{
            "title":"Payment Number",
            "type":"integer",
            "description":"The number used to identify an invoice installment to which the descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"The descriptive flexfield context display value for the invoice installment.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":150,
            "type":"string",
            "description":"The descriptive flexfield context name for the invoice installment.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

Discriminator Values

• JL_BR_APXINWKB_AP_PAY_SCHED
• JLxMXPaymentSchedules

{
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• JL_BR_APXINWKB_AP_PAY_SCHED - object oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
• JLxMXPaymentSchedules - object oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response

{
    "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"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 150

  Default Value: JL_BR_APXINWKB_AP_PAY_SCHED

  The global descriptive flexfield context name for the invoice installment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information

  The global descriptive flexfield context display value for the invoice installment.
• _Anticipated__Withholding__Amount: number
  Title: Withholding Amount
• _Interest__Formula: string
  Title: Interest Formula

  Maximum Length: 150
• _Interest__Formula_Display: string
  Title: Interest Formula
• _Interest__Grace__Days: number
  Title: Interest Grace Days
• _Interest__Penalty__Rate___2F__Amount: number
  Title: Interest Penalty Rate or Amount
• _Interest__Penalty__Type: string
  Title: Interest Penalty Type

  Maximum Length: 150
• _Interest__Penalty__Type_Display: string
  Title: Interest Penalty Type
• _Interest__Period: number
  Title: Interest Period
• _Interest__Rate___2F__Amount: number
  Title: Interest Rate or Amount
• _Interest__Type: string
  Title: Interest Type

  Maximum Length: 150
• _Interest__Type_Display: string
  Title: Interest Type
• InstallmentNumber: integer (int64)
  Title: Payment Number

  The number used to identify an invoice installment to which the global descriptive flexfield is associated.
• InvoiceId: integer (int64)
  The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• originalInstallmentDueDate: string (date)
  Title: Original Installment Due Date
• ValidatedInstallmentGrossAmt: string
  Title: Validated Installment Gross Amount

  Maximum Length: 150

{
    "type":"object",
    "properties":{
        "_Interest__Penalty__Rate___2F__Amount":{
            "title":"Interest Penalty Rate or Amount",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"15",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INT_PENALTY_RATE_AMOUNT#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"0",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Interest Penalty Rate / Amount",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Rate___2F__Amount":{
            "title":"Interest Rate or Amount",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"15",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_RATE_AMOUNT#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"0",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Interest Rate / Amount",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "InvoiceId":{
            "type":"integer",
            "description":"The unique identifier for the invoice to which the installment global descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "_Anticipated__Withholding__Amount":{
            "title":"Withholding Amount",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JG_NUMBER#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Anticipated Withholding Amount",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "ValidatedInstallmentGrossAmt":{
            "title":"Validated Installment Gross Amount",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_OpenIdentifier":"ValidatedInstallmentGrossAmt",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Validated Installment Gross Am",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Grace__Days":{
            "title":"Interest Grace Days",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"4",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_GRACE_DAYS#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"0",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Interest Grace Days",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Formula":{
            "title":"Interest Formula",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Interest__Formula_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_FORMULA#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"Interest Formula",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Period":{
            "title":"Interest Period",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"4",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_PERIOD#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_MinimumValue":"0",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Interest Period",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "InstallmentNumber":{
            "title":"Payment Number",
            "type":"integer",
            "description":"The number used to identify an invoice installment to which the global descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "originalInstallmentDueDate":{
            "title":"Original Installment Due Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JLBR_STANDARD_DATE_STANDARD#FORMAT_ONLY",
                "controlType":"date",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_OpenIdentifier":"originalInstallmentDueDate",
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_SegmentName":"Original Installment Due Date",
                "FND_ACFF_PreferredDisplayType":"DATE_TIME"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "description":"The global descriptive flexfield context display value for the invoice installment.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Penalty__Type_Display":{
            "title":"Interest Penalty Type",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Interest__Penalty__Type",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "_Interest__Penalty__Type":{
            "title":"Interest Penalty Type",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Interest__Penalty__Type_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_PENALTY_TYPE#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"Interest Penalty Type",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Type_Display":{
            "title":"Interest Type",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Interest__Type",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Formula_Display":{
            "title":"Interest Formula",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Interest__Formula",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Type":{
            "title":"Interest Type",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Interest__Type_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_AP_INTEREST_PENALTY_TYPE#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"Interest Type",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":150,
            "type":"string",
            "description":"The global descriptive flexfield context name for the invoice installment.",
            "nullable":true,
            "default":"JL_BR_APXINWKB_AP_PAY_SCHED",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.lang.String",
                "FND_ACFF_ValueSetInfo":"JG_GDF_CONTEXTS_BY_COUNTRY#TABLE",
                "controlType":"choice",
                "includeInCompactView":true,
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 150

  Default Value: JLxMXPaymentSchedules

  The global descriptive flexfield context name for the invoice installment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information

  The global descriptive flexfield context display value for the invoice installment.
• CFDCBBInvoiceNumber: string
  Title: Digital Tax Receipt Invoice Number

  Maximum Length: 150
• CFDCBBSerialNumber: string
  Title: Digital Tax Receipt Serial Number

  Maximum Length: 150
• CFDIUniqueIdentifier: string
  Title: Digital Tax Receipt using Internet Unique ID

  Maximum Length: 150
• InstallmentNumber: integer (int64)
  Title: Payment Number

  The number used to identify an invoice installment to which the global descriptive flexfield is associated.
• InvoiceId: integer (int64)
  The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CFDCBBInvoiceNumber":{
            "title":"Digital Tax Receipt Invoice Number",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_OpenIdentifier":"CFDCBBInvoiceNumber",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"CFDCBBInvoiceNumber",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "CFDCBBSerialNumber":{
            "title":"Digital Tax Receipt Serial Number",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L30#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_OpenIdentifier":"CFDCBBSerialNumber",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"30",
                "FND_ACFF_SegmentName":"CFDCBBSerialNumber",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "InstallmentNumber":{
            "title":"Payment Number",
            "type":"integer",
            "description":"The number used to identify an invoice installment to which the global descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "description":"The global descriptive flexfield context display value for the invoice installment.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "CFDIUniqueIdentifier":{
            "title":"Digital Tax Receipt using Internet Unique ID",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_OpenIdentifier":"CFDIUniqueIdentifier",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"CFDIUniqueIdentifier",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoiceId":{
            "type":"integer",
            "description":"The unique identifier for the invoice to which the installment global descriptive flexfield is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":150,
            "type":"string",
            "description":"The global descriptive flexfield context name for the invoice installment.",
            "nullable":true,
            "default":"JLxMXPaymentSchedules",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FlexClientVar_flex_vst_bind3_JT":"java.lang.String",
                "FlexClientVar_flex_vst_bind2_JT":"java.lang.String",
                "FND_ACFF_ValueSetInfo":"JG_GDF_CONTEXTS_BY_COUNTRY#TABLE",
                "controlType":"choice",
                "includeInCompactView":true,
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.GLOBAL_COUNTRY_CODE",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind2",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

invoiceInstallmentDff

Operation: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/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

Operation: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/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 an invoice installment.

Get all the invoice installments of an invoice and use the self URI of the specific invoice installment.

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 retrieve the 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/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001

Example Response Body

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

{
    "InstallmentNumber": 1,
    "UnpaidAmount": 0,
    "DueDate": "2018-02-15",
    "GrossAmount": 31,
    ...
    "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": "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"
        },
        ...
    ]
}

Back to Top