Get all procurement business functions

get

/fscmRestApi/resources/11.13.18.05/procurementBusinessFunctions

Request

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

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

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

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds procurement business functions according to the procurement business unit identifier.
      Finder Variables
      • ProcurementBUId; integer; Unique identifier of the business unit for which the configuration is set up.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • 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; number; Value that identifies the maximum number of days the material may be on consignment.
    • AgreementLineActionType; string; Action type for agreement lines.
    • AgreementLineActionTypeName; string; Name of the action type for agreement lines.
    • AllowItemDescriptionUpdateFlag; boolean; Value that identifies whether item descriptions can be updated on document lines.
    • AllowManualPriceUpdateOnFulfilledOrdersFlag; boolean; Value that identifies whether you can manually update the price on fulfilled orders.
    • AutoGenerateOrdersForNegotiatedRequisitionLinesFlag; boolean; Value that indicates whether orders are automatically generated for negotiated requisition lines.
    • AutoGenerateStagedDocumentsFromRequisitionLinesFlag; boolean; Value that indicates whether staged documents are automatically generated from requisition lines.
    • AutoSourcingFlag; boolean; Enable automatic sourcing
    • AutomaticallyAddNewSupplierItemsToItemRelationshipsFlag; boolean; Indicates whether new supplier items are automatically added to item relationships. Contains one of the following values: true or false. If true, then new supplier items are automatically added to item relationships. If false, then new supplier items aren't automatically added to item relationships. This attribute doesn't have a default value.
    • AutomaticallyGenerateOrdersFlag; boolean; Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.
    • AutomaticallyPopulateResponsesToPredefinedQuestionsFlag; boolean; Value that controls set at the business unit level to default supplier responses from supplier qualification management response repository for predefined questions.
    • AutomaticallySubmitForApprovalFlag; boolean; Indicates whether the record is automatically submitted for approval. Contains one of the following values: true or false. If true, then the record is automatically submitted for approval. If false, then the record isn't automatically submitted for approval. This attribute doesn't have a default value.
    • Buyer; string; Buyer associated with the procurement business function.
    • BuyerId; integer; Unique identifier of the buyer.
    • BuyerManagedTransportFlag; boolean; Contains one of the following values: true or false. If true, then the buyer or an agent that the buyer designates must arrange transportation from picking up the requested item to delivering it to the ship-to location that the purchase order specifies. If false, then the supplier must arrange transportation. This attribute doesn't have a default value.
    • BypassApprovalsForAutomaticallySubmittedOrdersFlag; boolean; Indicates whether approvals are bypassed for automatically submitted orders. Contains one of the following values: true or false. If true, then the application bypasses approvals for automatically submitted orders. If false, then the application requires approvals for automatically submitted orders. This attribute doesn't have a default value.
    • Carrier; string; Company that transports the item.
    • CarrierId; integer; Unique identifier of the company that transports the item.
    • CommunicatePurchaseAgreementFlag; boolean; Contains one of the following values: true or false. If true, then purchase agreements will be communicated and acknowledged. If false, then purchase agreements won't be communicated and acknowledged. This attribute doesn't have a default value.
    • CommunicatepurchaseOrderChangesFlag; boolean; Indicates whether purchase order changes are communicated. Contains one of the following values: true or false. If true, then the application communicates purchase order changes. If false, then the application doesn't communicate purchase order changes. This attribute doesn't have a default value.
    • 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.
    • ConversionRateType; string; Code that identifies the currency conversion rate type.
    • ConversionRateTypeCode; string; Abbreviation that identifies the conversion rate type.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time of the creation of the record.
    • Currency; string; Name of the currency.
    • CurrencyCode; string; Code that identifies the currency.
    • DefaultPromisedDateFromRequestedDateFlag; boolean; Indicates whether the promised date defaults from the requested date. Contains one of the following values: true or false. If true, then the promised date defaults from the requested date. If false, then the promised date doesn't default from the requested date. This attribute doesn't have a default value.
    • DisplayBestPriceInBlindNegotiationsFlag; boolean; Indicates whether the best price appears in blind negotiations. Contains one of the following values: true or false. If true, then the best price appears in blind negotiations. If false, then the best price doesn't appear in blind negotiations. This attribute doesn't have a default value.
    • DisplayRankInBlindNegotiationsFlag; boolean; Indicates whether the business function is displayed in blind negotiations. Contains one of the following values: true or false. If true, then the business function is displayed in blind negotiations. If false, then the business function isn't displayed in blind negotiations. This attribute doesn't have a default value.
    • DisplayRequirementScoringCriteriaToSuppliersFlag; boolean; Indicates whether scoring criteria display to suppliers. Contains one of the following values: true or false. If true, then scoring criteria display to suppliers. If false, then scoring criteria don't display to suppliers. This attribute doesn't have a default value.
    • EmailAttachmentFilename; string; Email address of the attachment file.
    • EnableAwardApprovalFlag; boolean; Indicates whether award approval is enabled. Contains one of the following values: true or false. If true, then award approval is enabled. If false, then award approval isn't enabled. This attribute doesn't have a default value.
    • EnableNegotiationApprovalFlag; boolean; Indicates whether negotiation approval is enabled. Contains one of the following values: true or false. If true, then negotiation approval is enabled. If false, then negotiation approval isn't enabled. This attribute doesn't have a default value.
    • EnableWeightsInRequirementsFlag; boolean; Indicates whether weights are enabled in requirements. Contains one of the following values: true or false. If true, then you can use weights in requirements. If false, then you can't use weights in requirements. This attribute doesn't have a default value.
    • EnforceSupplierHoldFlag; boolean; Indicates whether supplier hold is enforced. Contains one of the following values: true or false. If true, then supplier hold is enforced. If false, then supplier hold isn't enforced. This attribute doesn't have a default value.
    • EnforceSuppliersPreviousRoundPriceAsStartPriceFlag; boolean; Indicates whether the supplier's previous round price is used as the start price. Contains one of the following values: true or false. If true, then the supplier's previous round price is used as the start price. If false, then the supplier's previous round price isn't used as the start price. This attribute doesn't have a default value.
    • FOB; string; Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
    • FOBCode; string; Code that identifies the type of free-on-board terms for the document.
    • FreightTerms; string; Terms that describe who pays charges to transport the item.
    • FreightTermsCode; string; Code that identifies the type of freight terms for the document.
    • GroupRequisitionLinesFlag; boolean; Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.
    • GroupRequisitionsFlag; boolean; Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order.
    • InitiateApprovalFlag; boolean; Contains one of the following values: true or false. If true, then default initiate approval for the purchasing documents created from negotiation award is required. If false, then initiate approval isn't required. This attribute doesn't have a default value.
    • InspectionRequiredFlag; boolean; Code that identifies the tax classification on the schedule.
    • InventoryOrganization; string; Name of the inventory organization of the procurement business unit.
    • InventoryOrganizationId; integer; Unique identifier of the inventory organization.
    • InviteOnlySourcingEligibleSuppliersFlag; boolean; Indicates whether only eligible suppliers can be invited to sourcing events. Contains one of the following values: true or false. If true, then only eligible suppliers can be invited to sourcing events. If false, then suppliers can be invited regardless of eligibility. This attribute doesn't have a default value.
    • InvoiceCloseTolerancePercent; number; Value that identifies the default invoice close tolerance percent for business unit.
    • Language; string; Language used for the procurement business function.
    • LanguageCode; string; Language code for the procurement business function.
    • LastUpdateDate; string; Date and time the procurement business function was last updated.
    • LastUpdatedBy; string; User who last updated the procurement business function.
    • LineType; string; Line type on purchasing documents.
    • LineTypeId; integer; Indicates whether the line type references an item or a service.
    • MaximumFileSizeMegabytes; number; The maximum file size, in megabytes, allowed for a file-type attachment to an e-mailed purchasing document.
    • MaximumRequirementScore; number; Maximum score that a requirement can have.
    • MinimumReleaseAmount; number; Value that identifies the minimum amount that can be released against a purchase agreement.
    • 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.
    • NegotiationStyle; string; Name of the negotiation style.
    • NegotiationStyleId; integer; Unique identifier of the negotiation style.
    • NegotiationTemplateRequiredFlag; boolean; Indicates whether template selection is required for negotiation creation. Contains one of the following values: true or false. If true, then template selection is required for negotiation creation. If false, then template selection isn't required. This attribute doesn't have a default value.
    • NegotiationType; string; Name of the negotiation type.
    • NegotiationTypeId; integer; Unique identifier of the negotiation type.
    • PaymentTerms; string; Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
    • PaymentTermsId; integer; Unique identifier of the payment terms.
    • PriceBreakType; string; Value that identifies the pricing scheme for the price breaks of this line.
    • PriceBreakTypeCode; string; Code that identifies the pricing scheme for the price breaks of this line.
    • ProcurementBU; string; Business unit for which configuration is set up.
    • ProcurementBUId; integer; Unique identifier of the business unit for which configuration is set up.
    • ProspectiveSupplierRegistrationURL; string; URL for prospective supplier registration.
    • PunchoutRequestsOnlyFlag; boolean; Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value.
    • PurchasingDocumentCreation; string; Purchasing document creation method.
    • PurchasingDocumentCreationName; string; Name of the purchasing document creation.
    • RankIndicator; string; Rank of the procurement business function.
    • RankIndicatorName; string; Name of the rank indicator.
    • ReceiptClosePoint; string; Determines when the application closes receipts for procurement transactions.
    • ReceiptClosePointCode; string; Code that identifies the point in the receiving process when the receipt is closed.
    • ReceiptCloseTolerancePercent; number; Default percentage used to determine when a receipt is closed.
    • ReceivingFlag; boolean; Contains one of the following values: true or false. If true, then the schedule must be received before the buyer can pay the invoice. If false, then the buyer can pay the invoice even if the schedule hasn't been received. This attribute doesn't have a default value.
    • 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.
    • ShippingMethod; string; Shipping method used on the purchasing document.
    • SpendAuthorizedSupplierRegistrationURL; string; URL used for supplier registration for authorized spend.
    • UseCustomerSalesOrderFlag; boolean; Indicates whether requisition lines are grouped by sales order number to create distinct purchase orders. Contains one of the following values: true or false. If true, then requisition lines are grouped by sales order number to create distinct purchase orders. If false, then requisition lines aren't grouped by sales order number when creating purchase orders. This attribute doesn't have a default value.
    • UseRequestedDateFlag; boolean; Indicates whether the requested date on requisition lines is used when grouping requisitions to create an order. Contains one of the following values: true or false. If true, then the requested date on requisition lines is used when grouping requisitions to create an order. If false, then the requested date on requisition lines isn't used when grouping requisitions to create an order. This attribute doesn't have a default value.
    • UseShipToLocationFlag; boolean; Indicates whether requisitions are grouped by the requisition line ship-to location when creating orders. Contains one of the following values: true or false. If true, then requisitions are grouped by the requisition line ship-to location when creating orders. If false, then requisitions aren't grouped by the requisition line ship-to location when creating orders. This attribute doesn't have a default value.
    • UseShipToOrganizationAndLocationFlag; boolean; Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders. Contains one of the following values: true or false. If true, then requisitions are grouped by both ship-to organization and ship-to location when creating orders. If false, then requisitions aren't grouped by both ship-to organization and ship-to location when creating orders. This attribute doesn't have a default value.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : procurementBusinessFunctions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : procurementBusinessFunctions-item-response
