Get one line
get
/fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}/child/lines/{AgreementLineId}
Request
Path Parameters
-
AgreementLineId(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=
-
purchaseAgreementsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Purchase Agreements resource and used to uniquely identify an instance of Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Purchase Agreements collection resource in order to navigate to a specific instance of Purchase Agreements to get the hash key.
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 : purchaseAgreements-lines-item-response
Type:
Show Source
object
-
AgingPeriodDays: integer
(int32)
Title:
Aging Period Days
Read Only:true
Value that identifies the maximum number of days the material may be on consignment. -
AgreementAmount: number
Title:
Agreement Amount
Read Only:true
Value that identifies the amount agreed for an agreement line. -
AgreementHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase agreement. -
AgreementLineId: integer
(int64)
Title:
Line ID
Read Only:true
Value that indicates the status of the line. -
AgreementNumber: string
Title:
Agreement
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase agreement in the sold-to legal entity. -
AgreementQuantity: number
Title:
Agreement Quantity
Read Only:true
Quantity agreed for an agreement line. -
AllowItemDescriptionUpdateFlag: boolean
Title:
Allow item description update
Read Only:true
Maximum Length:1
Value that identifies whether item descriptions can be updated on document lines. -
AllowPriceOverrideFlag: boolean
Title:
Allow Price Override
Read Only:true
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
Read Only:true
Value that identifies the amount agreed on an agreement line between the buying and selling organization. -
Category: string
Read Only:
true
Maximum Length:2400
Value that uniquely identifies the purchasing category. -
CategoryCode: string
Title:
Category Name
Read Only:true
Maximum Length:820
Abbreviation that identifies the purchasing category. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchasing category. -
ConsignmentLineFlag: boolean
Title:
Consignment line
Read Only:true
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. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Currency on the purchase agreement line. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Code that identifies the purchase order currency. -
Description: string
Title:
Line Description
Read Only:true
Maximum Length:240
Description for the line item. -
ExpirationDate: string
(date)
Title:
Expiration Date
Read Only:true
Value that identifies the expiration date of the document. -
HazardClass: string
Title:
Hazard Class
Read Only:true
Maximum Length:40
Name of the hazard class. -
HazardClassCode: string
Title:
Code
Read Only:true
Maximum Length:30
Code that identifies the hazard class. -
HazardClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the hazard class. -
Item: string
Title:
Item
Read Only:true
Maximum Length:255
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. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item on the purchase agreement. -
ItemRevision: string
Title:
Revision
Read Only:true
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. -
LineNumber: number
Title:
Line
Read Only:true
Value that uniquely identifies the purchase order or agreement line. -
LineType: string
Title:
Agreement
Read Only:true
Maximum Length:30
Line type on purchasing documents. -
LineTypeId: integer
(int64)
Title:
Document Line Type
Read Only:true
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
Read Only:true
Value that identifies the minimum amount that can be released against a blanket or planned purchase order. -
NegotiatedFlag: boolean
Title:
Negotiated
Read Only:true
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. -
NoteToSupplier: string
Title:
Note to Supplier
Read Only:true
Maximum Length:1000
Value that uniquely identifies a note to supplier. -
ParentItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent option class or model for the item. -
Price: number
Title:
Price
Read Only:true
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. -
PriceBreakTypeCode: string
Title:
Price Break Type
Read Only:true
Maximum Length:25
Value that identifies the pricing scheme for the price breaks of this line. -
PriceLimit: number
Title:
Price Limit
Read Only:true
Value that identifies the price limit that you can't exceed on a release shipment. -
ProcurementBU: string
Read Only:
true
Maximum Length:255
Business unit that manages and owns the purchase agreement. -
ProcurementBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that manages and owns the purchasing document. -
ReleasedAmount: number
Title:
Released Amount
Read Only:true
Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of an agreement line. -
StatusCode: string
Title:
Line Status
Read Only:true
Maximum Length:25
Code that identifies the agreement line status. -
Supplier: string
Read Only:
true
Maximum Length:255
Name of the supplier who fulfills the item. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierItem: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Value that identifies the supplier item number. -
SupplierItemAuxiliaryIdentifier: string
Title:
Supplier Item Auxiliary Identifier
Read Only:true
Maximum Length:255
Value that uniquely identifies the item information. -
SupplierParentItem: string
Title:
Supplier Parent Item
Read Only:true
Maximum Length:300
Value that identifies the supplier's identification number for the option class or model associated with item. -
SupplierSite: string
Read Only:
true
Maximum Length:255
Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
SupplierTopModel: string
Title:
Supplier Top Model
Read Only:true
Maximum Length:300
Value that identifies the top model associated with the option or option class, or submodel. -
TopModelId: integer
(int64)
Read Only:
true
Value that uniquely identifies the top model associated with the option, option class, or submodel. -
UnNumber: string
Title:
UN Number
Read Only:true
Maximum Length:20
Value that identifies the United Nations identification number for the hazardous material. -
UNNumberDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UnNumberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Abbreviation that identifies the unit of measure on the agreement line -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Code that identifies the 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 : purchaseAgreements-lines-itemAttributes-item-response
Type:
Show Source
object
-
Alias: string
Title:
Alias
Read Only:true
Maximum Length:700
Alternate identifier for an item specified on a blanket purchase agreement line. -
AttachmentURL: string
Title:
Attachment URL
Read Only:true
Maximum Length:700
URL of the attachment associated with the item. -
AttributeValuesId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object. -
AttributeValuesTlpId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object. -
Availability: string
Title:
Availability
Read Only:true
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
Read Only:true
Maximum Length:700
URL of the image file associated with the item specified on a blanket purchase agreement line. -
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. -
LeadTimeDays: number
Title:
Lead Time Days
Read Only:true
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. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
Text describing the long description of the item specified on a blanket purchase agreement line. -
Manufacturer: string
Title:
Manufacturer
Read Only:true
Maximum Length:700
Name of the manufacturer of the item specified on a blanket purchase agreement line. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
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
Read Only:true
Maximum Length:700
URL of the manufacturer of the item specified on a blanket purchase agreement line. -
PackagingString: string
Title:
Packaging String
Read Only:true
Maximum Length:240
String that describes how the item is packed by the supplier. -
RoundingFactor: number
Title:
Rounding Factor
Read Only:true
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
Read Only:true
Maximum Length:700
URL of the supplier's organization. -
ThumbnailImageURL: string
Title:
Thumbnail Image
Read Only:true
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
Read Only:true
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 : purchaseAgreements-lines-priceBreaks-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the price breaks for a purchase agreement line. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the buyer or application created the price breaks for a purchase agreement line. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Currency on the agreement line price break. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Code that identifies the currency on the agreement line price break. -
DiscountPercent: number
Title:
Discount Percent
Read Only:true
Value that identifies the discount percentage for the price break. -
EndDate: string
(date)
Title:
End Date
Read Only:true
Date after which the purchase agreement is no longer valid. -
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. -
LineNumber: number
Title:
Line
Read Only:true
Value that uniquely identifies the purchase order or agreement line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Display Name
Read Only:true
Maximum Length:240
Name of the location where the supplier ships the item. -
LocationCode: string
Title:
Location
Read Only:true
Maximum Length:60
Abbreviation that identifies the location where the supplier ships the item. -
LocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location where the supplier ships the shipment item. -
Price: number
Title:
Price
Read Only:true
Unit price for the line. -
PriceBreakId: integer
(int64)
Read Only:
true
Value that uniquely identifies the price break referenced by this line. -
PriceBreakNumber: number
Title:
Price Break
Read Only:true
Number that uniquely identifies the price break on the purchase agreement line. -
Quantity: number
Title:
Quantity
Read Only:true
Value that identifies the price break quantity, when the price break is effective for blanket purchase orders. -
ShipToOrganization: string
Title:
Ship-to Organization
Read Only:true
Maximum Length:240
Name of the inventory organization that receives the item. -
ShipToOrganizationCode: string
Title:
Ship-to Organization
Read Only:true
Maximum Length:18
Abbreviation that identifies the ship-to organization. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship-to organization. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Date on which the agreement becomes effective. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Abbreviation that identifies the unit of measure on the agreement line price break. -
UOMCode: string
Read Only:
true
Maximum Length:3
Code that identifies the unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- itemAttributes
-
Parameters:
- AgreementLineId:
$request.path.AgreementLineId
- purchaseAgreementsUniqID:
$request.path.purchaseAgreementsUniqID
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. - AgreementLineId:
- priceBreaks
-
Parameters:
- AgreementLineId:
$request.path.AgreementLineId
- purchaseAgreementsUniqID:
$request.path.purchaseAgreementsUniqID
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. - AgreementLineId: