Jump to

• Request
• Response
• Examples

Get one line

get

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}

Request

Path Parameters

• AgreementLineId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• draftPurchaseAgreementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.

Body ()

Root Schema : draftPurchaseAgreements-lines-item-response

Type: object

Show Source

• AcknowledgeResponseCode: string
  Read Only: true

  Maximum Length: 1

  Abbreviation that identifies the acknowledgment response for the agreement line. Values include Y when the agreement line is accepted and N when the line is rejected.
• AgingPeriodDays: integer (int32)
  Value that identifies the maximum number of days the material may be on consignment.
• AgreementAmount: number
  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)
  Read Only: true

  Value that uniquely identifies the agreement line.
• AgreementQuantity: number
  Quantity agreed for an agreement line.
• AllowItemDescriptionUpdateFlag: boolean
  Maximum Length: 1

  Value that identifies whether item descriptions can be updated on document lines.
• AllowPriceOverrideFlag: boolean
  Maximum Length: 1

  Value that indicates whether a price limit can be provided for an agreement line. Possible values: Y and N.
• Amount: number
  Value that identifies the amount agreed on an agreement line between the buying and selling organization.
• AmountReleased: number
  Read Only: true

  Value that identifies the amount released for a purchase agreement line.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CancelFlag: boolean
  Maximum Length: 1

  Indicates whether the agreement line is canceled. Possible values: Y and N.
• CancelledBy: integer (int64)
  User who canceled the purchase agreement line.
• CancelReason: string
  Maximum Length: 240

  Reason provided for canceling the agreement line.
• Category: string
  Maximum Length: 2400

  Value that uniquely identifies the purchasing category.
• CategoryCode: string
  Maximum Length: 820

  Abbreviation that identifies the purchasing category.
• CategoryId: integer (int64)
  Value that uniquely identifies the purchasing category.
• ComponentAmountReleased: number
  Read Only: true

  Total value of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product.
• ComponentQuantityReleased: number
  Read Only: true

  Total quantity of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product.
• ConsignmentLineFlag: boolean
  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
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase agreement currency.
• DeliveredAmount: number
  Read Only: true

  Value that identifies the amount delivered for a purchase agreement line.
• DeliveredQuantity: number
  Read Only: true

  Quantity delivered for an agreement line.
• Description: string
  Maximum Length: 240

  Description for the line item.
• DFF: array DFF
• EntityChangeTypeCode: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the record is new or changed.
• ExpirationDate: string (date)
  Value that identifies the expiration date of the agreement line.
• HazardClass: string
  Title: Hazard Class

  Maximum Length: 40

  Name of the hazard class.
• HazardClassCode: string
  Title: Hazard Class Code

  Maximum Length: 30

  Code that identifies the hazard class.
• HazardClassId: integer (int64)
  Value that uniquely identifies the hazard class.
• InvoicedAmount: number
  Read Only: true

  Value that identifies the amount invoiced for a purchase agreement line.
• InvoicedQuantity: number
  Read Only: true

  Quantity invoiced for an agreement line.
• IsLineApprovedOnceFlag: boolean
  Read Only: true

  Indicates whether a line has been approved at least once.
• Item: string
  Title: Item

  Abbreviation that uniquely identifies the item on the purchase agreement line.
• ItemAllowItemDescriptionUpdateFlag: boolean
  Read Only: true

  Maximum Length: 255

  Value that identifies whether item descriptions can be updated on document lines.
• 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)
  Value that uniquely identifies the item on the purchase agreement.
• ItemRevision: string
  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
  Value that uniquely identifies the purchase order or agreement line.
• LineStartDate: string (date)
  Date after which the agreement line becomes effective.
• LineType: string
  Title: Line Type

  Maximum Length: 30

  Line type on purchasing documents.
• LineTypeId: integer (int64)
  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
  Minimum amount that can be released against the blanket purchase agreement.
• NegotiatedFlag: boolean
  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.
