Jump to

• Request
• Response
• Examples

Update a receivables invoice installment

patch

/fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}

Request

Path Parameters

• CustomerTransactionId(required): integer(int64)
  The unique identifier of the invoice.
• InstallmentId(required): integer(int64)
  The unique identifier of the invoice installment.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ExcludeFromCollections: string
  Title: Exclude from Collection Activities

  Maximum Length: 1

  Flag that determines if the installment is dummy or not.
• InstallmentDueDate: string (date)
  Title: Installment Due Date

  The due date of the installment.
• OriginalAmount: number
  Title: Original Amount

  The original due amount of the installment.
• receivablesInvoiceInstallmentGDF: array Receivables Invoice Installment Global Descriptive Flexfields
  Title: Receivables Invoice Installment Global Descriptive Flexfields

  The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.
• receivablesInvoiceInstallmentNotes: array Receivables Invoice Installment Notes
  Title: Receivables Invoice Installment Notes

  The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.

{
    "type":"object",
    "properties":{
        "receivablesInvoiceInstallmentNotes":{
            "title":"Receivables Invoice Installment Notes",
            "type":"array",
            "description":"The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.",
            "items":{
                "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-patch-request"
            }
        },
        "ExcludeFromCollections":{
            "title":"Exclude from Collection Activities",
            "maxLength":"1",
            "type":"string",
            "description":"Flag that determines if the installment is dummy or not.",
            "nullable":true,
            "x-queryable":false
        },
        "InstallmentDueDate":{
            "title":"Installment Due Date",
            "type":"string",
            "description":"The due date of the installment.",
            "format":"date",
            "nullable":false
        },
        "OriginalAmount":{
            "title":"Original Amount",
            "type":"number",
            "description":"The original due amount of the installment.",
            "nullable":false
        },
        "receivablesInvoiceInstallmentGDF":{
            "title":"Receivables Invoice Installment Global Descriptive Flexfields",
            "type":"array",
            "description":"The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.",
            "items":{
                "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentGDF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Receivables Invoice Installment Global Descriptive Flexfields

Type: array

Title: Receivables Invoice Installment Global Descriptive Flexfields

The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.

Show Source

• Array of: object Discriminator: __FLEX_Context
  Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request", "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request" } }

{
    "title":"Receivables Invoice Installment Global Descriptive Flexfields",
    "type":"array",
    "description":"The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.",
    "items":{
        "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentGDF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Receivables Invoice Installment Notes

Type: array

Title: Receivables Invoice Installment Notes

The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.

Show Source

• Array of: object receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-patch-request

{
    "title":"Receivables Invoice Installment Notes",
    "type":"array",
    "description":"The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.",
    "items":{
        "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-patch-request"
    }
}

Nested Schema : Discriminator: __FLEX_Context

Type: object

Discriminator: __FLEX_Context

Discriminator Values

• JL_BR_ARXTWMAI_Additional
• JLxMXReceivablePayment

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request",
            "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request"
        }
    ]
}

Match One Schema

Show Source

• JL_BR_ARXTWMAI_Additional - object oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request
• JLxMXReceivablePayment - object oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request",
            "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request"
        }
    ]
}

Nested Schema : oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 30

  Default Value: JL_BR_ARXTWMAI_Additional

  The installment global descriptive flexfield context segment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information
• _Base__Interest__Calculation: string
  Title: Base Interest Calculation

  Maximum Length: 150
• _Calculated__Interest: string
  Title: Calculated Interest

  Maximum Length: 150
• _Collection__Document__Number: string
  Title: Collection Document Number

  Maximum Length: 150
• _Format__Flag: string
  Title: Format

  Maximum Length: 150
• _Interest__Difference__Action: string
  Title: Interest Difference Action

  Maximum Length: 150
• _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__Payment__Date: string (date)
  Title: Interest Payment Date
• _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
• _Main__Amount__Received: string
  Title: Main Amount Received

  Maximum Length: 150
• _Payment__Method: number
  Title: Receipt Method
• _Payment__Method_Display: string
  Title: Receipt Method
• _Received__Interest: string
  Title: Received Interest

  Maximum Length: 150
• _Remittance__Batch__Number: string
  Title: Remittance Batch Number

  Maximum Length: 150
• _Write__Off__Date: string (date)
  Title: Write-Off Date
