1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Purchase Agreements

Get one agreement

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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.
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : purchaseAgreements-item-response
Type: object
Show Source
  • Title: Acknowledgment Due Date
    Read Only: true
    Date that the application requests the supplier to acknowledge the document.
  • Title: Acknowledge Within Days
    Read Only: true
    Number of days that the supplier can decide to accept or reject the document.
  • 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.
  • Title: Aging Onset Point Code
    Read Only: true
    Maximum Length: 30
    Code that identifies the aging onset point.
  • Title: Aging Period Days
    Read Only: true
    Value that identifies the maximum number of days the material may be on consignment.
  • Title: Agreement Amount
    Read Only: true
    Value that identifies the amount agreed for an agreement line.
  • Read Only: true
    Value that uniquely identifies the purchase agreement.
  • Title: Agreement
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase agreement in the sold-to legal entity.
  • 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.
  • 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.
  • 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.
  • Title: Automatically submit for approval
    Read Only: true
    Maximum Length: 1
    Value that identifies whether the document can be automatically submitted for approval.
  • 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.
  • Title: Buyer
    Read Only: true
    Maximum Length: 240
    Person who's responsible for managing the purchase agreement.
  • Read Only: true
    Value that uniquely identifies the buyer.
  • 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.
  • Title: Carrier
    Read Only: true
    Maximum Length: 360
    Company that transports the item.
  • Read Only: true
    Value that uniquely identifies the company that transports the item.
  • Title: Checklist
    Read Only: true
    Maximum Length: 80
    Value that uniquely identifies the checklist associated with the purchasing document.
  • Title: Closed Date
    Read Only: true
    Date when the order was closed.
  • 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.
  • 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.
  • 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.
  • Title: Consumption Advice Frequency Code
    Read Only: true
    Maximum Length: 30
    Code that indicates the consumption advice frequency.
  • 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.
  • Title: Consumption Advice Summary Code
    Read Only: true
    Maximum Length: 30
    Code that indicates the consumption advice summary.
  • Title: Conversion Rate
    Read Only: true
    Conversion rate to use when converting the currency.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase agreement.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application created the purchase agreement.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Currency of the purchase agreement.
  • Read Only: true
    Maximum Length: 15
    Code that identifies the purchase agreement currency.
  • Title: Agreement Description
    Read Only: true
    Maximum Length: 240
    Description for the line item.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 25
    Value that identifies the document type associated with a change order template.
  • 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.
  • Title: End Date
    Read Only: true
    Date after which the purchase agreement is no longer valid.
  • Title: FOB
    Read Only: true
    Maximum Length: 80
    Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
  • Title: FOB Code
    Read Only: true
    Maximum Length: 30
    Code that identifies the type of free-on-board terms for the document.
  • Title: Freight Terms
    Read Only: true
    Maximum Length: 80
    Terms that describe who pays charges to transport the item.
  • Title: Freight Terms Code
    Read Only: true
    Maximum Length: 30
    Code that identifies the type of freight terms for the document
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Date and time when the buyer or application last updated the purchase agreement.
  • Read Only: true
    Maximum Length: 64
    User who last updated the purchase agreement.
  • 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
  • Read Only: true
    Value that uniquely identifies the associated contract.
  • Title: Master Contract
    Read Only: true
    Maximum Length: 120
    Number that identifies the contract from enterprise contracts.
  • 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.
  • Read Only: true
    Value that uniquely identifies the master contract type.
  • Title: Minimum Release Amount
    Read Only: true
    Value that identifies the minimum amount that can be released against a blanket or planned purchase order.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 80
    Mode of transport to ship the item, such as truck, air, or boat.
  • Read Only: true
    Maximum Length: 30
    Mode of transport that the shipper uses to transport the item such as land, sea, and air.
  • 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.
  • Title: Note to Supplier
    Read Only: true
    Maximum Length: 1000
    Value that uniquely identifies a note to supplier.
  • 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.
  • 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.
  • Read Only: true
    Value that uniquely identifies the payment terms.
  • 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.
  • Title: Priority
    Read Only: true
    Priority that determines how quickly to transport the item.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Business unit that manages and owns the purchase agreement.
  • Title: Procurement BU ID
    Read Only: true
    Value that uniquely identifies the business unit that manages and owns the purchasing document.
  • 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.
  • Title: Reference Number
    Read Only: true
    Maximum Length: 120
    Number used for EDI transaction audit trail reference.
  • 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.
  • 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.
  • 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.
  • Title: Required Acknowledgment Code
    Read Only: true
    Maximum Length: 1
    Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required.
  • 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.
  • Title: Agreement Revision
    Read Only: true
    Value that uniquely identifies the document revision number.
  • Title: Service Level
    Read Only: true
    Maximum Length: 80
    Priority that determines how quickly to transport the item.
  • Read Only: true
    Maximum Length: 30
    Value that identifies the priority of transportation that affects how quickly goods are transported.
  • Title: Start Date
    Read Only: true
    Date on which the agreement becomes effective.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase agreement relative to the purchase agreement life cycle.
  • Title: Status Code
    Read Only: true
    Maximum Length: 25
    Value that identifies the header status.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier who fulfills the item.
  • Title: Supplier Agreement
    Read Only: true
    Maximum Length: 25
    Number that indicates the supplier document number.
  • Title: Communication Method
    Read Only: true
    Maximum Length: 25
    Code that identifies the supplier communication method.
  • Read Only: true
    Maximum Length: 4000
    Person who represents the supplier when communicating with the buyer.
  • Read Only: true
    Value that uniquely identifies the supplier contact.
  • 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.
  • 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.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Location that the supplier uses to purchase the item.
  • Read Only: true
    Value that uniquely identifies the supplier site.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : 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: object
