ContractRequests

Retrieves contract request header information.

Table-Specific Information

Select

The connector uses the SAP Ariba API to process WHERE clause conditions that are built with the following columns and operators:

UniqueName supports the '=,!=,CONTAINS' comparison operators.
Name supports the '=,!=,CONTAINS' comparison operators.
VersionNumber supports the '=,!=,>,>=,<,<=' comparison operators.
StatusString supports the '=,!=,CONTAINS' comparison operators.
CompanyCode supports the '=,!=' comparison operators.
CreateDate supports the '>,>=,=,<=,<' comparison operators.
GlobalReleaseFlag supports the '=,!=' comparison operators.
LimitType supports the '=,!=' comparison operators.
TermType supports the '=,!=' comparison operators.
ReleaseType supports the '=,!=' comparison operators.
HierarchicalType supports the '=,!=' comparison operators.
MaxAmount supports the '=,!=,>,>=,<,<=,IS NULL,IS NOT NULL' comparison operators.
MaxAmountCurrencyName supports the 'IS NULL,IS NOT NULL' comparison operators.
MaxAmountCurrencyUniqueName supports the '=,!=' comparison operators.
MinAmount supports the '=,!=,>,>=,<,<=,IS NULL,IS NOT NULL' comparison operators.
MinAmountCurrencyName supports the 'IS NULL,IS NOT NULL' comparison operators.
MinAmountCurrencyUniqueName supports the '=,!=' comparison operators.
ReleaseMinAmount supports the '=,!=,>,>=,<,<=,IS NULL,IS NOT NULL' comparison operators.
ReleaseMinAmountCurrencyName supports the 'IS NULL,IS NOT NULL' comparison operators.
ReleaseMinAmountCurrencyUniqueName supports the '=,!=' comparison operators.
ReleaseMaxAmount supports the '=,!=,>,>=,<,<=,IS NULL,IS NOT NULL' comparison operators.
ReleaseMaxAmountCurrencyName supports the 'IS NULL,IS NOT NULL' comparison operators.
ReleaseMaxAmountCurrencyUniqueName supports the '=,!=' comparison operators.
PreloadAmount supports the '=,!=,>,>=,<,<=,IS NULL,IS NOT NULL' comparison operators.
PreloadAmountCurrencyName supports the 'IS NULL,IS NOT NULL' comparison operators.
PreloadAmountCurrencyUniqueName supports the '=,!=' comparison operators.
SupplierName supports the 'IS NULL,IS NOT NULL' comparison operators.
SupplierUniqueName supports the '=,!=' comparison operators.
SupplierLocationName supports the 'IS NULL,IS NOT NULL' comparison operators.
SupplierLocationUniqueName supports the '=,!=' comparison operators.
RequesterName supports the 'IS NULL,IS NOT NULL' comparison operators.
RequesterUniqueName supports the '=,!=' comparison operators.
PaymentTerms supports the '=,!=' comparison operators.
LastModified supports the '>,>=,=,<=,<' comparison operators.
ApprovedDate supports the '>,>=,=,<=,<' comparison operators.

For example, the following queries are processed server-side:

SELECT * FROM [ContractRequests]
SELECT * FROM [ContractRequests] WHERE [UniqueName] = 'CR10'
SELECT * FROM [ContractRequests] WHERE [Name] = '(CW4926) Contract Workspace'
SELECT * FROM [ContractRequests] WHERE [VersionNumber] = 1
SELECT * FROM [ContractRequests] WHERE [StatusString] = 'Submitted'
SELECT * FROM [ContractRequests] WHERE [CompanyCode] = 'ARCO'
SELECT * FROM [ContractRequests] WHERE [CreateDate] >= '2023-01-01 11:10:00'
SELECT * FROM [ContractRequests] WHERE [GlobalReleaseFlag] = false
SELECT * FROM [ContractRequests] WHERE [LimitType] = 'Amount'
SELECT * FROM [ContractRequests] WHERE [TermType] = 'Item'
SELECT * FROM [ContractRequests] WHERE [ReleaseType] = 'Yes'
SELECT * FROM [ContractRequests] WHERE [HierarchicalType] = 'MasterAgreement'
SELECT * FROM [ContractRequests] WHERE [MaxAmount] = '100.00'
SELECT * FROM [ContractRequests] WHERE [MaxAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [ContractRequests] WHERE [MinAmount] = '100.00'
SELECT * FROM [ContractRequests] WHERE [MinAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [ContractRequests] WHERE [ReleaseMinAmount] = '100.00'
SELECT * FROM [ContractRequests] WHERE [ReleaseMinAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [ContractRequests] WHERE [ReleaseMaxAmount] = '100.00'
SELECT * FROM [ContractRequests] WHERE [ReleaseMaxAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [ContractRequests] WHERE [PreloadAmount] = '100.00'
SELECT * FROM [ContractRequests] WHERE [PreloadAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [ContractRequests] WHERE [SupplierUniqueName] = '1000005900'
SELECT * FROM [ContractRequests] WHERE [SupplierLocationUniqueName] = '1000003550'
SELECT * FROM [ContractRequests] WHERE [RequesterUniqueName] = 'user'
SELECT * FROM [ContractRequests] WHERE [PaymentTerms] = 'PT1'
SELECT * FROM [ContractRequests] WHERE [LastModified] >= '2023-01-01 11:10:00'
SELECT * FROM [ContractRequests] WHERE [ApprovedDate] >= '2023-01-01 11:10:00'

The connector processes other filters client-side within the connector.

The connector uses the SAP Ariba API to process ORDER BY clause conditions that are built with the following columns:

UniqueName
Name
VersionNumber
StatusString
CompanyCode
CreateDate
GlobalReleaseFlag
LimitType
TermType
ReleaseType
HierarchicalType
MaxAmount
MaxAmountCurrencyUniqueName
MinAmount
MinAmountCurrencyUniqueName
ReleaseMinAmount
ReleaseMinAmountCurrencyUniqueName
ReleaseMaxAmount
ReleaseMaxAmountCurrencyUniqueName
PreloadAmount
PreloadAmountCurrencyUniqueName
SupplierUniqueName
SupplierLocationUniqueName
RequesterUniqueName
PaymentTerms
LastModified
ApprovedDate

SELECT * FROM [ContractRequests] ORDER BY [UniqueName]
SELECT * FROM [ContractRequests] ORDER BY [Name]
SELECT * FROM [ContractRequests] ORDER BY [VersionNumber]
SELECT * FROM [ContractRequests] ORDER BY [StatusString]
SELECT * FROM [ContractRequests] ORDER BY [CompanyCode]
SELECT * FROM [ContractRequests] ORDER BY [CreateDate]
SELECT * FROM [ContractRequests] ORDER BY [GlobalReleaseFlag]
SELECT * FROM [ContractRequests] ORDER BY [LimitType]
SELECT * FROM [ContractRequests] ORDER BY [TermType]
SELECT * FROM [ContractRequests] ORDER BY [ReleaseType]
SELECT * FROM [ContractRequests] ORDER BY [HierarchicalType]
SELECT * FROM [ContractRequests] ORDER BY [MaxAmount]
SELECT * FROM [ContractRequests] ORDER BY [MaxAmountCurrencyUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [MinAmount]
SELECT * FROM [ContractRequests] ORDER BY [MinAmountCurrencyUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [ReleaseMinAmount]
SELECT * FROM [ContractRequests] ORDER BY [ReleaseMinAmountCurrencyUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [ReleaseMaxAmount]
SELECT * FROM [ContractRequests] ORDER BY [ReleaseMaxAmountCurrencyUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [PreloadAmount]
SELECT * FROM [ContractRequests] ORDER BY [PreloadAmountCurrencyUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [SupplierUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [SupplierLocationUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [RequesterUniqueName]
SELECT * FROM [ContractRequests] ORDER BY [PaymentTerms]
SELECT * FROM [ContractRequests] ORDER BY [LastModified]
SELECT * FROM [ContractRequests] ORDER BY [ApprovedDate]

The connector processes ordering by other columns client-side within the connector.

Insert

Note that create or amend of Contract Request through this API is not allowed in case of Suite Integrated Realm.

You can use the following columns to create (insert) a new record:

Name
Description
ExternalId
ExternalApplicationId
CreateDate
EffectiveDate
ExpirationDate
GlobalReleaseFlag
Evergreen
IsBlanketPurchaseOrder
IsHardMaxAmount
IsInvoiceable
IsReceivable
AllowNonCatalogOnInvoice
ApplySupAndCommTermsToNonCatalogItems
CreateSubscription
HideAmount
HideUnitPrice
IncludeSubAgreementAccumulators
IsHardReleaseMaxAmount
IsHardReleaseMinAmount
IsNonCatalogItemsAccumulated
ExcludeChargesOnAvailableAmount
ExcludeTaxesOnAvailableAmount
LimitType
TermType
ReleaseType
HierarchicalType
MaxAmount
MaxAmountCurrencyUniqueName
MinAmount
MinAmountCurrencyUniqueName
ReleaseMinAmount
ReleaseMinAmountCurrencyUniqueName
ReleaseMaxAmount
ReleaseMaxAmountCurrencyUniqueName
PreloadAmount
PreloadAmountCurrencyUniqueName
CurrencyUniqueName
SupplierUniqueName
SupplierLocationUniqueName
SupplierLocationContactId
RequesterUniqueName
RequesterPasswordAdapter
PreparerUniqueName
PreparerPasswordAdapter
PaymentTerms
NotificationDays
NotificationRecurringDays
MinAvailableAmountNotificationDays
AvailableAmountNotificationPercent
MinAvailableAmountNotificationPercent
ReleaseTolerancePercent
MaxAmountTolerancePercent
ParentAgreement
ParentAgreementExternalSourcingId
PhysicalLocation
ProcurementUnit
UseExternalIdForMA
ForecastedSpendFrequencyUniqueName
ForecastedSpendSavingPercentage
ForecastedSpendTotalAmount
ForecastedSpendTotalAmountCurrencyUniqueName
ForecastedSpendItems

You can use the following pseudo-column to amend a record: PreviousVersion

INSERT INTO [ContractRequests] ([PreviousVersion]) VALUES ('CR230')

Update

Note that the contract request details that can be updated depends on your site configuration.

You can use the following columns to update a record:

Name
Description
ExternalId
ExternalApplicationId
EffectiveDate
ExpirationDate
GlobalReleaseFlag
Evergreen
IsBlanketPurchaseOrder
IsHardMaxAmount
IsInvoiceable
IsReceivable
AllowNonCatalogOnInvoice
ApplySupAndCommTermsToNonCatalogItems
CreateSubscription
IncludeSubAgreementAccumulators
IsHardReleaseMaxAmount
IsHardReleaseMinAmount
IsNonCatalogItemsAccumulated
ExcludeChargesOnAvailableAmount
ExcludeTaxesOnAvailableAmount
LimitType
TermType
ReleaseType
HierarchicalType
MaxAmount
MaxAmountCurrencyUniqueName
MinAmount
MinAmountCurrencyUniqueName
ReleaseMinAmount
ReleaseMinAmountCurrencyUniqueName
ReleaseMaxAmount
ReleaseMaxAmountCurrencyUniqueName
PreloadAmount
PreloadAmountCurrencyUniqueName
CurrencyUniqueName
SupplierUniqueName
SupplierLocationUniqueName
SupplierLocationContactId
RequesterUniqueName
RequesterPasswordAdapter
PreparerUniqueName
PreparerPasswordAdapter
PaymentTerms
NotificationDays
NotificationRecurringDays
MinAvailableAmountNotificationDays
AvailableAmountNotificationPercent
MinAvailableAmountNotificationPercent
ReleaseTolerancePercent
MaxAmountTolerancePercent
ParentAgreement
ParentAgreementExternalSourcingId
PhysicalLocation
ProcurementUnit
UseExternalIdForMA
ForecastedSpendFrequencyUniqueName
ForecastedSpendSavingPercentage
ForecastedSpendTotalAmount
ForecastedSpendTotalAmountCurrencyUniqueName
ForecastedSpendItems

UPDATE [ContractRequests] SET [EffectiveDate] = '2010-09-03' WHERE [UniqueName] = 'CR12'
UPDATE [ContractRequests] SET [ExpirationDate] = '2070-02-02' WHERE [UniqueName] = 'CR12'
UPDATE [ContractRequests] SET [MaxAmount] = '5000' WHERE [UniqueName] = 'CR11'
UPDATE [ContractRequests] SET [Name] = 'Test' WHERE [UniqueName] = 'CR11'
UPDATE [ContractRequests] SET [NotificationDays] = 30 WHERE [UniqueName] = 'CR11'

Columns


Name	Type	ReadOnly	References	Description
UniqueName [KEY]	String	True		The unique identifier of the contract request.
Name	String	False		The name of the contract request.
VersionNumber	Int	True		Version number of the contract request.
StatusString	String	True		Current status of the contract request (e.g., Open, Closed, Processing).
Description	String	False		Description of the contract request.
Active	Boolean	True		The Active flag indicates whether the document is marked as hidden (hidden if 'ContractBean.Active = false') in Buyer data store (because no use cases will need to refer the document). Note that 'ContractBean.Active = false' is NOT the same as 'ContractBean.StatusString = Inactive'.
CompanyCode	String	True		Company code for this contract request (used with SAP ERPs).
ExternalId	String	False		Id from external system.
ExternalApplicationId	String	False		Reference Id for the external applications
ExternalSourcingId	String	True		Reference of document or object in the sourcing destination.
CreateDate	Datetime	False		Date when the contract request was created.
EffectiveDate	Date	False		Effective date when the contract becomes active.
ExpirationDate	Date	False		The date on which the contract expires, after which it is no longer available for ordering
GlobalReleaseFlag	Boolean	False		This flag is used to indicate whether releases can be made against this Master Agreement from partitions other than the partition the Master Agreement was created in.
Evergreen	Boolean	False		Indicates if the contract can remain in effect indefinitely without an expiration date.
IsBlanketPurchaseOrder	Boolean	False		Indicates if this contract is a Blanket Purchase Order (BPO).
IsHardMaxAmount	Boolean	False		Indicates if a hard maximum limit is applied to this contract.
IsInvoiceable	Boolean	False		Indicates if invoices can be created directly against this contract.
IsReceivable	Boolean	False		Indicates if receipts can be created directly against this contract.
AllowNonCatalogOnInvoice	Boolean	False		Indicates if non-catalog items can be added to invoices.
ApplySupAndCommTermsToNonCatalogItems	Boolean	False		This flag is used to specify whether to allow price markdown of non-catalog items. It is only applicable to supplier and commodity term Master Agreements.
CreateSubscription	Boolean	False		Flag used to determine if a catalog subscription should be created for non-catalog items. This field is only applicable for Item Level, User Release Contracts. For Item Level No Release Contracts, the subscription is always created.
HideAmount	Boolean	False		Amount value in BPOs is hidden from suppliers in the Ariba Network.
HideUnitPrice	Boolean	False		Unit Price value in BPOs is hidden from suppliers in the Ariba Network.
IncludeSubAgreementAccumulators	Boolean	False		Boolean to indicate if this contract wants to track the spend from its SubAgreements.
IsHardReleaseMaxAmount	Boolean	False		Indicates if the release maximum amount is a hard constraint.
IsHardReleaseMinAmount	Boolean	False		Indicates if the release minimum amount is a hard constraint.
IsNonCatalogItemsAccumulated	Boolean	False		Indicates if non-catalog items can be accumulated against this contract.
ExcludeChargesOnAvailableAmount	Boolean	False		Default AvailableAmount includes taxes and charges. This flag specifies whether to exclude charges from AvailableAmount calculation.
ExcludeTaxesOnAvailableAmount	Boolean	False		Default AvailableAmount includes taxes and charges. This flag specifies whether to exclude taxes from AvailableAmount calculation.
LimitType	String	False		How the contract limit is determined (Amount or Quantity). The allowed values are Amount, Quantity.
TermType	String	False		The term type for this contract (Supplier, Commodity, Item, or Catalog). The allowed values are Supplier, Commodity, Item, Catalog.
ReleaseType	String	False		The type of releases allowed for this contract (Yes for requisitions, No for receipts and invoices). The allowed values are Yes, No.
HierarchicalType	String	False		The HierarchicalType is a string that can take one of the following values: StandAlone (for a contract that has no parent or sub agreements), SubAgreement (a contract that has parent contract and sub contracts), or MasterAgreement (a contract that has no parent contract and only sub contracts). The allowed values are StandAlone, SubAgreement, MasterAgreement.
MaxAmount	Decimal	False		Maximum amount for all line items on this contract.
MaxAmountCurrencyName	String	True		Currency name for the maximum amount.
MaxAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the maximum amount.
MinAmount	Decimal	False		The minimum amount for all line items committed for the Master Agreement.
MinAmountCurrencyName	String	True		Currency name for the minimum amount.
MinAmountCurrencyUniqueName	String	False		Unique name of the currency for minimum amount.
ReleaseMinAmount	Decimal	False		Release minimum amount value.
ReleaseMinAmountCurrencyName	String	True		Currency name for the release minimum amount.
ReleaseMinAmountCurrencyUniqueName	String	False		Unique name of the currency for release minimum amount.
ReleaseMaxAmount	Decimal	False		Release maximum amount value.
ReleaseMaxAmountCurrencyName	String	True		Currency name for the release maximum amount.
ReleaseMaxAmountCurrencyUniqueName	String	False		Unique name of the currency for release maximum amount.
PreloadAmount	Decimal	False		Preload amount value.
PreloadAmountCurrencyName	String	True		Currency name for the preload amount.
PreloadAmountCurrencyUniqueName	String	False		Unique name of the currency for preload amount.
CurrencyName	String	True		Name of the contract currency.
CurrencyUniqueName	String	False		Unique name of the contract currency.
SupplierName	String	True		Name of the supplier for this contract.
SupplierUniqueName	String	False		Unique identifier of the supplier for this contract.
SupplierBuyerSystemId	String	True		Buyer system Id for this supplier.
SupplierErpVendorId	String	True		ERP vendor Id for this supplier.
SupplierAnId	String	True		Supplier network Id.
SupplierLocationName	String	True		Name of the supplier location for this contract.
SupplierLocationUniqueName	String	False		Unique identifier of the supplier location for this contract.
SupplierLocationContactId	String	False		Contact Id for the supplier location.
RequesterName	String	True		Name of the person who requested this contract.
RequesterUniqueName	String	False		Unique identifier of the person who requested this contract.
RequesterPasswordAdapter	String	False		Password adapter for the contract requester.
PreparerName	String	True		Name of the person who prepared this contract.
PreparerUniqueName	String	False		Unique identifier of the person who prepared this contract.
PreparerPasswordAdapter	String	False		Password adapter for the contract preparer.
PaymentTerms	String	False		Payment terms for this contract.
SourcingDestinationName	String	True		Name of the sourcing destination for this contract.
SourcingDestinationUniqueName	String	True		Unique identifier of the sourcing destination for this contract.
MAState	Int	True		State showing whether the Master Agreement is available for releases (1-Created, 2-Processing,4-Processed, 8-Open,16-Closed, 32-Sending, 64-Process Failed, 128-Opening, 256-Closing). The allowed values are 1, 2, 4, 8, 16, 32, 64, 128, 256.
NotificationDays	Int	False		Number of days before expiration when users are notified.
NotificationRecurringDays	Int	False		Number of days between recurring notifications.
MinAvailableAmountNotificationDays	Int	False		Number of days before expiration when minimum amount notifications are sent.
AvailableAmountNotificationPercent	Decimal	False		The percentage of the MaxAmount remaining at which a notification will be sent to the users on the edit list.
MinAvailableAmountNotificationPercent	Decimal	False		Minimum percentage amount required before expiration to avoid notifications.
ReleaseTolerancePercent	Decimal	False		Percentage tolerance for release amounts before requiring additional approval.
MaxAmountTolerancePercent	Decimal	False		Maximum amount tolerance percentage for this contract.
MasterAgreement	String	True		Reference to the MasterAgreement created from this MasterAgreementRequest.
ParentAgreement	String	False		Reference to the parent contract, if such a contract exists.
ParentAgreementExternalSourcingId	String	False		Reference of parent agreement external sourcing id.
PhysicalLocation	String	False		Stores the physical location of the contract.
ProcurementUnit	String	False		The purchasing unit to which this document belongs.
PurchaseOrg	String	True		Purchase organization for SAP ERP systems.
SetId	String	True		Set identifier for PeopleSoft ERP systems.
UseExternalIdForMA	Boolean	False		Id from external system.
ForecastedSpendFrequencyName	String	True		Name of the forecasted spend frequency (e.g., quarterly, monthly).
ForecastedSpendFrequencyUniqueName	String	False		Unique identifier of the forecasted spend frequency. The allowed values are ANN, MON, QAN, SAN.
ForecastedSpendSavingPercentage	Decimal	False		Percentage of anticipated savings for the entire contract.
ForecastedSpendTotalAmount	Decimal	False		Total monetary amount of the forecasted spend.
ForecastedSpendTotalAmountCurrencyName	String	True		Currency name for the forecasted spend total amount.
ForecastedSpendTotalAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the forecasted spend total amount.
ForecastedSpendItems	String	False		Individual items within the forecasted spend breakdown.
OrganizationIdsPartIds	String	True		Organization identifiers for the supplier.
LastModified	Datetime	True		Date when the contract request was last modified.
ApprovedDate	Datetime	True		Date when the contract request was approved.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
PreviousVersion	String	Field to initiate the amend contract request. When this field is populated, contract request amend is performed ignoring the remaining fields value.