• Negotiation: string
  Maximum Length: 240

  Value that identifies the negotiation number.
• NoteToSupplier: string
  Maximum Length: 1000

  Value that uniquely identifies a note to supplier.
• ParentItem: string
  Maximum Length: 255

  Value that uniquely identifies the parent option class or model for the item.
• ParentItemId: integer (int64)
  Value that uniquely identifies the parent option class or model for the item.
• PimItemCategory: string
  Read Only: true

  Maximum Length: 255

  Name of the purchasing category associated with the item.
• PimItemCategoryCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the purchasing category associated with the item.
• PimItemCategoryId: integer
  Read Only: true

  Value that uniquely identifies the purchasing category associated with the item.
• PimItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item that the purchase order line references.
• Price: number
  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.
• PriceBreakType: string
  Title: Price Break Type

  Maximum Length: 80

  Value that identifies the pricing scheme for the price breaks of this line.
• PriceBreakTypeCode: string
  Maximum Length: 25

  Code that identifies the pricing scheme for the price breaks of this line.
• PriceLimit: number
  Value that identifies the price limit that can't be exceeded on a purchase order referencing the blanket agreement line.
• PurchaseBasis: string
  Read Only: true

  Maximum Length: 30

  Value that indicates whether the line is for goods or services.
• PurchaseOrdersCreated: number
  Read Only: true

  Number of purchase orders created by referencing the agreement line.
• ReasonForChange: string
  Maximum Length: 240

  Value that identifies the reason for changing the line.
• ReceivedAmount: number
  Read Only: true

  Value that identifies the amount received for a purchase agreement line.
• ReceivedQuantity: number
  Read Only: true

  Quantity received for an agreement line.
• RejectedReason: string
  Read Only: true

  Maximum Length: 240

  Reason for rejecting the line.
• ReleasedQuantity: number
  Read Only: true

  Quantity released for an agreement line.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Status of an agreement line.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 25

  Code that identifies the agreement line status.
• SupplierItem: string
  Maximum Length: 300

  Value that identifies the supplier item number.
• SupplierParentItem: string
  Maximum Length: 300

  Value that identifies the supplier's identification number for the option class or model associated with item.
• SupplierPartAuxid: string
  Maximum Length: 255

  Supplier item auxiliary identifier for the blanket agreement line.
• SupplierTopModel: string
  Maximum Length: 300

  Value that identifies the supplier top model associated with the option, option class, or submodel.
• TopModel: string
  Maximum Length: 255

  Value that identifies the top model associated with the option or option class or submodel.
• TopModelId: integer (int64)
  Value that uniquely identifies the top model associated with the option, option class, or submodel.
• UNNumber: string
  Title: UN Number

  Maximum Length: 20

  Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
• UNNumberDescription: string
  Title: UN Number Description

  Maximum Length: 240

  Description of the hazardous material referenced by the UN number.
• UNNumberId: integer (int64)
  Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
