Get all procurement business functions
get
/fscmRestApi/resources/11.13.18.05/procurementBusinessFunctions
Request
Query Parameters
-
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 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.
- PrimaryKey Finds procurement business functions according to the procurement business unit identifier.
-
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:- 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.
-
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
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : procurementBusinessFunctions
Type:
Show Source
object-
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : procurementBusinessFunctions-item-response
Type:
Show Source
object-
abstractListingConfigurations: array
Abstract Listing Configurations
Title:
Abstract Listing ConfigurationsInformation about abstract listing configurations and the details used to define them. For example, it can include configuration values for an abstract listing. -
AgingOnsetPoint: string
Title:
Aging Onset PointMaximum Length:80Value 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 PointMaximum Length:30Default Value:NONECode that identifies the aging onset point. -
AgingPeriodDays: number
Title:
Aging Period DaysValue that identifies the maximum number of days the material may be on consignment. -
AgreementLineActionType: string
Title:
Agreement LinesMaximum Length:30Action type for agreement lines. -
AgreementLineActionTypeName: string
Title:
Agreement LinesMaximum Length:80Name of the action type for agreement lines. -
AllowItemDescriptionUpdateFlag: boolean
Title:
Allow Item Description UpdateMaximum Length:1Default Value:trueValue that identifies whether item descriptions can be updated on document lines. -
AllowManualPriceUpdateOnFulfilledOrdersFlag: boolean
Title:
Allow manual price update on fulfilled ordersMaximum Length:1Value that identifies whether you can manually update the price on fulfilled orders. -
AutoGenerateOrdersForNegotiatedRequisitionLinesFlag: boolean
Title:
Autogenerate orders from requester-negotiated requisition linesMaximum Length:1Default Value:falseValue that indicates whether orders are automatically generated for negotiated requisition lines. -
AutoGenerateStagedDocumentsFromRequisitionLinesFlag: boolean
Title:
Autogenerate staged documents from requisition linesMaximum Length:1Default Value:falseValue that indicates whether staged documents are automatically generated from requisition lines. -
AutomaticallyAddNewSupplierItemsToItemRelationshipsFlag: boolean
Title:
Automatically add new supplier items to item relationshipsMaximum Length:1Indicates 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
Title:
Autogenerate orders from requisition lines sourced to agreementsMaximum Length:1Default Value:trueValue that identifies whether an order should be automatically created for a requisition line referencing the agreement or not. -
AutomaticallyPopulateResponsesToPredefinedQuestionsFlag: boolean
Title:
Automatically populate responses to predefined questionsMaximum Length:1Default Value:trueValue that controls set at the business unit level to default supplier responses from supplier qualification management response repository for predefined questions. -
AutomaticallySubmitForApprovalFlag: boolean
Title:
Automatically submit for approvalMaximum Length:1Default Value:trueIndicates 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. -
AutoSourcingFlag: boolean
Title:
Enable automatic sourcing to contract purchase agreementsMaximum Length:1Default Value:trueEnable automatic sourcing -
Buyer: string
Title:
BuyerMaximum Length:240Buyer associated with the procurement business function. -
BuyerId: integer
(int64)
Title:
BuyerUnique identifier of the buyer. -
BuyerManagedTransportFlag: boolean
Title:
Buyer managed transportationMaximum Length:1Default Value:falseContains 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
Title:
Bypass approvals for automatically submitted ordersMaximum Length:1Indicates 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
Title:
CarrierMaximum Length:360Company that transports the item. -
CarrierId: integer
(int64)
Title:
CarrierUnique identifier of the company that transports the item. -
CommunicatePurchaseAgreementFlag: boolean
Title:
Communicate purchase agreementsMaximum Length:1Default Value:trueContains 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
Title:
Communicate purchase order changesMaximum Length:1Default Value:trueIndicates 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
Title:
Consumption Advice FrequencyMaximum Length:80Value 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 FrequencyMaximum Length:30Default Value:DAILYCode that indicates the consumption advice frequency. -
ConsumptionAdviceSummary: string
Title:
Consumption Advice SummaryMaximum Length:80Value 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 SummaryMaximum Length:30Default Value:ALL_INVENTORY_ORGSCode that indicates the consumption advice summary. -
ConversionRateType: string
Title:
Conversion Rate TypeMaximum Length:30Code that identifies the currency conversion rate type. -
ConversionRateTypeCode: string
Title:
Conversion Rate TypeMaximum Length:30Default Value:CorporateAbbreviation that identifies the conversion rate type. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time of the creation of the record. -
Currency: string
Title:
CurrencyMaximum Length:80Name of the currency. -
CurrencyCode: string
Title:
CurrencyMaximum Length:215Code that identifies the currency. -
DefaultPromisedDateFromRequestedDateFlag: boolean
Title:
Default promised date from requested dateMaximum Length:1Indicates 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
Title:
Display best price in blind negotiationsMaximum Length:1Default Value:falseIndicates 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
Title:
Display rank in blind negotiationsMaximum Length:1Default Value:falseIndicates 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
Title:
Display requirement scoring criteria to suppliersMaximum Length:1Default Value:falseIndicates 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. -
documentTypes: array
Document Types
Title:
Document TypesDocument types used to classify procurement documents. -
EmailAttachmentFilename: string
Title:
Email Attachment File NameMaximum Length:30Email address of the attachment file. -
EnableAwardApprovalFlag: boolean
Title:
Enable award approvalMaximum Length:1Default Value:falseIndicates 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
Title:
Enable negotiation approvalMaximum Length:1Default Value:falseIndicates 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
Title:
Enable weights in requirementsMaximum Length:1Default Value:trueIndicates 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
Title:
Enforce supplier holdMaximum Length:1Default Value:trueIndicates 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
Title:
Enforce supplier's previous round price as start priceMaximum Length:1Default Value:trueIndicates 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
Title:
FOBMaximum Length:80Freight on board. Location where ownership of the item transfers from the supplier to the buyer. -
FOBCode: string
Title:
FOBMaximum Length:30Code that identifies the type of free-on-board terms for the document. -
FreightTerms: string
Title:
Freight TermsMaximum Length:80Terms that describe who pays charges to transport the item. -
FreightTermsCode: string
Title:
Freight TermsMaximum Length:30Code that identifies the type of freight terms for the document. -
GroupRequisitionLinesFlag: boolean
Title:
Group requisition linesMaximum Length:1Default Value:trueValue that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order. -
GroupRequisitionsFlag: boolean
Title:
Group requisitionsMaximum Length:1Default Value:trueValue that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order. -
InitiateApprovalFlag: boolean
Title:
Initiate approvalMaximum Length:1Default Value:trueContains 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
Title:
Inspection RequiredMaximum Length:1Default Value:falseCode that identifies the tax classification on the schedule. -
InventoryOrganization: string
Title:
Inventory OrganizationMaximum Length:240Name of the inventory organization of the procurement business unit. -
InventoryOrganizationId: integer
(int64)
Title:
Inventory OrganizationUnique identifier of the inventory organization. -
InviteOnlySourcingEligibleSuppliersFlag: boolean
Title:
Invite only sourcing eligible suppliersMaximum Length:1Indicates 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
Title:
Invoice Close Tolerance PercentDefault Value:0Value that identifies the default invoice close tolerance percent for business unit. -
Language: string
Title:
Preferred LanguageMaximum Length:255Language used for the procurement business function. -
LanguageCode: string
Title:
Preferred LanguageMaximum Length:16Language code for the procurement business function. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time the procurement business function was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the procurement business function. -
LineType: string
Title:
Line TypeMaximum Length:30Line type on purchasing documents. -
LineTypeId: integer
(int64)
Title:
Line TypeIndicates whether the line type references an item or a service. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatchApprovalLevel: string
Title:
Match Approval LevelMaximum Length:255Name of the match approval level. -
MatchApprovalLevelCode: string
Title:
Match Approval LevelMaximum Length:255Abbreviation that identifies the match approval level. -
MaximumFileSizeMegabytes: number
Title:
Maximum File Size MegabytesDefault Value:5The maximum file size, in megabytes, allowed for a file-type attachment to an e-mailed purchasing document. -
MaximumRequirementScore: number
Title:
Maximum Requirement ScoreDefault Value:5Maximum score that a requirement can have. -
MinimumReleaseAmount: number
Title:
Minimum Release AmountValue that identifies the minimum amount that can be released against a purchase agreement. -
ModeOfTransport: string
Title:
Mode of TransportMaximum Length:80Mode of transport to ship the item, such as truck, air, or boat. -
ModeOfTransportCode: string
Title:
Mode of TransportMaximum Length:30Mode of transport that the shipper uses to transport the item such as land, sea, and air. -
NegotiationStyle: string
Title:
Negotiation StyleMaximum Length:240Name of the negotiation style. -
NegotiationStyleId: integer
(int64)
Title:
Negotiation StyleUnique identifier of the negotiation style. -
NegotiationTemplateRequiredFlag: boolean
Title:
Negotiation template requiredMaximum Length:1Indicates 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
Title:
Negotiation TypeMaximum Length:80Name of the negotiation type. -
NegotiationTypeId: integer
(int64)
Title:
Negotiation TypeUnique identifier of the negotiation type. -
PaymentTerms: string
Title:
Payment TermsMaximum Length:50Terms 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
(int64)
Title:
Payment TermsUnique identifier of the payment terms. -
PriceBreakType: string
Title:
Price Break TypeMaximum Length:80Value that identifies the pricing scheme for the price breaks of this line. -
PriceBreakTypeCode: string
Title:
Price Break TypeMaximum Length:25Default Value:CUMULATIVECode that identifies the pricing scheme for the price breaks of this line. -
ProcurementBU: string
Title:
Procurement BUMaximum Length:240Business unit for which configuration is set up. -
ProcurementBUId: integer
(int64)
Title:
Procurement BUUnique identifier of the business unit for which configuration is set up. -
ProspectiveSupplierRegistrationURL: string
Read Only:
trueMaximum Length:4000URL for prospective supplier registration. -
PunchoutRequestsOnlyFlag: boolean
Title:
Punchout requests onlyMaximum Length:1Default Value:falseContains 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
Maximum Length:
30Purchasing document creation method. -
PurchasingDocumentCreationName: string
Title:
MeaningMaximum Length:80Name of the purchasing document creation. -
RankIndicator: string
Title:
Rank IndicatorMaximum Length:30Default Value:NUMBERINGRank of the procurement business function. -
RankIndicatorName: string
Title:
Rank IndicatorMaximum Length:80Name of the rank indicator. -
ReceiptClosePoint: string
Title:
Receipt Close PointMaximum Length:80Determines when the application closes receipts for procurement transactions. -
ReceiptClosePointCode: string
Title:
Receipt Close PointMaximum Length:25Default Value:RECEIVEDCode that identifies the point in the receiving process when the receipt is closed. -
ReceiptCloseTolerancePercent: number
Title:
Receipt Close Tolerance PercentDefault Value:0Default percentage used to determine when a receipt is closed. -
ReceivingFlag: boolean
Title:
Receipt RequiredMaximum Length:1Default Value:trueContains 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
Title:
Service LevelMaximum Length:80Priority that determines how quickly to transport the item. -
ServiceLevelCode: string
Title:
Service LevelMaximum Length:30Value that identifies the priority of transportation that affects how quickly goods are transported. -
ShippingMethod: string
Title:
Shipping MethodMaximum Length:522Shipping method used on the purchasing document. -
SpendAuthorizedSupplierRegistrationURL: string
Read Only:
trueMaximum Length:4000URL used for supplier registration for authorized spend. -
termsAndConditions: array
Terms and Conditions
Title:
Terms and ConditionsInformation about terms and conditions associated with procurement business functions. For example, it can include standard purchasing terms used for a business function. -
UseCustomerSalesOrderFlag: boolean
Title:
Use customer sales orderMaximum Length:1Indicates 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
Title:
Use requested dateMaximum Length:1Indicates 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
Title:
Use ship-to locationMaximum Length:1Indicates 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
Title:
Use ship-to organization and locationMaximum Length:1Default Value:falseIndicates 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:
arrayTitle:
Abstract Listing ConfigurationsInformation 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:
arrayTitle:
Document TypesDocument types used to classify procurement documents.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Terms and Conditions
Type:
arrayTitle:
Terms and ConditionsInformation 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:
Show Source
object-
AbstractURL: string
Read Only:
trueMaximum Length:2000URL used for the abstract listing configuration. -
CompanyName: string
Maximum Length:
50Name of the company in the abstract listing configuration. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the buyer or application created the abstract listing configuration for the procurement business unit. -
DateFormat: string
Maximum Length:
255Date format used for the abstract listing configuration. -
DateFormatCode: string
Maximum Length:
30Code that specifies the date format to use. -
DisplayLogoFlag: boolean
Title:
Display LogoMaximum Length:1Indicates 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. - FooterContent: string (byte)
-
HeaderContent: string
(byte)
Title:
Header ContentContent used in the header of the abstract listing configuration. -
Language: string
Title:
LanguageMaximum Length:255Language of the abstract listing configuration. -
LanguageCode: string
Title:
LanguageMaximum Length:4Code that identifies the language for the abstract listing configuration. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the abstract listing configuration was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the abstract listing configuration. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LogoHeight: number
Height of the logo in the abstract listing configuration if the display logo option is true.
-
LogoLocation: string
Title:
Logo URLMaximum Length:240Location of the logo if the display logo option is true. -
LogoWidth: number
Width of the logo if the display logo option is true.
-
NumberFormat: string
Maximum Length:
255Format used for numbering in the abstract listing configuration. -
NumberFormatCode: string
Maximum Length:
30Code that identifies the number format used for the abstract listing configuration. -
OnlyShowNegotiationsFromThisBUFlag: boolean
Title:
Only show negotiations from this BUMaximum Length:1Indicates 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. -
ProcurementBUId: integer
(int64)
Title:
Procurement BUUnique identifier of the business unit for which the configuration is being set up. -
TimeFormat: string
Maximum Length:
255Time format used for the abstract listing configuration. -
TimeFormatCode: string
Maximum Length:
30Code that specifies the time format in the abstract listing configuration. -
Timezone: string
Maximum Length:
255Time zone for the abstract listing configuration. -
TimezoneCode: string
Maximum Length:
50Code that identifies the time zone in the abstract listing configuration.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : procurementBusinessFunctions-documentTypes-item-response
Type:
Show Source
object-
ChangeOrderTemplateId: integer
(int64)
Title:
Change Order TemplateUnique identifier of the change order template. -
ChangeOrderTemplateName: string
Title:
Change Order TemplateName of the change order template. -
ContractLayout: string
Title:
Contract Terms LayoutMaximum Length:240Layout used for the contract terms. -
DFF: array
DFF
-
DisplayName: string
Title:
Display NameMaximum Length:80Display name for the document type. -
DocumentLayout: string
Title:
Document LayoutMaximum Length:240Layout used to format the document. -
DocumentSubtype: string
Title:
Document SubtypeMaximum Length:25Subtype of the document type. -
DocumentTypeCode: string
Title:
TypeMaximum Length:25Code that identifies the document type. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when document type was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NegotiationLayout: string
Title:
Negotiation LayoutMaximum Length:240Layout used for the negotiation type. -
NegotiationLayoutForBuyer: string
Title:
Negotiation Layout for BuyerMaximum Length:240Layout that buyers use for negotiations. -
NegotiationLayoutForSupplier: string
Title:
Negotiation Layout for SupplierMaximum Length:240Layout used for supplier-facing negotiations. -
NegotiationResponseLayout: string
Title:
Response LayoutMaximum Length:240Layout used for responses in the negotiation. -
ProcurementBUId: integer
(int64)
Title:
Procurement BURead Only:trueValue that uniquely identifies a business unit. -
TemplateExistsFlag: boolean
Maximum Length:
1Indicates whether a template exists for the document type. Contains one of the following values: true or false. If true, then a template exists for the document type. If false, then a template doesn't exist for the document type. This attribute doesn't have a default value.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : procurementBusinessFunctions-documentTypes-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
DocumentSubtype: string
Maximum Length:
25 -
DocumentTypeCode: string
Title:
TypeMaximum Length:25 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrcBuId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : procurementBusinessFunctions-termsAndConditions-item-response
Type:
Show Source
object-
ApplicationCode: string
Maximum Length:
10Code that identifies the application associated with the terms and conditions. Valid values are SOURCING and PURCHASING. -
ApplicationId: integer
(int64)
Unique identifier of the application in terms and conditions.
-
attachments: array
Attachments
Title:
AttachmentsInformation about attachments associated with terms and conditions. For example, it can include supporting documents linked to a terms document. -
Body: string
(byte)
Terms and conditions text for the procurement business function.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the buyer or application created the terms and conditions. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the buyer or application updated the terms and conditions. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the terms and conditions. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32User session that last updated the terms and conditions record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number of the record for terms and conditions.
-
ProcurementBUId: integer
(int64)
Read Only:
trueUnique identifier of the business unit for which configuration is being set up. -
TermsAndConditionsDisplayOption: string
Title:
EnabledMaximum Length:1Display option for the sourcing terms and conditions for the configured procurement business unit. -
VersionFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the version is current. Contains one of the following values: true or false. If true, then the version is current. If false, then the version isn't current. This attribute doesn't have a default value. -
VersionNumber: integer
(int64)
Version number of the terms and conditions.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsInformation about attachments associated with terms and conditions. For example, it can include supporting documents linked to a terms document.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : procurementBusinessFunctions-termsAndConditions-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdUnique identifier of the asynchronous tracker for the supporting document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the supporting document. -
CategoryName: string
Title:
CategoryMaximum Length:30Code for the category to which the supporting document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies whether the supporting document is a file or a URL. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the supporting document in the content server. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder for the supporting document in the content server. -
DmVersionNumber: string
Maximum Length:
255Version number of the supporting document in the content server. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the supporting document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the supporting document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the supporting document. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the supporting document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the supporting document. A file name or URL is required. -
FileUrl: string
Title:
File UrlURL location of the supporting document. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. -
UploadedFileLength: integer
Title:
File SizeFile size of the uploaded attachment. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. -
UploadedText: string
Title:
Uploaded TextText of the uploaded attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- createAndUpdateSourcingTermsAndConditions
-
Creates and updates sourcing terms and conditions.
- defaultProcurementBusinessUnit
-
Sets the procurement business unit as the default value for the user to login next time.