Get all installments for a group of receivables invoices
get
/fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments
Request
Path Parameters
-
CustomerTransactionId(required): integer(int64)
The unique identifier of the invoice.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the invoice installment that matches the primary key criteria specified.
Finder Variables:- InstallmentId; integer; The unique identifier of the invoice installment.
- PrimaryKey: Finds the invoice installment that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- InstallmentDueDate; string; The due date of the installment.
- InstallmentId; integer; The unique identifier of the invoice installment.
- InstallmentSequenceNumber; integer; The sequence number of the invoice installment.
- OriginalAmount; number; The original due amount of the installment.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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 : receivablesInvoices-receivablesInvoiceInstallments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : receivablesInvoices-receivablesInvoiceInstallments-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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" } }
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
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_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
Nested Schema : receivablesInvoices-receivablesInvoiceInstallments-receivablesInvoiceInstallmentNotes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source