• _Write__Off__Reason: string
  Title: Write-Off Reason

  Maximum Length: 150

{
    "type":"object",
    "properties":{
        "_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"
                }
            }
        },
        "_Payment__Method":{
            "title":"Receipt Method",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Payment__Method_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_JLBR_AR_RECEIPT_METHOD#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Payment Method",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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__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"
                }
            }
        },
        "_Payment__Method_Display":{
            "title":"Receipt Method",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Payment__Method",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Base__Interest__Calculation":{
            "title":"Base Interest Calculation",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Base Interest Calculation",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "_Calculated__Interest":{
            "title":"Calculated Interest",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Calculated Interest",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":"30",
            "type":"string",
            "description":"The installment global descriptive flexfield context segment.",
            "nullable":true,
            "default":"JL_BR_ARXTWMAI_Additional",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FND_ACFF_IsDiscriminator":"true",
                "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"
                }
            }
        },
        "_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"
                }
            }
        },
        "_Main__Amount__Received":{
            "title":"Main Amount Received",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Main Amount Received",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Difference__Action":{
            "title":"Interest Difference Action",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Interest Difference Action",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Remittance__Batch__Number":{
            "title":"Remittance Batch Number",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Remittance Batch Number",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Received__Interest":{
            "title":"Received Interest",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Received Interest",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "_Format__Flag":{
            "title":"Format",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Format Flag",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Collection__Document__Number":{
            "title":"Collection Document Number",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Collection Document Number",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "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"
                }
            }
        },
        "_Write__Off__Reason":{
            "title":"Write-Off Reason",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Write Off Reason",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "_Interest__Payment__Date":{
            "title":"Interest Payment Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_STANDARD_DATE_STANDARD#FORMAT_ONLY",
                "controlType":"date",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_SegmentName":"Interest Payment Date",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_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"
                }
            }
        },
        "_Write__Off__Date":{
            "title":"Write-Off Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_STANDARD_DATE_STANDARD#FORMAT_ONLY",
                "controlType":"date",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_SegmentName":"Write Off Date",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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_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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 30

  Default Value: JLxMXReceivablePayment

  The installment global descriptive flexfield context segment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information
• 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

{
    "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"
                }
            }
        },
        "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"
                }
            }
        },
        "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":"30",
            "type":"string",
            "description":"The installment global descriptive flexfield context segment.",
            "nullable":true,
            "default":"JLxMXReceivablePayment",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FND_ACFF_IsDiscriminator":"true",
                "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 : receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-patch-request

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The text of the note on the invoice.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The text of the note on the invoice.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : receivablesInvoices-receivablesInvoiceInstallments-item-response

Type: object

Show Source

• AccountedBalanceDue: number
  Title: Accounted Balance Due

  Read Only: true

  The amount due on the installment in the ledger currency.
• AmountPaid: number
  Title: Amount Paid

  Read Only: true

  The amount that was paid on the installment.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DisputeAmount: number
  Title: Dispute Amount

  Read Only: true

  The amount in dispute on the installment.
• DisputeDate: string (date)
  Title: Dispute Date

  Read Only: true

  The date when a dispute was recorded against the installment.
• ExcludeFromCollections: string
  Title: Exclude from Collection Activities

  Maximum Length: 1

  Flag that determines if the installment is dummy or not.
• InstallmentAmountAdjusted: number
  Title: Installment Amount Adjusted

  Read Only: true

  The amount that was adjusted on the installment.
• InstallmentAmountCredited: number
  Title: Installment Amount Credited

  Read Only: true

  The amount that was credited on the installment.
• InstallmentBalanceDue: number
  Title: Installment Balance Due

  Read Only: true

  The outstanding balance on the installment.
• InstallmentClosedDate: string (date)
  Title: Installment Closed Date

  Read Only: true

  The actual date when the payment schedule was closed.
• InstallmentDueDate: string (date)
  Title: Installment Due Date

  The due date of the installment.
• InstallmentFreightAmountDue: number
  Title: Installment Freight Amount Due

  Read Only: true

  The freight amount due on the installment.
• InstallmentFreightAmountOriginal: number
  Title: Installment Freight Amount Original

  Read Only: true

  The original freight amount of the installment.
• InstallmentGLClosedDate: string (date)
  Title: Installment GL Closed Date

  Read Only: true

  The accounting date when the payment schedule was closed.
