Jump to

• Request
• Response

Get all agreements

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreementsInSupplierPortal

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 procurement business unit.
  • AmountLimit; number; Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
  • 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.
  • 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.
  • 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
  • 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.
  • NoteToAuthorizer; string; Text comments to the approver, included as needed when submitting a document for approval.
  • 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.
  • 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.
  • 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.
  • 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.
  • ScheduleGroup; string; Priority that determines how quickly to transport the item.
  • 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.
• 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: string
  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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : purchaseAgreementsInSupplierPortal

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-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 : purchaseAgreementsInSupplierPortal-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 procurement business unit.
• 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.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• AutoSourcingFlag: boolean
  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.
• BillingCycleClosingDate: string (date)
  Title: Billing Cycle Closing Date

  Read Only: true

  Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.
• Buyer: string
  Title: Buyer

  Read Only: true

  Maximum Length: 240

  Person who's responsible for managing the purchase agreement.
• BuyerFullName: string
  Title: Buyer

  Read Only: true

  Maximum Length: 240

  Person who's responsible for managing the purchase order.
• 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.
• ConfigurationOrderingEnabledFlag: boolean
  Title: Configuration Ordering Enabled

  Read Only: true

  Maximum Length: 1

  Indicates if the document style is enabled for ordering a configuration item.
• 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.
• ConsignmentTermsFlag: boolean
  Title: Consignment Terms Enabled

  Read Only: true

  Maximum Length: 1

  Indicates if the document style is enabled for consignment terms.
• 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.
• contractDocuments: array 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.
• 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.
• DefaultConsignmentLinesFlag: boolean
  Title: Default line as consignment line

  Read Only: true

  Maximum Length: 1

  Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default.
• Description: string
  Title: Agreement Description

  Read Only: true

  Maximum Length: 240

  Description for the line item.
• DFF: array DFF
• 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.
• DocumentStyleAllowedForGoodsFlag: boolean
  Read Only: true

  Indicates whether specific or all purchasing document line types are enabled for the document style.
• 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.
• 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
• FrozenFlag: boolean
  Title: Frozen

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the purchase order is frozen and modifications aren't allowed. If false, then the purchase order isn't frozen.
• LastBilledDate: string (date)
  Title: Last Billing Date

  Read Only: true

  Date when the consumption transaction on the agreement was last billed.
• 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.
• lifecycleDetails: array Purchase Agreement Line Lifecycle Details
  Title: Purchase Agreement Line Lifecycle Details

  A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the 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.
• Negotiation: string
  Title: Negotiation

  Read Only: true

  Maximum Length: 255

  Number that uniquely identifies the negotiation that the purchase order line references.
• NegotiationId: integer
  Read Only: true

  Value that uniquely identifies the negotiation that the purchase order line references.
• NoteToAuthorizer: string
  Title: Note to Approver

  Read Only: true

  Maximum Length: 1000

  Text comments to the approver, included as needed when submitting a document for approval.
• NoteToSupplier: string
  Title: Note to Supplier

  Read Only: true

  Maximum Length: 1000

  Value that uniquely identifies a note to supplier.
• 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.
• PayOnUseFlag: boolean
  Title: Pay on use

  Read Only: true

  Maximum Length: 1

  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.
• PriceUpdateTolerance: number
  Title: Price Update Tolerance Percent

  Read Only: true

  Price Update Tolerance Percent
• 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.
• ProgressPaymentFlag: boolean
  Title: Progress Payments Enabled

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the progress payment is enabled for this document style. If false, then the progress payment isn't enabled for this document style. 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.
• 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.
• ScheduleGroup: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Priority that determines how quickly to transport the item.
• 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.
• SupplierCommunicationMethod: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the supplier communication method.
• 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.
• SupplierContactDisplayName: string
  Title: Supplier Contact

  Read Only: true

  Maximum Length: 360

  Display name of the 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.