Type: object
Show Source
  • Abstract Listing Configurations
    Title: Abstract Listing Configurations
    Information about abstract listing configurations and the details used to define them. For example, it can include configuration values for an abstract listing.
  • Title: Aging Onset Point
    Maximum Length: 80
    Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment.
  • Title: Aging Onset Point
    Maximum Length: 30
    Default Value: NONE
    Code that identifies the aging onset point.
  • Title: Aging Period Days
    Value that identifies the maximum number of days the material may be on consignment.
  • Title: Agreement Lines
    Maximum Length: 30
    Action type for agreement lines.
  • Title: Agreement Lines
    Maximum Length: 80
    Name of the action type for agreement lines.
  • Title: Allow Item Description Update
    Maximum Length: 1
    Default Value: true
    Value that identifies whether item descriptions can be updated on document lines.
  • Title: Allow manual price update on fulfilled orders
    Maximum Length: 1
    Value that identifies whether you can manually update the price on fulfilled orders.
  • Title: Autogenerate orders from requester-negotiated requisition lines
    Maximum Length: 1
    Default Value: false
    Value that indicates whether orders are automatically generated for negotiated requisition lines.
  • Title: Autogenerate staged documents from requisition lines
    Maximum Length: 1
    Default Value: false
    Value that indicates whether staged documents are automatically generated from requisition lines.
  • Title: Automatically add new supplier items to item relationships
    Maximum Length: 1
    Indicates whether new supplier items are automatically added to item relationships. Contains one of the following values: true or false. If true, then new supplier items are automatically added to item relationships. If false, then new supplier items aren't automatically added to item relationships. This attribute doesn't have a default value.
  • Title: Autogenerate orders from requisition lines sourced to agreements
    Maximum Length: 1
    Default Value: true
    Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not.
  • Title: Automatically populate responses to predefined questions
    Maximum Length: 1
    Default Value: true
    Value that controls set at the business unit level to default supplier responses from supplier qualification management response repository for predefined questions.
  • Title: Automatically submit for approval
    Maximum Length: 1
    Default Value: true
    Indicates whether the record is automatically submitted for approval. Contains one of the following values: true or false. If true, then the record is automatically submitted for approval. If false, then the record isn't automatically submitted for approval. This attribute doesn't have a default value.
  • Title: Enable automatic sourcing to contract purchase agreements
    Maximum Length: 1
    Default Value: true
    Enable automatic sourcing
  • Title: Buyer
    Maximum Length: 240
    Buyer associated with the procurement business function.
  • Title: Buyer
    Unique identifier of the buyer.
  • Title: Buyer managed transportation
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the buyer or an agent that the buyer designates must arrange transportation from picking up the requested item to delivering it to the ship-to location that the purchase order specifies. If false, then the supplier must arrange transportation. This attribute doesn't have a default value.
  • Title: Bypass approvals for automatically submitted orders
    Maximum Length: 1
    Indicates whether approvals are bypassed for automatically submitted orders. Contains one of the following values: true or false. If true, then the application bypasses approvals for automatically submitted orders. If false, then the application requires approvals for automatically submitted orders. This attribute doesn't have a default value.
  • Title: Carrier
    Maximum Length: 360
    Company that transports the item.
  • Title: Carrier
    Unique identifier of the company that transports the item.
  • Title: Communicate purchase agreements
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then purchase agreements will be communicated and acknowledged. If false, then purchase agreements won't be communicated and acknowledged. This attribute doesn't have a default value.
  • Title: Communicate purchase order changes
    Maximum Length: 1
    Default Value: true
    Indicates whether purchase order changes are communicated. Contains one of the following values: true or false. If true, then the application communicates purchase order changes. If false, then the application doesn't communicate purchase order changes. This attribute doesn't have a default value.
  • Title: Consumption Advice Frequency
    Maximum Length: 80
    Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
  • Title: Consumption Advice Frequency
    Maximum Length: 30
    Default Value: DAILY
    Code that indicates the consumption advice frequency.
  • Title: Consumption Advice Summary
    Maximum Length: 80
    Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly.
  • Title: Consumption Advice Summary
    Maximum Length: 30
    Default Value: ALL_INVENTORY_ORGS
    Code that indicates the consumption advice summary.
  • Title: Conversion Rate Type
    Maximum Length: 30
    Code that identifies the currency conversion rate type.
  • Title: Conversion Rate Type
    Maximum Length: 30
    Default Value: Corporate
    Abbreviation that identifies the conversion rate type.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time of the creation of the record.
  • Title: Currency
    Maximum Length: 80
    Name of the currency.
  • Title: Currency
    Maximum Length: 215
    Code that identifies the currency.
  • Title: Default promised date from requested date
    Maximum Length: 1
    Indicates whether the promised date defaults from the requested date. Contains one of the following values: true or false. If true, then the promised date defaults from the requested date. If false, then the promised date doesn't default from the requested date. This attribute doesn't have a default value.
  • Title: Display best price in blind negotiations
    Maximum Length: 1
    Default Value: false
    Indicates whether the best price appears in blind negotiations. Contains one of the following values: true or false. If true, then the best price appears in blind negotiations. If false, then the best price doesn't appear in blind negotiations. This attribute doesn't have a default value.
  • Title: Display rank in blind negotiations
    Maximum Length: 1
    Default Value: false
    Indicates whether the business function is displayed in blind negotiations. Contains one of the following values: true or false. If true, then the business function is displayed in blind negotiations. If false, then the business function isn't displayed in blind negotiations. This attribute doesn't have a default value.
  • Title: Display requirement scoring criteria to suppliers
    Maximum Length: 1
    Default Value: false
    Indicates whether scoring criteria display to suppliers. Contains one of the following values: true or false. If true, then scoring criteria display to suppliers. If false, then scoring criteria don't display to suppliers. This attribute doesn't have a default value.
  • Document Types
    Title: Document Types
    Document types used to classify procurement documents.
  • Title: Email Attachment File Name
    Maximum Length: 30
    Email address of the attachment file.
  • Title: Enable award approval
    Maximum Length: 1
    Default Value: false
    Indicates whether award approval is enabled. Contains one of the following values: true or false. If true, then award approval is enabled. If false, then award approval isn't enabled. This attribute doesn't have a default value.
  • Title: Enable negotiation approval
    Maximum Length: 1
    Default Value: false
    Indicates whether negotiation approval is enabled. Contains one of the following values: true or false. If true, then negotiation approval is enabled. If false, then negotiation approval isn't enabled. This attribute doesn't have a default value.
  • Title: Enable weights in requirements
    Maximum Length: 1
    Default Value: true
    Indicates whether weights are enabled in requirements. Contains one of the following values: true or false. If true, then you can use weights in requirements. If false, then you can't use weights in requirements. This attribute doesn't have a default value.
  • Title: Enforce supplier hold
    Maximum Length: 1
    Default Value: true
    Indicates whether supplier hold is enforced. Contains one of the following values: true or false. If true, then supplier hold is enforced. If false, then supplier hold isn't enforced. This attribute doesn't have a default value.
  • Title: Enforce supplier's previous round price as start price
    Maximum Length: 1
    Default Value: true
    Indicates whether the supplier's previous round price is used as the start price. Contains one of the following values: true or false. If true, then the supplier's previous round price is used as the start price. If false, then the supplier's previous round price isn't used as the start price. This attribute doesn't have a default value.
  • Title: FOB
    Maximum Length: 80
    Freight on board. Location where ownership of the item transfers from the supplier to the buyer.
  • Title: FOB
    Maximum Length: 30
    Code that identifies the type of free-on-board terms for the document.
  • Title: Freight Terms
    Maximum Length: 80
    Terms that describe who pays charges to transport the item.
  • Title: Freight Terms
    Maximum Length: 30
    Code that identifies the type of freight terms for the document.
  • Title: Group requisition lines
    Maximum Length: 1
    Default Value: true
    Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order.
  • Title: Group requisitions
    Maximum Length: 1
    Default Value: true
    Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order.
  • Title: Initiate approval
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then default initiate approval for the purchasing documents created from negotiation award is required. If false, then initiate approval isn't required. This attribute doesn't have a default value.
  • Title: Inspection Required
    Maximum Length: 1
    Default Value: false
    Code that identifies the tax classification on the schedule.
  • Title: Inventory Organization
    Maximum Length: 240
    Name of the inventory organization of the procurement business unit.
  • Title: Inventory Organization
    Unique identifier of the inventory organization.
  • Title: Invite only sourcing eligible suppliers
    Maximum Length: 1
    Indicates whether only eligible suppliers can be invited to sourcing events. Contains one of the following values: true or false. If true, then only eligible suppliers can be invited to sourcing events. If false, then suppliers can be invited regardless of eligibility. This attribute doesn't have a default value.
  • Title: Invoice Close Tolerance Percent
    Default Value: 0
    Value that identifies the default invoice close tolerance percent for business unit.
  • Title: Preferred Language
    Maximum Length: 255
    Language used for the procurement business function.
  • Title: Preferred Language
    Maximum Length: 16
    Language code for the procurement business function.
  • Title: Last Updated Date
    Read Only: true
    Date and time the procurement business function was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the procurement business function.
  • Title: Line Type
    Maximum Length: 30
    Line type on purchasing documents.
  • Title: Line Type
    Indicates whether the line type references an item or a service.
  • Links
  • Title: Match Approval Level
    Maximum Length: 255
    Name of the match approval level.
  • Title: Match Approval Level
    Maximum Length: 255
    Abbreviation that identifies the match approval level.
  • Title: Maximum File Size Megabytes
    Default Value: 5
    The maximum file size, in megabytes, allowed for a file-type attachment to an e-mailed purchasing document.
  • Title: Maximum Requirement Score
    Default Value: 5
    Maximum score that a requirement can have.
  • Title: Minimum Release Amount
    Value that identifies the minimum amount that can be released against a purchase agreement.
  • Title: Mode of Transport
    Maximum Length: 80
    Mode of transport to ship the item, such as truck, air, or boat.
  • Title: Mode of Transport
    Maximum Length: 30
    Mode of transport that the shipper uses to transport the item such as land, sea, and air.
  • Title: Negotiation Style
    Maximum Length: 240
    Name of the negotiation style.
  • Title: Negotiation Style
    Unique identifier of the negotiation style.
  • Title: Negotiation template required
    Maximum Length: 1
    Indicates whether template selection is required for negotiation creation. Contains one of the following values: true or false. If true, then template selection is required for negotiation creation. If false, then template selection isn't required. This attribute doesn't have a default value.
  • Title: Negotiation Type
    Maximum Length: 80
    Name of the negotiation type.
  • Title: Negotiation Type
    Unique identifier of the negotiation type.
  • Title: Payment Terms
    Maximum Length: 50
    Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
  • Title: Payment Terms
    Unique identifier of the payment terms.
  • Title: Price Break Type
    Maximum Length: 80
    Value that identifies the pricing scheme for the price breaks of this line.
  • Title: Price Break Type
    Maximum Length: 25
    Default Value: CUMULATIVE
    Code that identifies the pricing scheme for the price breaks of this line.
  • Title: Procurement BU
    Maximum Length: 240
    Business unit for which configuration is set up.
  • Title: Procurement BU
    Unique identifier of the business unit for which configuration is set up.
  • Read Only: true
    Maximum Length: 4000
    URL for prospective supplier registration.
  • Title: Punchout requests only
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value.
  • Maximum Length: 30
    Purchasing document creation method.
  • Title: Meaning
    Maximum Length: 80
    Name of the purchasing document creation.
  • Title: Rank Indicator
    Maximum Length: 30
    Default Value: NUMBERING
    Rank of the procurement business function.
  • Title: Rank Indicator
    Maximum Length: 80
    Name of the rank indicator.
  • Title: Receipt Close Point
    Maximum Length: 80
    Determines when the application closes receipts for procurement transactions.
  • Title: Receipt Close Point
    Maximum Length: 25
    Default Value: RECEIVED
    Code that identifies the point in the receiving process when the receipt is closed.
  • Title: Receipt Close Tolerance Percent
    Default Value: 0
    Default percentage used to determine when a receipt is closed.
  • Title: Receipt Required
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then the schedule must be received before the buyer can pay the invoice. If false, then the buyer can pay the invoice even if the schedule hasn't been received. This attribute doesn't have a default value.
  • Title: Service Level
    Maximum Length: 80
    Priority that determines how quickly to transport the item.
  • Title: Service Level
    Maximum Length: 30
    Value that identifies the priority of transportation that affects how quickly goods are transported.
  • Title: Shipping Method
    Maximum Length: 522
    Shipping method used on the purchasing document.
  • Read Only: true
    Maximum Length: 4000
    URL used for supplier registration for authorized spend.
  • Terms and Conditions
    Title: Terms and Conditions
    Information about terms and conditions associated with procurement business functions. For example, it can include standard purchasing terms used for a business function.
  • Title: Use customer sales order
    Maximum Length: 1
    Indicates whether requisition lines are grouped by sales order number to create distinct purchase orders. Contains one of the following values: true or false. If true, then requisition lines are grouped by sales order number to create distinct purchase orders. If false, then requisition lines aren't grouped by sales order number when creating purchase orders. This attribute doesn't have a default value.
  • Title: Use requested date
    Maximum Length: 1
    Indicates whether the requested date on requisition lines is used when grouping requisitions to create an order. Contains one of the following values: true or false. If true, then the requested date on requisition lines is used when grouping requisitions to create an order. If false, then the requested date on requisition lines isn't used when grouping requisitions to create an order. This attribute doesn't have a default value.
  • Title: Use ship-to location
    Maximum Length: 1
    Indicates whether requisitions are grouped by the requisition line ship-to location when creating orders. Contains one of the following values: true or false. If true, then requisitions are grouped by the requisition line ship-to location when creating orders. If false, then requisitions aren't grouped by the requisition line ship-to location when creating orders. This attribute doesn't have a default value.
  • Title: Use ship-to organization and location
    Maximum Length: 1
    Default Value: false
    Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders. Contains one of the following values: true or false. If true, then requisitions are grouped by both ship-to organization and ship-to location when creating orders. If false, then requisitions aren't grouped by both ship-to organization and ship-to location when creating orders. This attribute doesn't have a default value.
