Get one agreement price break
get
/fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/priceBreaks/{priceBreaksUniqID}
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=
-
priceBreaksUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Price Breaks resource and used to uniquely identify an instance of Price Breaks. The client should not generate the hash key value. Instead, the client should query on the Price Breaks collection resource in order to navigate to a specific instance of Price Breaks to get the hash key.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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-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
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.