REST API for Oracle Fusion Cloud Procurement

Get all agreements

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreements

Request

Query Parameters

effectiveDate: string

This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
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
finder: string
Used as a predefined finder to search the collection.

Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables
- PrimaryKey Finds purchase agreements according to their primary key.
  Finder Variables
  - AgreementHeaderId; integer; Value that uniquely identifies the purchase agreement.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- AcknowledgmentDueDate; string; Date that the application requests the supplier to acknowledge the document.
- AcknowledgmentWithinDays; number; Number of days that the supplier can decide to accept or reject the document.
- AgingOnsetPoint; string; Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment.
- AgingOnsetPointCode; string; Code that identifies the aging onset point.
- AgingPeriodDays; integer; 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; Value that uniquely identifies the purchase agreement.
- AgreementNumber; string; Number that uniquely identifies the purchase agreement in the sold-to legal entity.
- AllowUnassignedSitesFlag; boolean; Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments.
- AmountLimit; number; Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
- AutomaticallyGenerateOrdersFlag; boolean; Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.
- AutomaticallySubmitForApprovalFlag; boolean; Value that identifies whether the document can be automatically submitted for approval.
- Buyer; string; Person who's responsible for managing the purchase agreement.
- BuyerId; integer; Value that uniquely identifies the buyer.
- BuyerManagedTransportFlag; boolean; Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order.
- Carrier; string; Company that transports the item.
- CarrierId; integer; Value that uniquely identifies the company that transports the item.
- Checklist; string; Value that uniquely identifies the checklist associated with the purchasing document.
- ClosedDate; string; Date when the order was closed.
- CommunicateRepricedOrdersFlag; boolean; Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier.
- ConfirmingOrderFlag; boolean; Value that identifies whether the document is a confirmation of an order the supplier may already be aware of.
- ConsumptionAdviceFrequency; string; Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
- ConsumptionAdviceFrequencyCode; string; Code that indicates the consumption advice frequency.
- ConsumptionAdviceSummary; string; Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
- ConsumptionAdviceSummaryCode; string; Code that indicates the consumption advice summary.
- ConversionRate; number; Conversion rate to use when converting the currency.
- ConversionRateDate; string; Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date.
- ConversionRateTypeCode; string; Value that identifies the rate type that the application uses to determine the currency conversion rate for the purchase order.
- CreatedBy; string; User who created the purchase agreement.
- CreationDate; string; Date and time when the buyer or application created the purchase agreement.
- Currency; string; Currency of the purchase agreement.
- CurrencyCode; string; Code that identifies the purchase agreement currency.
- Description; string; Description for the line item.
- DocumentStyle; string; Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
- DocumentStyleId; integer; Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document header.
- DocumentTypeCode; string; Value that identifies the document type associated with a change order template.
- EnableRetroactivePricingFlag; boolean; Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement.
- EndDate; string; Date after which the purchase agreement is no longer valid.
- FOB; string; Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
- FOBCode; string; Code that identifies the type of free-on-board terms for the document.
- FreightTerms; string; Terms that describe who pays charges to transport the item.
- FreightTermsCode; string; Code that identifies the type of freight terms for the document
- GroupRequisitionLinesFlag; boolean; Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.
- GroupRequisitionsFlag; boolean; Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order.
- InitiateRetroactivePricingUponApprovalFlag; boolean; Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval.
- LastUpdateDate; string; Date and time when the buyer or application last updated the purchase agreement.
- LastUpdatedBy; string; User who last updated the purchase agreement.
- MasterContractId; integer; Value that uniquely identifies the associated contract.
- MasterContractNumber; string; Number that identifies the contract from enterprise contracts.
- MasterContractType; string; Administrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms.
- MasterContractTypeId; integer; Value that uniquely identifies the master contract type.
- MinimumReleaseAmount; number; Value that identifies the minimum amount that can be released against a blanket or planned purchase order.
- ModeOfTransport; string; Mode of transport to ship the item, such as truck, air, or boat.
- ModeOfTransportCode; string; Mode of transport that the shipper uses to transport the item such as land, sea, and air.
- NoteToReceiver; string; Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.
- NoteToSupplier; string; Value that uniquely identifies a note to supplier.
- PayOnReceiptFlag; boolean; Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization.
- PaymentTerms; string; Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
- PaymentTermsId; integer; Value that uniquely identifies the payment terms.
- Priority; integer; Priority that determines how quickly to transport the item.
- ProcurementBU; string; Business unit that manages and owns the purchase agreement.
- ProcurementBUId; integer; Value that uniquely identifies the business unit that manages and owns the purchasing document.
- PunchoutRequestsOnlyFlag; boolean; Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value.
- ReferenceNumber; string; Number used for EDI transaction audit trail reference.
- ReleasedAmount; number; Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
- RepriceOpenOrdersFlag; boolean; Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement.
- RequiredAcknowledgment; string; Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment.
- RequiredAcknowledgmentCode; string; Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required.
- RequiresSignatureFlag; boolean; Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No.
- RevisionNumber; number; Value that uniquely identifies the document revision number.
- ServiceLevel; string; Priority that determines how quickly to transport the item.
- ServiceLevelCode; string; Value that identifies the priority of transportation that affects how quickly goods are transported.
- StartDate; string; Date on which the agreement becomes effective.
- Status; string; Status of the purchase agreement relative to the purchase agreement life cycle.
- StatusCode; string; Value that identifies the header status.
- Supplier; string; Name of the supplier who fulfills the item.
- SupplierAgreement; string; Number that indicates the supplier document number.
- SupplierCommunicationMethodCode; string; Code that identifies the supplier communication method.
- SupplierContact; string; Person who represents the supplier when communicating with the buyer.
- SupplierContactId; integer; Value that uniquely identifies the supplier contact.
- SupplierEmailAddress; string; Value that identifies the email address specified on the document to which the document after approval will be communicated.
- SupplierFax; string; Value that identifies the fax number specified on the document to which the document after approval will be communicated.
- SupplierId; integer; Value that uniquely identifies the supplier.
- SupplierSite; string; Location that the supplier uses to purchase the item.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
- UseCustomerSalesOrderFlag; boolean; Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order.
- UseOrderDateForOrderPricingFlag; boolean; Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value.
- UseRequestedDateFlag; boolean; Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order.
- UseShipToLocationFlag; boolean; Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders.
- UseShipToOrganizationAndLocationFlag; boolean; Value that identifies whether item descriptions can be updated on document lines.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

