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

Get all draft purchase agreements

get

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements

Request

Query Parameters
  • 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
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • 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 the primary key.
      Finder Variables
      • AgreementHeaderId; integer; Value that uniquely identifies the purchase agreement.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
    • 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 upon for an agreement.
    • AgreementHeaderId; integer; Value that uniquely identifies the purchase agreement.
    • AgreementNumber; string; Number that uniquely identifies the purchase agreement in the procurement business unit.
    • 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.
    • AutoSourcingFlag; boolean; Enable automatic sourcing
    • 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.
    • BillingCycleClosingDate; string; Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.
    • Buyer; string; Person who's responsible for managing the purchase agreement.
    • BuyerEmail; string; Email address of the buyer.
    • 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.
    • ChangeOrderCreationDate; string; Date and time when the buyer or application created the change order.
    • ChangeOrderInitiatorId; integer; Value that uniquely identifies the user who initiated the change order.
    • ChangeOrderInitiatorRole; string; Role of the user who created the change order.
    • ChangeOrderNumber; string; Number that uniquely identifies the change order for a purchasing document.
    • ChangeOrderSequence; integer; The sequence number for each change order. This is internally generated (start with 0) and increment by 1 for each new change order created for the document.
    • ChangeOrderStatus; string; Status of the change order relative to the change order life cycle.
    • ChangeOrderStatusCode; string; Abbreviation that identifies the change order status.
    • ChangeOrderType; string; Value that indicates whether change order is an internal change order or an external change order. Suppliers can view the external changes.
    • ChangeOrderTypeCode; string; Abbreviation that defines the change order type.
    • Checklist; string; Title of the compliance checklist.
    • ChecklistNumber; string; Number that uniquely identifies the compliance checklist.
    • 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.
    • 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.
    • ContractTermsExists; string; Contains one of the following values: true or false. If true, contract clauses were added from the terms library to the purchase agreement. If false, the purchase agreement doesn't contain any contract clauses from the terms library. This attribute has no default value.
    • 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.
    • DefaultConsignmentLineFlag; boolean; Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default.
    • Description; string; Description of the purchase agreement.
    • 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; Value that uniquely identifies the purchasing document style.
    • DocumentType; string; Value that identifies the document type associated with a change order template.
    • DocumentTypeCode; string; Code that identifies the document type.
    • 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.
    • EntityChangeTypeCode; string; Value that indicates if the header is changed.
    • 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.
    • IdentificationKey; string; Value that uniquely identifies the approval actions of a purchase agreement.
    • InitiateRetroactivePricingUponApprovalFlag; boolean; Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval.
    • LatestIdentificationKey; string; Value that uniquely identifies the header of 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 purchase agreement.
    • Negotiation; string; Number that uniquely identifies the negotiation referenced by the purchase agreement.
    • NegotiationId; integer; Unique identifier for the negotiation referenced by the purchase agreement.
    • NoteToAuthorizer; string; Text comments to the approver, included as needed when submitting a document for approval.
    • OkcContractId; integer; Unique identifier for the contract in Oracle Enterprise Contracts.
    • OkcContractNumber; string; Unique number for the contract in Oracle Enterprise Contracts.
    • PayOnUseFlag; boolean; Indicates whether invoices are automatically created when consigned material is consumed for document styles that allow consignment lines.
    • PaymentTerms; string; Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase agreement.
    • PaymentTermsId; integer; Value that uniquely identifies the payment terms.
    • Priority; number; 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 approved purchase order amounts.
    • RepriceOpenOrdersFlag; boolean; Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement.
    • RequiresSignatureFlag; boolean; Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No.
    • ScheduleGroup; string; Code that identifies the schedule group used to consolidate requisition demand into fewer purchase orders by applying order-generation schedules to agreements with the same ordering cadence. The Generate Orders process uses this value to process only requisitions sourced to agreements in the specified group.
    • ScheduleGroupMeaning; string; Display name or meaning of the schedule group.
    • ShippingMethod; string; Shipping method on the purchasing document.
    • 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.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierPartyId; integer; Value that uniquely identifies the party for 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; Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders.
    • VersionId; integer; Value that uniquely identifies the current version of the purchase agreement.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : draftPurchaseAgreements
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : draftPurchaseAgreements-item-response
Type: object
Show Source
  • Read Only: true
    Date that the application requests the supplier to acknowledge the document.
  • Number of days that the supplier can decide to accept or reject the document.
  • Title: Aging Onset Point
    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.
  • Maximum Length: 30
    Code that identifies the aging onset point.
  • Value that identifies the maximum number of days the material may be on consignment.
  • Value that identifies the amount agreed upon for an agreement.
  • Read Only: true
    Value that uniquely identifies the purchase agreement.
  • Maximum Length: 30
    Number that uniquely identifies the purchase agreement in the procurement business unit.
  • 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.
  • Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Maximum Length: 1
    Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.
  • Maximum Length: 1
    Value that identifies whether the document can be automatically submitted for approval.
  • Maximum Length: 1
    Enable automatic sourcing
  • Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.
  • Business Unit Accesses
    Title: Business Unit Accesses
    Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.
  • Title: Buyer
    Maximum Length: 240
    Person who's responsible for managing the purchase agreement.
  • Title: Buyer Email
    Maximum Length: 240
    Email address of the buyer.
  • Title: Buyer Full Name
    Read Only: true
    Maximum Length: 240
    Display name of the buyer on the purchasing document.
  • Value that uniquely identifies the buyer.
  • Title: Buyer managed transportation
    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.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the purchase agreement is canceled. Valid values: True or False.
  • Title: Carrier
    Maximum Length: 360
    Company that transports the item.
  • Value that uniquely identifies the company that transports the item.
  • Read Only: true
    Date and time when the buyer or application created the change order.
  • Maximum Length: 255
    Text that describes the reason or purpose of the change order.
  • Maximum Length: 255
    Party where the purchase document change request originated. Valid values are requester, buyer, supplier, and catalog administrator.
  • Read Only: true
    Value that uniquely identifies the user who initiated the change order.
  • Read Only: true
    Maximum Length: 255
    Role of the user who created the change order.
  • Title: Change Order Number
    Read Only: true
    Maximum Length: 80
    Number that uniquely identifies the change order for a purchasing document.
  • Title: Change Order Sequence
    Read Only: true
    The sequence number for each change order. This is internally generated (start with 0) and increment by 1 for each new change order created for the document.
  • Read Only: true
    Maximum Length: 255
    Status of the change order relative to the change order life cycle.
  • Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the change order status.
  • Read Only: true
    Maximum Length: 255
    Value that indicates whether change order is an internal change order or an external change order. Suppliers can view the external changes.
  • Read Only: true
    Maximum Length: 1
    Abbreviation that defines the change order type.
  • Read Only: true
    Maximum Length: 360
    User who requested changes to the purchase agreement.
  • Maximum Length: 80
    Title of the compliance checklist.
  • Value that uniquely identifies the checklist associated with the purchasing document.
  • Maximum Length: 30
    Number that uniquely identifies the compliance checklist.
  • 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.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the document style allows configuration items on agreements and purchase orders.
  • Title: Confirming order
    Maximum Length: 1
    Value that identifies whether the document is a confirmation of an order the supplier may already be aware of.
  • Title: Consignment Terms Enabled
    Read Only: true
    Maximum Length: 1
    Indicates whether the document style allows consignment lines on agreements and purchase orders.
  • Title: Consumption Advice Frequency
    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.
  • Maximum Length: 30
    Code that indicates the consumption advice frequency.
  • Title: Consumption Advice Summary
    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.
  • Maximum Length: 30
    Code that indicates the consumption advice summary.
  • Contract Documents for Contract Terms
    Title: Contract Documents for Contract Terms
    Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, contract clauses were added from the terms library to the purchase agreement. If false, the purchase agreement doesn't contain any contract clauses from the terms library. This attribute has no default value.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase agreement.
  • Read Only: true
    Date and time when the buyer or application created the purchase agreement.
  • Title: Currency Name
    Maximum Length: 80
    Currency of the purchase agreement.
  • Maximum Length: 15
    Code that identifies the purchase agreement currency.
  • Maximum Length: 1
    Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default.
  • Maximum Length: 240
    Description of the purchase agreement.
  • DFF
  • Maximum Length: 30
    Method by which the document was created.
  • Title: Style
    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.
  • Value that uniquely identifies the purchasing document style.
  • Title: Document Type
    Maximum Length: 80
    Value that identifies the document type associated with a change order template.
  • Maximum Length: 25
    Code that identifies the document type.
  • 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.
  • Date after which the purchase agreement is no longer valid.
  • Read Only: true
    Maximum Length: 1
    Value that indicates if the header is changed.
  • Title: FOB
    Maximum Length: 80
    Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
  • Maximum Length: 30
    Code that identifies the type of free-on-board terms for the document.
  • Title: Freight Terms
    Maximum Length: 80
    Terms that describe who pays charges to transport the item.
  • Maximum Length: 30
    Code that identifies the type of freight terms for the document
  • Maximum Length: 1
    Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the approval actions of a purchase agreement.
  • Maximum Length: 1
    Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval.
  • Read Only: true
    Date and time when the buyer or application last updated the purchase agreement.
  • Read Only: true
    Maximum Length: 64
    User who last updated the purchase agreement.
  • Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the header of the purchase agreement.
  • Purchase Agreement Lines
    Title: Purchase Agreement Lines
    Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.
  • Links
  • Value that uniquely identifies the associated contract.
  • Title: Master Contract
    Maximum Length: 120
    Number that identifies the contract from enterprise contracts.
  • Title: Master Contract Type
    Administrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms.
  • Value that uniquely identifies the master contract type.
  • Value that identifies the minimum amount that can be released against a purchase agreement.
  • Title: Mode of Transport
    Maximum Length: 80
    Mode of transport to ship the item, such as truck, air, or boat.
  • Maximum Length: 30
    Mode of transport that the shipper uses to transport the item such as land, sea, and air.
  • Title: Negotiation
    Read Only: true
    Maximum Length: 255
    Number that uniquely identifies the negotiation referenced by the purchase agreement.
  • Read Only: true
    Unique identifier for the negotiation referenced by the purchase agreement.
  • Maximum Length: 1000
    Text comments to the approver, included as needed when submitting a document for approval.
  • Maximum Length: 1000
    Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.
  • Maximum Length: 1000
    Note to the supplier for the purchase agreement.
  • Notification Controls
    Title: Notification Controls
    Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.
  • Title: Contract ID
    Read Only: true
    Unique identifier for the contract in Oracle Enterprise Contracts.
  • Title: Contract Number
    Read Only: true
    Maximum Length: 255
    Unique number for the contract in Oracle Enterprise Contracts.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the document style allows outside processing lines on agreements.
  • Title: Payment Terms
    Maximum Length: 50
    Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase agreement.
  • Value that uniquely identifies the payment terms.
  • Title: Pay on Receipt
    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.
  • Maximum Length: 1
    Indicates whether invoices are automatically created when consigned material is consumed for document styles that allow consignment lines.
  • Title: Price Breaks Allowed
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the price breaks are enabled for this document style. If false, then the price breaks aren't enabled for this document style. The default value is false.
  • Value that identifies the tolerance in percent above which if the price changes on an agreement line, the line should be highlighted to the user making the change.
  • Priority that determines how quickly to transport the item.
  • Title: Procurement BU
    Maximum Length: 240
    Business unit that manages and owns the purchase agreement.
  • Value that uniquely identifies the business unit that manages and owns the purchasing document.
  • 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.
  • Maximum Length: 120
    Number used for EDI transaction audit trail reference.
  • Title: Released Amount
    Read Only: true
    Value that identifies the amount released against this agreement. It's the sum of all approved purchase order amounts.
  • Maximum Length: 1
    Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement.
  • Title: Required Acknowledgment
    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.
  • Maximum Length: 1
    Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required.
  • Title: Requires signature
    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.
  • Maximum Length: 30
    Code that identifies the schedule group used to consolidate requisition demand into fewer purchase orders by applying order-generation schedules to agreements with the same ordering cadence. The Generate Orders process uses this value to process only requisitions sourced to agreements in the specified group.
  • Title: Schedule Group
    Maximum Length: 80
    Display name or meaning of the schedule group.
  • Title: Service Level
    Maximum Length: 80
    Priority that determines how quickly to transport the item.
  • Maximum Length: 30
    Value that identifies the priority of transportation that affects how quickly goods are transported.
  • Title: Shipping Method
    Shipping method on the purchasing document.
  • Date on which the agreement becomes effective.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase agreement relative to the purchase agreement life cycle.
  • Read Only: true
    Maximum Length: 40
    Value that identifies the header status.
  • Maximum Length: 360
    Name of the supplier who fulfills the item.
  • Maximum Length: 25
    Number that indicates the supplier document number.
  • Maximum Length: 25
    Code that identifies the supplier communication method.
  • Maximum Length: 4000
    Person who represents the supplier when communicating with the buyer.
  • Read Only: true
    Display name of the supplier contact.
  • Value that uniquely identifies the supplier contact.
  • Maximum Length: 2000
    Value that identifies the email address specified on the document to which the document after approval will be communicated.
  • Maximum Length: 60
    Value that identifies the fax number specified on the document to which the document after approval will be communicated.
  • Value that uniquely identifies the supplier.
  • Value that uniquely identifies the party for the supplier.
  • Read Only: true
    Maximum Length: 1
    Indicates whether pay-on-use is enabled for this agreement.
  • Title: Site
    Maximum Length: 240
    Location that the supplier uses to purchase the item.
  • Value that uniquely identifies the supplier site.
  • Supporting Documents for Contract Terms
    Title: Supporting Documents for Contract Terms
    Details of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
  • Template Usages
    Title: Template Usages
    The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
  • Maximum Length: 1
    Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order.
  • 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.
  • 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.
  • Maximum Length: 1
    Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders.
  • Maximum Length: 1
    Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders.
  • Read Only: true
    Value that uniquely identifies the current version of the purchase agreement.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Business Unit Accesses
