Contracts
Retrieves contract header information.
View-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 [Contracts]
SELECT * FROM [Contracts] WHERE [UniqueName] = 'C10'
SELECT * FROM [Contracts] WHERE [Name] = '(CW4909) Contract Workspace'
SELECT * FROM [Contracts] WHERE [VersionNumber] = 2
SELECT * FROM [Contracts] WHERE [StatusString] = 'Open'
SELECT * FROM [Contracts] WHERE [CompanyCode] = '3000'
SELECT * FROM [Contracts] WHERE [CreateDate] >= '2023-01-01 11:10:00'
SELECT * FROM [Contracts] WHERE [GlobalReleaseFlag] = true
SELECT * FROM [Contracts] WHERE [LimitType] = 'Amount'
SELECT * FROM [Contracts] WHERE [TermType] = 'Item'
SELECT * FROM [Contracts] WHERE [ReleaseType] = 'Yes'
SELECT * FROM [Contracts] WHERE [HierarchicalType] = 'StandAlone'
SELECT * FROM [Contracts] WHERE [MaxAmount] = '100.00'
SELECT * FROM [Contracts] WHERE [MaxAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [Contracts] WHERE [MinAmount] = '100.00'
SELECT * FROM [Contracts] WHERE [MinAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [Contracts] WHERE [ReleaseMinAmount] = '100.00'
SELECT * FROM [Contracts] WHERE [ReleaseMinAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [Contracts] WHERE [ReleaseMaxAmount] = '100.00'
SELECT * FROM [Contracts] WHERE [ReleaseMaxAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [Contracts] WHERE [PreloadAmount] = '100.00'
SELECT * FROM [Contracts] WHERE [PreloadAmountCurrencyUniqueName] = 'USD'
SELECT * FROM [Contracts] WHERE [SupplierUniqueName] = '1000005900'
SELECT * FROM [Contracts] WHERE [SupplierLocationUniqueName] = '1000005900'
SELECT * FROM [Contracts] WHERE [RequesterUniqueName] = 'user'
SELECT * FROM [Contracts] WHERE [PaymentTerms] = 'PT1'
SELECT * FROM [Contracts] WHERE [LastModified] >= '2023-01-01 11:10:00'
SELECT * FROM [Contracts] 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 [Contracts] ORDER BY [UniqueName]
SELECT * FROM [Contracts] ORDER BY [Name]
SELECT * FROM [Contracts] ORDER BY [VersionNumber]
SELECT * FROM [Contracts] ORDER BY [StatusString]
SELECT * FROM [Contracts] ORDER BY [CompanyCode]
SELECT * FROM [Contracts] ORDER BY [CreateDate]
SELECT * FROM [Contracts] ORDER BY [GlobalReleaseFlag]
SELECT * FROM [Contracts] ORDER BY [LimitType]
SELECT * FROM [Contracts] ORDER BY [TermType]
SELECT * FROM [Contracts] ORDER BY [ReleaseType]
SELECT * FROM [Contracts] ORDER BY [HierarchicalType]
SELECT * FROM [Contracts] ORDER BY [MaxAmount]
SELECT * FROM [Contracts] ORDER BY [MaxAmountCurrencyUniqueName]
SELECT * FROM [Contracts] ORDER BY [MinAmount]
SELECT * FROM [Contracts] ORDER BY [MinAmountCurrencyUniqueName]
SELECT * FROM [Contracts] ORDER BY [ReleaseMinAmount]
SELECT * FROM [Contracts] ORDER BY [ReleaseMinAmountCurrencyUniqueName]
SELECT * FROM [Contracts] ORDER BY [ReleaseMaxAmount]
SELECT * FROM [Contracts] ORDER BY [ReleaseMaxAmountCurrencyUniqueName]
SELECT * FROM [Contracts] ORDER BY [PreloadAmount]
SELECT * FROM [Contracts] ORDER BY [PreloadAmountCurrencyUniqueName]
SELECT * FROM [Contracts] ORDER BY [SupplierUniqueName]
SELECT * FROM [Contracts] ORDER BY [SupplierLocationUniqueName]
SELECT * FROM [Contracts] ORDER BY [RequesterUniqueName]
SELECT * FROM [Contracts] ORDER BY [PaymentTerms]
SELECT * FROM [Contracts] ORDER BY [LastModified]
SELECT * FROM [Contracts] ORDER BY [ApprovedDate]
The connector processes ordering by other columns client-side within the connector.
Columns
| Name | Type | References | Description |
| UniqueName [KEY] | String | The unique identifier of the contract. | |
| Name | String | The name of the contract. | |
| VersionNumber | Int | Version number of the contract. | |
| StatusString | String | Current status of the contract (e.g., Open, Closed, Processing). | |
| Description | String | Description of the contract. | |
| Active | Boolean | 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 | Company code for this contract (used with SAP ERPs). | |
| ExternalId | String | Id from external system. | |
| ExternalApplicationId | String | Reference Id for the external applications | |
| ExternalSourcingId | String | Reference of document or object in the sourcing destination. | |
| CreateDate | Datetime | Date when the contract was created. | |
| EffectiveDate | Date | Effective date when the contract becomes active. | |
| ExpirationDate | Date | The date on which the contract expires, after which it is no longer available for ordering | |
| GlobalReleaseFlag | Boolean | 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 | Indicates if the contract can remain in effect indefinitely without an expiration date. | |
| IsBlanketPurchaseOrder | Boolean | Indicates if this contract is a Blanket Purchase Order (BPO). | |
| IsHardMaxAmount | Boolean | Indicates if a hard maximum limit is applied to this contract. | |
| IsInvoiceable | Boolean | Indicates if invoices can be created directly against this contract. | |
| IsReceivable | Boolean | Indicates if receipts can be created directly against this contract. | |
| AllowNonCatalogOnInvoice | Boolean | Indicates if non-catalog items can be added to invoices. | |
| ApplySupAndCommTermsToNonCatalogItems | Boolean | 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 | 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 | Amount value in BPOs is hidden from suppliers in the Ariba Network. | |
| HideUnitPrice | Boolean | Unit Price value in BPOs is hidden from suppliers in the Ariba Network. | |
| IncludeSubAgreementAccumulators | Boolean | Boolean to indicate if this contract wants to track the spend from its SubAgreements. | |
| IsHardReleaseMaxAmount | Boolean | Indicates if the release maximum amount is a hard constraint. | |
| IsHardReleaseMinAmount | Boolean | Indicates if the release minimum amount is a hard constraint. | |
| IsNonCatalogItemsAccumulated | Boolean | Indicates if non-catalog items can be accumulated against this contract. | |
| ExcludeChargesOnAvailableAmount | Boolean | Indicates whether to exclude charges from the available amount calculation. | |
| ExcludeTaxesOnAvailableAmount | Boolean | Indicates whether to exclude taxes from the available amount calculation. | |
| LimitType | String | How the contract limit is determined (Amount or Quantity).
The allowed values are Amount, Quantity. | |
| TermType | String | The term type for this contract (Supplier, Commodity, Item, or Catalog).
The allowed values are Supplier, Commodity, Item, Catalog. | |
| ReleaseType | String | The type of releases allowed for this contract (Yes for requisitions, No for receipts and invoices).
The allowed values are Yes, No. | |
| HierarchicalType | String | 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 | Maximum amount for all line items on this contract. | |
| MaxAmountCurrencyName | String | Currency name for the maximum amount. | |
| MaxAmountCurrencyUniqueName | String | Unique identifier of the currency for the maximum amount. | |
| MinAmount | Decimal | The minimum amount for all line items committed for the Master Agreement. | |
| MinAmountCurrencyName | String | Currency name for the minimum amount. | |
| MinAmountCurrencyUniqueName | String | Unique name of the currency for minimum amount. | |
| ReleaseMinAmount | Decimal | Release minimum amount value. | |
| ReleaseMinAmountCurrencyName | String | Currency name for the release minimum amount. | |
| ReleaseMinAmountCurrencyUniqueName | String | Unique name of the currency for release minimum amount. | |
| ReleaseMaxAmount | Decimal | Release maximum amount value. | |
| ReleaseMaxAmountCurrencyName | String | Currency name for the release maximum amount. | |
| ReleaseMaxAmountCurrencyUniqueName | String | Unique name of the currency for release maximum amount. | |
| PreloadAmount | Decimal | Preload amount value. | |
| PreloadAmountCurrencyName | String | Currency name for the preload amount. | |
| PreloadAmountCurrencyUniqueName | String | Unique name of the currency for preload amount. | |
| CurrencyName | String | Name of the contract currency. | |
| CurrencyUniqueName | String | Unique name of the contract currency. | |
| SupplierName | String | Name of the supplier for this contract. | |
| SupplierUniqueName | String | Unique identifier of the supplier for this contract. | |
| SupplierBuyerSystemId | String | Buyer system Id for this supplier. | |
| SupplierErpVendorId | String | ERP vendor Id for this supplier. | |
| SupplierAnId | String | Supplier network Id. | |
| SupplierLocationName | String | Name of the supplier location for this contract. | |
| SupplierLocationUniqueName | String | Unique identifier of the supplier location for this contract. | |
| SupplierLocationContactId | String | Contact Id for the supplier location. | |
| RequesterName | String | Name of the person who requested this contract. | |
| RequesterUniqueName | String | Unique identifier of the person who requested this contract. | |
| RequesterPasswordAdapter | String | Password adapter for the contract requester. | |
| PreparerName | String | Name of the person who prepared this contract. | |
| PreparerUniqueName | String | Unique identifier of the person who prepared this contract. | |
| PreparerPasswordAdapter | String | Password adapter for the contract preparer. | |
| PaymentTerms | String | Payment terms for this contract. | |
| SourcingDestinationName | String | Name of the sourcing destination for this contract. | |
| SourcingDestinationUniqueName | String | Unique identifier of the sourcing destination for this contract. | |
| MAState | Int | 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 | Number of days before expiration when users are notified. | |
| NotificationRecurringDays | Int | Number of days between recurring notifications. | |
| MinAvailableAmountNotificationDays | Int | Number of days before expiration when minimum amount notifications are sent. | |
| AvailableAmountNotificationPercent | Decimal | Percentage of maximum amount remaining at which notifications are sent. | |
| MinAvailableAmountNotificationPercent | Decimal | Minimum percentage amount required before expiration to avoid notifications. | |
| ReleaseTolerancePercent | Decimal | Percentage tolerance for release amounts before requiring additional approval. | |
| MaxAmountTolerancePercent | Decimal | Maximum amount tolerance percentage for this contract. | |
| MasterAgreementRequest | String | Reference to the original Master Agreement Request from which this MasterAgreement was created. | |
| ParentAgreement | String | Reference to the parent contract, if such a contract exists. | |
| PhysicalLocation | String | Stores the physical location of the contract. | |
| ProcurementUnit | String | The purchasing unit to which this document belongs. | |
| PurchaseOrg | String | Purchase organization for SAP ERP systems. | |
| SetId | String | Set identifier for PeopleSoft ERP systems. | |
| UseExternalIdForMA | Boolean | Id from external system. | |
| ForecastedSpendFrequencyName | String | Name of the forecasted spend frequency (e.g., quarterly, monthly). | |
| ForecastedSpendFrequencyUniqueName | String | Unique identifier of the forecasted spend frequency.
The allowed values are ANN, MON, QAN, SAN. | |
| ForecastedSpendSavingPercentage | Decimal | Percentage of anticipated savings for the entire contract. | |
| ForecastedSpendTotalAmount | Decimal | Total monetary amount of the forecasted spend. | |
| ForecastedSpendTotalAmountCurrencyName | String | Currency name for the forecasted spend total amount. | |
| ForecastedSpendTotalAmountCurrencyUniqueName | String | Unique identifier of the currency for the forecasted spend total amount. | |
| ForecastedSpendItems | String | Individual items within the forecasted spend breakdown. | |
| OrganizationIdsPartIds | String | Organization identifiers for the supplier. | |
| LastModified | Datetime | Date when the contract was last modified. | |
| ApprovedDate | Datetime | Date when the contract was approved. |