• UOM: string
  Title: UOM

  Maximum Length: 25

  Abbreviation that identifies the unit of measure on the agreement line
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "AcknowledgeResponseCode":{
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation that identifies the acknowledgment response for the agreement line. Values include Y when the agreement line is accepted and N when the line is rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgingPeriodDays":{
            "type":"integer",
            "description":"Value that identifies the maximum number of days the material may be on consignment.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":5
            }
        },
        "AgreementAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed for an agreement line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementQuantity":{
            "type":"number",
            "description":"Quantity agreed for an agreement line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "AllowItemDescriptionUpdateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies whether item descriptions can be updated on document lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "AllowPriceOverrideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether a price limit can be provided for an agreement line. Possible values: Y and N.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "Amount":{
            "type":"number",
            "description":"Value that identifies the amount agreed on an agreement line between the buying and selling organization.",
            "nullable":true,
            "x-queryable":false
        },
        "AmountReleased":{
            "type":"number",
            "description":"Value that identifies the amount released for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CancelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the agreement line is canceled. Possible values: Y and N.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CancelReason"
                ]
            },
            "x-queryable":true
        },
        "CancelReason":{
            "maxLength":240,
            "type":"string",
            "description":"Reason provided for canceling the agreement line.",
            "nullable":true,
            "x-queryable":true
        },
        "CancelledBy":{
            "type":"integer",
            "description":"User who canceled the purchase agreement line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Category":{
            "maxLength":2400,
            "type":"string",
            "description":"Value that uniquely identifies the purchasing category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ComponentAmountReleased":{
            "type":"number",
            "description":"Total value of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentQuantityReleased":{
            "type":"number",
            "description":"Total quantity of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConsignmentLineFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase agreement currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Value that identifies the amount delivered for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveredQuantity":{
            "type":"number",
            "description":"Quantity delivered for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description for the line item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is new or changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Value that identifies the expiration date of the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "HazardClass":{
            "title":"Hazard Class",
            "maxLength":40,
            "type":"string",
            "description":"Name of the hazard class.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HazardClassCode":{
            "title":"Hazard Class Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the hazard class.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HazardClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hazard class.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"Value that identifies the amount invoiced for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InvoicedQuantity":{
            "type":"number",
            "description":"Quantity invoiced for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IsLineApprovedOnceFlag":{
            "type":"boolean",
            "description":"Indicates whether a line has been approved at least once.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the item on the purchase agreement line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemAllowItemDescriptionUpdateFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that identifies whether item descriptions can be updated on document lines.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item on the purchase agreement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision number of the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "LineStartDate":{
            "type":"string",
            "description":"Date after which the agreement line becomes effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":30,
            "type":"string",
            "description":"Line type on purchasing documents.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line type on your documents.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MinimumReleaseAmount":{
            "type":"number",
            "description":"Minimum amount that can be released against the blanket purchase agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "NegotiatedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "Negotiation":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the negotiation number.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteToSupplier":{
            "maxLength":1000,
            "type":"string",
            "description":"Value that uniquely identifies a note to supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentItem":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the parent option class or model for the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent option class or model for the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "ParentItem"
                ]
            },
            "x-queryable":true
        },
        "PimItemCategory":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the purchasing category associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PimItemCategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PimItemCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PimItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item that the purchase order line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "PriceBreakType":{
            "title":"Price Break Type",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the pricing scheme for the price breaks of this line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CancelFlag"
                ]
            },
            "x-queryable":true
        },
        "PriceBreakTypeCode":{
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the pricing scheme for the price breaks of this line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceLimit":{
            "type":"number",
            "description":"Value that identifies the price limit that can't be exceeded on a purchase order referencing the blanket agreement line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "PurchaseBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates whether the line is for goods or services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchaseOrdersCreated":{
            "type":"number",
            "description":"Number of purchase orders created by referencing the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReasonForChange":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the reason for changing the line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            },
            "x-queryable":true
        },
        "ReceivedAmount":{
            "type":"number",
            "description":"Value that identifies the amount received for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceivedQuantity":{
            "type":"number",
            "description":"Quantity received for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedReason":{
            "maxLength":240,
            "type":"string",
            "description":"Reason for rejecting the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReleasedQuantity":{
            "type":"number",
            "description":"Quantity released for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of an agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the agreement line status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the supplier item number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CancelFlag"
                ]
            }
        },
        "SupplierParentItem":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the supplier's identification number for the option class or model associated with item.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierPartAuxid":{
            "maxLength":255,
            "type":"string",
            "description":"Supplier item auxiliary identifier for the blanket agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierTopModel":{
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the supplier top model associated with the option, option class, or submodel.",
            "nullable":true,
            "x-queryable":false
        },
        "TopModel":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the top model associated with the option or option class or submodel.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TopModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the top model associated with the option, option class, or submodel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "TopModel"
                ]
            },
            "x-queryable":true
        },
        "UNNumber":{
            "title":"UN Number",
            "maxLength":20,
            "type":"string",
            "description":"Value that uniquely identifies the number that the United Nations uses to identify hazardous material.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UNNumberDescription":{
            "title":"UN Number Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the hazardous material referenced by the UN number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UNNumberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the number that the United Nations uses to identify hazardous material.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "UOM":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit",
                "dependencies":[
                    "Item"
                ]
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Item"
                ]
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-attachments-item-response"
            }
        },
        "itemAttributes":{
            "title":"Item Attributes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-itemAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "priceBreaks":{
            "title":"Price Breaks",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object draftPurchaseAgreements-lines-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-lines-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-DFF-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object draftPurchaseAgreements-lines-itemAttributes-item-response

{
    "title":"Item Attributes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-itemAttributes-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object draftPurchaseAgreements-lines-priceBreaks-item-response

{
    "title":"Price Breaks",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-item-response"
    }
}

Nested Schema : draftPurchaseAgreements-lines-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : draftPurchaseAgreements-lines-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PoLineId: integer (int64)

{
    "type":"object",
    "properties":{
        "PoLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : draftPurchaseAgreements-lines-itemAttributes-item-response

Type: object

Show Source

• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the agreement line.
• Alias: string
  Maximum Length: 700

  Alternate identifier for an item specified on a blanket purchase agreement line.
• AttachmentURL: string
  Maximum Length: 700

  URL of the attachment associated with the item.
• AttributeValuesId: integer (int64)
  Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
• AttributeValuesTlpId: integer (int64)
  Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
• Availability: string
  Maximum Length: 700

  Status of the item availability from supplier.
• Comments: string
  Maximum Length: 700

  Additional comments for the item specified on the blanket purchase agreement line.
• 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.
• DFF: array DFF
• EntityChangeTypeCode: string
  Read Only: true

  Maximum Length: 1

  Value that identifies if the row is new or changed.
• 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

  Abbreviation that identifies the hazard class.
• HazardClassId: integer (int64)
  Read Only: true

  Value that uniquely identifies the hazard class.
• ImageURL: string
  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
  Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Maximum Length: 4000

  Text describing the long description of the item specified on a blanket purchase agreement line.
• Manufacturer: string
  Maximum Length: 700

  Name of the manufacturer of the item specified on a blanket purchase agreement line.
• ManufacturerPartNumber: string
  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
  Maximum Length: 700

  URL of the manufacturer of the item specified on a blanket purchase agreement line.
• PackagingString: string
  Maximum Length: 240

  String that describes how the item is packed by the supplier.
• RoundingFactor: number
  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.
• SupplierPartAuxid: string
  Read Only: true

  Maximum Length: 255

  Supplier item auxiliary identifier for the blanket agreement line.
• SupplierURL: string
  Maximum Length: 700

  URL of the supplier's organization.
• ThumbnailImageURL: string
  Maximum Length: 700

  Location of the small version of a larger image file for the item specified on the blanket purchase agreement.
• UNNumber: string
  Title: UN Number

  Read Only: true

  Maximum Length: 20

  Number that the United Nations uses to identify hazardous material.
• UNNumberDescription: string
  Title: UN Number Description

  Read Only: true

  Maximum Length: 240

  Description of the hazardous material that the United Nations identification number references.
• UNNumberId: integer (int64)
  Read Only: true

  Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
• UNSPSC: string
  Maximum Length: 700

  The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.

{
    "type":"object",
    "properties":{
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Alias":{
            "maxLength":700,
            "type":"string",
            "description":"Alternate identifier for an item specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentURL":{
            "maxLength":700,
            "type":"string",
            "description":"URL of the attachment associated with the item.",
            "nullable":true,
            "x-queryable":false
        },
        "AttributeValuesId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValuesTlpId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Availability":{
            "maxLength":700,
            "type":"string",
            "description":"Status of the item availability from supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "maxLength":700,
            "type":"string",
            "description":"Additional comments for the item specified on the blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item attributes for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the item attributes for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-itemAttributes-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HazardClass":{
            "title":"Hazard Class",
            "maxLength":40,
            "type":"string",
            "description":"Name of the hazard class.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HazardClassCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the hazard class.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HazardClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hazard class.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":700,
            "type":"string",
            "description":"URL of the image file associated with the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the item attributes on a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the item attributes on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadTimeDays":{
            "type":"number",
            "description":"Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.",
            "nullable":true,
            "x-queryable":false
        },
        "LongDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Text describing the long description of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "Manufacturer":{
            "maxLength":700,
            "type":"string",
            "description":"Name of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "maxLength":700,
            "type":"string",
            "description":"Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "ManufacturerURL":{
            "maxLength":700,
            "type":"string",
            "description":"URL of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "x-queryable":false
        },
        "PackagingString":{
            "maxLength":240,
            "type":"string",
            "description":"String that describes how the item is packed by the supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "RoundingFactor":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3,
                "scale":3
            }
        },
        "SupplierPartAuxid":{
            "maxLength":255,
            "type":"string",
            "description":"Supplier item auxiliary identifier for the blanket agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierURL":{
            "maxLength":700,
            "type":"string",
            "description":"URL of the supplier's organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ThumbnailImageURL":{
            "maxLength":700,
            "type":"string",
            "description":"Location of the small version of a larger image file for the item specified on the blanket purchase agreement.",
            "nullable":true,
            "x-queryable":false
        },
        "UNNumber":{
            "title":"UN Number",
            "maxLength":20,
            "type":"string",
            "description":"Number that the United Nations uses to identify hazardous material.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UNNumberDescription":{
            "title":"UN Number Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the hazardous material that the United Nations identification number references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UNNumberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the number that the United Nations uses to identify hazardous material.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "UNSPSC":{
            "maxLength":700,
            "type":"string",
            "description":"The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-lines-itemAttributes-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-itemAttributes-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : draftPurchaseAgreements-lines-itemAttributes-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 240

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• AttributeValuesId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttributeValuesId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":240,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : draftPurchaseAgreements-lines-priceBreaks-item-response

Type: object

Show Source

• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the agreement line.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CancelFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the purchase order is canceled. If N, then the purchase order isn't canceled. This attribute doesn't have a default value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the price breaks for a purchase agreement line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application created the price breaks for a purchase agreement line.
• Currency: string
  Title: Currency Name

  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.
• DFF: array DFF
• DiscountPercent: number
  Value that identifies the discount percentage for the price break.
• EndDate: string (date)
  Date after which the price break is no longer valid for the agreement line.
• EntityChangeTypeCode: string
  Read Only: true

  Maximum Length: 1

  Value that identifies if the row is new or changed.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• LocationCode: string
  Title: Name

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• LocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the item.
• NumberOfPriceBreakAttachments: integer (int64)
  Read Only: true

  Count of attachments associated with the price break of an agreement line.
• NumberOfPriceBreakSupplierAttachments: integer (int64)
  Read Only: true

  URL of the attachment associated with the item.
• Price: number
  Price of the price break.
• PriceBreakId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price break.
• PriceBreakNumber: number
  Number that uniquely identifies the price break for the purchase agreement line.
• Quantity: number
  Quantity of the item on the price break.
• ReasonForChange: string
  Maximum Length: 240

  Value that identifies the reason for changing the agreement price break.
• ShipToOrganization: string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization that receives the item.
• ShipToOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization where the supplier ships the item.
• ShipToOrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization where the supplier ships the item.
• StartDate: string (date)
  Date on which the price break becomes effective for the agreement line.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure on the agreement line price break.
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CancelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the purchase order is canceled. If N, then the purchase order isn't canceled. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the price breaks for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the price breaks for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency on the agreement line price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DiscountPercent":{
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date after which the price break is no longer valid for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the price break was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the price breaks on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Location":{
            "title":"Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationCode":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "NumberOfPriceBreakAttachments":{
            "type":"integer",
            "description":"Count of attachments associated with the price break of an agreement line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "NumberOfPriceBreakSupplierAttachments":{
            "type":"integer",
            "description":"URL of the attachment associated with the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Price of the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceBreakId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price break.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceBreakNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the price break for the purchase agreement line.",
            "nullable":false,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item on the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "ReasonForChange":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the reason for changing the agreement price break.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization that receives the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date on which the price break becomes effective for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : draftPurchaseAgreements-lines-priceBreaks-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : draftPurchaseAgreements-lines-priceBreaks-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• LineLocationId: integer (int64)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LineLocationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

DFF

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/DFF

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

attachments

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/attachments

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

The attachments resource is used to view, create, and update attachments.

itemAttributes

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/itemAttributes

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

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

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/priceBreaks

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

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.

undoChanges

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/action/undoChanges

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID

Reverts the changes made to a line in a change order.

Back to Top

Examples

These examples describes how to get one purchase agreement line.

Table - Examples

Example Number	Description
Example 1	Get One Draft Purchase Agreement Line
Example 2	Get One Purchase Agreement According to Item ID

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/draftPurchaseAgreements/draftPurchaseAgreementsUniqID/child/lines/AgreementLineId"

For example1:

curl -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316"

Example Response Body

The following example includes the contents of the response body in JSON format:

 {
    "AgreementLineId": 602316,
    "LineNumber": 1,
    "AgreementHeaderId": 624291,
    "LineTypeId": 1,
    "LineType": "Goods",
    "ItemId": null,
    "Item": null,
    "ItemRevision": null,
    "Description": "dummy line",
    "SupplierItem": null,
    "CategoryId": 1,
    "CategoryCode": "MISC.MISC",
    "Category": "Miscellaneous_1",
    "StatusCode": "OPEN",
    "Status": "Open",
    "UOMCode": "Ea",
    "UOM": "Each",
    "Price": 10,
    "Amount": null,
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "ConsignmentLineFlag": false,
    "NoteToSupplier": null,
    "AllowItemDescriptionUpdateFlag": null,
    "PriceLimit": null,
    "AllowPriceOverrideFlag": false,
    "NegotiatedFlag": true,
    "LineStartDate": null,
    "ExpirationDate": null,
    "MinimumReleaseAmount": null,
    "AgreementAmount": null,
    "AgreementQuantity": null,
    "PriceBreakTypeCode": "CUMULATIVE",
    "ParentItemId": null,
    "ParentItem": null,
    "SupplierParentItem": null,
    "TopModelId": null,
    "TopModel": null,
    "SupplierTopModel": null,
    "SupplierPartAuxid": null,
    "UNNumberId": null,
    "UNNumber": null,
    "UNNumberDescription": null,
    "HazardClassId": null,
    "HazardClassCode": null,
    "HazardClass": null,
    "AgingPeriodDays": null,
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2026-04-10T08:58:37+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2026-04-10T08:58:37+00:00",
    "Negotiation": null,
    "PurchaseBasis": "GOODS",
    "PriceBreakType": "Cumulative",
    "ItemAllowItemDescriptionUpdateFlag": null,
    "IsLineApprovedOnceFlag": true,
    "CancelReason": null,
    "CancelFlag": false,
    "EntityChangeTypeCode": null,
    "ReasonForChange": null,
    "CancelledBy": null,
    "ReceivedQuantity": null,
    "ReceivedAmount": null,
    "InvoicedQuantity": null,
    "InvoicedAmount": null,
    "DeliveredQuantity": null,
    "DeliveredAmount": null,
    "ReleasedQuantity": null,
    "AmountReleased": null,
    "ComponentQuantityReleased": null,
    "ComponentAmountReleased": null,
    "PurchaseOrdersCreated": 0,
    "RejectedReason": null,
    "AcknowledgeResponseCode": null,
    "PimItemCategoryId": null,
    "PimItemDescription": null,
    "PimItemCategoryCode": null,
    "PimItemCategory": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316",
            "name": "lines",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316",
            "name": "lines",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291",
            "name": "draftPurchaseAgreements",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316/child/itemAttributes",
            "name": "itemAttributes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316/child/priceBreaks",
            "name": "priceBreaks",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/624291/child/lines/602316/action/undoChanges",
            "name": "undoChanges",
            "kind": "other"
        }
    ]
}

For example2:

curl -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/663907"

{
    "items": [
        {
            "AgreementLineId": 300100648089771,
            "LineNumber": 1,
            "AgreementHeaderId": 300100648089769,
            "LineTypeId": 1,
            "LineType": "Goods",
            "ItemId": 663907,
            "Item": "RCV-100",
            "ItemRevision": null,
            "Description": "Plain Item",
            "SupplierItem": null,
            "CategoryId": 1,
            "CategoryCode": "MISC.MISC",
            "Category": "Miscellaneous_1",
            "StatusCode": null,
            "Status": null,
            "UOMCode": "Ea",
            "UOM": "Each",
            "Price": 20,
            "Amount": null,
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ConsignmentLineFlag": false,
            "NoteToSupplier": null,
            "AllowItemDescriptionUpdateFlag": true,
            "PriceLimit": 30,
            "AllowPriceOverrideFlag": true,
            "NegotiatedFlag": null,
            "LineStartDate": null,
            "ExpirationDate": "2026-07-31",
            "MinimumReleaseAmount": null,
            "AgreementAmount": null,
            "AgreementQuantity": null,
            "PriceBreakTypeCode": "NON CUMULATIVE",
            "ParentItemId": null,
            "ParentItem": null,
            "SupplierParentItem": null,
            "TopModelId": null,
            "TopModel": null,
            "SupplierTopModel": null,
            "SupplierPartAuxid": null,
            "UNNumberId": null,
            "UNNumber": null,
            "UNNumberDescription": null,
            "HazardClassId": null,
            "HazardClassCode": null,
            "HazardClass": null,
            "AgingPeriodDays": null,
            "CreatedBy": "CVBUYER01",
            "CreationDate": "2026-04-16T06:13:24.532+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdateDate": "2026-04-16T06:13:24.532+00:00",
            "Negotiation": null,
            "PurchaseBasis": "GOODS",
            "PriceBreakType": "Noncumulative",
            "ItemAllowItemDescriptionUpdateFlag": true,
            "IsLineApprovedOnceFlag": false,
            "CancelReason": null,
            "CancelFlag": false,
            "EntityChangeTypeCode": "I",
            "ReasonForChange": null,
            "CancelledBy": null,
            "ReceivedQuantity": null,
            "ReceivedAmount": null,
            "InvoicedQuantity": null,
            "InvoicedAmount": null,
            "DeliveredQuantity": null,
            "DeliveredAmount": null,
            "ReleasedQuantity": null,
            "AmountReleased": null,
            "ComponentQuantityReleased": null,
            "ComponentAmountReleased": null,
            "PurchaseOrdersCreated": 0,
            "RejectedReason": null,
            "AcknowledgeResponseCode": null,
            "PimItemCategoryId": 1,
            "PimItemDescription": "Plain Item",
            "PimItemCategoryCode": "MISC.MISC",
            "PimItemCategory": "Miscellaneous_1",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769",
                    "name": "draftPurchaseAgreements",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771/child/DFF",
                    "name": "DFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771/child/itemAttributes",
                    "name": "itemAttributes",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771/child/priceBreaks",
                    "name": "priceBreaks",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines/300100648089771/action/undoChanges",
                    "name": "undoChanges",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648089769/child/lines",
            "name": "lines",
            "kind": "collection"
        }
    ]
}

Back to Top