Show Source
  • Title: Bill-to BU
    Read Only: true
    Maximum Length: 240
    Value that identifies the business unit that processes supplier invoices for the purchasing document.
  • Read Only: true
    Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
  • Title: Bill-to Location
    Read Only: true
    Maximum Length: 240
    Value that identifies the bill-to location where the supplier sends the invoice.
  • Read Only: true
    Value that uniquely identifies the bill-to location.
  • Read Only: true
    Maximum Length: 64
    User who created the business unit access on the purchase agreement
  • Read Only: true
    Date and time when the buyer or application created the purchase agreement.
  • 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.
  • Read Only: true
    Date and time when the buyer or application last updated the business unit access of a purchase agreement.
  • Read Only: true
    Maximum Length: 64
    User who last updated the business unit access of a purchase agreement.
  • Links
  • 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.
  • Read Only: true
    Value that uniquely identifies the procurement agent assignment.
  • Title: Purchasing Site
    Read Only: true
    Maximum Length: 240
    Value that uniquely identifies the supplier site for the purchasing operating unit.
  • Read Only: true
    Value that uniquely identifies the supplier site for the purchasing operating unit.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Business unit that creates the requisition.
  • Read Only: true
    Value that uniquely identifies the business unit that requested the goods or services being purchased.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 240
    Name of the location where the supplier ships the item.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the location where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the location where the supplier ships the shipment item.
Nested Schema : purchaseAgreements-lines-item-response
Type: object
Show Source
  • Title: Aging Period Days
    Read Only: true
    Value that identifies the maximum number of days the material may be on consignment.
  • Title: Agreement Amount
    Read Only: true
    Value that identifies the amount agreed for an agreement line.
  • Read Only: true
    Value that uniquely identifies the purchase agreement.
  • Title: Line ID
    Read Only: true
    Value that indicates the status of the line.
  • Title: Agreement
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase agreement in the sold-to legal entity.
  • Title: Agreement Quantity
    Read Only: true
    Quantity agreed for an agreement line.
  • Title: Allow item description update
    Read Only: true
    Maximum Length: 1
    Value that identifies whether item descriptions can be updated on document lines.
  • 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.
  • Title: Agreement Amount
    Read Only: true
    Value that identifies the amount agreed on an agreement line between the buying and selling organization.
  • Read Only: true
    Maximum Length: 2400
    Value that uniquely identifies the purchasing category.
  • Title: Category Code
    Read Only: true
    Maximum Length: 820
    Abbreviation that identifies the purchasing category.
  • Read Only: true
    Value that uniquely identifies the purchasing category.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application created the purchase agreement line.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Currency on the purchase agreement line.
  • Title: Currency Code
    Read Only: true
    Maximum Length: 15
    Code that identifies the purchase order currency.
  • Title: Line Description
    Read Only: true
    Maximum Length: 240
    Description for the line item.
  • Title: Expiration Date
    Read Only: true
    Value that identifies the expiration date of the document.
  • Title: Hazard Class
    Read Only: true
    Maximum Length: 40
    Name of the hazard class.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Code that identifies the hazard class.
  • Read Only: true
    Value that uniquely identifies the hazard class.
  • Title: Item
    Read Only: true
    Maximum Length: 255
    Abbreviation that uniquely identifies the item on the purchase order.
  • 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.
  • Read Only: true
    Value that uniquely identifies the item on the purchase agreement.
  • Title: Revision
    Read Only: true
    Maximum Length: 18
    Value that identifies the revision number of the item.
  • Read Only: true
    Date and time when the buyer or application last updated the purchase agreement line
  • Read Only: true
    Maximum Length: 64
    User who last updated the purchase agreement line.
  • Title: Line
    Read Only: true
    Value that uniquely identifies the purchase order or agreement line.
  • Title: Line Type
    Read Only: true
    Maximum Length: 30
    Line type on purchasing documents.
  • Title: Line Type ID
    Read Only: true
    Value that uniquely identifies the line type on your documents.
  • Links
  • Title: Minimum Release Amount
    Read Only: true
    Value that identifies the minimum amount that can be released against a blanket or planned purchase order.
  • 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.
  • Title: Note to Supplier
    Read Only: true
    Maximum Length: 1000
    Value that uniquely identifies a note to supplier.
  • Read Only: true
    Value that uniquely identifies the parent option class or model for the item.
  • Title: Price
    Read Only: true
    Unit price for the line.
  • 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.
  • Title: Price Break Type
    Read Only: true
    Maximum Length: 25
    Value that identifies the pricing scheme for the price breaks of this line.
  • Title: Price Limit
    Read Only: true
    Value that identifies the price limit that you can't exceed on a release shipment.
  • Read Only: true
    Maximum Length: 255
    Business unit that manages and owns the purchase agreement.
  • Read Only: true
    Value that uniquely identifies the business unit that manages and owns the purchasing document.
  • 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.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of an agreement line.
  • Title: Status Code
    Read Only: true
    Maximum Length: 25
    Code that identifies the agreement line status.
  • Read Only: true
    Maximum Length: 255
    Name of the supplier who fulfills the item.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 300
    Value that identifies the supplier item number.
  • Title: Supplier Item Auxiliary Identifier
    Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the item information.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Location that the supplier uses to purchase the item.
  • Read Only: true
    Value that uniquely identifies the supplier site.
  • 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.
  • Read Only: true
    Value that uniquely identifies the top model associated with the option, option class, or submodel.
  • Title: UN Number
    Read Only: true
    Maximum Length: 20
    Value that identifies the United Nations identification number for the hazardous material.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Read Only: true
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the unit of measure on the agreement line
  • 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 : 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: object
