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

Get one line

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreementLines/{AgreementLineId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • 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
  • 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 : purchaseAgreementLines-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 : purchaseAgreementLines-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 : purchaseAgreementLines-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.
Links
itemAttributes
Parameters:
  • AgreementLineId: $request.path.AgreementLineId
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.
priceBreaks
Parameters:
  • AgreementLineId: $request.path.AgreementLineId
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.
Back to Top

Examples

This example describes how to get one purchase agreement line.

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/purchaseAgreementLines/AgreementLineId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseAgreementLines/300100038599154"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "AgreementLineId": 300100038599154,
    "LineNumber": 1,
    "AgreementHeaderId": 300100038599060,
    "AgreementNumber": "1001970",
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Operations",
    "SupplierId": 300100000344131,
    "Supplier": "zBIA_Supplier_01",
    "SupplierSiteId": 300100000344161,
    "SupplierSite": "zBIA_Address_01",
    "LineTypeId": 1,
    "LineType": "Goods",
    "ItemId": 300100036705253,
    "Item": "zRel9BIA_CONS_LOT_INV011",
    "ItemRevision": null,
    "Description": "zRel9BIA_CONS_LOT_INV011",
    "SupplierItem": null,
    "CategoryId": 1,
    "CategoryCode": "MISC.MISC",
    "Category": "Miscellaneous_1",
    "StatusCode": "OPEN",
    "Status": "Open",
    "UOMCode": "KG",
    "UOM": "Kilogram",
    "Price": 10,
    "Amount": null,
    "CurrencyCode": "JPY",
    "Currency": "Yen",
    "ConsignmentLineFlag": true,
    "NoteToSupplier": null,
    "AllowItemDescriptionUpdateFlag": true,
    "PriceLimit": null,
    "AllowPriceOverrideFlag": false,
    "NegotiatedFlag": true,
    "ExpirationDate": null,
    "MinimumReleaseAmount": null,
    "AgreementAmount": null,
    "AgreementQuantity": null,
    "ReleasedAmount": null,
    "PriceBreakTypeCode": "CUMULATIVE",
    "SupplierItemAuxiliaryIdentifier": null,
    "ParentItemId": null,
    "SupplierParentItem": null,
    "TopModelId": null,
    "SupplierTopModel": null,
    "UnNumberId": null,
    "UnNumber": null,
    "UNNumberDescription": null,
    "HazardClassId": null,
    "HazardClassCode": null,
    "HazardClass": null,
    "AgingPeriodDays": null,
    "CreatedBy": "CVBUYER00",
    "CreationDate": "2014-07-31T00:32:35+00:00",
    "LastUpdatedBy": "CVBUYER00",
    "LastUpdateDate": "2014-07-31T00:34:43.073+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchaseAgreementLines/300100038599154",
            "name": "purchaseAgreementLines",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/purchaseAgreementLines/300100038599154",
            "name": "purchaseAgreementLines",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/purchaseAgreementLines/300100038599154/child/itemAttributes",
            "name": "itemAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/purchaseAgreementLines/300100038599154/child/priceBreaks",
            "name": "priceBreaks",
            "kind": "collection"
        }
    ]
}
Back to Top