Nested Schema : Abstract Listing Configurations
Type: array
Title: Abstract Listing Configurations
Information about abstract listing configurations and the details used to define them. For example, it can include configuration values for an abstract listing.
Show Source
Nested Schema : Document Types
Type: array
Title: Document Types
Document types used to classify procurement documents.
Show Source
Nested Schema : Terms and Conditions
Type: array
Title: Terms and Conditions
Information about terms and conditions associated with procurement business functions. For example, it can include standard purchasing terms used for a business function.
Show Source
Nested Schema : procurementBusinessFunctions-abstractListingConfigurations-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 2000
    URL used for the abstract listing configuration.
  • Maximum Length: 50
    Name of the company in the abstract listing configuration.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the buyer or application created the abstract listing configuration for the procurement business unit.
  • Maximum Length: 255
    Date format used for the abstract listing configuration.
  • Maximum Length: 30
    Code that specifies the date format to use.
  • Title: Display Logo
    Maximum Length: 1
    Indicates whether the logo is displayed. Contains one of the following values: true or false. If true, then the logo is displayed. If false, then the logo isn't displayed. This attribute doesn't have a default value.
  • Title: Footer Content
    Content used in the footer of the abstract listing configuration.
  • Title: Header Content
    Content used in the header of the abstract listing configuration.
  • Title: Language
    Maximum Length: 255
    Language of the abstract listing configuration.
  • Title: Language
    Maximum Length: 4
    Code that identifies the language for the abstract listing configuration.
  • Title: Last Updated Date
    Read Only: true
    The date when the abstract listing configuration was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the abstract listing configuration.
  • Links
  • Height of the logo in the abstract listing configuration if the display logo option is true.
  • Title: Logo URL
    Maximum Length: 240
    Location of the logo if the display logo option is true.
  • Width of the logo if the display logo option is true.
  • Maximum Length: 255
    Format used for numbering in the abstract listing configuration.
  • Maximum Length: 30
    Code that identifies the number format used for the abstract listing configuration.
  • Title: Only show negotiations from this BU
    Maximum Length: 1
    Indicates whether only negotiations from this business unit are shown in the abstract listing configuration. Contains one of the following values: true or false. If true, then only negotiations from this business unit are shown. If false, then negotiations from all applicable business units are shown. This attribute doesn't have a default value.
  • Title: Procurement BU
    Unique identifier of the business unit for which the configuration is being set up.
  • Maximum Length: 255
    Time format used for the abstract listing configuration.
  • Maximum Length: 30
    Code that specifies the time format in the abstract listing configuration.
  • Maximum Length: 255
    Time zone for the abstract listing configuration.
  • Maximum Length: 50
    Code that identifies the time zone in the abstract listing configuration.
Nested Schema : procurementBusinessFunctions-documentTypes-item-response
Type: object
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : procurementBusinessFunctions-documentTypes-DFF-item-response
Type: object
Show Source
Nested Schema : procurementBusinessFunctions-termsAndConditions-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
Information about attachments associated with terms and conditions. For example, it can include supporting documents linked to a terms document.
Show Source
Nested Schema : procurementBusinessFunctions-termsAndConditions-attachments-item-response
Type: object
Show Source
Back to Top