Get one external purchase price
get
/fscmRestApi/resources/11.13.18.05/externalPurchasePrices/{HeaderId}
Request
Path Parameters
-
HeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to 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 : externalPurchasePrices-item-response
Type:
Show Source
object-
ApprovalStatus: string
Title:
MeaningMaximum Length:80Status of the external purchase prices. -
ApprovalStatusCode: string
Maximum Length:
30Abbreviation that identifies status of the external purchase prices. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Abbreviation that identifies the currency of the external purchase prices. -
EndDate: string
(date)
Read Only:
trueDate when the external purchase prices becomes ineffective. -
ExpiredFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then the external purchase price is expired. If false, then the external purchase price is active. The default value is false. -
ExternalPurchasePricesNumber: integer
(int64)
Read Only:
trueNumber that uniquely identifies the external purchase prices. -
HeaderId: integer
(int64)
Value that uniquely identifies the external purchase prices.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the external purchase prices record. -
lines: array
Lines
Title:
LinesThe Lines resource manages the external purchase price lines. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerName: string
Read Only:
trueMaximum Length:700Name of the manufacturer. -
ObjectVersionNumber: integer
(int32)
Number of times the external purchase prices has been updated.
-
ProcurementBUId: integer
(int64)
Read Only:
trueValue that uniquely identifies the procurement business unit. -
ProcurementBUName: string
Title:
Business UnitRead Only:trueMaximum Length:240Name of the procurement business unit. -
RequisitioningBUGroupId: integer
(int64)
Value that uniquely identifies a group of requisitioning business units.
-
RequisitioningBUName: string
Read Only:
trueMaximum Length:700Name of the requisitioning business unit. -
Source: string
Read Only:
trueMaximum Length:60Name of the person or organization in the source contract. -
SourceContractDescription: string
Read Only:
trueMaximum Length:2000Description of the source contract. -
SourceContractNumber: string
Read Only:
trueMaximum Length:120Number that uniquely identifies the source contract. -
SourceContractType: string
Title:
MeaningRead Only:trueMaximum Length:80Type of the source contract. -
SourceContractTypeCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the type of the source contract. -
SourceReferenceId: string
Read Only:
trueMaximum Length:30Value that uniquely identifies the external purchase prices in the source application. -
SourceType: string
Read Only:
trueMaximum Length:60Type of the source contract. -
StartDate: string
(date)
Read Only:
trueDate when the external purchase prices becomes effective. -
SupplierId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier. -
SupplierName: string
Title:
NameRead Only:trueMaximum Length:360Name of the supplier. -
SupplierNumber: string
Title:
Supplier NumberRead Only:trueMaximum Length:30Number that uniquely identifies the supplier. -
SupplierSite: string
Title:
SiteRead Only:trueMaximum Length:240Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supplier site. -
TierDescription: string
Read Only:
trueMaximum Length:2000Description of the tier to which the source organization belongs. -
TierLevel: integer
(int64)
Read Only:
trueNumber that indicates the tier to which the source organization belongs.
Nested Schema : Lines
Type:
arrayTitle:
LinesThe Lines resource manages the external purchase price lines.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : externalPurchasePrices-lines-item-response
Type:
Show Source
object-
AdjustedPrice: number
Read Only:
trueValue of the unit price after adjustment. -
AdjustmentPercentage: number
Read Only:
truePercent value by which the base price is adjusted. -
CancelledFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false. -
HeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the external purchase prices. -
InventoryItemId: integer
(int64)
Unique identifier representing the master item.
-
ItemDescription: string
Read Only:
trueMaximum Length:240Description of the item. -
ItemNumber: string
Read Only:
trueMaximum Length:300Number that uniquely identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the external purchase price line record. -
LineEndDate: string
(date)
Read Only:
trueValue that uniquely identifies the external purchase price line. -
LineId: integer
(int64)
Number that uniquely identifies the external purchase price line.
-
LineNumber: integer
(int64)
Read Only:
trueDate when the price becomes ineffective. -
LineStartDate: string
(date)
Read Only:
trueDate when the price becomes effective. -
LineStatus: string
Title:
MeaningRead Only:trueMaximum Length:80Status of the external purchase price line. -
LineStatusCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies status of the external purchase price line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerPartNumber: string
Read Only:
trueMaximum Length:700Number that uniquely identifies the manufacturer part. -
ObjectVersionNumber: integer
(int32)
Number of times the external purchase price line has been updated.
-
Price: number
Read Only:
trueValue of the unit price before adjustment. -
PurchaseAgreementFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then a purchase agreement line is created for the line. If false, then a purchase agreement line isn't created for the line. The default value is false. -
PurchaseAgreementNumber: string
Read Only:
trueMaximum Length:255Number that uniquely identifies the purchase agreement. -
PurchasingCategoryId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchasing category. -
PurchasingCategoryName: string
Read Only:
trueMaximum Length:2400Name of the purchasing category. -
SelectionEnabledFlag: boolean
Maximum Length:
1Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true. -
SupplierPartNumber: string
Read Only:
trueMaximum Length:300Number that uniquely identifies the supplier part. -
UnitOfMeasure: string
Title:
UOM NameRead Only:trueMaximum Length:25Name of the unit of measure. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure. -
UpdateFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then an unprocessed update exists for the line. If false, then there are no unprocessed updates for the line. The default value is false. -
UserSelectedFlag: boolean
Maximum Length:
1Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false. -
ValidatedFlag: boolean
Read Only:
trueMaximum Length:1Contains one of the following values: true or false. If true, then the line is validated by the Import Purchase Agreements from External Purchase Prices process. If false, then the line isn't validated. The default value is true. -
ValidationOrgId: integer
(int64)
Unique identifier representing the item validation organization.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- lines
-
Parameters:
- HeaderId:
$request.path.HeaderId
The Lines resource manages the external purchase price lines. - HeaderId:
- updateRowLineStatus
-
Operation: /fscmRestApi/resources/11.13.18.05/externalPurchasePrices/{HeaderId}/action/updateRowLineStatusParameters:
- HeaderId:
$request.path.HeaderId
Updates the status of the lines in an external purchase price or a change order. - HeaderId: