Get one line
get
/fscmRestApi/resources/11.13.18.05/purchaseAgreementImportRequests/{InterfaceHeaderId}/child/lines/{InterfaceLineId}
Request
Path Parameters
-
InterfaceHeaderId(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=
-
InterfaceLineId(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 : purchaseAgreementImportRequests-lines-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
25
Values that indicates if a new record needs to be created or to update an existing record. -
AgingPeriodDays: integer
(int32)
Title:
Aging Period Days
Value that identifies the maximum number of days the material may be on consignment. -
AgreementAmount: number
Title:
Agreement Amount
Value that identifies the amount agreed for an agreement line. -
AgreementQuantity: number
Quantity agreed for an agreement line.
-
AllowDescriptionUpdateFlag: boolean
Title:
Allow item description update
Maximum Length:1
Value that identifies whether item descriptions can be updated on document lines. -
AllowPriceOverrideFlag: boolean
Title:
Allow Price Override
Maximum Length:1
Value that identifies if you can change the price on release shipments. Possible values are Y and N. This attribute doesn't have a default value. -
Amount: number
Title:
Agreement Amount
Value that identifies the amount agreed on an agreement line between the buying and selling organization. -
Attribute16: string
Maximum Length:
150
Segment for the purchase agreement line descriptive flexfield. -
Attribute17: string
Maximum Length:
150
Segment for the purchase agreement line descriptive flexfield. -
Attribute18: string
Maximum Length:
150
Segment for the purchase agreement line descriptive flexfield. -
Attribute19: string
Maximum Length:
150
Segment for the purchase agreement line descriptive flexfield. -
Attribute20: string
Maximum Length:
150
Segment for the purchase agreement line descriptive flexfield. -
AttributeCategory: string
Maximum Length:
150
Category segment for the purchase agreement line descriptive flexfield. -
AttributeDate1: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate10: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate2: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate3: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate4: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate5: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate6: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate7: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate8: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeDate9: string
(date)
Date segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber1: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber10: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber2: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber3: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber4: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber5: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber6: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber7: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber8: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeNumber9: number
Number segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp1: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp10: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp2: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp3: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp4: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp5: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp6: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp7: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp8: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
AttributeTimestamp9: string
(date-time)
Date and time segment for the purchase agreement line descriptive flexfield.
-
Category: string
Maximum Length:
2000
Value that uniquely identifies the purchasing category. -
CategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
ConsignmentLineFlag: boolean
Title:
Consignment line
Maximum Length:1
Contains one of the following values: true or false. If true, then the blanket purchase agreement and the purchase order include consignment lines. If false, then the blanket purchase agreement and the purchase order don't include consignment lines. The default value is false. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase agreement line. -
ExpirationDate: string
(date)
Date after which the item on this line can no longer be ordered.
-
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceHeaderKey: string
Maximum Length:
50
Value that uniquely identifies the header record and is unique for the load request. -
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the interface line. -
Item: string
Title:
Item
Maximum Length:300
Abbreviation that uniquely identifies the item on the purchase order. -
itemAttributes: array
Item Attributes
Title:
Item Attributes
Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television. -
ItemDescription: string
Title:
Line Description
Maximum Length:240
Description for the line item. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the purchase agreement.
-
ItemRevision: string
Title:
Revision
Maximum Length:18
Value that identifies the revision number of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the purchase agreement line -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the purchase agreement line. -
LineAttribute1: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute10: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute11: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute12: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute13: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute14: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute15: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute2: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute3: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute4: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute5: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute6: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute7: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute8: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineAttribute9: string
Maximum Length:
150
Line segment for the purchase agreement line descriptive flexfield. -
LineNumber: number
Title:
Line
Value that uniquely identifies the purchase order or agreement line. -
LineType: string
Title:
Line Type
Maximum Length:30
Line type on purchasing documents. -
LineTypeId: integer
(int64)
Title:
Document Line Type
Value that uniquely identifies the line type on your documents. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumReleaseAmount: number
Title:
Minimum Release Amount
Value that identifies the minimum amount that can be released against a blanket or planned purchase order. -
NegotiatedFlag: boolean
Title:
Negotiated
Maximum Length:1
Contains one of the following values: true or false. If true, then the buyer and the supplier negotiated and agreed on the price before the purchase. If false, then the buyer and the supplier didn't negotiate the price before the purchase. This attribute doesn't have a default value. -
NoteToReceiver: string
Maximum Length:
1000
Special text instructions to the receiver in the docking area to be reviewed while performing the receipt. -
NoteToSupplier: string
Title:
Note to Supplier
Maximum Length:1000
Value that uniquely identifies a note to supplier. -
NotToExceedPrice: number
Title:
Price Limit
Value that identifies the price limit that you can't exceed on a release shipment. -
ParentItem: string
Maximum Length:
300
Value that uniquely identifies the parent option class or model for the item. -
ParentItemId: integer
(int64)
Value that uniquely identifies the parent option class or model for the item.
-
Price: number
Title:
Price
Unit price for the line. -
priceBreaks: array
Price Breaks
Title:
Price Breaks
Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location. -
PriceBreakType: string
Title:
Price Break Type
Maximum Length:25
Value that identifies the pricing scheme for the price breaks of this line. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status. -
SupplierItem: string
Title:
Supplier Item
Maximum Length:300
Value that identifies the supplier item number. -
SupplierParentItem: string
Title:
Supplier Parent Item
Maximum Length:300
Value that identifies the supplier's identification number for the option class or model associated with item. -
SupplierPartAuxiliaryId: string
Title:
Supplier Item Auxiliary Identifier
Maximum Length:255
Value that uniquely identifies the item information. -
SupplierReferenceNumber: string
Maximum Length:
150
Value that identifies the top model associated with the option or option class, or submodel. -
SupplierTopModel: string
Title:
Supplier Top Model
Maximum Length:300
Value that identifies the top model associated with the option or option class, or submodel. -
TopModel: string
Maximum Length:
300
Value that identifies the top model associated with the option or option class, or submodel. -
TopModelId: integer
(int64)
Value that uniquely identifies the top model associated with the option, option class, or submodel.
-
translationItemAttributes: array
Translation Item Attributes
Title:
Translation Item Attributes
Translation item attributes capture additional information about purchasing item translation attributes. -
UnitVolume: number
Value that indicates the unit volume.
-
UnitWeight: number
Value that indicates the unit weight.
-
UOM: string
Title:
UOM
Maximum Length:25
Abbreviation that identifies the unit of measure on the agreement line -
UOMCode: string
Maximum Length:
3
Code that identifies the unit of measure. -
VolumeUOMCode: string
Maximum Length:
3
Value that uniquely identifies the volume unit of measure code. -
VolumeUOMName: string
Maximum Length:
25
Value that indicates the volume unit of measure. -
WeightUOMCode: string
Maximum Length:
3
Value that uniquely identifies the weight unit of measure code. -
WeightUOMName: string
Maximum Length:
25
Value that indicates the weight unit of measure.
Nested Schema : Item Attributes
Type:
array
Title:
Item Attributes
Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Price Breaks
Type:
array
Title:
Price Breaks
Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location.
Show Source
Nested Schema : Translation Item Attributes
Type:
array
Title:
Translation Item Attributes
Translation item attributes capture additional information about purchasing item translation attributes.
Show Source
Nested Schema : purchaseAgreementImportRequests-lines-itemAttributes-item-response
Type:
Show Source
object
-
AttachmentURL: string
Title:
Attachment URL
Maximum Length:700
URL of the attachment associated with the item. -
Attribute1: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute10: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute11: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute12: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute13: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute14: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute15: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute16: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute17: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute18: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute19: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute2: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute20: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute3: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute4: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute5: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute6: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute7: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute8: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
Attribute9: string
Maximum Length:
240
Segment for the purchase agreement line item attributes descriptive flexfield. -
AttributeCategory: string
Maximum Length:
240
Category segment for the purchase agreement item attributes descriptive flexfield. -
AttributeDate1: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate10: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate2: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate3: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate4: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate5: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate6: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate7: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate8: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeDate9: string
(date)
Date segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber1: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber10: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber2: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber3: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber4: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber5: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber6: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber7: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber8: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeNumber9: number
Number segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp1: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp10: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp2: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp3: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp4: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp5: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp6: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp7: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp8: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
AttributeTimestamp9: string
(date-time)
Date and time segment for the purchase agreement item attributes descriptive flexfield.
-
Availability: string
Title:
Availability
Maximum Length:700
Status of the item availability from supplier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the item attributes for a purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the item attributes for a purchase agreement line. -
ImageURL: string
Title:
Image URL
Maximum Length:700
URL of the image file associated with the item specified on a blanket purchase agreement line. -
InterfaceAttributeId: integer
(int64)
Value that uniquely identifies the interface line item attribute.
-
InterfaceAttributeKey: string
Maximum Length:
50
Value that uniquely identifies the interface line item attribute. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line for an item attribute.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the interface line for an item attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the item attributes on a purchase agreement line. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the item attributes on a purchase agreement line. -
LeadTime: number
Title:
Lead Time Days
The number of days in which the item, specified on the blanket purchase order line, can be delivered when ordered. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Maximum Length:700
Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line. -
ManufacturerURL: string
Title:
Manufacturer URL
Maximum Length:700
URL of the manufacturer of the item specified on a blanket purchase agreement line. -
PackagingString: string
Maximum Length:
240
String that describes how the item is packed by the supplier. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status. -
RoundingFactor: number
Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
-
SupplierURL: string
Title:
Supplier URL
Maximum Length:700
URL of the supplier's organization. -
ThumbnailImageURL: string
Title:
Thumbnail Image
Maximum Length:700
Location of the small version of a larger image file for the item specified on the blanket purchase agreement. -
UNSPSC: string
Title:
UNSPSC
Maximum Length:700
The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
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 : purchaseAgreementImportRequests-lines-priceBreaks-item-response
Type:
Show Source
object
-
Attribute1: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute10: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute11: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute12: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute13: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute14: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute15: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute16: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute17: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute18: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute19: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute2: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute20: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute3: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute4: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute5: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute6: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute7: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute8: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute9: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeCategory: string
Maximum Length:
30
Category segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeDate1: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate10: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate2: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate3: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate4: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate5: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate6: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate7: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate8: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate9: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber1: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber10: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber2: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber3: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber4: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber5: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber6: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber7: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber8: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber9: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp1: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp10: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp2: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp3: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp4: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp5: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp6: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp7: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp8: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp9: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the price breaks for a purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the price breaks for a purchase agreement line. -
DiscountPercent: number
Title:
Discount Percent
Value that identifies the discount percentage for the price break. -
EndDate: string
(date)
Date after which the purchase agreement is no longer valid.
-
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the agreement line interface price break. -
InterfaceLineLocationId: integer
(int64)
Value that uniquely identifies the agreement line interface price break.
-
InterfaceLineLocationKey: string
Maximum Length:
50
Value that uniquely identifies the price break record and is unique for the load request. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the price break was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the price breaks on a purchase agreement line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Price: number
Title:
Price
Unit price for the line. -
PriceBreakNumber: number
Title:
Price Break
Value that uniquely identifies the price break referenced by this line. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status. -
Quantity: number
Title:
Quantity
Value that identifies the price break quantity, when the price break is effective for blanket purchase orders. -
ShipToLocation: string
Maximum Length:
60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
-
ShipToOrganizationCode: string
Title:
Ship-to Organization
Maximum Length:18
Name of the inventory organization that receives the item. -
ShipToOrganizationId: integer
(int64)
Value that uniquely identifies the ship-to organization.
-
StartDate: string
(date)
Date on which the agreement becomes effective.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : purchaseAgreementImportRequests-lines-translationItemAttributes-item-response
Type:
Show Source
object
-
Alias: string
Maximum Length:
700
Alternate identifier for an item specified on a blanket purchase agreement line. -
Comments: string
Maximum Length:
700
Additional comments for the item specified on the blanket purchase agreement line. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the translation item attributes for a purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the translation item attributes for a purchase agreement line. -
Description: string
Maximum Length:
240
Description for the line item. -
InterfaceAttributeTlpId: integer
(int64)
Value that uniquely identifies the interface line item attribute translation.
-
InterfaceAttributeTlpKey: string
Maximum Length:
50
Value that uniquely identifies the interface line item attribute translation. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line for a translation item attribute.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the interface line for a translation item attribute. -
Language: string
Maximum Length:
4
Value that indicates the code of the language into which the contents of the translatable columns are translated. The maximum length of the language code is 4. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the translation item attributes on a purchase agreement line. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the translation item attributes on a purchase agreement line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Maximum Length:
4000
Text describing the long description of the item specified on a blanket purchase agreement line. -
Manufacturer: string
Maximum Length:
700
Name of the manufacturer of the item specified on a blanket purchase agreement line. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- itemAttributes
-
Parameters:
- InterfaceHeaderId:
$request.path.InterfaceHeaderId
- InterfaceLineId:
$request.path.InterfaceLineId
Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television. - InterfaceHeaderId:
- priceBreaks
-
Parameters:
- InterfaceHeaderId:
$request.path.InterfaceHeaderId
- InterfaceLineId:
$request.path.InterfaceLineId
Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location. - InterfaceHeaderId:
- translationItemAttributes
-
Parameters:
- InterfaceHeaderId:
$request.path.InterfaceHeaderId
- InterfaceLineId:
$request.path.InterfaceLineId
Translation item attributes capture additional information about purchasing item translation attributes. - InterfaceHeaderId:
Examples
This example describes how to get one line in a purchasing document import request.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/InterfaceHeaderId/child/lines/InterfaceLineId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "InterfaceLineId" : 300100590264651, "InterfaceHeaderKey" : null, "InterfaceLineKey" : null, "ActionCode" : "ADD", "LineNumber" : 1, "LineType" : "Goods", "LineTypeId" : null, "Item" : "RCV-100", "ItemId" : null, "ItemRevision" : null, "Category" : "Miscellaneous_1", "CategoryId" : null, "ItemDescription" : null, "AgreementAmount" : null, "UOM" : "Each", "UOMCode" : null, "Price" : 150, "Amount" : null, "AllowPriceOverrideFlag" : null, "NotToExceedPrice" : null, "SupplierItem" : null, "NegotiatedFlag" : null, "NoteToReceiver" : null, "NoteToSupplier" : null, "MinimumReleaseAmount" : null, "SupplierPartAuxiliaryId" : null, "SupplierReferenceNumber" : null, "AgingPeriodDays" : null, "ConsignmentLineFlag" : null, "UnitWeight" : null, "WeightUOMCode" : null, "WeightUOMName" : null, "UnitVolume" : null, "VolumeUOMCode" : null, "VolumeUOMName" : null, "ParentItem" : null, "ParentItemId" : null, "TopModel" : null, "TopModelId" : null, "SupplierParentItem" : null, "SupplierTopModel" : null, "PriceBreakType" : null, "AllowDescriptionUpdateFlag" : null, "AttributeCategory" : null, "LineAttribute1" : null, "LineAttribute2" : null, "LineAttribute3" : null, "LineAttribute4" : null, "LineAttribute5" : null, "LineAttribute6" : null, "LineAttribute7" : null, "LineAttribute8" : null, "LineAttribute9" : null, "LineAttribute10" : null, "LineAttribute11" : null, "LineAttribute12" : null, "LineAttribute13" : null, "LineAttribute14" : null, "LineAttribute15" : null, "Attribute16" : null, "Attribute17" : null, "Attribute18" : null, "Attribute19" : null, "Attribute20" : null, "AttributeDate1" : null, "AttributeDate2" : null, "AttributeDate3" : null, "AttributeDate4" : null, "AttributeDate5" : null, "AttributeDate6" : null, "AttributeDate7" : null, "AttributeDate8" : null, "AttributeDate9" : null, "AttributeDate10" : null, "AttributeNumber1" : null, "AttributeNumber2" : null, "AttributeNumber3" : null, "AttributeNumber4" : null, "AttributeNumber5" : null, "AttributeNumber6" : null, "AttributeNumber7" : null, "AttributeNumber8" : null, "AttributeNumber9" : null, "AttributeNumber10" : null, "AttributeTimestamp1" : null, "AttributeTimestamp2" : null, "AttributeTimestamp3" : null, "AttributeTimestamp4" : null, "AttributeTimestamp5" : null, "AttributeTimestamp6" : null, "AttributeTimestamp7" : null, "AttributeTimestamp8" : null, "AttributeTimestamp9" : null, "AttributeTimestamp10" : null, "InterfaceHeaderId" : 300100590200472, "CreatedBy" : "PRC_INTEGRATION_USER", "CreationDate" : "2024-01-17T07:34:01.002+00:00", "LastUpdatedBy" : "PRC_INTEGRATION_USER", "LastUpdateDate" : "2024-01-17T07:34:01.002+00:00", "ProcessCode" : "ACCEPTED", "RequestId" : null, "ExpirationDate" : null, "AgreementQuantity" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651", "name" : "lines", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651", "name" : "lines", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472", "name" : "purchaseAgreementImportRequests", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651/child/itemAttributes", "name" : "itemAttributes", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651/child/priceBreaks", "name" : "priceBreaks", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590200472/child/lines/300100590264651/child/translationItemAttributes", "name" : "translationItemAttributes", "kind" : "collection" } ] }