Type: array
Title: Business Unit Accesses
Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services.
Show Source
Nested Schema : Contract Documents for Contract Terms
Type: array
Title: Contract Documents for Contract Terms
Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Purchase Agreement Lines
Type: array
Title: Purchase Agreement Lines
Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops.
Show Source
Nested Schema : Notification Controls
Type: array
Title: Notification Controls
Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released.
Show Source
Nested Schema : Supporting Documents for Contract Terms
Type: array
Title: Supporting Documents for Contract Terms
Details of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.
Show Source
Nested Schema : Template Usages
Type: array
Title: Template Usages
The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001.
Show Source
Nested Schema : draftPurchaseAgreements-attachments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-businessUnitAccess-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-contractDocuments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Item Attributes
Type: array
Title: Item Attributes
Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television.
Show Source
Nested Schema : Price Breaks
Type: array
Title: Price Breaks
Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location.
Show Source
Nested Schema : draftPurchaseAgreements-lines-attachments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-itemAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the agreement line.
  • Maximum Length: 700
    Alternate identifier for an item specified on a blanket purchase agreement line.
  • Maximum Length: 700
    URL of the attachment associated with the item.
  • Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
  • Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
  • Maximum Length: 700
    Status of the item availability from supplier.
  • Maximum Length: 700
    Additional comments for the item specified on the blanket purchase agreement line.
  • Read Only: true
    Maximum Length: 64
    User who created the item attributes for a purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application created the item attributes for a purchase agreement line.
  • DFF
  • Read Only: true
    Maximum Length: 1
    Value that identifies if the row is new or changed.
  • Title: Hazard Class
    Read Only: true
    Maximum Length: 40
    Name of the hazard class.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the hazard class.
  • Read Only: true
    Value that uniquely identifies the hazard class.
  • Maximum Length: 700
    URL of the image file associated with the item specified on a blanket purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application last updated the item attributes on a purchase agreement line.
  • Read Only: true
    Maximum Length: 64
    User who last updated the item attributes on a purchase agreement line.
  • Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.
  • Links
  • Maximum Length: 4000
    Text describing the long description of the item specified on a blanket purchase agreement line.
  • Maximum Length: 700
    Name of the manufacturer of the item specified on a blanket purchase agreement line.
  • 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.
  • Maximum Length: 700
    URL of the manufacturer of the item specified on a blanket purchase agreement line.
  • Maximum Length: 240
    String that describes how the item is packed by the supplier.
  • 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.
  • Read Only: true
    Maximum Length: 255
    Supplier item auxiliary identifier for the blanket agreement line.
  • Maximum Length: 700
    URL of the supplier's organization.
  • Maximum Length: 700
    Location of the small version of a larger image file for the item specified on the blanket purchase agreement.
  • Title: UN Number
    Read Only: true
    Maximum Length: 20
    Number that the United Nations uses to identify hazardous material.
  • Title: UN Number Description
    Read Only: true
    Maximum Length: 240
    Description of the hazardous material that the United Nations identification number references.
  • Read Only: true
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Maximum Length: 700
    The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : draftPurchaseAgreements-lines-itemAttributes-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-attachments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-notificationControls-item-response