Effective-Of:

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

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.

Root Schema : purchaseAgreements

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreements-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object purchaseAgreements-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreements-item-response"
    }
}

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 : purchaseAgreements-item-response

Type: object

Show Source

AcknowledgmentDueDate: string (date)

Title: Acknowledgment Due Date

Read Only: true

Date that the application requests the supplier to acknowledge the document.
AcknowledgmentWithinDays: number

Title: Acknowledge Within Days

Read Only: true

Number of days that the supplier can decide to accept or reject the document.
AgingOnsetPoint: string

Title: Aging Onset Point

Read Only: true

Maximum Length: 80

Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment.
AgingOnsetPointCode: string

Title: Aging Onset Point Code

Read Only: true

Maximum Length: 30

Code that identifies the aging onset point.
AgingPeriodDays: integer (int32)

Title: Aging Period Days

Read Only: true

Value that identifies the maximum number of days the material may be on consignment.
AgreementAmount: number

Title: Agreement Amount

Read Only: true

Value that identifies the amount agreed for an agreement line.
AgreementHeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the purchase agreement.
AgreementNumber: string

Title: Agreement

Read Only: true

Maximum Length: 30

Number that uniquely identifies the purchase agreement in the sold-to legal entity.
AllowUnassignedSitesFlag: boolean

Title: Allow ordering from unassigned sites

Read Only: true

Maximum Length: 1

Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments.
AmountLimit: number

Title: Amount Limit

Read Only: true

Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
AutomaticallyGenerateOrdersFlag: boolean

Title: Automatically generate orders

Read Only: true

Maximum Length: 1

Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.
AutomaticallySubmitForApprovalFlag: boolean

Title: Automatically submit for approval

Read Only: true

Maximum Length: 1

Value that identifies whether the document can be automatically submitted for approval.
businessUnitAccess: array Business Unit Accesses

Title: Business Unit Accesses

Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.
Buyer: string

Title: Buyer

Read Only: true

Maximum Length: 240

Person who's responsible for managing the purchase agreement.
BuyerId: integer (int64)

Read Only: true

Value that uniquely identifies the buyer.
BuyerManagedTransportFlag: boolean

Title: Buyer managed transportation

Read Only: true

Maximum Length: 1

Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order.
Carrier: string

Title: Carrier

Read Only: true

Maximum Length: 360

Company that transports the item.
CarrierId: integer (int64)

Read Only: true

Value that uniquely identifies the company that transports the item.
Checklist: string

Title: Checklist

Read Only: true

Maximum Length: 80

Value that uniquely identifies the checklist associated with the purchasing document.
ClosedDate: string (date)

Title: Closed Date

Read Only: true

Date when the order was closed.
CommunicateRepricedOrdersFlag: boolean

Title: Communicate repriced orders

Read Only: true

Maximum Length: 1

Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier.
ConfirmingOrderFlag: boolean

Title: Confirming order

Read Only: true

Maximum Length: 1

Value that identifies whether the document is a confirmation of an order the supplier may already be aware of.
ConsumptionAdviceFrequency: string

Title: Consumption Advice Frequency

Read Only: true

Maximum Length: 80

Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
ConsumptionAdviceFrequencyCode: string

Title: Consumption Advice Frequency Code

Read Only: true

Maximum Length: 30

Code that indicates the consumption advice frequency.
ConsumptionAdviceSummary: string

Title: Consumption Advice Summary

Read Only: true

Maximum Length: 80

Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
ConsumptionAdviceSummaryCode: string

Title: Consumption Advice Summary Code

Read Only: true

Maximum Length: 30

Code that indicates the consumption advice summary.
ConversionRate: number

Title: Conversion Rate

Read Only: true

Conversion rate to use when converting the currency.
ConversionRateDate: string (date)

Title: Conversion Date

Read Only: true

Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date.
ConversionRateTypeCode: string

Read Only: true

Maximum Length: 30

Value that identifies the rate type that the application uses to determine the currency conversion rate for the purchase order.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the purchase agreement.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date and time when the buyer or application created the purchase agreement.
Currency: string

Title: Currency

Read Only: true

Maximum Length: 80

Currency of the purchase agreement.
CurrencyCode: string

Read Only: true

Maximum Length: 15

Code that identifies the purchase agreement currency.
Description: string

Title: Agreement Description

Read Only: true

Maximum Length: 240

Description for the line item.
DocumentStyle: string

Title: Document Style

Read Only: true

Maximum Length: 240

Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
DocumentStyleId: integer (int64)

Read Only: true

Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document header.
DocumentTypeCode: string

Read Only: true

Maximum Length: 25

Value that identifies the document type associated with a change order template.
EnableRetroactivePricingFlag: boolean

Title: Enable retroactive pricing

Read Only: true

Maximum Length: 1

Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement.
EndDate: string (date)

Title: End Date

Read Only: true

Date after which the purchase agreement is no longer valid.
FOB: string

Title: FOB

Read Only: true

Maximum Length: 80

Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
FOBCode: string

Title: FOB Code

Read Only: true

Maximum Length: 30

Code that identifies the type of free-on-board terms for the document.
FreightTerms: string

Title: Freight Terms

Read Only: true

Maximum Length: 80

Terms that describe who pays charges to transport the item.
FreightTermsCode: string

Title: Freight Terms Code

Read Only: true

Maximum Length: 30

Code that identifies the type of freight terms for the document
GroupRequisitionLinesFlag: boolean

Title: Group requisition lines

Read Only: true