• templateUsages: array Template Applied to Business Documents
  Title: Template Applied to Business Documents

  The relationship between the contract template and the business document in which it's used. For example, contract template Subcontracting Terms and Conditions is used in purchase order 11001.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "AgreementAmount":{
            "title":"Agreement Amount",
            "type":"number",
            "description":"Value that identifies the amount agreed for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementNumber":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the procurement business unit.",
            "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
        },
        "AutoSourcingFlag":{
            "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":false
        },
        "BillingCycleClosingDate":{
            "title":"Billing Cycle Closing Date",
            "type":"string",
            "description":"Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":240,
            "type":"string",
            "description":"Person who's responsible for managing the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerFullName":{
            "title":"Buyer",
            "maxLength":240,
            "type":"string",
            "description":"Person who's responsible for managing the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "Carrier":{
            "title":"Carrier",
            "maxLength":360,
            "type":"string",
            "description":"Company that transports the item.",
            "nullable":false,
            "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
        },
        "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
        },
        "ClosedDate":{
            "title":"Closed Date",
            "type":"string",
            "description":"Date when the order was closed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigurationOrderingEnabledFlag":{
            "title":"Configuration Ordering Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the document style is enabled for ordering a configuration item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "ConsignmentTermsFlag":{
            "title":"Consignment Terms Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the document style is enabled for consignment terms.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"Conversion rate to use when converting the currency.",
            "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the purchase agreement.",
            "nullable":false,
            "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
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the purchase agreement.",
            "nullable":false,
            "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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DefaultConsignmentLinesFlag":{
            "title":"Default line as consignment line",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Agreement Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for the line item.",
            "nullable":true,
            "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
        },
        "DocumentStyleAllowedForGoodsFlag":{
            "type":"boolean",
            "description":"Indicates whether specific or all purchasing document line types are enabled for the document style.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "FrozenFlag":{
            "title":"Frozen",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the purchase order is frozen and modifications aren't allowed. If false, then the purchase order isn't frozen.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastBilledDate":{
            "title":"Last Billing Date",
            "type":"string",
            "description":"Date when the consumption transaction on the agreement was last billed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated 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
        },
        "MasterContractNumber":{
            "title":"Master Contract",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the contract from enterprise contracts.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "MasterContractTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master contract type.",
            "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
        },
        "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
        },
        "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
        },
        "Negotiation":{
            "title":"Negotiation",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the negotiation that the purchase order line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NegotiationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation that the purchase order line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteToAuthorizer":{
            "title":"Note to Approver",
            "maxLength":1000,
            "type":"string",
            "description":"Text comments to the approver, included as needed when submitting a document for approval.",
            "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
        },
        "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
        },
        "PayOnUseFlag":{
            "title":"Pay on use",
            "maxLength":1,
            "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":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "PaymentTermsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment terms.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceUpdateTolerance":{
            "title":"Price Update Tolerance Percent",
            "type":"number",
            "description":"Price Update Tolerance Percent",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "ProgressPaymentFlag":{
            "title":"Progress Payments Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the progress payment is enabled for this document style. If false, then the progress payment isn't enabled for this document style. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":120,
            "type":"string",
            "description":"Number used for EDI transaction audit trail reference.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "RevisionNumber":{
            "title":"Agreement Revision",
            "type":"number",
            "description":"Value that uniquely identifies the document revision number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleGroup":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Priority that determines how quickly to transport the item.",
            "nullable":false,
            "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
        },
        "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
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the agreement becomes effective.",
            "format":"date",
            "nullable":true,
            "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
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":25,
            "type":"string",
            "description":"Value that identifies the header status.",
            "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
        },
        "SupplierAgreement":{
            "title":"Supplier Agreement",
            "maxLength":25,
            "type":"string",
            "description":"Number that indicates the supplier document number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierCommunicationMethod":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the supplier communication method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierCommunicationMethodCode":{
            "title":"Communication Method",
            "maxLength":25,
            "type":"string",
            "description":"Code that identifies the supplier communication method.",
            "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
        },
        "SupplierContactDisplayName":{
            "title":"Supplier Contact",
            "maxLength":360,
            "type":"string",
            "description":"Display name of the person who represents the supplier when communicating with the buyer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-attachments-item-response"
            }
        },
        "contractDocuments":{
            "title":"Supporting Documents for Contract Terms",
            "type":"array",
            "description":"Details of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-contractDocuments-item-response"
            }
        },
        "lifecycleDetails":{
            "title":"Purchase Agreement Line Lifecycle Details",
            "type":"array",
            "description":"A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lifecycleDetails-item-response"
            },
            "x-cardinality":"1"
        },
        "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/purchaseAgreementsInSupplierPortal-lines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "templateUsages":{
            "title":"Template Applied to Business Documents",
            "type":"array",
            "description":"The relationship between the contract template and the business document in which it's used. For example, contract template Subcontracting Terms and Conditions is used in purchase order 11001.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-templateUsages-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-attachments-item-response

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

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