Type: object
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : draftPurchaseAgreements-notificationControls-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-supportingDocuments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-templateUsages-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : draftPurchaseAgreements-templateUsages-ContractFormAttachment-item-response
Type: object
Show Source
Links
suggestCategory
Return a single best-fit category to the user.
Back to Top

Examples

This example describes how to get all draft purchase agreements.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

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

For example:

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

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items":  [
                  {
                      "AgreementHeaderId":  422015,
                      "AgreementNumber":  "1000501",
                      "ProcurementBUId":  204,
                      "ProcurementBU":  "Vision Operations",
                      "BuyerId":  100010026863783,
                      "Buyer":  "Furey,Clare",
                      "BuyerFullName":  "Clare Furey",
                      "DocumentStyleId":  1,
                      "DocumentStyle":  "Contract Purchase Agreement",
                      "StatusCode":  "OPEN",
                      "Status":  "Open",
                      "SupplierId":  559,
                      "Supplier":  "CV_SuppA02",
                      "SupplierPartyId":  12507,
                      "SupplierSiteId":  5058,
                      "SupplierSite":  "CVSuppA02Site01",
                      "SupplierContactId":  100000011552368,
                      "SupplierContact":  "Bibb, Carl",
                      "SupplierContactFullName":  "Carl Bibb",
                      "SupplierCommunicationMethodCode":  "NONE",
                      "SupplierEmailAddress":  null,
                      "SupplierFax":  null,
                      "StartDate":  null,
                      "EndDate":  null,
                      "AgreementAmount":  100,
                      "CurrencyCode":  "USD",
                      "Currency":  "US Dollar",
                      "AmountLimit":  100,
                      "MinimumReleaseAmount":  null,
                      "Description":  null,
                      "DocumentTypeCode":  "CONTRACT",
                      "MasterContractId":  null,
                      "MasterContractNumber":  null,
                      "SupplierAgreement":  null,
                      "ReferenceNumber":  null,
                      "RequiredAcknowledgmentCode":  "N",
                      "RequiredAcknowledgment":  "None",
                      "AcknowledgmentDueDate":  null,
                      "AcknowledgmentWithinDays":  null,
                      "PaymentTermsId":  10003,
                      "PaymentTerms":  "45 Net (terms date + 45)",
                      "CarrierId":  null,
                      "Carrier":  null,
                      "ModeOfTransportCode":  null,
                      "ModeOfTransport":  null,
                      "ServiceLevelCode":  null,
                      "ServiceLevel":  null,
                      "FreightTermsCode":  "Due",
                      "FreightTerms":  "Due",
                      "FOBCode":  "Origin",
                      "FOB":  "Origin",
                      "RequiresSignatureFlag":  false,
                      "BuyerManagedTransportFlag":  false,
                      "PayOnReceiptFlag":  null,
                      "ConfirmingOrderFlag":  false,
                      "ConsumptionAdviceFrequencyCode":  null,
                      "ConsumptionAdviceFrequency":  null,
                      "ConsumptionAdviceSummaryCode":  null,
                      "ConsumptionAdviceSummary":  null,
                      "AgingOnsetPointCode":  null,
                      "AgingOnsetPoint":  null,
                      "AgingPeriodDays":  null,
                      "NoteToReceiver":  null,
                      "NoteToSupplier":  null,
                      "AutomaticallyGenerateOrdersFlag":  true,
                      "AutomaticallySubmitForApprovalFlag":  true,
                      "GroupRequisitionsFlag":  false,
                      "UseCustomerSalesOrderFlag":  null,
                      "UseShipToLocationFlag":  false,
                      "GroupRequisitionLinesFlag":  false,
                      "UseRequestedDateFlag":  false,
                      "UseShipToOrganizationAndLocationFlag":  false,
                      "AllowUnassignedSitesFlag":  false,
                      "EnableRetroactivePricingFlag":  false,
                      "InitiateRetroactivePricingUponApprovalFlag":  null,
                      "RepriceOpenOrdersFlag":  null,
                      "CommunicateRepricedOrdersFlag":  null,
                      "PunchoutRequestsOnlyFlag":  null,
                      "UseOrderDateForOrderPricingFlag":  false,
                      "Priority":  null,
                      "ChecklistId":  null,
                      "Checklist":  null,
                      "ChecklistNumber":  null,
                      "CreationDate":  "2010-08-02T03:49:08+00:00",
                      "CreatedBy":  "DD7A1614BBFAA0F0A4511ACD96D2C88D",
                      "LastUpdateDate":  "2014-07-02T16:49:58.697+00:00",
                      "LastUpdatedBy":  "po_txn_upg_sold_to_le_transition.sql",
                      "PayOnUseFlag":  false,
                      "DefaultConsignmentLineFlag":  false,
                      "BillingCycleClosingDate":  null,
                      "ChangeOrderNumber":  null,
                      "ChangeOrderSequence":  null,
                      "VersionId":  null,
                      "ChangeOrderStatusCode":  null,
                      "EntityChangeTypeCode":  null,
                      "DocumentCreationMethod":  "COPY_DOCUMENT",
                      "AutoSourcingFlag":  true,
                      "IdentificationKey":  "PA_422015_100000019392072_4",
                      "CancelDocumentFlag":  null,
                      "ScheduleGroup":  null,
                      "ContractTermsExists":  "N",
                      "PriceUpdateTolerance":  null,
                      "NegotiationId":  null,
                      "Negotiation":  null,
                      "ConfiguredItemFlag":  false,
                      "OutsideProcessingFlag":  false,
                      "ConsignedItemsFlag":  false,
                      "PriceBreaksFlag":  true,
                      "NoteToAuthorizer":  null,
                      "LatestIdentificationKey":  "PA_422015_100000019392072_0",
                      "ScheduleGroupMeaning":  null,
                      "ChangeOrderTypeCode":  null,
                      "ChangeRequestedBy":  null,
                      "ChangeOrderInitiatingParty":  null,
                      "ChangeOrderDescription":  null,
                      "ChangeOrderStatus":  null,
                      "ChangeOrderType":  null,
                      "ChangeOrderCreationDate":  null,
                      "ReleasedAmount":  null,
                      "ChangeOrderInitiatorRole":  null,
                      "OkcContractNumber":  null,
                      "OkcContractId":  null,
                      "SupplierPayOnUseFlag":  null,
                      "DocumentType":  "Contract Purchase Agreement",
                      "BuyerEmail":  null,
                      "ShippingMethod":  null,
                      "MasterContractTypeId":  null,
                      "MasterContractType":  null,
                      "ChangeOrderInitiatorId":  null,
                      "links":  [
                                    {
                                        "rel":  "self",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015",
                                        "name":  "draftPurchaseAgreements",
                                        "kind":  "item",
                                        "properties":  {
                                                           "changeIndicator":  "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
                                                       }
                                    },
                                    {
                                        "rel":  "canonical",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015",
                                        "name":  "draftPurchaseAgreements",
                                        "kind":  "item"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/DFF",
                                        "name":  "DFF",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/attachments",
                                        "name":  "attachments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/businessUnitAccess",
                                        "name":  "businessUnitAccess",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/contractDocuments",
                                        "name":  "contractDocuments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/lines",
                                        "name":  "lines",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/notificationControls",
                                        "name":  "notificationControls",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/supportingDocuments",
                                        "name":  "supportingDocuments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/child/templateUsages",
                                        "name":  "templateUsages",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/viewPDF",
                                        "name":  "viewPDF",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/validateDocument",
                                        "name":  "validateDocument",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/removeContractTerms",
                                        "name":  "removeContractTerms",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/viewMasterContract",
                                        "name":  "viewMasterContract",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/downloadLinesResources",
                                        "name":  "downloadLinesResources",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/submit",
                                        "name":  "submit",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/eSign",
                                        "name":  "eSign",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/addContractTerms",
                                        "name":  "addContractTerms",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/withdraw",
                                        "name":  "withdraw",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/applyLatestTemplate",
                                        "name":  "applyLatestTemplate",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/changeContractSource",
                                        "name":  "changeContractSource",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/cancelChangeOrder",
                                        "name":  "cancelChangeOrder",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/deleteChangeOrder",
                                        "name":  "deleteChangeOrder",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/422015/action/transferAuthoring",
                                        "name":  "transferAuthoring",
                                        "kind":  "other"
                                    }
                                ]
                  },
                  {
                      "AgreementHeaderId":  423616,
                      "AgreementNumber":  "1001383",
                      "ProcurementBUId":  204,
                      "ProcurementBU":  "Vision Operations",
                      "BuyerId":  100010026863855,
                      "Buyer":  "Quam,Ericka",
                      "BuyerFullName":  "Ericka Quam",
                      "DocumentStyleId":  1,
                      "DocumentStyle":  "Blanket Purchase Agreement",
                      "StatusCode":  "OPEN",
                      "Status":  "Open",
                      "SupplierId":  1717,
                      "Supplier":  "CV_SuppA05",
                      "SupplierPartyId":  37816,
                      "SupplierSiteId":  4060,
                      "SupplierSite":  "CVSuppA05Site01",
                      "SupplierContactId":  null,
                      "SupplierContact":  null,
                      "SupplierContactFullName":  null,
                      "SupplierCommunicationMethodCode":  "PRINT",
                      "SupplierEmailAddress":  null,
                      "SupplierFax":  null,
                      "StartDate":  null,
                      "EndDate":  null,
                      "AgreementAmount":  null,
                      "CurrencyCode":  "USD",
                      "Currency":  "US Dollar",
                      "AmountLimit":  null,
                      "MinimumReleaseAmount":  null,
                      "Description":  "PORUPGCAT10-BPA created for upgrade testing-Please do not use it for any other testing",
                      "DocumentTypeCode":  "BLANKET",
                      "MasterContractId":  null,
                      "MasterContractNumber":  null,
                      "SupplierAgreement":  null,
                      "ReferenceNumber":  null,
                      "RequiredAcknowledgmentCode":  "N",
                      "RequiredAcknowledgment":  "None",
                      "AcknowledgmentDueDate":  null,
                      "AcknowledgmentWithinDays":  null,
                      "PaymentTermsId":  10003,
                      "PaymentTerms":  "45 Net (terms date + 45)",
                      "CarrierId":  12519,
                      "Carrier":  "Airborne",
                      "ModeOfTransportCode":  null,
                      "ModeOfTransport":  null,
                      "ServiceLevelCode":  null,
                      "ServiceLevel":  null,
                      "FreightTermsCode":  "Due",
                      "FreightTerms":  "Due",
                      "FOBCode":  "Origin",
                      "FOB":  "Origin",
                      "RequiresSignatureFlag":  false,
                      "BuyerManagedTransportFlag":  false,
                      "PayOnReceiptFlag":  false,
                      "ConfirmingOrderFlag":  false,
                      "ConsumptionAdviceFrequencyCode":  null,
                      "ConsumptionAdviceFrequency":  null,
                      "ConsumptionAdviceSummaryCode":  null,
                      "ConsumptionAdviceSummary":  null,
                      "AgingOnsetPointCode":  null,
                      "AgingOnsetPoint":  null,
                      "AgingPeriodDays":  null,
                      "NoteToReceiver":  null,
                      "NoteToSupplier":  null,
                      "AutomaticallyGenerateOrdersFlag":  true,
                      "AutomaticallySubmitForApprovalFlag":  true,
                      "GroupRequisitionsFlag":  false,
                      "UseCustomerSalesOrderFlag":  null,
                      "UseShipToLocationFlag":  false,
                      "GroupRequisitionLinesFlag":  false,
                      "UseRequestedDateFlag":  false,
                      "UseShipToOrganizationAndLocationFlag":  false,
                      "AllowUnassignedSitesFlag":  false,
                      "EnableRetroactivePricingFlag":  false,
                      "InitiateRetroactivePricingUponApprovalFlag":  false,
                      "RepriceOpenOrdersFlag":  false,
                      "CommunicateRepricedOrdersFlag":  false,
                      "PunchoutRequestsOnlyFlag":  null,
                      "UseOrderDateForOrderPricingFlag":  false,
                      "Priority":  null,
                      "ChecklistId":  null,
                      "Checklist":  null,
                      "ChecklistNumber":  null,
                      "CreationDate":  "2012-08-30T04:19:34+00:00",
                      "CreatedBy":  "CVBUYER10",
                      "LastUpdateDate":  "2014-07-02T16:49:58.697+00:00",
                      "LastUpdatedBy":  "po_txn_upg_sold_to_le_transition.sql",
                      "PayOnUseFlag":  false,
                      "DefaultConsignmentLineFlag":  false,
                      "BillingCycleClosingDate":  null,
                      "ChangeOrderNumber":  null,
                      "ChangeOrderSequence":  null,
                      "VersionId":  null,
                      "ChangeOrderStatusCode":  null,
                      "EntityChangeTypeCode":  null,
                      "DocumentCreationMethod":  "COPY_DOCUMENT",
                      "AutoSourcingFlag":  true,
                      "IdentificationKey":  "PA_423616_300100012365190_6",
                      "CancelDocumentFlag":  null,
                      "ScheduleGroup":  null,
                      "ContractTermsExists":  "N",
                      "PriceUpdateTolerance":  null,
                      "NegotiationId":  null,
                      "Negotiation":  null,
                      "ConfiguredItemFlag":  false,
                      "OutsideProcessingFlag":  false,
                      "ConsignedItemsFlag":  false,
                      "PriceBreaksFlag":  true,
                      "NoteToAuthorizer":  null,
                      "LatestIdentificationKey":  "PA_423616_300100012365190_0",
                      "ScheduleGroupMeaning":  null,
                      "ChangeOrderTypeCode":  null,
                      "ChangeRequestedBy":  null,
                      "ChangeOrderInitiatingParty":  null,
                      "ChangeOrderDescription":  null,
                      "ChangeOrderStatus":  null,
                      "ChangeOrderType":  null,
                      "ChangeOrderCreationDate":  null,
                      "ReleasedAmount":  null,
                      "ChangeOrderInitiatorRole":  null,
                      "OkcContractNumber":  null,
                      "OkcContractId":  null,
                      "SupplierPayOnUseFlag":  null,
                      "DocumentType":  "Blanket Purchase Agreement",
                      "BuyerEmail":  "sendmail-test-discard@oracle.com",
                      "ShippingMethod":  "Airborne",
                      "MasterContractTypeId":  null,
                      "MasterContractType":  null,
                      "ChangeOrderInitiatorId":  null,
                      "links":  [
                                    {
                                        "rel":  "self",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616",
                                        "name":  "draftPurchaseAgreements",
                                        "kind":  "item",
                                        "properties":  {
                                                           "changeIndicator":  "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001078"
                                                       }
                                    },
                                    {
                                        "rel":  "canonical",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616",
                                        "name":  "draftPurchaseAgreements",
                                        "kind":  "item"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/DFF",
                                        "name":  "DFF",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/attachments",
                                        "name":  "attachments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/businessUnitAccess",
                                        "name":  "businessUnitAccess",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/contractDocuments",
                                        "name":  "contractDocuments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/lines",
                                        "name":  "lines",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/notificationControls",
                                        "name":  "notificationControls",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/supportingDocuments",
                                        "name":  "supportingDocuments",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "child",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/child/templateUsages",
                                        "name":  "templateUsages",
                                        "kind":  "collection"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/viewPDF",
                                        "name":  "viewPDF",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/validateDocument",
                                        "name":  "validateDocument",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/removeContractTerms",
                                        "name":  "removeContractTerms",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/viewMasterContract",
                                        "name":  "viewMasterContract",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/downloadLinesResources",
                                        "name":  "downloadLinesResources",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/submit",
                                        "name":  "submit",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/eSign",
                                        "name":  "eSign",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/addContractTerms",
                                        "name":  "addContractTerms",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/withdraw",
                                        "name":  "withdraw",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/applyLatestTemplate",
                                        "name":  "applyLatestTemplate",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/changeContractSource",
                                        "name":  "changeContractSource",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/cancelChangeOrder",
                                        "name":  "cancelChangeOrder",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/deleteChangeOrder",
                                        "name":  "deleteChangeOrder",
                                        "kind":  "other"
                                    },
                                    {
                                        "rel":  "action",
                                        "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/423616/action/transferAuthoring",
                                        "name":  "transferAuthoring",
                                        "kind":  "other"
                                    }
                                ]
                  }
              ],
    "count":  2,
    "hasMore":  true,
    "limit":  2,
    "offset":  0,
    "links":  [
                  {
                      "rel":  "self",
                      "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements",
                      "name":  "draftPurchaseAgreements",
                      "kind":  "collection"
                  },
                  {
                      "rel":  "action",
                      "href":  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/action/suggestCategory",
                      "name":  "suggestCategory",
                      "kind":  "other"
                  }
              ]
}
Back to Top