Maximum Length: 1

Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.
GroupRequisitionsFlag: boolean

Title: Group requisitions

Read Only: true

Maximum Length: 1

Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order.
InitiateRetroactivePricingUponApprovalFlag: boolean

Title: Initiate process upon agreement approval

Read Only: true

Maximum Length: 1

Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the buyer or application last updated the purchase agreement.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the purchase agreement.
lines: array Purchase Agreement Lines

Title: Purchase Agreement Lines

Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.
links: array Links

Title: Links

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

Read Only: true

Value that uniquely identifies the associated contract.
MasterContractNumber: string

Title: Master Contract

Read Only: true

Maximum Length: 120

Number that identifies the contract from enterprise contracts.
MasterContractType: string

Title: Master Contract Type

Read Only: true

Maximum Length: 255

Administrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms.
MasterContractTypeId: integer

Read Only: true

Value that uniquely identifies the master contract type.
MinimumReleaseAmount: number

Title: Minimum Release Amount

Read Only: true

Value that identifies the minimum amount that can be released against a blanket or planned purchase order.
ModeOfTransport: string

Title: Mode of Transport

Read Only: true

Maximum Length: 80

Mode of transport to ship the item, such as truck, air, or boat.
ModeOfTransportCode: string

Read Only: true

Maximum Length: 30

Mode of transport that the shipper uses to transport the item such as land, sea, and air.
NoteToReceiver: string

Title: Note to Receiver

Read Only: true

Maximum Length: 1000

Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.
NoteToSupplier: string

Title: Note to Supplier

Read Only: true

Maximum Length: 1000

Value that uniquely identifies a note to supplier.
notificationControls: array Notification Controls

Title: Notification Controls

Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.
PaymentTerms: string

Title: Payment Terms

Read Only: true

Maximum Length: 50

Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
PaymentTermsId: integer (int64)

Read Only: true

Value that uniquely identifies the payment terms.
PayOnReceiptFlag: boolean

Title: Pay on Receipt

Read Only: true

Maximum Length: 25

Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization.
Priority: integer (int32)

Title: Priority

Read Only: true

Priority that determines how quickly to transport the item.
ProcurementBU: string

Title: Procurement BU

Read Only: true

Maximum Length: 240

Business unit that manages and owns the purchase agreement.
ProcurementBUId: integer (int64)

Title: Procurement BU ID

Read Only: true

Value that uniquely identifies the business unit that manages and owns the purchasing document.
PunchoutRequestsOnlyFlag: boolean

Title: Punchout requests only

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value.
ReferenceNumber: string

Title: Reference Number

Read Only: true

Maximum Length: 120

Number used for EDI transaction audit trail reference.
ReleasedAmount: number

Title: Released Amount

Read Only: true

Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
RepriceOpenOrdersFlag: boolean

Title: Reprice open orders only

Read Only: true

Maximum Length: 1

Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement.
RequiredAcknowledgment: string

Title: Required Acknowledgment

Read Only: true

Maximum Length: 80

Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment.
RequiredAcknowledgmentCode: string

Title: Required Acknowledgment Code

Read Only: true

Maximum Length: 1

Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required.
RequiresSignatureFlag: boolean

Title: Requires signature

Read Only: true

Maximum Length: 1

Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No.
RevisionNumber: number

Title: Agreement Revision

Read Only: true

Value that uniquely identifies the document revision number.
ServiceLevel: string

Title: Service Level

Read Only: true

Maximum Length: 80

Priority that determines how quickly to transport the item.
ServiceLevelCode: string

Read Only: true

Maximum Length: 30

Value that identifies the priority of transportation that affects how quickly goods are transported.
StartDate: string (date)

Title: Start Date

Read Only: true

Date on which the agreement becomes effective.
Status: string

Title: Status

Read Only: true

Maximum Length: 80

Status of the purchase agreement relative to the purchase agreement life cycle.
StatusCode: string

Title: Status Code

Read Only: true

Maximum Length: 25

Value that identifies the header status.
Supplier: string

Title: Supplier

Read Only: true

Maximum Length: 360

Name of the supplier who fulfills the item.
SupplierAgreement: string

Title: Supplier Agreement

Read Only: true

Maximum Length: 25

Number that indicates the supplier document number.
SupplierCommunicationMethodCode: string

Title: Communication Method

Read Only: true

Maximum Length: 25

Code that identifies the supplier communication method.
SupplierContact: string

Read Only: true

Maximum Length: 4000

Person who represents the supplier when communicating with the buyer.
SupplierContactId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier contact.
SupplierEmailAddress: string

Title: Supplier Email

Read Only: true

Maximum Length: 2000

Value that identifies the email address specified on the document to which the document after approval will be communicated.
SupplierFax: string

Title: Supplier Fax

Read Only: true

Maximum Length: 60

Value that identifies the fax number specified on the document to which the document after approval will be communicated.
SupplierId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier.
SupplierSite: string

Title: Supplier Site

Read Only: true

Maximum Length: 240

Location that the supplier uses to purchase the item.
SupplierSiteId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier site.
UseCustomerSalesOrderFlag: boolean

Title: Use customer sales order

Read Only: true

Maximum Length: 1

Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order.
UseOrderDateForOrderPricingFlag: boolean

Title: Use order date for order pricing

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value.
UseRequestedDateFlag: boolean

Title: Use need-by date

Read Only: true

Maximum Length: 1

Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order.
UseShipToLocationFlag: boolean

Title: Group Requisition Lines Using Ship-to Organization and Location

Read Only: true

Maximum Length: 1

Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders.
UseShipToOrganizationAndLocationFlag: boolean

Title: Use ship-to organization and location

Read Only: true

Maximum Length: 1

Value that identifies whether item descriptions can be updated on document lines.

