Get an available prepayment
/fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/availablePrepayments/{availablePrepaymentsUniqID}
Request
-
availablePrepaymentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Available Prepayments resource and used to uniquely identify an instance of Available Prepayments. The client should not generate the hash key value. Instead, the client should query on the Available Prepayments collection resource in order to navigate to a specific instance of Available Prepayments to get the hash key.
-
invoicesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Invoices resource and used to uniquely identify an instance of Invoices. The client should not generate the hash key value. Instead, the client should query on the Invoices collection resource in order to navigate to a specific instance of Invoices to get the hash key.
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
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
- application/json
Default Response
-
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.
object
-
AvailableAmount: number
Read Only:
true
Indicates the prepayment amount available that can be applied to invoices. -
Currency: string
Read Only:
true
Maximum Length:15
The currency code used on the invoice. -
Description: string
Read Only:
true
Maximum Length:240
The description from the prepayment invoice line. -
IncludedTax: number
Read Only:
true
Indicates the tax amount that was included on the prepayment invoice. -
InvoiceNumber: string
Read Only:
true
Maximum Length:50
The unique number for the prepayment invoice. -
LineNumber: integer
(int64)
Read Only:
true
The unique number for the prepayment invoice line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PurchaseOrder: string
Read Only:
true
Maximum Length:30
The purchase order document number that is matched to the invoice. -
SupplierSite: string
Read Only:
true
Maximum Length:240
The name of the physical location of the supplier from where the goods and services are rendered.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve an available prepayment.
Get all the available prepayments and use the self URI of the specific available prepayment.
Here's the cURL command to retrieve all the available prepayments:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"items": [
{
"InvoiceNumber": "AND-PP-1",
"LineNumber": 1,
"Description": "Advance payment",
"SupplierSite": "FRESNO",
"PurchaseOrder": null,
"Currency": "USD",
"AvailableAmount": 725.25,
"IncludedTax": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments/00020000000EACED00057708000110F07A94AF4F0000000EACED000577080000000000000001",
"name": "availablePrepayments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments/00020000000EACED00057708000110F07A94AF4F0000000EACED000577080000000000000001",
"name": "availablePrepayments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569",
"name": "invoices",
"kind": "item"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments",
"name": "availablePrepayments",
"kind": "collection"
}
]
}
A hash key of InvoiceId
and LineNumber
of the Prepayment Invoice identifies an available prepayment.
Here's the cURL command that uses the hash key in the self URI to retrieve the available prepayment:
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments/00020000000EACED00057708000110F07A94AF4F0000000EACED000577080000000000000001
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "InvoiceNumber": "AND-PP-1", "LineNumber": 1, "Description": "Advance payment", "SupplierSite": "FRESNO", "PurchaseOrder": null, "Currency": "USD", "AvailableAmount": 725.25, "IncludedTax": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments/00020000000EACED00057708000110F07A94AF4F0000000EACED000577080000000000000001", "name": "availablePrepayments", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569/child/availablePrepayments/00020000000EACED00057708000110F07A94AF4F0000000EACED000577080000000000000001", "name": "availablePrepayments", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100185068569", "name": "invoices", "kind": "item" } ] }