Show Source
  • Title: Alias
    Read Only: true
    Maximum Length: 700
    Alternate identifier for an item specified on a blanket purchase agreement line.
  • Title: Attachment URL
    Read Only: true
    Maximum Length: 700
    URL of the attachment associated with the item.
  • Read Only: true
    Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
  • 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.
  • Title: Availability
    Read Only: true
    Maximum Length: 700
    Status of the item availability from supplier.
  • Read Only: true
    Maximum Length: 64
    User who created the item attributes for a purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application created the item attributes for a purchase agreement line.
  • 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.
  • Read Only: true
    Date and time when the buyer or application last updated the item attributes on a purchase agreement line.
  • Read Only: true
    Maximum Length: 64
    User who last updated the item attributes on a purchase agreement line.
  • 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
  • Title: Long Description
    Read Only: true
    Maximum Length: 4000
    Text describing the long description of the item specified on a blanket purchase agreement line.
  • Title: Manufacturer
    Read Only: true
    Maximum Length: 700
    Name of the manufacturer of the item specified on a blanket purchase agreement line.
  • 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.
  • Title: Manufacturer URL
    Read Only: true
    Maximum Length: 700
    URL of the manufacturer of the item specified on a blanket purchase agreement line.
  • Title: Packaging String
    Read Only: true
    Maximum Length: 240
    String that describes how the item is packed by the supplier.
  • 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.
  • Title: Supplier URL
    Read Only: true
    Maximum Length: 700
    URL of the supplier's organization.
  • 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.
  • 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 : purchaseAgreements-lines-priceBreaks-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the price breaks for a purchase agreement line.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application created the price breaks for a purchase agreement line.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Currency on the agreement line price break.
  • Read Only: true
    Maximum Length: 15
    Code that identifies the currency on the agreement line price break.
  • Title: Discount Percent
    Read Only: true
    Value that identifies the discount percentage for the price break.
  • Title: End Date
    Read Only: true
    Date after which the purchase agreement is no longer valid.
  • Read Only: true
    Date when the price break was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the price breaks on a purchase agreement line.
  • Title: Line
    Read Only: true
    Value that uniquely identifies the purchase order or agreement line.
  • Links
  • Title: Location
    Read Only: true
    Maximum Length: 240
    Name of the location where the supplier ships the item.
  • Title: Location Code
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the location where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the location where the supplier ships the shipment item.
  • Title: Price
    Read Only: true
    Unit price for the line.
  • Read Only: true
    Value that uniquely identifies the price break referenced by this line.
  • Title: Price Break
    Read Only: true
    Number that uniquely identifies the price break on the purchase agreement line.
  • Title: Quantity
    Read Only: true
    Value that identifies the price break quantity, when the price break is effective for blanket purchase orders.
  • Title: Ship-to Organization
    Read Only: true
    Maximum Length: 240
    Name of the inventory organization that receives the item.
  • Title: Ship-to Organization Code
    Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the ship-to organization.
  • Read Only: true
    Value that uniquely identifies the ship-to organization.
  • Title: Start Date
    Read Only: true
    Date on which the agreement becomes effective.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the unit of measure on the agreement line price break.
  • Read Only: true
    Maximum Length: 3
    Code that identifies the unit of measure.
Nested Schema : purchaseAgreements-notificationControls-item-response
Type: object
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.
lines
Parameters:
  • 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.
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.
Back to Top

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"
        }
    ]
}
Back to Top