• InstallmentId: integer (int64)
  Title: Installment ID

  The unique identifier of the invoice installment.
• InstallmentLineAmountDue: number
  Title: Installment Line Amount Due

  Read Only: true

  The transaction line amount due on the installment.
• InstallmentLineAmountOriginal: number
  Title: Installment Line Amount Original

  Read Only: true

  The original transaction line amount of the installment.
• InstallmentSequenceNumber: integer (int64)
  Title: Installment Sequence Number

  Read Only: true

  The sequence number of the invoice installment.
• InstallmentStatus: string
  Title: Installment Status

  Read Only: true

  Maximum Length: 80

  The status of the installment.
• InstallmentTaxAmountDue: number
  Title: Installment Tax Amount Due

  Read Only: true

  The tax amount due on the installment.
• InstallmentTaxAmountOriginal: number
  Title: Installment Tax Amount Original

  Read Only: true

  The original tax amount of the installment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalAmount: number
  Title: Original Amount

  The original due amount of the installment.
• PaymentDaysLate: integer
  Title: Payment Days Late

  Read Only: true

  The number of days after the due date of the installment.
• PendingAdjustmentAmount: number
  Title: Pending Adjustment Amount

  Read Only: true

  The adjustment amount on the installment that is pending approval.
• receivablesInvoiceInstallmentGDF: array Receivables Invoice Installment Global Descriptive Flexfields
  Title: Receivables Invoice Installment Global Descriptive Flexfields

  The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.