• Array of: object purchaseAgreementsInSupplierPortal-contractDocuments-item-response

{
    "title":"Supporting Documents for Contract Terms",
    "type":"array",
    "description":"Details of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-contractDocuments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-DFF-item-response

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

Nested Schema : Purchase Agreement Line Lifecycle Details

Type: array

Title: Purchase Agreement Line Lifecycle Details

A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-lifecycleDetails-item-response

{
    "title":"Purchase Agreement Line Lifecycle Details",
    "type":"array",
    "description":"A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lifecycleDetails-item-response"
    },
    "x-cardinality":"1"
}

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 purchaseAgreementsInSupplierPortal-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/purchaseAgreementsInSupplierPortal-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 : Template Applied to Business Documents

Type: array

Title: Template Applied to Business Documents

The relationship between the contract template and the business document in which it's used. For example, contract template Subcontracting Terms and Conditions is used in purchase order 11001.

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-templateUsages-item-response

{
    "title":"Template Applied to Business Documents",
    "type":"array",
    "description":"The relationship between the contract template and the business document in which it's used. For example, contract template Subcontracting Terms and Conditions is used in purchase order 11001.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-templateUsages-item-response"
    }
}

Nested Schema : purchaseAgreementsInSupplierPortal-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

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

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : purchaseAgreementsInSupplierPortal-contractDocuments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Asynchronous tracker ID of the supporting document.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the supporting document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Code for the category to which the supporting document is assigned.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates if the supporting document is shared in the content repository.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  Code that identifies if the supporting document is a file or a URL.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the supporting document.
• DmDocumentId: string
  Maximum Length: 255

  Document identifier of the supporting document in the content server.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path of the folder for the supporting document in the content server.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the supporting document in the content server.
• DownloadInfo: string
  Title: DownloadInfo

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

  Error status code for the supporting document.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message for the supporting document.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the supporting document.
• FileContents: string (byte)
  Title: File Contents

  File contents of the supporting document.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the supporting document. A file name or URL is required.
• FileUrl: string
  Title: File Url

  URL location of the supporting document.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Name of the user who last updated the record.
• links: array Links
  Title: Links

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

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

  Title of the supporting document.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Uploaded file content type of the supporting document.
• UploadedFileLength: integer
  Title: File Size

  Uploaded file length of the supporting document.
• UploadedFileName: string
  Title: Uploaded File Name

  Uploaded file name of the supporting document.
• UploadedText: string
  Title: Uploaded Text

  Uploaded text of the supporting document.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the supporting document.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the supporting document.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Name of the category to which the supporting document is assigned.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseAgreementsInSupplierPortal-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Read Only: true

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PoHeaderId: integer (int64)
  Read Only: true

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseAgreementsInSupplierPortal-lifecycleDetails-item-response

Type: object

Show Source

• AgreedAmount: number
  Value that identifies the amount agreed upon for a purchase agreement.
• AgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• AgreementNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement in the procurement business unit.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

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

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

  Value that identifies the amount invoiced for a purchase agreement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderedAmount: number
  Read Only: true

  Value that identifies the amount released for a purchase agreement.
• PurchaseOrdersCreated: integer
  Read Only: true

  Number of purchase orders created by referencing the agreement.
• ReceivedAmount: number
  Read Only: true

  Value that identifies the amount received for a purchase agreement.