{
    "type":"object",
    "properties":{
        "NoteToSupplier":{
            "title":"Note to Supplier",
            "maxLength":"1000",
            "type":"string",
            "description":"Value that uniquely identifies a note to supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the buyer or application created the purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the priority of transportation that affects how quickly goods are transported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterContractNumber":{
            "title":"Master Contract",
            "maxLength":"120",
            "type":"string",
            "description":"Number that identifies the contract from enterprise contracts.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"25",
            "type":"string",
            "description":"Value that identifies the header status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgingOnsetPoint":{
            "title":"Aging Onset Point",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountLimit":{
            "title":"Amount Limit",
            "type":"number",
            "description":"Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAgreement":{
            "title":"Supplier Agreement",
            "maxLength":"25",
            "type":"string",
            "description":"Number that indicates the supplier document number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgingPeriodDays":{
            "title":"Aging Period Days",
            "type":"integer",
            "description":"Value that identifies the maximum number of days the material may be on consignment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the agreement becomes effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the purchase agreement currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcknowledgmentDueDate":{
            "title":"Acknowledgment Due Date",
            "type":"string",
            "description":"Date that the application requests the supplier to acknowledge the document.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerManagedTransportFlag":{
            "title":"Buyer managed transportation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowUnassignedSitesFlag":{
            "title":"Allow ordering from unassigned sites",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "notificationControls":{
            "title":"Notification Controls",
            "type":"array",
            "description":"Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreements-notificationControls-item-response"
            }
        },
        "SupplierEmailAddress":{
            "title":"Supplier Email",
            "maxLength":"2000",
            "type":"string",
            "description":"Value that identifies the email address specified on the document to which the document after approval will be communicated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency of the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterContractId":{
            "type":"integer",
            "description":"Value that uniquely identifies the associated contract.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FOB":{
            "title":"FOB",
            "maxLength":"80",
            "type":"string",
            "description":"Freight on board. Location where ownership of the item transfers from the supplier to the buyer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutomaticallySubmitForApprovalFlag":{
            "title":"Automatically submit for approval",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether the document can be automatically submitted for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Carrier":{
            "title":"Carrier",
            "maxLength":"360",
            "type":"string",
            "description":"Company that transports the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicateRepricedOrdersFlag":{
            "title":"Communicate repriced orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AutomaticallyGenerateOrdersFlag":{
            "title":"Automatically generate orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchasing document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that manages and owns the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the purchase agreement relative to the purchase agreement life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FOBCode":{
            "title":"FOB Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the type of free-on-board terms for the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseRequestedDateFlag":{
            "title":"Use need-by date",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceSummaryCode":{
            "title":"Consumption Advice Summary Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the consumption advice summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"Priority that determines how quickly to transport the item.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"120",
            "type":"string",
            "description":"Number used for EDI transaction audit trail reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTermsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment terms.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierFax":{
            "title":"Supplier Fax",
            "maxLength":"60",
            "type":"string",
            "description":"Value that identifies the fax number specified on the document to which the document after approval will be communicated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeOfTransportCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mode of transport that the shipper uses to transport the item such as land, sea, and air.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MasterContractType":{
            "title":"Master Contract Type",
            "maxLength":"255",
            "type":"string",
            "description":"Administrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceFrequency":{
            "title":"Consumption Advice Frequency",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceFrequencyCode":{
            "title":"Consumption Advice Frequency Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the consumption advice frequency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseCustomerSalesOrderFlag":{
            "title":"Use customer sales order",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToReceiver":{
            "title":"Note to Receiver",
            "maxLength":"1000",
            "type":"string",
            "description":"Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModeOfTransport":{
            "title":"Mode of Transport",
            "maxLength":"80",
            "type":"string",
            "description":"Mode of transport to ship the item, such as truck, air, or boat.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredAcknowledgmentCode":{
            "title":"Required Acknowledgment Code",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumReleaseAmount":{
            "title":"Minimum Release Amount",
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against a blanket or planned purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Checklist":{
            "title":"Checklist",
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the checklist associated with the purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierCommunicationMethodCode":{
            "title":"Communication Method",
            "maxLength":"25",
            "type":"string",
            "description":"Code that identifies the supplier communication method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitiateRetroactivePricingUponApprovalFlag":{
            "title":"Initiate process upon agreement approval",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupRequisitionLinesFlag":{
            "title":"Group requisition lines",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceLevel":{
            "title":"Service Level",
            "maxLength":"80",
            "type":"string",
            "description":"Priority that determines how quickly to transport the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Agreement Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description for the line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcknowledgmentWithinDays":{
            "title":"Acknowledge Within Days",
            "type":"number",
            "description":"Number of days that the supplier can decide to accept or reject the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterContractTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master contract type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "maxLength":"4000",
            "type":"string",
            "description":"Person who represents the supplier when communicating with the buyer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseShipToLocationFlag":{
            "title":"Group Requisition Lines Using Ship-to Organization and Location",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"240",
            "type":"string",
            "description":"Person who's responsible for managing the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleasedAmount":{
            "title":"Released Amount",
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTerms":{
            "title":"Payment Terms",
            "maxLength":"50",
            "type":"string",
            "description":"Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentStyle":{
            "title":"Document Style",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PunchoutRequestsOnlyFlag":{
            "title":"Punchout requests only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseOrderDateForOrderPricingFlag":{
            "title":"Use order date for order pricing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the company that transports the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnableRetroactivePricingFlag":{
            "title":"Enable retroactive pricing",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayOnReceiptFlag":{
            "title":"Pay on Receipt",
            "maxLength":"25",
            "type":"boolean",
            "description":"Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Value that identifies the document type associated with a change order template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who fulfills the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RepriceOpenOrdersFlag":{
            "title":"Reprice open orders only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionRateDate":{
            "title":"Conversion Date",
            "type":"string",
            "description":"Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseShipToOrganizationAndLocationFlag":{
            "title":"Use ship-to organization and location",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether item descriptions can be updated on document lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lines":{
            "title":"Purchase Agreement Lines",
            "type":"array",
            "description":"Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreements-lines-item-response"
            }
        },
        "RequiredAcknowledgment":{
            "title":"Required Acknowledgment",
            "maxLength":"80",
            "type":"string",
            "description":"Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupRequisitionsFlag":{
            "title":"Group requisitions",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementNumber":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnitAccess":{
            "title":"Business Unit Accesses",
            "type":"array",
            "description":"Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreements-businessUnitAccess-item-response"
            }
        },
        "RevisionNumber":{
            "title":"Agreement Revision",
            "type":"number",
            "description":"Value that uniquely identifies the document revision number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the purchase agreement is no longer valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionRateTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the rate type that the application uses to determine the currency conversion rate for the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Conversion rate to use when converting the currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementAmount":{
            "title":"Agreement Amount",
            "type":"number",
            "description":"Value that identifies the amount agreed for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiresSignatureFlag":{
            "title":"Requires signature",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FreightTermsCode":{
            "title":"Freight Terms Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the type of freight terms for the document",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgingOnsetPointCode":{
            "title":"Aging Onset Point Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the aging onset point.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentStyleId":{
            "type":"integer",
            "description":"Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Date when the order was closed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfirmingOrderFlag":{
            "title":"Confirming order",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether the document is a confirmation of an order the supplier may already be aware of.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionAdviceSummary":{
            "title":"Consumption Advice Summary",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FreightTerms":{
            "title":"Freight Terms",
            "maxLength":"80",
            "type":"string",
            "description":"Terms that describe who pays charges to transport the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Business Unit Accesses

Type: array

Title: Business Unit Accesses

Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.

Show Source

Array of: object purchaseAgreements-businessUnitAccess-item-response

{
    "title":"Business Unit Accesses",
    "type":"array",
    "description":"Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreements-businessUnitAccess-item-response"
    }
}

Nested Schema : Purchase Agreement Lines

Type: array

Title: Purchase Agreement Lines

Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.

Show Source

Array of: object purchaseAgreements-lines-item-response

{
    "title":"Purchase Agreement Lines",
    "type":"array",
    "description":"Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreements-lines-item-response"
    }
}

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 : Notification Controls

Type: array

Title: Notification Controls

Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.

Show Source

Array of: object purchaseAgreements-notificationControls-item-response

{
    "title":"Notification Controls",
    "type":"array",
    "description":"Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreements-notificationControls-item-response"
    }
}

Nested Schema : purchaseAgreements-businessUnitAccess-item-response

Type: object

Show Source

BillToBU: string

Title: Bill-to BU

Read Only: true

Maximum Length: 240

Value that identifies the business unit that processes supplier invoices for the purchasing document.
BilltoBUId: integer (int64)

Read Only: true

Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
BillToLocation: string

Title: Bill-to Location

Read Only: true

Maximum Length: 240

Value that identifies the bill-to location where the supplier sends the invoice.
BillToLocationId: integer (int64)

Read Only: true

Value that uniquely identifies the bill-to location.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the business unit access on the purchase agreement
CreationDate: string (date-time)

Read Only: true

Date and time when the buyer or application created the purchase agreement.
EnabledFlag: boolean

Title: Enabled

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the business unit assignment record on the agreement is enabled. If false, then business unit assignment record on the agreement is disabled. This attribute doesn't have a default value.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the buyer or application last updated the business unit access of a purchase agreement.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the business unit access of a purchase agreement.
links: array Links

Title: Links

The link relations associated with the resource instance.
OrderLocallyFlag: boolean

Title: Order Locally

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.
OrganizationAssignmentId: integer (int64)

Read Only: true

Value that uniquely identifies the procurement agent assignment.
PurchasingSite: string

Title: Purchasing Site

Read Only: true

Maximum Length: 240

Value that uniquely identifies the supplier site for the purchasing operating unit.
PurchasingSiteId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier site for the purchasing operating unit.
RequisitioningBU: string

Title: Requisitioning BU

Read Only: true

Maximum Length: 240

Business unit that creates the requisition.
RequisitioningBUId: integer (int64)

Read Only: true

Value that uniquely identifies the business unit that requested the goods or services being purchased.
ShipToLocation: string

Title: Ship-to Location

Read Only: true

Maximum Length: 240

Name of the location where the supplier ships the item.
ShipToLocationCode: string

Title: Ship-to Location

Read Only: true

Maximum Length: 60

Abbreviation that identifies the location where the supplier ships the item.
ShipToLocationId: integer (int64)

Read Only: true

Value that uniquely identifies the location where the supplier ships the shipment item.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the business unit access of a purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that requested the goods or services being purchased.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the shipment item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the business unit access on the purchase agreement",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PurchasingSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site for the purchasing operating unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderLocallyFlag":{
            "title":"Order Locally",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToBU":{
            "title":"Bill-to BU",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the business unit that processes supplier invoices for the purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that creates the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement agent assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PurchasingSite":{
            "title":"Purchasing Site",
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the supplier site for the purchasing operating unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the business unit assignment record on the agreement is enabled. If false, then business unit assignment record on the agreement is disabled. This attribute doesn't have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BilltoBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the bill-to location where the supplier sends the invoice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the business unit access of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : purchaseAgreements-lines-item-response

Type: object

Show Source

AgingPeriodDays: integer (int32)

Title: Aging Period Days

Read Only: true

Value that identifies the maximum number of days the material may be on consignment.
AgreementAmount: number

Title: Agreement Amount

Read Only: true

Value that identifies the amount agreed for an agreement line.
AgreementHeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the purchase agreement.
AgreementLineId: integer (int64)

Title: Line ID

Read Only: true

Value that indicates the status of the line.
AgreementNumber: string

Title: Agreement

Read Only: true

Maximum Length: 30

Number that uniquely identifies the purchase agreement in the sold-to legal entity.
AgreementQuantity: number

Title: Agreement Quantity

Read Only: true

Quantity agreed for an agreement line.
AllowItemDescriptionUpdateFlag: boolean

Title: Allow item description update

Read Only: true

Maximum Length: 1

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

Title: Allow Price Override

Read Only: true

Maximum Length: 1

Value that identifies if you can change the price on release shipments. Possible values are Y and N. This attribute doesn't have a default value.
Amount: number

Title: Agreement Amount

Read Only: true

Value that identifies the amount agreed on an agreement line between the buying and selling organization.
Category: string

Read Only: true

Maximum Length: 2400

Value that uniquely identifies the purchasing category.
CategoryCode: string

Title: Category Code

Read Only: true

Maximum Length: 820

Abbreviation that identifies the purchasing category.
CategoryId: integer (int64)

Read Only: true

Value that uniquely identifies the purchasing category.
ConsignmentLineFlag: boolean

Title: Consignment line

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the blanket purchase agreement and the purchase order include consignment lines. If false, then the blanket purchase agreement and the purchase order don't include consignment lines. The default value is false.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the purchase agreement line.
CreationDate: string (date-time)

Read Only: true

Date and time when the buyer or application created the purchase agreement line.
Currency: string

Title: Currency

Read Only: true

Maximum Length: 80

Currency on the purchase agreement line.
CurrencyCode: string

Title: Currency Code

Read Only: true

Maximum Length: 15

Code that identifies the purchase order currency.
Description: string

Title: Line Description

Read Only: true

Maximum Length: 240

Description for the line item.
ExpirationDate: string (date)

Title: Expiration Date

Read Only: true

Value that identifies the expiration date of the document.
HazardClass: string

Title: Hazard Class

Read Only: true

Maximum Length: 40

Name of the hazard class.
HazardClassCode: string

Title: Code

Read Only: true

Maximum Length: 30

Code that identifies the hazard class.
HazardClassId: integer (int64)

Read Only: true

Value that uniquely identifies the hazard class.
Item: string

Title: Item

Read Only: true

Maximum Length: 255

Abbreviation that uniquely identifies the item on the purchase order.
itemAttributes: array Item Attributes

Title: Item Attributes

Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television.
ItemId: integer (int64)

Read Only: true

Value that uniquely identifies the item on the purchase agreement.
ItemRevision: string

Title: Revision

Read Only: true

Maximum Length: 18

Value that identifies the revision number of the item.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the buyer or application last updated the purchase agreement line
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the purchase agreement line.
LineNumber: number

Title: Line

Read Only: true

Value that uniquely identifies the purchase order or agreement line.
LineType: string

Title: Line Type

Read Only: true

Maximum Length: 30

Line type on purchasing documents.
LineTypeId: integer (int64)

Title: Line Type ID

Read Only: true

Value that uniquely identifies the line type on your documents.
links: array Links

Title: Links

The link relations associated with the resource instance.
MinimumReleaseAmount: number

Title: Minimum Release Amount

Read Only: true

Value that identifies the minimum amount that can be released against a blanket or planned purchase order.
NegotiatedFlag: boolean

Title: Negotiated

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the buyer and the supplier negotiated and agreed on the price before the purchase. If false, then the buyer and the supplier didn't negotiate the price before the purchase. This attribute doesn't have a default value.
NoteToSupplier: string

Title: Note to Supplier

Read Only: true

Maximum Length: 1000

Value that uniquely identifies a note to supplier.
ParentItemId: integer (int64)

Read Only: true

Value that uniquely identifies the parent option class or model for the item.
Price: number

Title: Price

Read Only: true

Unit price for the line.
priceBreaks: array Price Breaks

Title: Price Breaks

Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location.
PriceBreakTypeCode: string

Title: Price Break Type

Read Only: true

Maximum Length: 25

Value that identifies the pricing scheme for the price breaks of this line.
PriceLimit: number

Title: Price Limit

Read Only: true

Value that identifies the price limit that you can't exceed on a release shipment.
ProcurementBU: string

Read Only: true

Maximum Length: 255

Business unit that manages and owns the purchase agreement.
ProcurementBUId: integer (int64)

Read Only: true

Value that uniquely identifies the business unit that manages and owns the purchasing document.
ReleasedAmount: number

Title: Released Amount

Read Only: true

Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.
Status: string

Title: Status

Read Only: true

Maximum Length: 80

Status of an agreement line.
StatusCode: string

Title: Status Code

Read Only: true

Maximum Length: 25

Code that identifies the agreement line status.
Supplier: string

Read Only: true

Maximum Length: 255

Name of the supplier who fulfills the item.
SupplierId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier.
SupplierItem: string

Title: Supplier Item

Read Only: true

Maximum Length: 300

Value that identifies the supplier item number.
SupplierItemAuxiliaryIdentifier: string

Title: Supplier Item Auxiliary Identifier

Read Only: true

Maximum Length: 255

Value that uniquely identifies the item information.
SupplierParentItem: string

Title: Supplier Parent Item

Read Only: true

Maximum Length: 300

Value that identifies the supplier's identification number for the option class or model associated with item.
SupplierSite: string

Read Only: true

Maximum Length: 255

Location that the supplier uses to purchase the item.
SupplierSiteId: integer (int64)

Read Only: true

Value that uniquely identifies the supplier site.
SupplierTopModel: string

Title: Supplier Top Model

Read Only: true

Maximum Length: 300

Value that identifies the top model associated with the option or option class, or submodel.
TopModelId: integer (int64)

Read Only: true

Value that uniquely identifies the top model associated with the option, option class, or submodel.
UnNumber: string

Title: UN Number

Read Only: true

Maximum Length: 20

Value that identifies the United Nations identification number for the hazardous material.
UNNumberDescription: string

Title: Description

Read Only: true

Maximum Length: 240

Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
UnNumberId: integer (int64)

Read Only: true

Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
UOM: string

Title: UOM

Read Only: true

Maximum Length: 25

Abbreviation that identifies the unit of measure on the agreement line
UOMCode: string

Title: UOM Code

Read Only: true

Maximum Length: 3

Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":"820",
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToSupplier":{
            "title":"Note to Supplier",
            "maxLength":"1000",
            "type":"string",
            "description":"Value that uniquely identifies a note to supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":true
        },
        "LineTypeId":{
            "title":"Line Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the line type on your documents.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierTopModel":{
            "title":"Supplier Top Model",
            "maxLength":"300",
            "type":"string",
            "description":"Value that identifies the top model associated with the option or option class, or submodel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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/purchaseAgreements-lines-itemAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "TopModelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the top model associated with the option, option class, or submodel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item on the purchase agreement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"25",
            "type":"string",
            "description":"Code that identifies the agreement line status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnNumber":{
            "title":"UN Number",
            "maxLength":"20",
            "type":"string",
            "description":"Value that identifies the United Nations identification number for the hazardous material.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowItemDescriptionUpdateFlag":{
            "title":"Allow item description update",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies whether item descriptions can be updated on document lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemAuxiliaryIdentifier":{
            "title":"Supplier Item Auxiliary Identifier",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the item information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgingPeriodDays":{
            "title":"Aging Period Days",
            "type":"integer",
            "description":"Value that identifies the maximum number of days the material may be on consignment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency on the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceLimit":{
            "title":"Price Limit",
            "type":"number",
            "description":"Value that identifies the price limit that you can't exceed on a release shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementLineId":{
            "title":"Line ID",
            "type":"integer",
            "description":"Value that indicates the status of the line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":"18",
            "type":"string",
            "description":"Value that identifies the revision number of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsignmentLineFlag":{
            "title":"Consignment line",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchasing document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "maxLength":"255",
            "type":"string",
            "description":"Business unit that manages and owns the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of an agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HazardClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hazard class.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HazardClassCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the hazard class.",
            "nullable":true,
            "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":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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/purchaseAgreements-lines-priceBreaks-item-response"
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowPriceOverrideFlag":{
            "title":"Allow Price Override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that identifies if you can change the price on release shipments. Possible values are Y and N. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NegotiatedFlag":{
            "title":"Negotiated",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumReleaseAmount":{
            "title":"Minimum Release Amount",
            "type":"number",
            "description":"Value that identifies the minimum amount that can be released against a blanket or planned purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Line Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description for the line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "maxLength":"2400",
            "type":"string",
            "description":"Value that uniquely identifies the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBreakTypeCode":{
            "title":"Price Break Type",
            "maxLength":"25",
            "type":"string",
            "description":"Value that identifies the pricing scheme for the price breaks of this line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HazardClass":{
            "title":"Hazard Class",
            "maxLength":"40",
            "type":"string",
            "description":"Name of the hazard class.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleasedAmount":{
            "title":"Released Amount",
            "type":"number",
            "description":"Value that identifies the amount released against this agreement. It's the sum of all the approved standard PO amounts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier who fulfills the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierParentItem":{
            "title":"Supplier Parent Item",
            "maxLength":"300",
            "type":"string",
            "description":"Value that identifies the supplier's identification number for the option class or model associated with item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":"30",
            "type":"string",
            "description":"Line type on purchasing documents.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementNumber":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Agreement Amount",
            "type":"number",
            "description":"Value that identifies the amount agreed on an agreement line between the buying and selling organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UNNumberDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the number that the United Nations uses to identify hazardous material.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent option class or model for the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Value that identifies the expiration date of the document.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementAmount":{
            "title":"Agreement Amount",
            "type":"number",
            "description":"Value that identifies the amount agreed for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":"300",
            "type":"string",
            "description":"Value that identifies the supplier item number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementQuantity":{
            "title":"Agreement Quantity",
            "type":"number",
            "description":"Quantity agreed for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":true
        }
    }
}

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 purchaseAgreements-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/purchaseAgreements-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 purchaseAgreements-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/purchaseAgreements-lines-priceBreaks-item-response"
    }
}

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

Type: object

Show Source

Alias: string

Title: Alias

Read Only: true

Maximum Length: 700

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

Title: Attachment URL

Read Only: true

Maximum Length: 700

URL of the attachment associated with the item.
AttributeValuesId: integer (int64)

Read Only: true

Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
AttributeValuesTlpId: integer (int64)

Read Only: true

Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
Availability: string

Title: Availability

Read Only: true

Maximum Length: 700

Status of the item availability from supplier.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the item attributes for a purchase agreement line.
CreationDate: string (date-time)

Read Only: true

Date and time when the buyer or application created the item attributes for a purchase agreement line.
ImageURL: string

Title: Image URL

Read Only: true

Maximum Length: 700

URL of the image file associated with the item specified on a blanket purchase agreement line.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the buyer or application last updated the item attributes on a purchase agreement line.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the item attributes on a purchase agreement line.
LeadTimeDays: number

Title: Lead Time Days

Read Only: true

The number of days in which the item, specified on the blanket purchase order line, can be delivered when ordered.
links: array Links

Title: Links

The link relations associated with the resource instance.
LongDescription: string

Title: Long Description

Read Only: true

Maximum Length: 4000

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

Title: Manufacturer

Read Only: true

Maximum Length: 700

Name of the manufacturer of the item specified on a blanket purchase agreement line.
ManufacturerPartNumber: string

Title: Manufacturer Part Number

Read Only: true

Maximum Length: 700

Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.
ManufacturerURL: string

Title: Manufacturer URL

Read Only: true

Maximum Length: 700

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

Title: Packaging String

Read Only: true

Maximum Length: 240

String that describes how the item is packed by the supplier.
RoundingFactor: number

Title: Rounding Factor

Read Only: true

Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
SupplierURL: string

Title: Supplier URL

Read Only: true

Maximum Length: 700

URL of the supplier's organization.
ThumbnailImageURL: string

Title: Thumbnail Image

Read Only: true

Maximum Length: 700

Location of the small version of a larger image file for the item specified on the blanket purchase agreement.
UNSPSC: string

Title: UNSPSC

Read Only: true

Maximum Length: 700

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

{
    "type":"object",
    "properties":{
        "Availability":{
            "title":"Availability",
            "maxLength":"700",
            "type":"string",
            "description":"Status of the item availability from supplier.",
            "nullable":true,
            "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
        },
        "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
        },
        "AttachmentURL":{
            "title":"Attachment URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the attachment associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerURL":{
            "title":"Manufacturer URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the item attributes for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadTimeDays":{
            "title":"Lead Time Days",
            "type":"number",
            "description":"The number of days in which the item, specified on the blanket purchase order line, can be delivered when ordered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the image file associated with the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RoundingFactor":{
            "title":"Rounding Factor",
            "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,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3",
                "scale":"3"
            }
        },
        "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":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Text describing the long description of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Alias":{
            "title":"Alias",
            "maxLength":"700",
            "type":"string",
            "description":"Alternate identifier for an item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ThumbnailImageURL":{
            "title":"Thumbnail Image",
            "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,
            "readOnly":true,
            "x-queryable":false
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "maxLength":"700",
            "type":"string",
            "description":"Name of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UNSPSC":{
            "title":"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,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PackagingString":{
            "title":"Packaging String",
            "maxLength":"240",
            "type":"string",
            "description":"String that describes how the item is packed by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierURL":{
            "title":"Supplier URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the supplier's organization.",
            "nullable":true,
            "readOnly":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
        }
    }
}

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 : purchaseAgreements-lines-priceBreaks-item-response

Type: object

Show Source

CreatedBy: string

Read Only: true

Maximum Length: 64

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

Title: Creation Date

Read Only: true

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

Title: Currency

Read Only: true

Maximum Length: 80

Currency on the agreement line price break.
CurrencyCode: string

Read Only: true

Maximum Length: 15

Code that identifies the currency on the agreement line price break.
DiscountPercent: number

Title: Discount Percent

Read Only: true

Value that identifies the discount percentage for the price break.
EndDate: string (date)

Title: End Date

Read Only: true

Date after which the purchase agreement is no longer valid.
LastUpdateDate: string (date-time)

Read Only: true

Date when the price break was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the price breaks on a purchase agreement line.
LineNumber: number

Title: Line

Read Only: true

Value that uniquely identifies the purchase order or agreement line.
links: array Links

Title: Links

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

Title: Location

Read Only: true

Maximum Length: 240

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

Title: Location Code

Read Only: true

Maximum Length: 60

Abbreviation that identifies the location where the supplier ships the item.
LocationId: integer (int64)

Read Only: true

Value that uniquely identifies the location where the supplier ships the shipment item.
Price: number

Title: Price

Read Only: true

Unit price for the line.
PriceBreakId: integer (int64)

Read Only: true

Value that uniquely identifies the price break referenced by this line.
PriceBreakNumber: number

Title: Price Break

Read Only: true

Number that uniquely identifies the price break on the purchase agreement line.
Quantity: number

Title: Quantity

Read Only: true

Value that identifies the price break quantity, when the price break is effective for blanket purchase orders.
ShipToOrganization: string

Title: Ship-to Organization

Read Only: true

Maximum Length: 240

Name of the inventory organization that receives the item.
ShipToOrganizationCode: string

Title: Ship-to Organization Code

Read Only: true

Maximum Length: 18

Abbreviation that identifies the ship-to organization.
ShipToOrganizationId: integer (int64)

Read Only: true

Value that uniquely identifies the ship-to organization.
StartDate: string (date)

Title: Start Date

Read Only: true

Date on which the agreement becomes effective.
UOM: string

Title: UOM

Read Only: true

Maximum Length: 25

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

Read Only: true

Maximum Length: 3

Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the price breaks on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "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":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the price breaks for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBreakNumber":{
            "title":"Price Break",
            "type":"number",
            "description":"Number that uniquely identifies the price break on the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the shipment item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LocationCode":{
            "title":"Location Code",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Value that identifies the price break quantity, when the price break is effective for blanket purchase orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the purchase agreement is no longer valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the agreement becomes effective.",
            "format":"date",
            "nullable":true,
            "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
        },
        "UOM":{
            "title":"UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceBreakId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price break referenced by this line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShipToOrganizationCode":{
            "title":"Ship-to Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the ship-to organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DiscountPercent":{
            "title":"Discount Percent",
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Location":{
            "title":"Location",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the price break was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : purchaseAgreements-notificationControls-item-response

Type: object

Show Source

Amount: number

Title: Amount

Read Only: true

Notification amount of purchase agreement document total.
ConditionCode: string

Title: Condition

Read Only: true

Maximum Length: 25

Notification type of the purchase agreement.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the notification controls on the purchase agreement
CreationDate: string (date-time)

Read Only: true

Date and time when the buyer or application created the notification controls of a purchase agreement.
EndDate: string (date)

Title: End Date

Read Only: true

Expiration date of the notification.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the buyer or application last updated the notification controls of a purchase agreement.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who last updated the notification controls of a purchase agreement.
links: array Links

Title: Links

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

Read Only: true

Value that uniquely identifies the agreement notification control.
Percentage: number

Title: Percent

Read Only: true

Notification percentage of purchase agreement document total.
ReminderDays: number

Title: Reminder Days

Read Only: true

Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.
StartDate: string (date)

Title: Start Date

Read Only: true

Effective date of the notification.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Effective date of the notification.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the notification controls of a purchase agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ReminderDays":{
            "title":"Reminder Days",
            "type":"number",
            "description":"Value that identifies the number of days before the expiration event that the reminder notification needs to be sent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the notification controls of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notification controls on the purchase agreement",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement notification control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"Notification percentage of purchase agreement document total.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Notification amount of purchase agreement document total.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Expiration date of the notification.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConditionCode":{
            "title":"Condition",
            "maxLength":"25",
            "type":"string",
            "description":"Notification type of the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the notification controls of a purchase agreement.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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"
    }
}