• receivablesInvoiceInstallmentNotes: array Receivables Invoice Installment Notes
  Title: Receivables Invoice Installment Notes

  The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AmountPaid":{
            "title":"Amount Paid",
            "type":"number",
            "description":"The amount that was paid on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PendingAdjustmentAmount":{
            "title":"Pending Adjustment Amount",
            "type":"number",
            "description":"The adjustment amount on the installment that is pending approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentLineAmountDue":{
            "title":"Installment Line Amount Due",
            "type":"number",
            "description":"The transaction line amount due on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisputeDate":{
            "title":"Dispute Date",
            "type":"string",
            "description":"The date when a dispute was recorded against the installment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentClosedDate":{
            "title":"Installment Closed Date",
            "type":"string",
            "description":"The actual date when the payment schedule was closed.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisputeAmount":{
            "title":"Dispute Amount",
            "type":"number",
            "description":"The amount in dispute on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "receivablesInvoiceInstallmentNotes":{
            "title":"Receivables Invoice Installment Notes",
            "type":"array",
            "description":"The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.",
            "items":{
                "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-response"
            }
        },
        "InstallmentId":{
            "title":"Installment ID",
            "type":"integer",
            "description":"The unique identifier of the invoice installment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentDaysLate":{
            "title":"Payment Days Late",
            "type":"integer",
            "description":"The number of days after the due date of the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentGLClosedDate":{
            "title":"Installment GL Closed Date",
            "type":"string",
            "description":"The accounting date when the payment schedule was closed.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentFreightAmountDue":{
            "title":"Installment Freight Amount Due",
            "type":"number",
            "description":"The freight amount due on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExcludeFromCollections":{
            "title":"Exclude from Collection Activities",
            "maxLength":"1",
            "type":"string",
            "description":"Flag that determines if the installment is dummy or not.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InstallmentAmountAdjusted":{
            "title":"Installment Amount Adjusted",
            "type":"number",
            "description":"The amount that was adjusted on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentSequenceNumber":{
            "title":"Installment Sequence Number",
            "type":"integer",
            "description":"The sequence number of the invoice installment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentFreightAmountOriginal":{
            "title":"Installment Freight Amount Original",
            "type":"number",
            "description":"The original freight amount of the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "receivablesInvoiceInstallmentGDF":{
            "title":"Receivables Invoice Installment Global Descriptive Flexfields",
            "type":"array",
            "description":"The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.",
            "items":{
                "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentGDF-item-response"
            },
            "x-cardinality":"1"
        },
        "InstallmentStatus":{
            "title":"Installment Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Status"
                ]
            }
        },
        "AccountedBalanceDue":{
            "title":"Accounted Balance Due",
            "type":"number",
            "description":"The amount due on the installment in the ledger currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentTaxAmountDue":{
            "title":"Installment Tax Amount Due",
            "type":"number",
            "description":"The tax amount due on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentAmountCredited":{
            "title":"Installment Amount Credited",
            "type":"number",
            "description":"The amount that was credited on the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalAmount":{
            "title":"Original Amount",
            "type":"number",
            "description":"The original due amount of the installment.",
            "nullable":false,
            "x-queryable":true
        },
        "InstallmentLineAmountOriginal":{
            "title":"Installment Line Amount Original",
            "type":"number",
            "description":"The original transaction line amount of the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentTaxAmountOriginal":{
            "title":"Installment Tax Amount Original",
            "type":"number",
            "description":"The original tax amount of the installment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstallmentDueDate":{
            "title":"Installment Due Date",
            "type":"string",
            "description":"The due date of the installment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InstallmentBalanceDue":{
            "title":"Installment Balance Due",
            "type":"number",
            "description":"The outstanding balance on the installment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : Receivables Invoice Installment Global Descriptive Flexfields

Type: array

Title: Receivables Invoice Installment Global Descriptive Flexfields

The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.

Show Source

• Array of: object Discriminator: __FLEX_Context
  Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response", "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response" } }

{
    "title":"Receivables Invoice Installment Global Descriptive Flexfields",
    "type":"array",
    "description":"The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.",
    "items":{
        "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentGDF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Receivables Invoice Installment Notes

Type: array

Title: Receivables Invoice Installment Notes

The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.

Show Source

• Array of: object receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-response

{
    "title":"Receivables Invoice Installment Notes",
    "type":"array",
    "description":"The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.",
    "items":{
        "$ref":"#/components/schemas/receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-response"
    }
}

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_ARXTWMAI_Additional
• JLxMXReceivablePayment

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response",
            "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• JL_BR_ARXTWMAI_Additional - object oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response
• JLxMXReceivablePayment - object oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "JL_BR_ARXTWMAI_Additional":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response",
            "JLxMXReceivablePayment":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response"
        },
        {
            "$ref":"#/components/schemas/oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJL__5FBR__5FARXTWMAI__5FAdditionalVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 30

  Default Value: JL_BR_ARXTWMAI_Additional

  The installment global descriptive flexfield context segment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information
• _Base__Interest__Calculation: string
  Title: Base Interest Calculation

  Maximum Length: 150
• _Calculated__Interest: string
  Title: Calculated Interest

  Maximum Length: 150
• _Collection__Document__Number: string
  Title: Collection Document Number

  Maximum Length: 150
• _Format__Flag: string
  Title: Format

  Maximum Length: 150
• _Interest__Difference__Action: string
  Title: Interest Difference Action

  Maximum Length: 150
• _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__Payment__Date: string (date)
  Title: Interest Payment Date
• _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
• _Main__Amount__Received: string
  Title: Main Amount Received

  Maximum Length: 150
• _Payment__Method: number
  Title: Receipt Method
• _Payment__Method_Display: string
  Title: Receipt Method
• _Received__Interest: string
  Title: Received Interest

  Maximum Length: 150
• _Remittance__Batch__Number: string
  Title: Remittance Batch Number

  Maximum Length: 150
• _Write__Off__Date: string (date)
  Title: Write-Off Date
• _Write__Off__Reason: string
  Title: Write-Off Reason

  Maximum Length: 150
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentScheduleId: integer (int64)
  The unique identifier of the installment global descriptive flexfield.

{
    "type":"object",
    "properties":{
        "_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"
                }
            }
        },
        "_Payment__Method":{
            "title":"Receipt Method",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Payment__Method_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_JLBR_AR_RECEIPT_METHOD#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Payment Method",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "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__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"
                }
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "_Payment__Method_Display":{
            "title":"Receipt Method",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Payment__Method",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Base__Interest__Calculation":{
            "title":"Base Interest Calculation",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Base Interest Calculation",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "PaymentScheduleId":{
            "type":"integer",
            "description":"The unique identifier of the installment global descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "_Calculated__Interest":{
            "title":"Calculated Interest",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Calculated Interest",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":"30",
            "type":"string",
            "description":"The installment global descriptive flexfield context segment.",
            "nullable":true,
            "default":"JL_BR_ARXTWMAI_Additional",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FND_ACFF_IsDiscriminator":"true",
                "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"
                }
            }
        },
        "_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"
                }
            }
        },
        "_Main__Amount__Received":{
            "title":"Main Amount Received",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Main Amount Received",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Interest__Difference__Action":{
            "title":"Interest Difference Action",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Interest Difference Action",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Remittance__Batch__Number":{
            "title":"Remittance Batch Number",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Remittance Batch Number",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Received__Interest":{
            "title":"Received Interest",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Received Interest",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "_Format__Flag":{
            "title":"Format",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Format Flag",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Collection__Document__Number":{
            "title":"Collection Document Number",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "FND_ACFF_IsReadOnly":"true",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Collection Document Number",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "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"
                }
            }
        },
        "_Write__Off__Reason":{
            "title":"Write-Off Reason",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JG_CHARACTER_L150#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"150",
                "FND_ACFF_SegmentName":"Write Off Reason",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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"
                }
            }
        },
        "_Interest__Payment__Date":{
            "title":"Interest Payment Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_STANDARD_DATE_STANDARD#FORMAT_ONLY",
                "controlType":"date",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_SegmentName":"Interest Payment Date",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_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"
                }
            }
        },
        "_Write__Off__Date":{
            "title":"Write-Off Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"JLBR_STANDARD_DATE_STANDARD#FORMAT_ONLY",
                "controlType":"date",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.sql.Date",
                "FND_ACFF_SegmentName":"Write Off Date",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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_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"
                }
            }
        }
    }
}

Nested Schema : oracle_apps_financials_receivables_shared_model_flex_PaymentScheduleGdf_view_PaymentScheduleGdfJLxMXReceivablePaymentVO-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Regional Information

  Maximum Length: 30

  Default Value: JLxMXReceivablePayment

  The installment global descriptive flexfield context segment.
• __FLEX_Context_DisplayValue: string
  Title: Regional Information
• 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
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentScheduleId: integer (int64)
  The unique identifier of the installment global descriptive flexfield.

{
    "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Regional Information",
            "type":"string",
            "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"
            }
        },
        "PaymentScheduleId":{
            "type":"integer",
            "description":"The unique identifier of the installment global descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Regional Information",
            "maxLength":"30",
            "type":"string",
            "description":"The installment global descriptive flexfield context segment.",
            "nullable":true,
            "default":"JLxMXReceivablePayment",
            "x-hints":{
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "FND_ACFF_IsDiscriminator":"true",
                "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"
    }
}

Nested Schema : receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the note.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the note was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party who created the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  The option used to indicate whether the note can be deleted.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the note was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the note.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The text of the note on the invoice.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party associated with the note.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the note on the invoice.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  The option used to indicate whether the note can be updated.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the note on the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The visibility level of the note, such as Private, Internal, or External. A list of valid values is defined in the lookup NoteVisibilityLookupVA.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"The option used to indicate whether the note can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata. Possible values are Activities, Opportunities, and Sales Business Plan.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The text of the note on the invoice.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"The option used to indicate whether the note can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata. Examples are Activities and Opportunities.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party associated with the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the note was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the note.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Links

receivablesInvoiceInstallmentGDF

Operation: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentGDF

Parameters:

• CustomerTransactionId: $request.path.CustomerTransactionId
• InstallmentId: $request.path.InstallmentId

The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.

receivablesInvoiceInstallmentNotes

Operation: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes

Parameters:

• CustomerTransactionId: $request.path.CustomerTransactionId
• InstallmentId: $request.path.InstallmentId

The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.

Back to Top

Examples

The following example shows how to update the InstallmentDueDate of a receivables invoice installment by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100016218253/child/receivablesInvoiceInstallments/186816

Example Request Payload

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

{
    "InstallmentDueDate": "2018-03-20"
}

Example Response Body

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

{
    "InstallmentId": 186816,
    "InstallmentSequenceNumber": 1,
    "InstallmentDueDate": "2013-03-20",
    "OriginalAmount": 35219.27,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100016218253/child/receivablesInvoiceInstallments/186816",
            "name": "receivablesInvoiceInstallments",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100016218253/child/receivablesInvoiceInstallments/186816/child/receivablesInvoiceInstallmentNotes",
            "name": "receivablesInvoiceInstallmentNotes",
            "kind": "collection"
        },
        ...
    ]
}

Back to Top