{
    "type":"object",
    "properties":{
        "AgreedAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed upon for a purchase agreement.",
            "nullable":true,
            "x-queryable":false
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the procurement business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Value that identifies the amount delivered for a purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"Value that identifies the amount invoiced for a purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderedAmount":{
            "type":"number",
            "description":"Value that identifies the amount released for a purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrdersCreated":{
            "type":"integer",
            "description":"Number of purchase orders created by referencing the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceivedAmount":{
            "type":"number",
            "description":"Value that identifies the amount received for a 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"
            }
        }
    }
}

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 : purchaseAgreementsInSupplierPortal-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 procurement business unit.
• 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.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• 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.
• DFF: array DFF
• 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.
• lifecycleDetails: array Purchase Agreement Line Lifecycle Details
  Title: Purchase Agreement Line Lifecycle Details

  A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.
• LineNumber: number
  Title: Line

  Read Only: true

  Value that uniquely identifies the purchase order or agreement line.
• LineStartDate: string (date)
  Title: Line Start Date

  Read Only: true

  Date after which the agreement line becomes effective.
• 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.
• NoteToSupplier: string
  Title: Note to Supplier

  Read Only: true

  Maximum Length: 1000

  Value that uniquely identifies a note to supplier.
• ParentItem: string
  Title: Parent Item

  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the parent option class or model for the item.
• 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.
• PriceBreakType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Value that identifies the pricing scheme for the price breaks of this line.
• 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.
• PurchaseBasis: string
  Title: Purchase Basis

  Read Only: true

  Maximum Length: 30

  Value that indicates whether the line is for goods or services.
• 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.
• TopModel: string
  Title: Top Model

  Read Only: true

  Maximum Length: 255

  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: UN Number 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":{
        "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
        },
        "AgreementAmount":{
            "title":"Agreement Amount",
            "type":"number",
            "description":"Value that identifies the amount agreed for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementLineId":{
            "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
        },
        "AgreementNumber":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement in the procurement business unit.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "Category":{
            "maxLength":2400,
            "type":"string",
            "description":"Value that uniquely identifies the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category.",
            "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the purchase agreement line.",
            "nullable":false,
            "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
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Description":{
            "title":"Line Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for the line item.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "HazardClass":{
            "title":"Hazard Class",
            "maxLength":40,
            "type":"string",
            "description":"Name of the hazard class.",
            "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
        },
        "HazardClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hazard class.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision number of the item.",
            "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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the purchase agreement line.",
            "nullable":false,
            "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
        },
        "LineStartDate":{
            "title":"Line Start Date",
            "type":"string",
            "description":"Date after which the agreement line becomes effective.",
            "format":"date",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ParentItem":{
            "title":"Parent Item",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the parent option class or model for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriceBreakType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the pricing scheme for the price breaks of this line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "ProcurementBU":{
            "maxLength":255,
            "type":"string",
            "description":"Business unit that manages and owns the purchase agreement.",
            "nullable":true,
            "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
        },
        "PurchaseBasis":{
            "title":"Purchase Basis",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates whether the line is for goods or services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of an agreement line.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "Supplier":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier who fulfills the item.",
            "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
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "description":"Value that identifies the supplier item number.",
            "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
        },
        "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
        },
        "SupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":true,
            "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
        },
        "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
        },
        "TopModel":{
            "title":"Top Model",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the top model associated with the option or option class, or submodel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "UNNumberDescription":{
            "title":"UN Number 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
        },
        "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
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":false,
            "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
        },
        "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
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-attachments-item-response"
            }
        },
        "itemAttributes":{
            "title":"Item Attributes",
            "type":"array",
            "description":"Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-itemAttributes-item-response"
            },
            "x-cardinality":"1"
        },
        "lifecycleDetails":{
            "title":"Purchase Agreement Line Lifecycle Details",
            "type":"array",
            "description":"A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-lifecycleDetails-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "priceBreaks":{
            "title":"Price Breaks",
            "type":"array",
            "description":"Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-priceBreaks-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : DFF

Type: array

Show Source

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

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

Nested Schema : Item Attributes

Type: array

Title: Item Attributes

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

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-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/purchaseAgreementsInSupplierPortal-lines-itemAttributes-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Purchase Agreement Line Lifecycle Details

Type: array

Title: Purchase Agreement Line Lifecycle Details

A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-lines-lifecycleDetails-item-response

{
    "title":"Purchase Agreement Line Lifecycle Details",
    "type":"array",
    "description":"A purchase agreement's complete procure-to-pay flow, which includes details of the purchase order amount released, and of the shipments and receipts created for the agreement.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-lifecycleDetails-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 purchaseAgreementsInSupplierPortal-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/purchaseAgreementsInSupplierPortal-lines-priceBreaks-item-response"
    }
}

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

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

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Read Only: true

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• links: array Links
  Title: Links

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseAgreementsInSupplierPortal-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.
• DFF: array DFF
• 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":{
        "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
        },
        "AttachmentURL":{
            "title":"Attachment URL",
            "maxLength":700,
            "type":"string",
            "description":"URL of the attachment associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttributeValuesId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValuesTlpId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Availability":{
            "title":"Availability",
            "maxLength":700,
            "type":"string",
            "description":"Status of the item availability from supplier.",
            "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
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the item attributes for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-itemAttributes-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the item attributes on a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the item attributes on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadTimeDays":{
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "SupplierURL":{
            "title":"Supplier URL",
            "maxLength":700,
            "type":"string",
            "description":"URL of the supplier's organization.",
            "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
        },
        "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"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 240

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseAgreementsInSupplierPortal-lines-lifecycleDetails-item-response

Type: object

Show Source

• AgreementAmount: number
  Read Only: true

  Value that identifies the amount agreed for a purchase agreement line.
• AgreementHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement.
• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase agreement line.
• AgreementQuantity: number
  Read Only: true

  Quantity agreed upon for an agreement line.
• AmountReleased: number
  Read Only: true

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

  Component Released Amount
• ComponentQuantityReleased: number
  Read Only: true

  Component Released Quantity
• DeliveredAmount: number
  Read Only: true

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

  Quantity delivered for an agreement line.
• InvoicedAmount: number
  Read Only: true

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

  Quantity invoiced for an agreement line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PurchaseOrdersCreated: number
  Read Only: true

  Number of purchase orders created by referencing the agreement line.
• ReceivedAmount: number
  Read Only: true

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

  Quantity received for an agreement line.
• ReleasedQuantity: number
  Read Only: true

  Quantity released for an agreement line.

{
    "type":"object",
    "properties":{
        "AgreementAmount":{
            "type":"number",
            "description":"Value that identifies the amount agreed for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AgreementQuantity":{
            "type":"number",
            "description":"Quantity agreed upon for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AmountReleased":{
            "type":"number",
            "description":"Value that identifies the amount released for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentAmountReleased":{
            "type":"number",
            "description":"Component Released Amount",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComponentQuantityReleased":{
            "type":"number",
            "description":"Component Released Quantity",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Value that identifies the amount delivered for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeliveredQuantity":{
            "type":"number",
            "description":"Quantity delivered for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"Value that identifies the amount invoiced for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InvoicedQuantity":{
            "type":"number",
            "description":"Quantity invoiced for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchaseOrdersCreated":{
            "type":"number",
            "description":"Number of purchase orders created by referencing the agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceivedAmount":{
            "type":"number",
            "description":"Value that identifies the amount received for a purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReceivedQuantity":{
            "type":"number",
            "description":"Quantity received for an agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReleasedQuantity":{
            "type":"number",
            "description":"Quantity released for an agreement line.",
            "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"
            }
        }
    }
}

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

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• 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.
• DFF: array DFF
• 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":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the price breaks for 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
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency on the agreement line price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-priceBreaks-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DiscountPercent":{
            "title":"Discount Percent",
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the price break was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Value that uniquely identifies the purchase order or agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Unit price for the line.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date on which the agreement becomes effective.",
            "format":"date",
            "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
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-lines-priceBreaks-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : DFF

Type: array

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

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

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Read Only: true

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

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

  The link relations associated with the resource instance.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseAgreementsInSupplierPortal-templateUsages-item-response

Type: object

Show Source

• AuthoringParty: string
  Maximum Length: 255

  Indicates which party was the author of the contract terms for the document.
• AuthoringPartyCode: string
  Title: Authoring Party

  Maximum Length: 30

  Code that indicates which party was the author of the contract terms for the document.
• AutogenDeviationsFlag: string
  Title: Generate for approval

  Maximum Length: 1

  Default Value: Y

  Indicates if deviations should be autogenerated for the business document.
• ContractExpertEnabled: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the contract expert feature can be used after the contract template is applied to a business document. Possible values are Y and N.
• ContractFormAttachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ContractSourceCode: string
  Title: Contract Source

  Maximum Length: 30

  Indicates the current source of the contract terms for the business document. Valid values are STRUCTURED and ATTACHED.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time of the creation of the record.
• Description: string
  Read Only: true

  Maximum Length: 2000

  Description of the contract template used in the business document.
• DocumentId: integer
  Unique identifier for the business document that's associated with a contract template.
• DocumentNumber: string
  Title: Document Number

  Maximum Length: 150

  Number of the business document that's associated with a contract template.
• DocumentType: string
  Title: Document Type

  Maximum Length: 30

  Code for the document type of the business document that's associated with a contract template.
• DocumentTypeName: string
  Title: Document Type

  Document type of the business document that's associated with a contract template.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Sign in of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Major version number of the contract template applied to a business document.
• SimpleContractText: string (byte)
  HTML content of the simple contract terms.
• SimpleContractYn: string
  Maximum Length: 1

  Indicates whether the contract is simple.
• SourceChangeAllowedFlag: string
  Maximum Length: 1

  Indicates if the contract source is allowed to be changed.
• SourceCode: string
  Read Only: true

  Maximum Length: 80

  Source of the template. Possible values are STRUCTURED and ATTACHED.
• TemplateId: number
  Title: Contract Terms Template

  Unique identifier for the contract template used in the business document.
• TemplateId1: integer (int64)
  Read Only: true

  Unique identifier for the contract template used in the business document.
• TemplateName: string
  Title: Current Contract Terms Template

  Read Only: true

  Maximum Length: 240

  Name of the contract template used in the business document.
• VersionType: string
  Maximum Length: 1

  Version type of the contract template. It can have the values Current, Amendment, or History.

{
    "type":"object",
    "properties":{
        "AuthoringParty":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates which party was the author of the contract terms for the document.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthoringPartyCode":{
            "title":"Authoring Party",
            "maxLength":30,
            "type":"string",
            "description":"Code that indicates which party was the author of the contract terms for the document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AutogenDeviationsFlag":{
            "title":"Generate for approval",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if deviations should be autogenerated for the business document.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "ContractExpertEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract expert feature can be used after the contract template is applied to a business document. Possible values are Y and N.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractFormAttachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-templateUsages-ContractFormAttachment-item-response"
            }
        },
        "ContractSourceCode":{
            "title":"Contract Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current source of the contract terms for the business document. Valid values are STRUCTURED and ATTACHED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time of the creation of the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the contract template used in the business document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Unique identifier for the business document that's associated with a contract template.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document Number",
            "maxLength":150,
            "type":"string",
            "description":"Number of the business document that's associated with a contract template.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentType":{
            "title":"Document Type",
            "maxLength":30,
            "type":"string",
            "description":"Code for the document type of the business document that's associated with a contract template.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentTypeName":{
            "title":"Document Type",
            "type":"string",
            "description":"Document type of the business document that's associated with a contract template.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Sign in of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Major version number of the contract template applied to a business document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimpleContractText":{
            "type":"string",
            "description":"HTML content of the simple contract terms.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SimpleContractYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the contract is simple.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceChangeAllowedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the contract source is allowed to be changed.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCode":{
            "maxLength":80,
            "type":"string",
            "description":"Source of the template. Possible values are STRUCTURED and ATTACHED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Contract Terms Template",
            "type":"number",
            "description":"Unique identifier for the contract template used in the business document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateId1":{
            "type":"integer",
            "description":"Unique identifier for the contract template used in the business document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Current Contract Terms Template",
            "maxLength":240,
            "type":"string",
            "description":"Name of the contract template used in the business document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":1,
            "type":"string",
            "description":"Version type of the contract template. It can have the values Current, Amendment, or History.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object purchaseAgreementsInSupplierPortal-templateUsages-ContractFormAttachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/purchaseAgreementsInSupplierPortal-templateUsages-ContractFormAttachment-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 : purchaseAgreementsInSupplierPortal-templateUsages-ContractFormAttachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

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

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

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

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top