Create an invoice installment
post
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments
Request
Path Parameters
-
invoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BankAccount: string
Maximum Length:
255
The supplier bank account number to which the payment will be remitted. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. You can also update the value for the bank account. -
DueDate(required): string
(date)
Title:
Due Date
The date when the invoice installment is due for payment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the due date. -
ExternalBankAccountId: integer
(int64)
Title:
Bank Account
The unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Bank Account and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Bank Account is ignored. You can also update the value for the bank account. -
FirstDiscountAmount: number
Title:
First Discount Amount
The discount amount available at first discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Date attribute. You can also update the value for the first discount amount. -
FirstDiscountDate: string
(date)
Title:
First Discount Date
The date when the first discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Amount attribute. You can also update the value for the first discount date. -
GrossAmount(required): number
Title:
Gross Amount
The gross amount due for the invoice installment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the gross amount. -
HoldFlag: boolean
Maximum Length:
255
Indicates whether a scheduled payment is on hold. The value can either be provided while creating an invoice installment or proactive system holds are applied if there are validation failures. The default value is false. You can also update the value for the hold flag. -
HoldReason: string
Maximum Length:
2000
An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason. -
InstallmentNumber(required): integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment. The value must be provided while creating the installment. It cannot be updated once the invoice installment is created. -
invoiceInstallmentDff: array
Invoice Installments Descriptive Flexfields
Title:
Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment. -
invoiceInstallmentGdf: array
Invoice Installments Global Descriptive Flexfields
Title:
Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment. -
PaymentMethod: string
Title:
Name
Maximum Length:100
Indicates how the first party payer is going to make the payment for the invoice. Examples include check, cash, and credit. The value can either be provided while creating an invoice installment or populated by default based on the Payment Method Default Basis setup in the Manage Disbursement System Options. You can also update the value for the payment method. -
PaymentMethodCode(required): string
Title:
Payment Method
Maximum Length:30
The user-entered payment method code that helps to uniquely identify a payment method. -
PaymentPriority(required): integer
(int32)
Title:
Payment Priority
The number (1 to 99) representing the payment priority of an invoice installment. The value can either be provided while creating an invoice or populated by default from the Supplier Site or from the Manage Invoice Options for the invoicing business unit. You can also update the value for the payment priority. -
RemittanceMessageOne: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemittanceMessageThree: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemittanceMessageTwo: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemitToAddressName: string
Maximum Length:
240
The third-party payment related remit-to address where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to address. -
RemitToSupplier: string
Maximum Length:
240
The third-party payment related remit-to supplier where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to supplier. -
SecondDiscountAmount: number
Title:
Second Discount Amount
The discount amount available at second discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Date attribute. You can also update the value for the second discount amount. -
SecondDiscountDate: string
(date)
Title:
Second Discount Date
The date when the second discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Amount attribute. You can also update the value for the second discount date. -
ThirdDiscountAmount: number
Title:
Third Discount Amount
The discount amount available at third discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Date attribute. You can also update the value for the third discount amount. -
ThirdDiscountDate: string
(date)
Title:
Third Discount Date
The date when the third discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Amount attribute. You can also update the value for the third discount date.
Nested Schema : Invoice Installments Descriptive Flexfields
Type:
array
Title:
Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
Show Source
Nested Schema : Invoice Installments Global Descriptive Flexfields
Type:
array
Title:
Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_APXINWKB_AP_PAY_SCHED":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-post-request", "JLxMXPaymentSchedules":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-post-request" } }
Nested Schema : invoices-invoiceInstallments-invoiceInstallmentDff-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice installment. -
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment descriptive flexfield is associated.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
JL_BR_APXINWKB_AP_PAY_SCHED -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-post-request
-
JLxMXPaymentSchedules -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-post-request
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JL_BR_APXINWKB_AP_PAY_SCHED
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
_Anticipated__Withholding__Amount: number
Title:
Withholding Amount
-
_Interest__Formula: string
Title:
Interest Formula
Maximum Length:150
-
_Interest__Formula_Display: string
Title:
Interest Formula
-
_Interest__Grace__Days: number
Title:
Interest Grace Days
-
_Interest__Penalty__Rate___2F__Amount: number
Title:
Interest Penalty Rate or Amount
-
_Interest__Penalty__Type: string
Title:
Interest Penalty Type
Maximum Length:150
-
_Interest__Penalty__Type_Display: string
Title:
Interest Penalty Type
-
_Interest__Period: number
Title:
Interest Period
-
_Interest__Rate___2F__Amount: number
Title:
Interest Rate or Amount
-
_Interest__Type: string
Title:
Interest Type
Maximum Length:150
-
_Interest__Type_Display: string
Title:
Interest Type
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
-
originalInstallmentDueDate: string
(date)
Title:
Original Installment Due Date
-
ValidatedInstallmentGrossAmt: string
Title:
Validated Installment Gross Amount
Maximum Length:150
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentSchedules
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
CFDCBBInvoiceNumber: string
Title:
Digital Tax Receipt Invoice Number
Maximum Length:150
-
CFDCBBSerialNumber: string
Title:
Digital Tax Receipt Serial Number
Maximum Length:150
-
CFDIUniqueIdentifier: string
Title:
Digital Tax Receipt using Internet Unique ID
Maximum Length:150
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
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.
Root Schema : invoices-invoiceInstallments-item-response
Type:
Show Source
object
-
BankAccount: string
Maximum Length:
255
The supplier bank account number to which the payment will be remitted. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. You can also update the value for the bank account. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DueDate: string
(date)
Title:
Due Date
The date when the invoice installment is due for payment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the due date. -
ExternalBankAccountId: integer
(int64)
Title:
Bank Account
The unique identifier for the supplier bank account. The value can either be provided while creating an invoice installment or populated by default from the Supplier Site or Address or Profile level payment attributes. If both Bank Account and External Bank Account ID is provided in the payload then the value for the External Bank Account ID is given preference and the value provided for Bank Account is ignored. You can also update the value for the bank account. -
FirstDiscountAmount: number
Title:
First Discount Amount
The discount amount available at first discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Date attribute. You can also update the value for the first discount amount. -
FirstDiscountDate: string
(date)
Title:
First Discount Date
The date when the first discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the First Discount Amount attribute. You can also update the value for the first discount date. -
GrossAmount: number
Title:
Gross Amount
The gross amount due for the invoice installment. The value can either be provided while creating an invoice or derived based on the payment terms. You can also update the value for the gross amount. -
HeldBy: string
Read Only:
true
Maximum Length:64
The user who placed or requested the hold. -
HoldDate: string
(date-time)
Read Only:
true
The date when the hold was placed. -
HoldFlag: boolean
Maximum Length:
255
Indicates whether a scheduled payment is on hold. The value can either be provided while creating an invoice installment or proactive system holds are applied if there are validation failures. The default value is false. You can also update the value for the hold flag. -
HoldReason: string
Maximum Length:
2000
An explanation or justification provided for placing or releasing the hold on the installment. You can also update the value for the hold reason. -
HoldType: string
Read Only:
true
Indicates if the installment hold applied is by system or manually by the user. -
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment. The value must be provided while creating the installment. It cannot be updated once the invoice installment is created. -
invoiceInstallmentDff: array
Invoice Installments Descriptive Flexfields
Title:
Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment. -
invoiceInstallmentGdf: array
Invoice Installments Global Descriptive Flexfields
Title:
Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetAmountOne: number
Read Only:
true
The net installment amount after deducting the first discount amount. -
NetAmountThree: number
Read Only:
true
The net installment amount after deducting the third discount amount. -
NetAmountTwo: number
Read Only:
true
The net installment amount after deducting the second discount amount. -
PaymentMethod: string
Title:
Name
Maximum Length:100
Indicates how the first party payer is going to make the payment for the invoice. Examples include check, cash, and credit. The value can either be provided while creating an invoice installment or populated by default based on the Payment Method Default Basis setup in the Manage Disbursement System Options. You can also update the value for the payment method. -
PaymentMethodCode: string
Title:
Payment Method
Maximum Length:30
The user-entered payment method code that helps to uniquely identify a payment method. -
PaymentPriority: integer
(int32)
Title:
Payment Priority
The number (1 to 99) representing the payment priority of an invoice installment. The value can either be provided while creating an invoice or populated by default from the Supplier Site or from the Manage Invoice Options for the invoicing business unit. You can also update the value for the payment priority. -
RemittanceMessageOne: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemittanceMessageThree: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemittanceMessageTwo: string
Maximum Length:
150
Remittance message provided for payment processing. You can provide the information during invoice creation or it will be populated by default from the invoice header. You may update the information at a later stage. -
RemitToAddressName: string
Maximum Length:
240
The third-party payment related remit-to address where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to address. -
RemitToSupplier: string
Maximum Length:
240
The third-party payment related remit-to supplier where the payment should be sent. The value can either be provided while creating an invoice installment or populated by default from the Invoicing tab of the Supplier Site. You can also update the value for the remit-to supplier. -
SecondDiscountAmount: number
Title:
Second Discount Amount
The discount amount available at second discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Date attribute. You can also update the value for the second discount amount. -
SecondDiscountDate: string
(date)
Title:
Second Discount Date
The date when the second discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Second Discount Amount attribute. You can also update the value for the second discount date. -
ThirdDiscountAmount: number
Title:
Third Discount Amount
The discount amount available at third discount date. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Date attribute. You can also update the value for the third discount amount. -
ThirdDiscountDate: string
(date)
Title:
Third Discount Date
The date when the third discount is available. The value can either be provided while creating an invoice or derived based on the payment terms. The value for the attribute must exist if a value exists for the Third Discount Amount attribute. You can also update the value for the third discount date. -
UnpaidAmount: number
Read Only:
true
The invoice installment amount remaining for payment.
Nested Schema : Invoice Installments Descriptive Flexfields
Type:
array
Title:
Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
Show Source
Nested Schema : Invoice Installments Global Descriptive Flexfields
Type:
array
Title:
Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Show Source
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "JL_BR_APXINWKB_AP_PAY_SCHED":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response", "JLxMXPaymentSchedules":"#/components/schemas/oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : invoices-invoiceInstallments-invoiceInstallmentDff-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:150
The descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
The descriptive flexfield context display value for the invoice installment. -
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
-
JL_BR_APXINWKB_AP_PAY_SCHED -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
-
JLxMXPaymentSchedules -
object
oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJL__5FBR__5FAPXINWKB__5FAP__5FPAY__5FSCHEDVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JL_BR_APXINWKB_AP_PAY_SCHED
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
_Anticipated__Withholding__Amount: number
Title:
Withholding Amount
-
_Interest__Formula: string
Title:
Interest Formula
Maximum Length:150
-
_Interest__Formula_Display: string
Title:
Interest Formula
-
_Interest__Grace__Days: number
Title:
Interest Grace Days
-
_Interest__Penalty__Rate___2F__Amount: number
Title:
Interest Penalty Rate or Amount
-
_Interest__Penalty__Type: string
Title:
Interest Penalty Type
Maximum Length:150
-
_Interest__Penalty__Type_Display: string
Title:
Interest Penalty Type
-
_Interest__Period: number
Title:
Interest Period
-
_Interest__Rate___2F__Amount: number
Title:
Interest Rate or Amount
-
_Interest__Type: string
Title:
Interest Type
Maximum Length:150
-
_Interest__Type_Display: string
Title:
Interest Type
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
originalInstallmentDueDate: string
(date)
Title:
Original Installment Due Date
-
ValidatedInstallmentGrossAmt: string
Title:
Validated Installment Gross Amount
Maximum Length:150
Nested Schema : oracle_apps_flex_financials_payables_invoices_transactions_restModel_installmentsGdf_view_InstallmentRestGdfJLxMXPaymentSchedulesVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Regional Information
Maximum Length:150
Default Value:JLxMXPaymentSchedules
The global descriptive flexfield context name for the invoice installment. -
__FLEX_Context_DisplayValue: string
Title:
Regional Information
The global descriptive flexfield context display value for the invoice installment. -
CFDCBBInvoiceNumber: string
Title:
Digital Tax Receipt Invoice Number
Maximum Length:150
-
CFDCBBSerialNumber: string
Title:
Digital Tax Receipt Serial Number
Maximum Length:150
-
CFDIUniqueIdentifier: string
Title:
Digital Tax Receipt using Internet Unique ID
Maximum Length:150
-
InstallmentNumber: integer
(int64)
Title:
Payment Number
The number used to identify an invoice installment to which the global descriptive flexfield is associated. -
InvoiceId: integer
(int64)
The unique identifier for the invoice to which the installment global descriptive flexfield is associated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- invoiceInstallmentDff
-
Parameters:
- invoiceInstallmentsUniqID:
$request.path.invoiceInstallmentsUniqID
- invoicesUniqID:
$request.path.invoicesUniqID
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment. - invoiceInstallmentsUniqID:
- invoiceInstallmentGdf
-
Parameters:
- invoiceInstallmentsUniqID:
$request.path.invoiceInstallmentsUniqID
- invoicesUniqID:
$request.path.invoicesUniqID
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment. - invoiceInstallmentsUniqID:
Examples
The following example shows how to create an installment for an invoice by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "InstallmentNumber": 1, "DueDate": "2018-09-20", "GrossAmount": 2212.75 }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "InstallmentNumber": 1, "UnpaidAmount": 2212.75, "FirstDiscountAmount": null, "FirstDiscountDate": null, "DueDate": "2018-09-20", "GrossAmount": 2212.75, "HoldReason": null, "PaymentPriority": 1, "SecondDiscountAmount": null, "SecondDiscountDate": null, "ThirdDiscountAmount": null, "ThirdDiscountDate": null, "NetAmountOne": null, "NetAmountTwo": null, "NetAmountThree": null, "HoldFlag": false, "HeldBy": null, "HoldType": null, "PaymentMethod": "Electronic", "PaymentMethodCode": "EFT", "HoldDate": null, "BankAccount": null, "ExternalBankAccountId": null, "CreatedBy": "AP_SUPV_OPERATIONS", "CreationDate": "2018-09-04T18:02:54.280+00:00", "LastUpdateDate": "2018-09-04T18:02:54.280+00:00", "LastUpdatedBy": "AP_SUPV_OPERATIONS", "LastUpdateLogin": "73FC6524725D2946E0533CFDF40AABA8", "RemitToAddressName": null, "RemitToSupplier": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001", "name": "invoiceInstallments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001", "name": "invoiceInstallments", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967", "name": "invoices", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001/lov/DisbursementPaymentMethodPVO1", "name": "DisbursementPaymentMethodPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001/lov/ThirdPartyRelationshipsPVO1ForLOV", "name": "ThirdPartyRelationshipsPVO1ForLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001/lov/RemitToSupplierPVO1", "name": "RemitToSupplierPVO1", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100177545967/child/invoiceInstallments/00020000000EACED00057708000110F0847ACAEF0000000EACED000577080000000000000001/child/invoiceInstallmentDff", "name": "invoiceInstallmentDff", "kind": "collection" } ] }