Get one agreement
get
/fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}
Request
Path Parameters
-
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-item-response
Type:
Show Source
object
-
AcknowledgmentDueDate: string
(date)
Title:
Acknowledgment Due Date
Read Only:true
Date that the application requests the supplier to acknowledge the document. -
AcknowledgmentWithinDays: number
Title:
Acknowledge Within Days
Read Only:true
Number of days that the supplier can decide to accept or reject the document. -
AgingOnsetPoint: string
Title:
Aging Onset Point
Read Only:true
Maximum Length:80
Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment. -
AgingOnsetPointCode: string
Title:
Aging Onset Point
Read Only:true
Maximum Length:30
Code that identifies the aging onset point. -
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. -
AgreementNumber: string
Title:
Agreement
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase agreement in the sold-to legal entity. -
AllowUnassignedSitesFlag: boolean
Title:
Allow ordering from unassigned sites
Read Only:true
Maximum Length:1
Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments. -
AmountLimit: number
Title:
Amount Limit
Read Only:true
Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement. -
AutomaticallyGenerateOrdersFlag: boolean
Title:
Automatically generate orders
Read Only:true
Maximum Length:1
Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not. -
AutomaticallySubmitForApprovalFlag: boolean
Title:
Automatically submit for approval
Read Only:true
Maximum Length:1
Value that identifies whether the document can be automatically submitted for approval. -
businessUnitAccess: array
Business Unit Accesses
Title:
Business Unit Accesses
Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services. -
Buyer: string
Title:
Buyer
Read Only:true
Maximum Length:240
Person who's responsible for managing the purchase agreement. -
BuyerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the buyer. -
BuyerManagedTransportFlag: boolean
Title:
Buyer managed transportation
Read Only:true
Maximum Length:1
Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order. -
Carrier: string
Title:
Carrier
Read Only:true
Maximum Length:360
Company that transports the item. -
CarrierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the company that transports the item. -
Checklist: string
Title:
Checklist
Read Only:true
Maximum Length:80
Value that uniquely identifies the checklist associated with the purchasing document. -
ClosedDate: string
(date)
Title:
Closed Date
Read Only:true
Date when the order was closed. -
CommunicateRepricedOrdersFlag: boolean
Title:
Communicate repriced orders
Read Only:true
Maximum Length:1
Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier. -
ConfirmingOrderFlag: boolean
Title:
Confirming order
Read Only:true
Maximum Length:1
Value that identifies whether the document is a confirmation of an order the supplier may already be aware of. -
ConsumptionAdviceFrequency: string
Title:
Consumption Advice Frequency
Read Only:true
Maximum Length:80
Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceFrequencyCode: string
Title:
Consumption Advice Frequency
Read Only:true
Maximum Length:30
Code that indicates the consumption advice frequency. -
ConsumptionAdviceSummary: string
Title:
Consumption Advice Summary
Read Only:true
Maximum Length:80
Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceSummmaryCode: string
Title:
Consumption Advice Summary
Read Only:true
Maximum Length:30
Code that indicates the consumption advice summary. -
ConversionRate: number
Title:
Conversion Rate
Read Only:true
Conversion rate to use when converting the currency. -
ConversionRateDate: string
(date)
Title:
Conversion Date
Read Only:true
Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date. -
ConversionRateTypeCode: string
Read Only:
true
Maximum Length:30
Value that identifies the rate type that the application uses to determine the currency conversion rate for the purchase order. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase agreement. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the buyer or application created the purchase agreement. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Currency of the purchase agreement. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Code that identifies the purchase agreement currency. -
Description: string
Title:
Agreement Description
Read Only:true
Maximum Length:240
Description for the line item. -
DocumentStyle: string
Title:
Document Style
Read Only:true
Maximum Length:240
Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document. -
DocumentStyleId: integer
(int64)
Read Only:
true
Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document header. -
DocumentTypeCode: string
Read Only:
true
Maximum Length:25
Value that identifies the document type associated with a change order template. -
EnableRetroactivePricingFlag: boolean
Title:
Enable retroactive pricing
Read Only:true
Maximum Length:1
Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement. -
EndDate: string
(date)
Title:
End Date
Read Only:true
Date after which the purchase agreement is no longer valid. -
FOB: string
Title:
FOB
Read Only:true
Maximum Length:80
Freight on board. Location where ownership of the item transfers from the supplier to the buyer. -
FOBCode: string
Title:
FOB
Read Only:true
Maximum Length:30
Code that identifies the type of free-on-board terms for the document. -
FreightTerms: string
Title:
Freight Terms
Read Only:true
Maximum Length:80
Terms that describe who pays charges to transport the item. -
FreightTermsCode: string
Title:
Freight Terms
Read Only:true
Maximum Length:30
Code that identifies the type of freight terms for the document -
GroupRequisitionLinesFlag: boolean
Title:
Group requisition lines
Read Only:true
Maximum Length:1
Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order. -
GroupRequisitionsFlag: boolean
Title:
Group requisitions
Read Only:true
Maximum Length:1
Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order. -
InitiateRetroactivePricingUponApprovalFlag: boolean
Title:
Initiate process upon agreement approval
Read Only:true
Maximum Length:1
Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the purchase agreement. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the purchase agreement. -
lines: array
Purchase Agreement Lines
Title:
Purchase Agreement Lines
Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterContractId: integer
(int64)
Read Only:
true
Value that uniquely identifies the associated contract. -
MasterContractNumber: string
Title:
Master Contract
Read Only:true
Maximum Length:120
Number that identifies the contract from enterprise contracts. -
MasterContractType: string
Title:
Master Contract Type
Read Only:true
Maximum Length:255
Administrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms. -
MasterContractTypeId: integer
Read Only:
true
Value that uniquely identifies the master contract type. -
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. -
ModeOfTransport: string
Title:
Meaning
Read Only:true
Maximum Length:80
Mode of transport to ship the item, such as truck, air, or boat. -
ModeOfTransportCode: string
Read Only:
true
Maximum Length:30
Mode of transport that the shipper uses to transport the item such as land, sea, and air. -
NoteToReceiver: string
Title:
Note to Receiver
Read Only:true
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
Read Only:true
Maximum Length:1000
Value that uniquely identifies a note to supplier. -
notificationControls: array
Notification Controls
Title:
Notification Controls
Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released. -
PaymentTerms: string
Title:
Payment Terms
Read Only:true
Maximum Length:50
Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order. -
PaymentTermsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the payment terms. -
PayOnReceiptFlag: boolean
Title:
Pay on Receipt
Read Only:true
Maximum Length:25
Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization. -
Priority: integer
(int32)
Title:
Priority
Read Only:true
Priority that determines how quickly to transport the item. -
ProcurementBU: string
Title:
Procurement BU
Read Only:true
Maximum Length:240
Business unit that manages and owns the purchase agreement. -
ProcurementBUId: integer
(int64)
Title:
Procurement BU ID
Read Only:true
Value that uniquely identifies the business unit that manages and owns the purchasing document. -
PunchoutRequestsOnlyFlag: boolean
Title:
Punchout requests only
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
Maximum Length:120
Number used for EDI transaction audit trail reference. -
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. -
RepriceOpenOrdersFlag: boolean
Title:
Reprice open orders only
Read Only:true
Maximum Length:1
Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement. -
RequiredAcknowledgment: string
Title:
Required Acknowledgment
Read Only:true
Maximum Length:80
Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment. -
RequiredAcknowledgmentCode: string
Title:
Required Acknowledgment
Read Only:true
Maximum Length:1
Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required. -
RequiresSignatureFlag: boolean
Title:
Requires signature
Read Only:true
Maximum Length:1
Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No. -
RevisionNumber: number
Title:
Agreement Revision
Read Only:true
Value that uniquely identifies the document revision number. -
ServiceLevel: string
Title:
Meaning
Read Only:true
Maximum Length:80
Priority that determines how quickly to transport the item. -
ServiceLevelCode: string
Read Only:
true
Maximum Length:30
Value that identifies the priority of transportation that affects how quickly goods are transported. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Date on which the agreement becomes effective. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the purchase agreement relative to the purchase agreement life cycle. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:25
Value that identifies the header status. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:360
Name of the supplier who fulfills the item. -
SupplierAgreement: string
Title:
Supplier Agreement
Read Only:true
Maximum Length:25
Number that indicates the supplier document number. -
SupplierCommunicationMethodCode: string
Title:
Communication Method
Read Only:true
Maximum Length:25
Code that identifies the supplier communication method. -
SupplierContact: string
Read Only:
true
Maximum Length:4000
Person who represents the supplier when communicating with the buyer. -
SupplierContactId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier contact. -
SupplierEmailAddress: string
Title:
Supplier Email
Read Only:true
Maximum Length:2000
Value that identifies the email address specified on the document to which the document after approval will be communicated. -
SupplierFax: string
Title:
Supplier Fax
Read Only:true
Maximum Length:60
Value that identifies the fax number specified on the document to which the document after approval will be communicated. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:240
Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
UseCustomerSalesOrderFlag: boolean
Title:
Use customer sales order
Read Only:true
Maximum Length:1
Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order. -
UseOrderDateForOrderPricingFlag: boolean
Title:
Use order date for order pricing
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value. -
UseRequestedDateFlag: boolean
Title:
Use need-by date
Read Only:true
Maximum Length:1
Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order. -
UseShipToLocationFlag: boolean
Title:
Group Requisition Lines Using Ship-to Organization and Location
Read Only:true
Maximum Length:1
Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders. -
UseShipToOrganizationAndLocationFlag: boolean
Title:
Use ship-to organization and location
Read Only:true
Maximum Length:1
Value that identifies whether item descriptions can be updated on document lines.
Nested Schema : Business Unit Accesses
Type:
array
Title:
Business Unit Accesses
Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.
Show Source
Nested Schema : Purchase Agreement Lines
Type:
array
Title:
Purchase Agreement Lines
Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notification Controls
Type:
array
Title:
Notification Controls
Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.
Show Source
Nested Schema : purchaseAgreements-businessUnitAccess-item-response
Type:
Show Source
object
-
BillToBU: string
Title:
Bill-to BU
Read Only:true
Maximum Length:240
Value that identifies the business unit that processes supplier invoices for the purchasing document. -
BilltoBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that processes supplier invoices for the purchase order. -
BillToLocation: string
Title:
Bill-to Location
Read Only:true
Maximum Length:240
Value that identifies the bill-to location where the supplier sends the invoice. -
BillToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to location. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the business unit access on the purchase agreement -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase agreement. -
EnabledFlag: boolean
Title:
Enabled
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then the business unit assignment record on the agreement is enabled. If false, then business unit assignment record on the agreement is disabled. This attribute doesn't have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the business unit access of a purchase agreement. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the business unit access of a purchase agreement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderLocallyFlag: boolean
Title:
Order Locally
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value. -
OrganizationAssignmentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the procurement agent assignment. -
PurchasingSite: string
Title:
Purchasing Site
Read Only:true
Maximum Length:240
Value that uniquely identifies the supplier site for the purchasing operating unit. -
PurchasingSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site for the purchasing operating unit. -
RequisitioningBU: string
Title:
Requisitioning BU
Read Only:true
Maximum Length:240
Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that requested the goods or services being purchased. -
ShipToLocation: string
Title:
Ship-to Location
Read Only:true
Maximum Length:240
Name of the location where the supplier ships the item. -
ShipToLocationCode: string
Title:
Ship-to Location
Read Only:true
Maximum Length:60
Abbreviation that identifies the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location where the supplier ships the shipment item.
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-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 : 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 : purchaseAgreements-notificationControls-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
Read Only:true
Notification amount of purchase agreement document total. -
ConditionCode: string
Title:
Condition
Read Only:true
Maximum Length:25
Notification type of the purchase agreement. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the notification controls on the purchase agreement -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the notification controls of a purchase agreement. -
EndDate: string
(date)
Title:
End Date
Read Only:true
Expiration date of the notification. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the notification controls of a purchase agreement. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the notification controls of a purchase agreement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotificationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the agreement notification control. -
Percentage: number
Title:
Percent
Read Only:true
Notification percentage of purchase agreement document total. -
ReminderDays: number
Title:
Reminder Days
Read Only:true
Value that identifies the number of days before the expiration event that the reminder notification needs to be sent. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
Effective date of the notification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- businessUnitAccess
-
Parameters:
- purchaseAgreementsUniqID:
$request.path.purchaseAgreementsUniqID
Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services. - purchaseAgreementsUniqID:
- lines
-
Operation: /fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}/child/linesParameters:
- purchaseAgreementsUniqID:
$request.path.purchaseAgreementsUniqID
Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops. - purchaseAgreementsUniqID:
- notificationControls
-
Parameters:
- purchaseAgreementsUniqID:
$request.path.purchaseAgreementsUniqID
Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released. - purchaseAgreementsUniqID:
Examples
This example describes how to get one purchase agreement.
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/purchaseAgreements/AgreementHeaderId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "AgreementHeaderId": 300100038599060, "AgreementNumber": "1001970", "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "BuyerId": 59, "Buyer": "Baker, Catherine", "DocumentStyleId": 2, "DocumentStyle": "Consignment Agreement", "StatusCode": "OPEN", "Status": "Open", "SupplierId": 300100000344131, "Supplier": "zBIA_Supplier_01", "SupplierSiteId": 300100000344161, "SupplierSite": "zBIA_Address_01", "SupplierContactId": 300100000344205, "SupplierContact": "Contact1, ZBIA", "SupplierCommunicationMethodCode": "NONE", "SupplierEmailAddress": null, "SupplierFax": null, "StartDate": "2014-07-31", "EndDate": "2014-09-30", "AgreementAmount": 100000, "CurrencyCode": "JPY", "Currency": "Yen", "AmountLimit": 100000, "MinimumReleaseAmount": 50000, "ReleasedAmount": 99950, "Description": "zREL9_CONS_GK", "DocumentTypeCode": "BLANKET", "MasterContractId": null, "MasterContractNumber": null, "MasterContractTypeId": null, "MasterContractType": null, "ConversionRateTypeCode": null, "ConversionRateDate": null, "ConversionRate": null, "RevisionNumber": 0, "SupplierAgreement": null, "ReferenceNumber": null, "ClosedDate": null, "RequiredAcknowledgmentCode": "N", "RequiredAcknowledgment": "None", "AcknowledgmentDueDate": null, "AcknowledgmentWithinDays": null, "PaymentTermsId": 10003, "PaymentTerms": "45 Net (terms date + 45)", "CarrierId": 12517, "Carrier": "AIR", "ModeOfTransportCode": null, "ModeOfTransport": null, "ServiceLevelCode": null, "ServiceLevel": null, "FreightTermsCode": "Due", "FreightTerms": "Due", "FOBCode": "Origin", "FOB": "Origin", "RequiresSignatureFlag": false, "BuyerManagedTransportFlag": false, "PayOnReceiptFlag": false, "ConfirmingOrderFlag": false, "ConsumptionAdviceFrequencyCode": "WEEKLY", "ConsumptionAdviceFrequency": "Weekly", "ConsumptionAdviceSummaryCode": "INVENTORY_ORG_ITEM", "ConsumptionAdviceSummary": "Organization and item", "AgingOnsetPointCode": "NONE", "AgingOnsetPoint": "None", "AgingPeriodDays": null, "NoteToReceiver": null, "NoteToSupplier": null, "AutomaticallyGenerateOrdersFlag": true, "AutomaticallySubmitForApprovalFlag": true, "GroupRequisitionsFlag": false, "UseCustomerSalesOrderFlag": null, "UseShipToLocationFlag": false, "GroupRequisitionLinesFlag": false, "UseRequestedDateFlag": false, "UseShipToOrganizationAndLocationFlag": false, "AllowUnassignedSitesFlag": false, "EnableRetroactivePricingFlag": false, "InitiateRetroactivePricingUponApprovalFlag": false, "RepriceOpenOrdersFlag": false, "CommunicateRepricedOrdersFlag": false, "PunchoutRequestsOnlyFlag": null, "UseOrderDateForOrderPricingFlag": false, "Priority": null, "Checklist": null, "CreationDate": "2014-07-31T00:29:56+00:00", "CreatedBy": "CVBUYER00", "LastUpdateDate": "2014-07-31T00:34:43.069+00:00", "LastUpdatedBy": "CVBUYER00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060", "name": "purchaseAgreements", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060", "name": "purchaseAgreements", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060/child/businessUnitAccess", "name": "businessUnitAccess", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060/child/lines", "name": "lines", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/purchaseAgreements/300100038599060/child/notificationControls", "name": "notificationControls", "kind": "collection" } ] }