Establishing a Connection

Adding a Connection to SAP Ariba

To add a connection to SAP Ariba:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the SAP Ariba icon is not available, click the Add More icon to download and install the SAP Ariba connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to SAP Ariba

Set the following to connect:

API: Specify which API you would like the Sync App to retrieve SAP Ariba data from.
ANID: Your Ariba Network ID (required when connecting to Ariba Network APIs such as Purchase Orders Buyer, Purchase Orders Supplier, or Invoice Header Data Extraction).
Realm: The realm associated with your Ariba instance (required when connecting to instance-based APIs such as Operational Reporting for Procurement or Contract Compliance).
DataCenter: The data center where your account's data is hosted.
Environment: The development environment to use when connecting.

Authenticating to SAP Ariba

Authentication to SAP Ariba APIs is handled via OAuth. SAP Ariba's OAuth flow requires no user interaction.

OAuthClient

Set the AuthScheme to OAuthClient.

You need to register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

See Creating a Custom OAuth App for information about creating an application.

InitiateOAuth defaults to GETANDREFRESH for the OAuthClient authentication scheme.

Automatic OAuth

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

APIKey: The Application key in your app settings.
OAuthClientId: The OAuth Client Id in your app settings.
OAuthClientSecret: The OAuth Secret in your app settings.

When you connect, the Sync App automatically completes the OAuth process:

The Sync App obtains an access token from SAP Ariba and uses it to request data.
The Sync App refreshes the access token automatically when it expires.
The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

Manual OAuth

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

APIKey: The Application key in your app settings.
OAuthClientId: The OAuth Client Id in your app settings.
OAuthClientSecret: The OAuth Secret in your app settings.

Then call the GetOAuthAccessToken stored procedure. Set the GrantType input to client_credentials or openapi_2lo (available for legacy users). If not specified, GrantType defaults to client_credentials.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the Sync App automatically refresh the OAuth access token, set the following on the first data connection.

InitiateOAuth: REFRESH.
APIKey: The Application key in your app settings.
OAuthClientId: The OAuth Client Id in your app settings.
OAuthClientSecret: The OAuth Secret in your app settings.
OAuthAccessToken: The access token returned by GetOAuthAccessToken.
OAuthRefreshToken: The refresh token returned by GetOAuthAccessToken.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token. Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

APIKey: The Application key in your app settings.
OAuthClientId: The OAuth Client Id in your app settings.
OAuthClientSecret: The OAuth Secret in your app settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Creating a Custom OAuth App

Create a Custom OAuth App

Complete the following procedure to obtain the APIKey, OAuthClientId, and OAuthClientSecret.

Go to https://developer.ariba.com and sign in.
Click Manage (bottom icon on the left).
Click the + button next to the search field.
Fill in Application Name and Description, then click Submit.
Click Actions > Request API Access.
Select the API you want to retrieve data from. This corresponds to the API connection property.
Select your realm.
Click Submit.
Wait until the request is approved.
Once approved, click Actions > Generate OAuth Secret.
Save the values displayed for Application key, OAuth Client Id and OAuth Secret.

Advanced Features

This section details a selection of advanced features of the SAP Ariba Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to SAP Ariba and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models entities in the SAP Ariba API as views and stored procedures. These are defined in schema files, which are simple, text-based configuration files that are easy to customize.

Using Purchase Orders Buyer API V1

See Purchase Orders Buyer API V1 Data Model for the available entities in the Purchase Orders Buyer API V1.

Using Purchase Orders Supplier API V1

See Purchase Orders Supplier API V1 Data Model for the available entities in the Purchase Orders Supplier API V1.

Using Operational Reporting API For Procurement V2

See Operational Reporting API For Procurement V2 Data Model for the available entities and example view templates in the Operational Reporting API For Procurement V2.

Using Invoice Header Data Extraction API V1

See Invoice Header Data Extraction API V1 Data Model for the available entities in the Invoice Header Data Extraction API V1.

Using Contract Compliance API V1

See Contract Compliance API V1 Data Model for the available entities in the Contract Compliance API V1.

Purchase Orders Buyer API V1 Data Model

Overview

This section shows the available objects in the Purchase Orders Buyer API and provides more information about using SQL with it.

Key Features

The Sync App models SAP Ariba entities like documents, folders, and groups as relational views, allowing you to write SQL to query SAP Ariba data.
Stored procedures allow you to execute operations to SAP Ariba.
Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Views

Views are read-only tables that model SAP Ariba orders.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Ariba Procurement Connector for CData Sync Views


Name	Description
LineItems	Retrieves line-item information from purchase orders.
Orders	Retrieves purchase-order header information.

LineItems

Retrieves line-item information from purchase orders.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

DocumentNumber supports the '=' comparison operator.
SupplierANID supports the '=' comparison operator.
OrderStatus supports the '=' comparison operator.
RoutingStatus supports the '=' comparison operator.
StartDate and EndDate (when both are specified) support the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM LineItems WHERE DocumentNumber = 'DO240'

SELECT * FROM LineItems WHERE OrderStatus = 'CHANGED'

SELECT * FROM LineItems WHERE RoutingStatus = 'Sent'

SELECT * FROM LineItems WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'

Columns


Name	Type	References	Description
LineNumber [KEY]	Int		Position (counting from 1) of this item in an order. Used to maintain a reference between items in create and update OrderRequest documents.
DocumentNumber [KEY]	String	Orders.DocumentNumber	Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number.
Eanid	String		The European Article Number, EAN, barcode.
Unspsc	String		The United Nations Standard Products and Services Code, UNSPSC, classification.
Priority	Int		Priority indicator, used to drive the priority of the orders for the suppliers.
ProductIdentifier	String		Reference product number.
LineOfBusiness	String		Line of business.
ProductFamily	String		Product family.
ProductSubFamily	String		Product sub family.
ProductCode	String		Product code.
PartCategory	String		Part category.
PartType	String		Part type.
Category	String		Category.
SupplierPart	String		SupplierPartID is how the supplier identifies an item.
SupplierBatchId	String		An identifier from supplier to identify the material/goods produced in a single manufacturing run.
BuyerPartId	String		It represents a product in buyer system. This identifier is specified by the buyer.
BuyerBatchId	String		An identifier from buyer to identify the material/goods produced in a single manufacturing run.
ManufacturerName	String		The manufacturer's name.
ManufacturerPartId	String		The manufacturer's part number.
PlannerCode	String		Planner code.
PlannerDescription	String		Planner description.
Description	String		Description of the items.
MaterialGoAheadEndDate	Datetime		Date denoting the end of the material go-ahead period (go-ahead for purchase of input materials).
ProductionGoAheadEndDate	Datetime		Date denoting the end of the production go-ahead period.
AgreementId	String		The procurement system agreement ID for this request.
AgreementDate	Datetime		The date and time the agreement request was created. This is different from the effective and expiry date of the agreement.
NeedBy	Datetime		The date this item was requested for delivery.
RequestedDeliveryDate	Datetime		The date this item was requested for delivery.
RequestedShipmentDate	Datetime		The ship date requested by the buyer for the item.
PreviousAsnId	String		Previous ship notice ID.
PreviousAsnDate	Datetime		Previous ship notice date.
IsoCountryCode	String		The International Organization for Standardization (ISO) country code for the country in the shipping address.
ItemShipToStreet	String		The Street element is the street address of the ShipTo location where ordered products are to be delivered.
ItemShipToCity	String		The City element is the city where ordered products are to be shipped.
ItemShipToState	String		The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped.
ItemShipToCountry	String		The Country element is the country where goods are to be shipped.
ItemShipToCode	String		Item ship to code.
ItemShipToPostalCode	String		The PostalCode element is the postal or zip code where goods are to be shipped.
ItemShipToName	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products.
ItemReturnAuthorizationNumber	String		Return Authorization Number information for a line item.
ReleaseType	String		A string value to identify the type of release. The value will be either jit or forecast.
ItemLocation	String		Item location.
StorageLocation	String		Storage location.
Quantity	Double		How many items are desired. Supplier and Commodity level items in an order of type 'blanket' will use a default value of '1'. The quantity in this case will not be used to compute the sub total. The MaxAmount in the BlanketItemDetail will be used to indicate any line level amounts.
UnitOfMeasure	String		The UnitOfMeasure element contains the item Unit of Measure code as defined by the United Nations UOM standard.
PbqQuantity	Double		The PriceBasisQuantity element contains the quantity-based pricing for a line item. Quantity-based Pricing is commonly also referred to as Price-Based Quantity or PBQ. Quantity-based pricing allows the unit price of an item to be based on a different price unit quantity than 1.
PbqUOM	String		Unit of measure for the PriceBasisQuantity.
PbqConversionFactor	Double		Conversion factor for the PriceBasisQuantity.
ConfirmedQuantity	Double		Confirmed quantity.
PreviousReceivedQuantity	Double		Previous received quantity.
PreviousReceivedQuantityUom	String		Unit of measure for the previous received quantity.
CumulativeShipQuantity	Double		A number value to identify the cumulative quantity of all goods shipped against the scheduling agreement release over a period up to a certain date.
CumulativeReceivedQuantity	Double		A number value to identify the cumulative quantity of all goods received against the scheduling agreement released over a period up to a certain date.
CumulativeReceivedUom	String		Unit of measure for the cumulative received quantity.
UnitPriceConversionDate	Datetime		Price per unit of item conversion date.
UnitPriceAmount	Decimal		Price per unit of item amount.
UnitPriceApprox	Decimal		Price per unit of item approx.
UnitPriceCurrencyCode	String		Price per unit of item currency code.
AccountingDistributionAccountingName	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Name.
AccountingDistributionAccountingSegments	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Segments.
AccountingDistributionChargeConversionDate	Datetime		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge conversion date.
AccountingDistributionChargeAmount	Decimal		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge amount.
AccountingDistributionChargeApprox	Decimal		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge approx.
AccountingDistributionChargeCurrencyCode	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge currency code.
SerialNumberInfoMaximum	Double		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Maximum.
SerialNumberInfoMinimum	Double		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Minimum.
SerialNumberInfoProfile	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile. Can be profile, range, or list.
SerialNumberInfoValues	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Values.
SerialNumberInfoProfileType	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile type. Can be numeric or null.
SupplierANID	String		The supplier's ANID.
OrderStatus	String		Indicates what state of processing the order has reached.
RoutingStatus	String		Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.
StartDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.
EndDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.

Orders

Retrieves purchase-order header information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

DocumentNumber supports the '=' comparison operator.
SupplierANID supports the '=' comparison operator.
RoutingStatus supports the '=' comparison operator.
OrderStatus supports the '=' comparison operator.
StartDate and EndDate (when both are specified) support the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE DocumentNumber = 'DO240'

SELECT * FROM Orders WHERE RoutingStatus = 'Sent'

SELECT * FROM Orders WHERE OrderStatus = 'CHANGED'

SELECT * FROM Orders WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'

Columns


Name	Type	References	Description
VendorId	String		The supplier's vendor ID.
SupplierANID	String		The supplier's ANID.
SupplierName	String		The supplier's name.
ServiceId	Double		Service id.
DisputeId	Double		Dispute id.
DocumentNumber [KEY]	String		Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number.
PayloadId	String		An unique identifier for the document. This is copied directly from the cXML element of the original document.
PoVersion	Double		Specifies the order version number of change orders, starting with 1 for the original order.
Revision	String		Revision.
PoClosed	Bool		Po closed.
Settlement	String		Method of PO settlement.
IsRelease	Bool		Indicates whether the orderType is Release.
AttachmentCount	Int		Attachment count.
SystemId	String		The customer's system ID.
CustomerANID	String		The customer's ANID.
CustomerName	String		The customer's name.
EndPointId	String		The customer's endpoint ID.
PurchasingOrgCode	String		The customer's purchasing organization.
PurchasingGroupCode	String		The customer's purchasing group.
CompanyCode	String		The customer's buying entity.
BuyerANID	String		The buyer's ANID.
PurchasingAgentName	String		Name of contact whose role is purchasing agent.
Blanket	Bool		Blanket.
BlanketPoId	Double		Blanket po id.
ReleaseRequired	Bool		Used only if orderType is blanket, to indicate whether the blanket order requires releases (purchase orders). If yes, is specified, then the blanket order requires separate release orders before the supplier can act. If no, then the supplier can act on the blanket order itself. By default this value is unspecified.
NumberOfInvoices	Int		Number of invoices.
PaymentTerms	String		Net Terms or Payment Terms.
PaymentTermsExplanation	String		Free-form text describing the payment terms for information purposes.
SchedulingAgreement	Bool		Scheduling agreement.
TransportTerms	String		The transport information for the shipment described by the order and the ship notice. This information comes from the order specified by the buyer and has to be included in the ship notice, so that these can be edited by the supplier, if required. This information and possible changes have to be carried back to the buyer.
TransportTermsDesc	String		Transport terms description.
IsoCountryCode	String		The International Organization for Standardization (ISO) country code for the country in the shipping address.
PoShipToState	String		The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped.
PoShipToCountry	String		The Country element is the country where goods are to be shipped.
PoShipToCity	String		The City element is the city where ordered products are to be shipped.
PoShipToStreet	String		The Street element is the street address of the ShipTo location where ordered products are to be delivered.
PoShipToCode	String		Po ship to code.
PoShipToPostalCode	String		The PostalCode element is the postal or zip code where goods are to be shipped.
DocumentStatus	String		Document status.
DashboardStatus	String		Order Status indicates where the order stands with regards to your processing of the order.
RoutingStatus	String		Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.
OrderDate	Datetime		The date and time the order was created.
Created	Datetime		Date the order was created.
HideAmount	Bool		An extrinsic that allows you to mask values for the amount.
AmountAvailableConversionDate	Datetime		Amount available conversion date.
AmountAvailableAmount	Decimal		Amount available.
AmountAvailableApprox	Decimal		Amount available approx.
AmountAvailableCurrencyCode	String		Amount available currency code.
BalanceConversionDate	Datetime		In case of partially invoiced PO, the balance left on the PO to be invoiced conversion date.
BalanceAmount	Decimal		In case of partially invoiced PO, the balance left on the PO to be invoiced amount.
BalanceApprox	Decimal		In case of partially invoiced PO, the balance left on the PO to be invoiced approx.
BalanceCurrencyCode	String		In case of partially invoiced PO, the balance left on the PO to be invoiced currency code.
InvoicedAmountConversionDate	Datetime		Invoiced amount conversion date.
InvoicedAmountAmount	Decimal		Invoiced amount.
InvoicedAmountApprox	Decimal		Invoiced amount approx.
InvoicedAmountCurrencyCode	String		Invoiced amount currency code.
PoAmountConversionDate	Datetime		Total cost of the order conversion date.
PoAmountAmount	Decimal		Total cost of the order amount.
PoAmountApprox	Decimal		Total cost of the order approx.
PoAmountCurrencyCode	String		Total cost of the order currency code.
PoShipToNameKid	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Kid.
PoShipToNameValue	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Value.
PoShipToNameEncryptedValue	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Encrypted value.
OrderStatus	String		Indicates what state of processing the order has reached.
StartDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.
EndDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

SAP Ariba Procurement Connector for CData Sync Stored Procedures


Name	Description

GetOAuthAccessToken

Generates an OAuth access token token for a SAP Ariba API.

Input


Name	Type	Description
GrantType	String	Authorization grant type. The allowed values are client_credentials, openapi_2lo.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with a SAP Ariba API.

Input


Name	Type	Description
OAuthRefreshToken	String	The refresh token you received with the access token you wish to refresh.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

Purchase Orders Supplier API V1 Data Model

Overview

This section shows the available objects in the Purchase Orders Supplier API and provides more information about using SQL with it.

Key Features

The Sync App models SAP Ariba entities like documents, folders, and groups as relational views, allowing you to write SQL to query SAP Ariba data.
Stored procedures allow you to execute operations to SAP Ariba
Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Views

Views are read-only tables that model SAP Ariba orders.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Ariba Procurement Connector for CData Sync Views


Name	Description
LineItems	Retrieves line-item information from purchase orders.
Orders	Retrieves purchase-order header information.

LineItems

Retrieves line-item information from purchase orders.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

DocumentNumber supports the '=' comparison operator.
BuyerANID supports the '=' comparison operator.
OrderStatus supports the '=' comparison operator.
RoutingStatus supports the '=' comparison operator.
StartDate and EndDate (when both are specified) support the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM LineItems WHERE DocumentNumber = 'DO240'

SELECT * FROM LineItems WHERE OrderStatus = 'CHANGED'

SELECT * FROM LineItems WHERE RoutingStatus = 'Sent'

SELECT * FROM LineItems WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'

Columns


Name	Type	References	Description
LineNumber [KEY]	Int		Position (counting from 1) of this item in an order. Used to maintain a reference between items in create and update OrderRequest documents.
DocumentNumber [KEY]	String	Orders.DocumentNumber	Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number.
Eanid	String		The European Article Number, EAN, barcode.
Unspsc	String		The United Nations Standard Products and Services Code, UNSPSC, classification.
Priority	Int		Priority indicator, used to drive the priority of the orders for the suppliers.
ProductIdentifier	String		Reference product number.
LineOfBusiness	String		Line of business.
ProductFamily	String		Product family.
ProductSubFamily	String		Product sub family.
ProductCode	String		Product code.
PartCategory	String		Part category.
PartType	String		Part type.
Category	String		Category.
SupplierPart	String		SupplierPartID is how the supplier identifies an item.
SupplierBatchId	String		An identifier from supplier to identify the material/goods produced in a single manufacturing run.
BuyerPartId	String		It represents a product in buyer system. This identifier is specified by the buyer.
BuyerBatchId	String		An identifier from buyer to identify the material/goods produced in a single manufacturing run.
ManufacturerName	String		The manufacturer's name.
ManufacturerPartId	String		The manufacturer's part number.
PlannerCode	String		Planner code.
PlannerDescription	String		Planner description.
Description	String		Description of the items.
MaterialGoAheadEndDate	Datetime		Date denoting the end of the material go-ahead period (go-ahead for purchase of input materials).
ProductionGoAheadEndDate	Datetime		Date denoting the end of the production go-ahead period.
AgreementId	String		The procurement system agreement ID for this request.
AgreementDate	Datetime		The date and time the agreement request was created. This is different from the effective and expiry date of the agreement.
NeedBy	Datetime		The date this item was requested for delivery.
RequestedDeliveryDate	Datetime		The date this item was requested for delivery.
RequestedShipmentDate	Datetime		The ship date requested by the buyer for the item.
PreviousAsnId	String		Previous ship notice ID.
PreviousAsnDate	Datetime		Previous ship notice date.
IsoCountryCode	String		The International Organization for Standardization (ISO) country code for the country in the shipping address.
ItemShipToStreet	String		The Street element is the street address of the ShipTo location where ordered products are to be delivered.
ItemShipToCity	String		The City element is the city where ordered products are to be shipped.
ItemShipToState	String		The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped.
ItemShipToCountry	String		The Country element is the country where goods are to be shipped.
ItemShipToCode	String		Item ship to code.
ItemShipToPostalCode	String		The PostalCode element is the postal or zip code where goods are to be shipped.
ItemShipToName	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products.
ItemReturnAuthorizationNumber	String		Return Authorization Number information for a line item.
ReleaseType	String		A string value to identify the type of release. The value will be either jit or forecast.
ItemLocation	String		Item location.
StorageLocation	String		Storage location.
Quantity	Double		How many items are desired. Supplier and Commodity level items in an order of type 'blanket' will use a default value of '1'. The quantity in this case will not be used to compute the sub total. The MaxAmount in the BlanketItemDetail will be used to indicate any line level amounts.
UnitOfMeasure	String		The UnitOfMeasure element contains the item Unit of Measure code as defined by the United Nations UOM standard.
PbqQuantity	Double		The PriceBasisQuantity element contains the quantity-based pricing for a line item. Quantity-based Pricing is commonly also referred to as Price-Based Quantity or PBQ. Quantity-based pricing allows the unit price of an item to be based on a different price unit quantity than 1.
PbqUOM	String		Unit of measure for the PriceBasisQuantity.
PbqConversionFactor	Double		Conversion factor for the PriceBasisQuantity.
ConfirmedQuantity	Double		Confirmed quantity.
PreviousReceivedQuantity	Double		Previous received quantity.
PreviousReceivedQuantityUom	String		Unit of measure for the previous received quantity.
CumulativeShipQuantity	Double		A number value to identify the cumulative quantity of all goods shipped against the scheduling agreement release over a period up to a certain date.
CumulativeReceivedQuantity	Double		A number value to identify the cumulative quantity of all goods received against the scheduling agreement released over a period up to a certain date.
CumulativeReceivedUom	String		Unit of measure for the cumulative received quantity.
UnitPriceConversionDate	Datetime		Price per unit of item conversion date.
UnitPriceAmount	Decimal		Price per unit of item amount.
UnitPriceApprox	Decimal		Price per unit of item approx.
UnitPriceCurrencyCode	String		Price per unit of item currency code.
AccountingDistributionAccountingName	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Name.
AccountingDistributionAccountingSegments	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Segments.
AccountingDistributionChargeConversionDate	Datetime		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge conversion date.
AccountingDistributionChargeAmount	Decimal		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge amount.
AccountingDistributionChargeApprox	Decimal		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge approx.
AccountingDistributionChargeCurrencyCode	String		The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge currency code.
SerialNumberInfoMaximum	Double		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Maximum.
SerialNumberInfoMinimum	Double		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Minimum.
SerialNumberInfoProfile	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile. Can be profile, range, or list.
SerialNumberInfoValues	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Values.
SerialNumberInfoProfileType	String		The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile type. Can be numeric or null.
BuyerANID	String		The buyer's ANID.
OrderStatus	String		Indicates what state of processing the order has reached.
RoutingStatus	String		Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.
StartDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.
EndDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.

Orders

Retrieves purchase-order header information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

DocumentNumber supports the '=' comparison operator.
BuyerANID supports the '=' comparison operator.
RoutingStatus supports the '=' comparison operator.
OrderStatus support the '=' comparison operator.
StartDate and EndDate (when both are specified) supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE DocumentNumber = 'DO240'

SELECT * FROM Orders WHERE RoutingStatus = 'Sent'

SELECT * FROM Orders WHERE OrderStatus = 'CHANGED'

SELECT * FROM Orders WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'

Columns


Name	Type	References	Description
VendorId	String		The supplier's vendor ID.
SupplierANID	String		The supplier's ANID.
SupplierName	String		The supplier's name.
ServiceId	Double		Service id.
DisputeId	Double		Dispute id.
DocumentNumber [KEY]	String		Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number.
PayloadId	String		An unique identifier for the document. This is copied directly from the cXML element of the original document.
PoVersion	Double		Specifies the order version number of change orders, starting with 1 for the original order.
Revision	String		Revision.
PoClosed	Bool		Po closed.
Settlement	String		Method of PO settlement.
IsRelease	Bool		Indicates whether the orderType is Release.
AttachmentCount	Int		Attachment count.
SystemId	String		The customer's system ID.
CustomerANID	String		The customer's ANID.
CustomerName	String		The customer's name.
EndPointId	String		The customer's endpoint ID.
PurchasingOrgCode	String		The customer's purchasing organization.
PurchasingGroupCode	String		The customer's purchasing group.
CompanyCode	String		The customer's buying entity.
BuyerANID	String		The buyer's ANID.
PurchasingAgentName	String		Name of contact whose role is purchasing agent.
Blanket	Bool		Blanket.
BlanketPoId	Double		Blanket po id.
ReleaseRequired	Bool		Used only if orderType is blanket, to indicate whether the blanket order requires releases (purchase orders). If yes, is specified, then the blanket order requires separate release orders before the supplier can act. If no, then the supplier can act on the blanket order itself. By default this value is unspecified.
NumberOfInvoices	Int		Number of invoices.
PaymentTerms	String		Net Terms or Payment Terms.
PaymentTermsExplanation	String		Free-form text describing the payment terms for information purposes.
SchedulingAgreement	Bool		Scheduling agreement.
TransportTerms	String		The transport information for the shipment described by the order and the ship notice. This information comes from the order specified by the buyer and has to be included in the ship notice, so that these can be edited by the supplier, if required. This information and possible changes have to be carried back to the buyer.
TransportTermsDesc	String		Transport terms description.
IsoCountryCode	String		The International Organization for Standardization (ISO) country code for the country in the shipping address.
PoShipToState	String		The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped.
PoShipToCountry	String		The Country element is the country where goods are to be shipped.
PoShipToCity	String		The City element is the city where ordered products are to be shipped.
PoShipToStreet	String		The Street element is the street address of the ShipTo location where ordered products are to be delivered.
PoShipToCode	String		Po ship to code.
PoShipToPostalCode	String		The PostalCode element is the postal or zip code where goods are to be shipped.
DocumentStatus	String		Document status.
DashboardStatus	String		Order Status indicates where the order stands with regards to your processing of the order.
RoutingStatus	String		Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed.
OrderDate	Datetime		The date and time the order was created.
Created	Datetime		Date the order was created.
HideAmount	Bool		An extrinsic that allows you to mask values for the amount.
AmountAvailableConversionDate	Datetime		Amount available conversion date.
AmountAvailableAmount	Decimal		Amount available.
AmountAvailableApprox	Decimal		Amount available approx.
AmountAvailableCurrencyCode	String		Amount available currency code.
BalanceConversionDate	Datetime		In case of partially invoiced PO, the balance left on the PO to be invoiced conversion date.
BalanceAmount	Decimal		In case of partially invoiced PO, the balance left on the PO to be invoiced amount.
BalanceApprox	Decimal		In case of partially invoiced PO, the balance left on the PO to be invoiced approx.
BalanceCurrencyCode	String		In case of partially invoiced PO, the balance left on the PO to be invoiced currency code.
InvoicedAmountConversionDate	Datetime		Invoiced amount conversion date.
InvoicedAmountAmount	Decimal		Invoiced amount.
InvoicedAmountApprox	Decimal		Invoiced amount approx.
InvoicedAmountCurrencyCode	String		Invoiced amount currency code.
PoAmountConversionDate	Datetime		Total cost of the order conversion date.
PoAmountAmount	Decimal		Total cost of the order amount.
PoAmountApprox	Decimal		Total cost of the order approx.
PoAmountCurrencyCode	String		Total cost of the order currency code.
PoShipToNameKid	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Kid.
PoShipToNameValue	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Value.
PoShipToNameEncryptedValue	String		For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Encrypted value.
OrderStatus	String		Indicates what state of processing the order has reached.
StartDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.
EndDate	Datetime		Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

SAP Ariba Procurement Connector for CData Sync Stored Procedures


Name	Description

GetOAuthAccessToken

Generates an OAuth access token token for a SAP Ariba API.

Input


Name	Type	Description
GrantType	String	Authorization grant type. The allowed values are client_credentials, openapi_2lo.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with a SAP Ariba API.

Input


Name	Type	Description
OAuthRefreshToken	String	The refresh token you received with the access token you wish to refresh.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

Operational Reporting API For Procurement V2 Data Model

Overview

This section shows example available objects in the Operational Reporting API For Procurement and provides more information about using SQL with it.

This is a dynamic schema. The view templates included are examples for documentation purposes.

Key Features

The Sync App models SAP Ariba entities like documents, folders, and groups as relational tables and views, allowing you to write SQL to query SAP Ariba data.
Stored procedures allow you to execute operations to SAP Ariba.
Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Tables are statically defined to model resources like Views.

Views

Views are read-only tables that model SAP Ariba transaction data.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

Tables

The Sync App models the data in SAP Ariba as a list of tables in a relational database that can be queried using standard SQL statements.

SAP Ariba Procurement Connector for CData Sync Tables


Name	Description
Views	Get all view templates for a realm.

Views

Get all view templates for a realm.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ViewTemplateName supports the '=' comparison operator.
Status supports the '=' comparison operator.
DocumentType supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Views WHERE ViewTemplateName='Contract_SAP_createdRange_v1'
SELECT * FROM Views WHERE Status='published'
SELECT * FROM Views WHERE DocumentType='DirectOrder'

Insert

You can create views by executing INSERT statements and specifying the ViewTemplateName, Status, DocumentType, SelectAttributes and FilterExpressions. For example:

INSERT INTO Views (ViewTemplateName, Status, DocumentType, SelectAttributes, FilterExpressions) VALUES ('TestView','published','DirectOrder', '["SubmitDate"]','[{"name":"ExampleFilter","field":"UniqueName","op":"IN","defaultValue":["P011"]}]')

Update

You can update the status of views by executing UPDATE statements and specifying the ViewTemplateName and Status. For example:

UPDATE Views SET Status='published' WHERE ViewTemplateName='TestView'

Columns


Name	Type	ReadOnly	References	Description
ViewTemplateName [KEY]	String	False		The name of the view.
Type	String	False		The type of view template.
Status	String	False		Status of the view template.
DocumentType	String	False		The type of transaction data this view template queries.
SelectAttributes	String	False		The fields that will be included in the response to queries using this view template.
FilterExpressions	String	False		A collection of objects that defines filters for the view template.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Ariba Procurement Connector for CData Sync Views


Name	Description
ContractSAPcreatedRangev1	A 'system vsap' view template that queries 'Contract' transaction data.
ContractSAPupdatedRangev1	A 'system vsap' view template that queries 'Contract' transaction data.
CopyOrderSAPcreatedRange	A 'system vsap' view template that queries 'CopyOrder' transaction data.
CopyOrderSAPupdatedRange	A 'system vsap' view template that queries 'CopyOrder' transaction data.
DirectOrderSAPcreatedRange	A 'system vsap' view template that queries 'DirectOrder' transaction data.
DirectOrderSAPupdatedRange	A 'system vsap' view template that queries 'DirectOrder' transaction data.
ERPOrderSAPcreatedRange	A 'system vsap' view template that queries 'ERPOrder' transaction data.
ERPOrderSAPupdatedRange	A 'system vsap' view template that queries 'ERPOrder' transaction data.
InvoiceReconciliationSAPcreatedRange	A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.
InvoiceReconciliationSAPupdatedRange	A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.
ReceiptSAPcreatedRange	A 'system vsap' view template that queries 'Receipt' transaction data.
ReceiptSAPupdatedRange	A 'system vsap' view template that queries 'Receipt' transaction data.
ViewChildElements	Get all child elements for a specific view template.
ViewFields	Request a list of all supported document types or a list of all filter and selection fields, either for a single document type or for all document types, that can be used to create custom view templates.

ContractSAPcreatedRangev1

A 'system vsap' view template that queries 'Contract' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ContractSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ContractSAPcreatedRange WHERE IncludeInactive='True'

Columns

References Description Decimal Decimal Decimal Datetime String String Bool String String String String String String String String String String String String Decimal Decimal Decimal Datetime String String Datetime String String Decimal Decimal Decimal Datetime String String Datetime String String String Decimal Decimal Decimal Datetime String String String String String Decimal String String String String Bool String Decimal Decimal Decimal Datetime String Datetime Decimal Decimal Decimal Datetime String Decimal Decimal Decimal Datetime String Decimal Bool Bool String Datetime Decimal String String String Bool String Datetime Bool Datetime Datetime />


Name	Type style="white-space:nowrap">ForecastedSpend_TotalAmount_AmountInReportingCurrency
ForecastedSpend_TotalAmount_ApproxAmountInBaseCurrency
ForecastedSpend_TotalAmount_Amount
ForecastedSpend_TotalAmount_ConversionDate
ForecastedSpend_TotalAmount_Currency_UniqueName
Description	Description associated with the contract. style="white-space:nowrap">IsAutoRelease	This denotes if this contract is an Auto Release Contract. style="white-space:nowrap">InitialUniqueName	The ID of the contract when it was first created. This field is used for internal purpose only. style="white-space:nowrap">ForecastedSpend_Frequency_UniqueName
ExternalID	ExternalID is an Id from external system used while generating the UniqueName for the MA style="white-space:nowrap">SupplierLocation_State
SupplierLocation_Phone
SupplierLocation_Country_UniqueName
SupplierLocation_PostalCode
SupplierLocation_City
SupplierLocation_Fax
SupplierLocation_UniqueName
SupplierLocation_Lines
SupplierLocation_Name
SubPreloadAmount_AmountInReportingCurrency
SubPreloadAmount_ApproxAmountInBaseCurrency
SubPreloadAmount_Amount
SubPreloadAmount_ConversionDate
SubPreloadAmount_Currency_UniqueName
PaymentTerms_UniqueName
CreateDate	The date when a contract is created. style="white-space:nowrap">Attachments
TermType	The term type of a contract. style="white-space:nowrap">MaxAmount_AmountInReportingCurrency
MaxAmount_ApproxAmountInBaseCurrency
MaxAmount_Amount
MaxAmount_ConversionDate
MaxAmount_Currency_UniqueName
Name	The title of a contract. style="white-space:nowrap">TimeCreated	The time when a contract is created. style="white-space:nowrap">ParentAgreement_UniqueName
Requester_UniqueName	The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. style="white-space:nowrap">ExternalSourcingId	The ID of the contract request in the sourcing system. style="white-space:nowrap">MinAmount_AmountInReportingCurrency
MinAmount_ApproxAmountInBaseCurrency
MinAmount_Amount
MinAmount_ConversionDate
MinAmount_Currency_UniqueName
Currency_UniqueName
Supplier_UniqueName
Supplier_Name
Items
MaxAmountTolerancePercent	This denotes the amount above the MaxAmount allowing users to create releases against the contract. The Master Agreement will move to the Closed state when the tolerance is reached. A null value means the tolerance or the MaxAmount has not been set and the contract will stay Open until the Expiration Date or a user explicitly closes the contract. style="white-space:nowrap">ReleaseType	This determines the type of releases associated with the contract. style="white-space:nowrap">LineItems
StatusString	The approval state of a contract. Example: Processed, Open, or Closed. style="white-space:nowrap">SubAgreements
IsBlanketPurchaseOrder	This denotes if the created contract is a blanket purchase order. style="white-space:nowrap">PurchaseOrg_UniqueName
ReleaseMinAmount_AmountInReportingCurrency
ReleaseMinAmount_ApproxAmountInBaseCurrency
ReleaseMinAmount_Amount
ReleaseMinAmount_ConversionDate
ReleaseMinAmount_Currency_UniqueName
TimeUpdated	The time when a contract was last updated. style="white-space:nowrap">ReleaseMaxAmount_AmountInReportingCurrency
ReleaseMaxAmount_ApproxAmountInBaseCurrency
ReleaseMaxAmount_Amount
ReleaseMaxAmount_ConversionDate
ReleaseMaxAmount_Currency_UniqueName
PreloadAmount_AmountInReportingCurrency
PreloadAmount_ApproxAmountInBaseCurrency
PreloadAmount_Amount
PreloadAmount_ConversionDate
PreloadAmount_Currency_UniqueName
ForecastedSpend_SavingPercentage	This denotes the saving percent in spend forecast of a contract. style="white-space:nowrap">Active	Indicates whether a contract is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive contracts. Inactive contracts are considered as those that are deleted and do not appear in search results and contract choosers. style="white-space:nowrap">GlobalReleaseFlag	This denotes if releases can be made against this contract from partitions other than the partition where the contract was created in. If this flag is set to false, then only users in the same partition can create releases against the contract. If the flag is set to true then users in all of the partitions can create releases against this contract. style="white-space:nowrap">ProcurementUnit_UniqueName
ExpirationDate	This denotes the date on which contract is expired and no longer available for ordering. style="white-space:nowrap">ReleaseTolerancePercent	This denotes the percentage amount under which and over which a release can exceed the MinReleaseAmount and the MaxReleaseAmount before DefaultApprovers is added as an Approver. If the release exceeds those values within the tolerance, DefaultApprovers is added as a watcher. style="white-space:nowrap">UniqueName	The unique ID of a contract. Example: C123. style="white-space:nowrap">CompanyCode_UniqueName	The unique internal identifier for the SAP company code. style="white-space:nowrap">HierarchicalType	This denotes the hierarchical type of this contract. style="white-space:nowrap">Evergreen	This denotes if contract is in effect for ever. style="white-space:nowrap">Preparer_UniqueName	The user who creates a requisition and submits it for approval. style="white-space:nowrap">EffectiveDate	This denotes the date from which contract is available for release. style="white-space:nowrap">IncludeInactive	By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. style="white-space:nowrap">createdDateFrom	This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. style="white-space:nowrap">createdDateTo	This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ContractSAPupdatedRangev1

A 'system vsap' view template that queries 'Contract' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ContractSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ContractSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ForecastedSpend_TotalAmount_AmountInReportingCurrency	Decimal
ForecastedSpend_TotalAmount_ApproxAmountInBaseCurrency	Decimal
ForecastedSpend_TotalAmount_Amount	Decimal
ForecastedSpend_TotalAmount_ConversionDate	Datetime
ForecastedSpend_TotalAmount_Currency_UniqueName	String
Description	String		Description associated with the contract.
IsAutoRelease	Bool		This denotes if this contract is an Auto Release Contract.
InitialUniqueName	String		The ID of the contract when it was first created. This field is used for internal purpose only.
ForecastedSpend_Frequency_UniqueName	String
ExternalID	String		ExternalID is an Id from external system used while generating the UniqueName for the MA
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
SubPreloadAmount_AmountInReportingCurrency	Decimal
SubPreloadAmount_ApproxAmountInBaseCurrency	Decimal
SubPreloadAmount_Amount	Decimal
SubPreloadAmount_ConversionDate	Datetime
SubPreloadAmount_Currency_UniqueName	String
PaymentTerms_UniqueName	String
CreateDate	Datetime		The date when a contract is created.
Attachments	String
TermType	String		The term type of a contract.
MaxAmount_AmountInReportingCurrency	Decimal
MaxAmount_ApproxAmountInBaseCurrency	Decimal
MaxAmount_Amount	Decimal
MaxAmount_ConversionDate	Datetime
MaxAmount_Currency_UniqueName	String
Name	String		The title of a contract.
TimeCreated	Datetime		The time when a contract is created.
ParentAgreement_UniqueName	String
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
ExternalSourcingId	String		The ID of the contract request in the sourcing system.
MinAmount_AmountInReportingCurrency	Decimal
MinAmount_ApproxAmountInBaseCurrency	Decimal
MinAmount_Amount	Decimal
MinAmount_ConversionDate	Datetime
MinAmount_Currency_UniqueName	String
Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
Items	String
MaxAmountTolerancePercent	Decimal		This denotes the amount above the MaxAmount allowing users to create releases against the contract. The Master Agreement will move to the Closed state when the tolerance is reached. A null value means the tolerance or the MaxAmount has not been set and the contract will stay Open until the Expiration Date or a user explicitly closes the contract.
ReleaseType	String		This determines the type of releases associated with the contract.
LineItems	String
StatusString	String		The approval state of a contract. Example: Processed, Open, or Closed.
SubAgreements	String
IsBlanketPurchaseOrder	Bool		This denotes if the created contract is a blanket purchase order.
PurchaseOrg_UniqueName	String
ReleaseMinAmount_AmountInReportingCurrency	Decimal
ReleaseMinAmount_ApproxAmountInBaseCurrency	Decimal
ReleaseMinAmount_Amount	Decimal
ReleaseMinAmount_ConversionDate	Datetime
ReleaseMinAmount_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a contract was last updated.
ReleaseMaxAmount_AmountInReportingCurrency	Decimal
ReleaseMaxAmount_ApproxAmountInBaseCurrency	Decimal
ReleaseMaxAmount_Amount	Decimal
ReleaseMaxAmount_ConversionDate	Datetime
ReleaseMaxAmount_Currency_UniqueName	String
PreloadAmount_AmountInReportingCurrency	Decimal
PreloadAmount_ApproxAmountInBaseCurrency	Decimal
PreloadAmount_Amount	Decimal
PreloadAmount_ConversionDate	Datetime
PreloadAmount_Currency_UniqueName	String
ForecastedSpend_SavingPercentage	Decimal		This denotes the saving percent in spend forecast of a contract.
Active	Bool		Indicates whether a contract is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive contracts. Inactive contracts are considered as those that are deleted and do not appear in search results and contract choosers.
GlobalReleaseFlag	Bool		This denotes if releases can be made against this contract from partitions other than the partition where the contract was created in. If this flag is set to false, then only users in the same partition can create releases against the contract. If the flag is set to true then users in all of the partitions can create releases against this contract.
ProcurementUnit_UniqueName	String
ExpirationDate	Datetime		This denotes the date on which contract is expired and no longer available for ordering.
ReleaseTolerancePercent	Decimal		This denotes the percentage amount under which and over which a release can exceed the MinReleaseAmount and the MaxReleaseAmount before DefaultApprovers is added as an Approver. If the release exceeds those values within the tolerance, DefaultApprovers is added as a watcher.
UniqueName	String		The unique ID of a contract. Example: C123.
CompanyCode_UniqueName	String		The unique internal identifier for the SAP company code.
HierarchicalType	String		This denotes the hierarchical type of this contract.
Evergreen	Bool		This denotes if contract is in effect for ever.
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
EffectiveDate	Datetime		This denotes the date from which contract is available for release.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

CopyOrderSAPcreatedRange

A 'system vsap' view template that queries 'CopyOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM CopyOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM CopyOrderSAPcreatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
createdDateFrom	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
createdDateTo	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

CopyOrderSAPupdatedRange

A 'system vsap' view template that queries 'CopyOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM CopyOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM CopyOrderSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

DirectOrderSAPcreatedRange

A 'system vsap' view template that queries 'DirectOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM DirectOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM DirectOrderSAPcreatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
createdDateFrom	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
createdDateTo	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

DirectOrderSAPupdatedRange

A 'system vsap' view template that queries 'DirectOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM DirectOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM DirectOrderSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ERPOrderSAPcreatedRange

A 'system vsap' view template that queries 'ERPOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ERPOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ERPOrderSAPcreatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
createdDateFrom	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
createdDateTo	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ERPOrderSAPupdatedRange

A 'system vsap' view template that queries 'ERPOrder' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ERPOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ERPOrderSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value representing the current approval state of a purchase order. This field is used for internal purpose only.
InitialUniqueName	String		The ID of the purchase order when it was first created. This field is used for internal purpose only.
InvoicedState	String		The status indicating whether a line item is invoiced (fully or partially) or not invoiced.
SubmitDate	Datetime		The date when a purchase order is successfully submitted for approval.
ReceivedState	String		The status indicating whether a line item is received (either fully or partially) or not received.
HoldTillDate	Datetime		The date until which processing of a fully approved requisition is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
NumberReceivableOrders	Int		The number of orders that are not fully received.
OrderID	String		The unique ID of a purchase order. Example: PO456.
OrderStatusPunchOutDisabled	Bool		Indicates whether the punchout link on a purchase order is disabled.
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when a purchase order is created.
Conditions_UniqueName	String
Conditions_TAndCVersion	Int
Name	String		The title of a purchase order.
TotalCost_AmountInReportingCurrency	Decimal
TotalCost_ApproxAmountInBaseCurrency	Decimal
TotalCost_Amount	Decimal
TotalCost_ConversionDate	Datetime
TotalCost_Currency_UniqueName	String
OrderConfirmationState	String		The status of the order confirmation for a purchase order.
LastModified	Datetime		The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date.
TimeCreated	Datetime		The time when a purchase order is created.
AdvancedShipNoticeState	String		The status of the ship notice for an order.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
Version	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
InvoicedDate	Datetime		The date when an order was last invoiced.
UsePOLineNumberForIntegration	Bool		Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system.
AmountAccepted_AmountInReportingCurrency	Decimal
AmountAccepted_ApproxAmountInBaseCurrency	Decimal
AmountAccepted_Amount	Decimal
AmountAccepted_ConversionDate	Datetime
AmountAccepted_Currency_UniqueName	String
LineItems	String
OrderConfirmationStatusString	String		The status of the order confirmation associated with a purchase order.
ChangedBy_UniqueName	String
OrderedState	String		The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered.
ApprovedDate	Datetime		The date when a purchase order is fully approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
ResubmitDate	Datetime		The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders.
NumberCleared	Decimal		The number of invoiced items on an order that have been cleared after invoices are reconciled.
OrderMethodCategory	String		The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP.
RejectionReason	String		The reason provided by a supplier on Ariba Network while rejecting an order.
Active	Bool		Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers.
ReceivedDate	Datetime		The date when a shipment of an item was last received.
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items on an order.
UniqueName	String		The unique ID of a purchase order. Example: PO456.
ReportingCurrency_UniqueName	String
OrderedDate	Datetime		The date when an order is sent to the supplier.
ManuallyOrdered	Bool		Indicates whether an order needs to be processed manually.
IsFromExternalReq	Bool		Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices.
MasterAgreement_UniqueName	String
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
OriginatingSystem	String		The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available.
PaymentTerms_UniqueName	String
NumberReceivableLineItems	Int		The number of line items on a purchase order that are not fully received.
Attachments	String
AmountReconciled_AmountInReportingCurrency	Decimal
AmountReconciled_ApproxAmountInBaseCurrency	Decimal
AmountReconciled_Amount	Decimal
AmountReconciled_ConversionDate	Datetime
AmountReconciled_Currency_UniqueName	String
Supplier_UniqueName	String
Supplier_Name	String
AmountRejected_AmountInReportingCurrency	Decimal
AmountRejected_ApproxAmountInBaseCurrency	Decimal
AmountRejected_Amount	Decimal
AmountRejected_ConversionDate	Datetime
AmountRejected_Currency_UniqueName	String
StatusString	String		The status of a purchase order. Example: Ordering or Ordered.
PreOrdered	Bool		Indicates whether a purchasing card order originated from the buying solution and not an external system.
IsBlanketOrder	Bool		Indicates whether an order is a blanket purchase order.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
AmountInvoiced_AmountInReportingCurrency	Decimal
AmountInvoiced_ApproxAmountInBaseCurrency	Decimal
AmountInvoiced_Amount	Decimal
AmountInvoiced_ConversionDate	Datetime
AmountInvoiced_Currency_UniqueName	String
TimeUpdated	Datetime		The time when a purchase order was last updated.
OriginatingSystemReferenceID	String		The external system ID of an order associated with an imported requisition.
VersionNumber	Int		The version number of an order.
Type	String		The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder.
ExpirationDate	Datetime		The expiration date of a purchase order.
Closed	String		Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions.
IsServiceOrder	Bool		Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process.
Requisition_UniqueName	String
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
CompanyCode_UniqueName	String		The unique name for the SAP company code.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

InvoiceReconciliationSAPcreatedRange

A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM InvoiceReconcilationSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM InvoiceReconcilationSAPcreatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
RejectedDate	Datetime		The date when an invoice reconciliation was rejected.
ApprovedState	String		An integer value representing the current approval state of an invoice reconciliation. This field is used for internal purposes only. Possible numbers for the approvated state are: 1 - Composing, 2 - Submitted, 4 - Approved, 8 - Invalid, 16- Denied.
Invoice_UniqueName	String
InitialUniqueName	String		The ID of the invoice reconciliation when it was first created. This field is used for internal purposes only.
SubmitDate	Datetime		The date when an invoice reconciliation is successfully submitted for approval.
HoldTillDate	Datetime		The date until which processing of a fully approved invoice reconciliation is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
Payments	String
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when an invoice reconciliation is created.
Name	String		The title of an invoice reconciliation.
ExternalStatus	String		The status of this invoice reconciliation in the external system.
LastModified	Datetime		The date when an invoice reconciliation was last modified. Actions that lead to updates to the history record of an invoice reconciliation trigger changes to the last modified date.
TimeCreated	Datetime		The time when an invoice reconciliation is created.
PayloadID	String		The ID generated for documents transmitted to Ariba Network.
TaxAmount_AmountInReportingCurrency	Decimal
TaxAmount_ApproxAmountInBaseCurrency	Decimal
TaxAmount_Amount	Decimal
TaxAmount_ConversionDate	Datetime
TaxAmount_Currency_UniqueName	String
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
TaxDetails	String
PaidAmounts_AdjustmentAmount_Reason	String
PaidAmounts_AdjustmentAmount_Amount_AmountInReportingCurrency	Decimal
PaidAmounts_AdjustmentAmount_Amount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_AdjustmentAmount_Amount_Amount	Decimal
PaidAmounts_AdjustmentAmount_Amount_ConversionDate	Datetime
PaidAmounts_AdjustmentAmount_Amount_Currency_UniqueName	String
PaidAmounts_GrossAmount_AmountInReportingCurrency	Decimal
PaidAmounts_GrossAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_GrossAmount_Amount	Decimal
PaidAmounts_GrossAmount_ConversionDate	Datetime
PaidAmounts_GrossAmount_Currency_UniqueName	String
PaidAmounts_DiscountAmount_AmountInReportingCurrency	Decimal
PaidAmounts_DiscountAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_DiscountAmount_Amount	Decimal
PaidAmounts_DiscountAmount_ConversionDate	Datetime
PaidAmounts_DiscountAmount_Currency_UniqueName	String
PaidAmounts_NetAmount_AmountInReportingCurrency	Decimal
PaidAmounts_NetAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_NetAmount_Amount	Decimal
PaidAmounts_NetAmount_ConversionDate	Datetime
PaidAmounts_NetAmount_Currency_UniqueName	String
VATAmount_AmountInReportingCurrency	Decimal
VATAmount_ApproxAmountInBaseCurrency	Decimal
VATAmount_Amount	Decimal
VATAmount_ConversionDate	Datetime
VATAmount_Currency_UniqueName	String
LineItems	String
ChangedBy_UniqueName	String
ApprovedDate	Datetime		The date when an invoice reconciliation is fully approved.
TotalWithholdingTax_AmountInReportingCurrency	Decimal
TotalWithholdingTax_ApproxAmountInBaseCurrency	Decimal
TotalWithholdingTax_Amount	Decimal
TotalWithholdingTax_ConversionDate	Datetime
TotalWithholdingTax_Currency_UniqueName	String
ScheduledPaymentDate	Datetime		The scheduled payment date for a reconciled invoice.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purposes only.
ResubmitDate	Datetime		The date when an invoice is resubmitted for approval. An invoice is considered as resubmitted if a user edits a denied invoice and resubmits it for approval. Note: Invoices that are withdrawn by the preparer and submitted again are not considered as resubmitted invoices.
EligibleForDynamicDiscount	Bool		A flag used by Buyers to indicate if the supplier can ask for immediate remittance of this invoice reconciliation to get dynamic discounts.
NumberCleared	Decimal		The number of invoiced items that have been cleared after an invoice reconciliation is reconciled.
MaxDiscountApplicable_AmountInReportingCurrency	Decimal
MaxDiscountApplicable_ApproxAmountInBaseCurrency	Decimal
MaxDiscountApplicable_Amount	Decimal
MaxDiscountApplicable_ConversionDate	Datetime
MaxDiscountApplicable_Currency_UniqueName	String
DiscountAmount_AmountInReportingCurrency	Decimal
DiscountAmount_ApproxAmountInBaseCurrency	Decimal
DiscountAmount_Amount	Decimal
DiscountAmount_ConversionDate	Datetime
DiscountAmount_Currency_UniqueName	String
ServicePeriod	String
ApprovalRequests	String
Active	Bool		Indicates whether the invoice reconciliation is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive invoice reconciliations. Inactive invoice reconciliations are considered as those that are deleted and do not appear in search results and invoice reconciliation choosers.
ProcurementUnit_UniqueName	String
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items.
UniqueName	String		The unique identifier for an invoice reconciliation in the system.
TotalInvoiced_AmountInReportingCurrency	Decimal
TotalInvoiced_ApproxAmountInBaseCurrency	Decimal
TotalInvoiced_Amount	Decimal
TotalInvoiced_ConversionDate	Datetime
TotalInvoiced_Currency_UniqueName	String
ProcessedState	String		The current payment processing state for an invoice reconciliation after it has been reconciled. The following are the possible values for the processing state for an invoice reconciliation: - Unprocessed: The invoice reconciliation has not been processed for payment. - Rejected: The invoice reconciliation has been rejected by an approver. - Paying: The invoice reconciliation has been approved and payment is being processed. - Paid: The invoice reconciliation has been approved and invoiced amounts have been paid. - FailedPaying: The invoice reconciliation has been approved but payment for the invoiced amount has failed.
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
ProjectID	String		The ID of a project.
Attachments	String
SourcingStatusString	String		The status of a sourcing transaction in the sourcing solution. This field contains cXML updates received from the sourcing solution.
PaymentModel	Int		The payment model used for a payment request associated with an invoice reconciliation document. This field can contain one of the following values: -1 – Default, 0 - ExternalPay, 1 – LocalPay, or 2 - AribaNetworkPay.
RemittanceLocation_UniqueName	String
PaidDate	Datetime		The date when payment for a reconciled invoice was made.
ServiceLocation_State	String
ServiceLocation_Phone	String
ServiceLocation_Country_UniqueName	String
ServiceLocation_PostalCode	String
ServiceLocation_City	String
ServiceLocation_Fax	String
ServiceLocation_UniqueName	String
ServiceLocation_Lines	String
ServiceLocation_Name	String
Exceptions	String
Supplier_UniqueName	String
Supplier_Name	String
InvoiceDate	Datetime		The date when the invoice associated with an invoice reconciliation is created.
StatusString	String		The current status of an invoice reconciliation. Example: Approved or Reconciled.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purposes only.
TimeUpdated	Datetime		The time when an invoice reconciliation was last updated.
VersionNumber	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
TaxAccrualAmount_AmountInReportingCurrency	Decimal
TaxAccrualAmount_ApproxAmountInBaseCurrency	Decimal
TaxAccrualAmount_Amount	Decimal
TaxAccrualAmount_ConversionDate	Datetime
TaxAccrualAmount_Currency_UniqueName	String
Type	String		The internal name for the approvable document. For example, the internal name for an invoice reconciliation is ariba.invoicing.core.InvoiceReconciliation.
ProjectTitle	String		The title of a project.
IsAccruedOnIR	Bool		A flag that indicates if the amounts are accrued in an invoice reconciliation. Only NonPO Invoice's will have accrued amounts.
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
createdDateFrom	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
createdDateTo	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

InvoiceReconciliationSAPupdatedRange

A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM InvoiceReconcilationSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM InvoiceReconcilationSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
RejectedDate	Datetime		The date when an invoice reconciliation was rejected.
ApprovedState	String		An integer value representing the current approval state of an invoice reconciliation. This field is used for internal purposes only. Possible numbers for the approvated state are: 1 - Composing, 2 - Submitted, 4 - Approved, 8 - Invalid, 16- Denied.
Invoice_UniqueName	String
InitialUniqueName	String		The ID of the invoice reconciliation when it was first created. This field is used for internal purposes only.
SubmitDate	Datetime		The date when an invoice reconciliation is successfully submitted for approval.
HoldTillDate	Datetime		The date until which processing of a fully approved invoice reconciliation is withheld.
SupplierLocation_State	String
SupplierLocation_Phone	String
SupplierLocation_Country_UniqueName	String
SupplierLocation_PostalCode	String
SupplierLocation_City	String
SupplierLocation_Fax	String
SupplierLocation_UniqueName	String
SupplierLocation_Lines	String
SupplierLocation_Name	String
Payments	String
ChargeAmount_AmountInReportingCurrency	Decimal
ChargeAmount_ApproxAmountInBaseCurrency	Decimal
ChargeAmount_Amount	Decimal
ChargeAmount_ConversionDate	Datetime
ChargeAmount_Currency_UniqueName	String
CreateDate	Datetime		The date when an invoice reconciliation is created.
Name	String		The title of an invoice reconciliation.
ExternalStatus	String		The status of this invoice reconciliation in the external system.
LastModified	Datetime		The date when an invoice reconciliation was last modified. Actions that lead to updates to the history record of an invoice reconciliation trigger changes to the last modified date.
TimeCreated	Datetime		The time when an invoice reconciliation is created.
PayloadID	String		The ID generated for documents transmitted to Ariba Network.
TaxAmount_AmountInReportingCurrency	Decimal
TaxAmount_ApproxAmountInBaseCurrency	Decimal
TaxAmount_Amount	Decimal
TaxAmount_ConversionDate	Datetime
TaxAmount_Currency_UniqueName	String
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
TaxDetails	String
PaidAmounts_AdjustmentAmount_Reason	String
PaidAmounts_AdjustmentAmount_Amount_AmountInReportingCurrency	Decimal
PaidAmounts_AdjustmentAmount_Amount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_AdjustmentAmount_Amount_Amount	Decimal
PaidAmounts_AdjustmentAmount_Amount_ConversionDate	Datetime
PaidAmounts_AdjustmentAmount_Amount_Currency_UniqueName	String
PaidAmounts_GrossAmount_AmountInReportingCurrency	Decimal
PaidAmounts_GrossAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_GrossAmount_Amount	Decimal
PaidAmounts_GrossAmount_ConversionDate	Datetime
PaidAmounts_GrossAmount_Currency_UniqueName	String
PaidAmounts_DiscountAmount_AmountInReportingCurrency	Decimal
PaidAmounts_DiscountAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_DiscountAmount_Amount	Decimal
PaidAmounts_DiscountAmount_ConversionDate	Datetime
PaidAmounts_DiscountAmount_Currency_UniqueName	String
PaidAmounts_NetAmount_AmountInReportingCurrency	Decimal
PaidAmounts_NetAmount_ApproxAmountInBaseCurrency	Decimal
PaidAmounts_NetAmount_Amount	Decimal
PaidAmounts_NetAmount_ConversionDate	Datetime
PaidAmounts_NetAmount_Currency_UniqueName	String
VATAmount_AmountInReportingCurrency	Decimal
VATAmount_ApproxAmountInBaseCurrency	Decimal
VATAmount_Amount	Decimal
VATAmount_ConversionDate	Datetime
VATAmount_Currency_UniqueName	String
LineItems	String
ChangedBy_UniqueName	String
ApprovedDate	Datetime		The date when an invoice reconciliation is fully approved.
TotalWithholdingTax_AmountInReportingCurrency	Decimal
TotalWithholdingTax_ApproxAmountInBaseCurrency	Decimal
TotalWithholdingTax_Amount	Decimal
TotalWithholdingTax_ConversionDate	Datetime
TotalWithholdingTax_Currency_UniqueName	String
ScheduledPaymentDate	Datetime		The scheduled payment date for a reconciled invoice.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purposes only.
ResubmitDate	Datetime		The date when an invoice is resubmitted for approval. An invoice is considered as resubmitted if a user edits a denied invoice and resubmits it for approval. Note: Invoices that are withdrawn by the preparer and submitted again are not considered as resubmitted invoices.
EligibleForDynamicDiscount	Bool		A flag used by Buyers to indicate if the supplier can ask for immediate remittance of this invoice reconciliation to get dynamic discounts.
NumberCleared	Decimal		The number of invoiced items that have been cleared after an invoice reconciliation is reconciled.
MaxDiscountApplicable_AmountInReportingCurrency	Decimal
MaxDiscountApplicable_ApproxAmountInBaseCurrency	Decimal
MaxDiscountApplicable_Amount	Decimal
MaxDiscountApplicable_ConversionDate	Datetime
MaxDiscountApplicable_Currency_UniqueName	String
DiscountAmount_AmountInReportingCurrency	Decimal
DiscountAmount_ApproxAmountInBaseCurrency	Decimal
DiscountAmount_Amount	Decimal
DiscountAmount_ConversionDate	Datetime
DiscountAmount_Currency_UniqueName	String
ServicePeriod	String
ApprovalRequests	String
Active	Bool		Indicates whether the invoice reconciliation is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive invoice reconciliations. Inactive invoice reconciliations are considered as those that are deleted and do not appear in search results and invoice reconciliation choosers.
ProcurementUnit_UniqueName	String
AmountBilled_AmountInReportingCurrency	Decimal
AmountBilled_ApproxAmountInBaseCurrency	Decimal
AmountBilled_Amount	Decimal
AmountBilled_ConversionDate	Datetime
AmountBilled_Currency_UniqueName	String
NextVersion	String
NumberBilled	Decimal		The total number of invoiced items.
UniqueName	String		The unique identifier for an invoice reconciliation in the system.
TotalInvoiced_AmountInReportingCurrency	Decimal
TotalInvoiced_ApproxAmountInBaseCurrency	Decimal
TotalInvoiced_Amount	Decimal
TotalInvoiced_ConversionDate	Datetime
TotalInvoiced_Currency_UniqueName	String
ProcessedState	String		The current payment processing state for an invoice reconciliation after it has been reconciled. The following are the possible values for the processing state for an invoice reconciliation: - Unprocessed: The invoice reconciliation has not been processed for payment. - Rejected: The invoice reconciliation has been rejected by an approver. - Paying: The invoice reconciliation has been approved and payment is being processed. - Paid: The invoice reconciliation has been approved and invoiced amounts have been paid. - FailedPaying: The invoice reconciliation has been approved but payment for the invoiced amount has failed.
AmountCleared_AmountInReportingCurrency	Decimal
AmountCleared_ApproxAmountInBaseCurrency	Decimal
AmountCleared_Amount	Decimal
AmountCleared_ConversionDate	Datetime
AmountCleared_Currency_UniqueName	String
ProjectID	String		The ID of a project.
Attachments	String
SourcingStatusString	String		The status of a sourcing transaction in the sourcing solution. This field contains cXML updates received from the sourcing solution.
PaymentModel	Int		The payment model used for a payment request associated with an invoice reconciliation document. This field can contain one of the following values: -1 – Default, 0 - ExternalPay, 1 – LocalPay, or 2 - AribaNetworkPay.
RemittanceLocation_UniqueName	String
PaidDate	Datetime		The date when payment for a reconciled invoice was made.
ServiceLocation_State	String
ServiceLocation_Phone	String
ServiceLocation_Country_UniqueName	String
ServiceLocation_PostalCode	String
ServiceLocation_City	String
ServiceLocation_Fax	String
ServiceLocation_UniqueName	String
ServiceLocation_Lines	String
ServiceLocation_Name	String
Exceptions	String
Supplier_UniqueName	String
Supplier_Name	String
InvoiceDate	Datetime		The date when the invoice associated with an invoice reconciliation is created.
StatusString	String		The current status of an invoice reconciliation. Example: Approved or Reconciled.
PreviousVersion	String
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purposes only.
TimeUpdated	Datetime		The time when an invoice reconciliation was last updated.
VersionNumber	Int		The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only.
TaxAccrualAmount_AmountInReportingCurrency	Decimal
TaxAccrualAmount_ApproxAmountInBaseCurrency	Decimal
TaxAccrualAmount_Amount	Decimal
TaxAccrualAmount_ConversionDate	Datetime
TaxAccrualAmount_Currency_UniqueName	String
Type	String		The internal name for the approvable document. For example, the internal name for an invoice reconciliation is ariba.invoicing.core.InvoiceReconciliation.
ProjectTitle	String		The title of a project.
IsAccruedOnIR	Bool		A flag that indicates if the amounts are accrued in an invoice reconciliation. Only NonPO Invoice's will have accrued amounts.
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ReceiptSAPcreatedRange

A 'system vsap' view template that queries 'Receipt' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
createdDateFrom supports the '=' comparison operator.
createdDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ReceiptSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ReceiptSAPcreatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value that represents the current approval state of a receipt. This field is used for internal purpose only.
ReceiptItems	String
ProcessedState	String		The post-approval processing state of a receipt. The post-approval processing states can be one of the following for receipts imported from external systems: 0 - Unprocessed, 1 – Awaiting Processing, 2 – Processing, 3 – Failed Processing, or 4 - Processed. Note: Receipts created in the buying solution move to the Processed state after they are fully approved.
MasterAgreement_UniqueName	String
InitialUniqueName	String		The ID of the receipt when it was first created. This field is used for internal purpose only.
SubmitDate	Datetime		The date when a receipt was successfully submitted for approval.
HoldTillDate	Datetime		The date until which post-approval processing of the associated requisition was withheld.
CreateDate	Datetime		The date when a receipt was created.
Attachments	String
IsReceiptPushFailed	Bool		Indicates whether a receipt failed to be pushed to the external ERP system.
Name	String		The title of the receipt.
IsInTransitionToManual	Bool		Indicates the transition stage of a receipt in which line items configured for auto-receiving transition from automatic receiving to the manual receiving state. This field is set to true when a user creates manual receipts for line items that are configured for automatic receiving.
LastModified	Datetime		The date when a receipt was last modified. Actions that lead to updates to the history record or the comments section of a receipt trigger changes to the last modified date.
TimeCreated	Datetime		The time when a receipt was created.
GoodsReturnTrackingNumber	String		The goods return tracking number to identify items returned to suppliers.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
CloseOrder	Bool		Indicates whether the buying solution automatically closes an order for further receiving after the associated receipts are fully approved.
ERPReceiptNumber	String		The ID assigned to a receipt imported from the external ERP system.
DueDate	Datetime		The due date for creation of an automatic receipt.
Order_UniqueName	String
StatusString	String		The approval state of a receipt. Example: Composing, Submitted, or Approved.
ChangedBy_UniqueName	String
ApprovedDate	Datetime		The date when the status of a receipt changed to Approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
RecentReceiveDate	Datetime		The most recent date when a receipt transaction was performed for a line item.
PreviousVersion	String
ResubmitDate	Datetime		The date when a receipt was resubmitted for approval. A receipt is considered as resubmitted when a user edits a denied receipt and resubmits it for approval. Note: Receipts that are withdrawn by the preparer and submitted again are not considered as resubmitted receipts.
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
TimeUpdated	Datetime		The time when a receipt was last updated.
VersionNumber	Int		Indicates whether the changes for the receipt version are internal to the buying solution.
ApprovalRequests	String
Active	Bool		Indicates whether a receipt is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive receipts. Inactive receipts are considered as those that are deleted and do not appear in search results and receipt choosers.
IsImported	Bool		Indicates whether a receipt is imported from an external system
Type	String		The internal name for the approvable document. For example, the internal name for receipt is ariba.receiving.core.Receipt.
ANSentState	String		The state of transmission of a receipt to Ariba Network. This field can contain one of the following values: Sent (2), Sending (4), or Failed (8).
ProcurementUnit_UniqueName	String
NextVersion	String
IsUnitPriceChanged	Bool		Indicates whether the unit price of a line item on a receipt was edited.
UniqueName	String		The unique ID of a receipt. Example: RC678.
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
createdDateFrom	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
createdDateTo	Datetime		This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ReceiptSAPupdatedRange

A 'system vsap' view template that queries 'Receipt' transaction data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

IncludeInactive supports the '=' comparison operator.
updatedDateFrom supports the '=' comparison operator.
updatedDateTo supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ReceiptSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ReceiptSAPupdatedRange WHERE IncludeInactive='True'

Columns


Name	Type	References	Description
ApprovedState	String		An integer value that represents the current approval state of a receipt. This field is used for internal purpose only.
ReceiptItems	String
ProcessedState	String		The post-approval processing state of a receipt. The post-approval processing states can be one of the following for receipts imported from external systems: 0 - Unprocessed, 1 – Awaiting Processing, 2 – Processing, 3 – Failed Processing, or 4 - Processed. Note: Receipts created in the buying solution move to the Processed state after they are fully approved.
MasterAgreement_UniqueName	String
InitialUniqueName	String		The ID of the receipt when it was first created. This field is used for internal purpose only.
SubmitDate	Datetime		The date when a receipt was successfully submitted for approval.
HoldTillDate	Datetime		The date until which post-approval processing of the associated requisition was withheld.
CreateDate	Datetime		The date when a receipt was created.
Attachments	String
IsReceiptPushFailed	Bool		Indicates whether a receipt failed to be pushed to the external ERP system.
Name	String		The title of the receipt.
IsInTransitionToManual	Bool		Indicates the transition stage of a receipt in which line items configured for auto-receiving transition from automatic receiving to the manual receiving state. This field is set to true when a user creates manual receipts for line items that are configured for automatic receiving.
LastModified	Datetime		The date when a receipt was last modified. Actions that lead to updates to the history record or the comments section of a receipt trigger changes to the last modified date.
TimeCreated	Datetime		The time when a receipt was created.
GoodsReturnTrackingNumber	String		The goods return tracking number to identify items returned to suppliers.
Requester_UniqueName	String		The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created.
CloseOrder	Bool		Indicates whether the buying solution automatically closes an order for further receiving after the associated receipts are fully approved.
ERPReceiptNumber	String		The ID assigned to a receipt imported from the external ERP system.
DueDate	Datetime		The due date for creation of an automatic receipt.
Order_UniqueName	String
StatusString	String		The approval state of a receipt. Example: Composing, Submitted, or Approved.
ChangedBy_UniqueName	String
ApprovedDate	Datetime		The date when the status of a receipt changed to Approved.
PreviousApprovalRequestsVersion	Int		The version number for the previous version of the approval request. This field is used for internal purpose only.
RecentReceiveDate	Datetime		The most recent date when a receipt transaction was performed for a line item.
PreviousVersion	String
ResubmitDate	Datetime		The date when a receipt was resubmitted for approval. A receipt is considered as resubmitted when a user edits a denied receipt and resubmits it for approval. Note: Receipts that are withdrawn by the preparer and submitted again are not considered as resubmitted receipts.
ApprovalRequestsVersion	Int		The version of an approval request when it was generated. This field is used for internal purpose only.
TimeUpdated	Datetime		The time when a receipt was last updated.
VersionNumber	Int		Indicates whether the changes for the receipt version are internal to the buying solution.
ApprovalRequests	String
Active	Bool		Indicates whether a receipt is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive receipts. Inactive receipts are considered as those that are deleted and do not appear in search results and receipt choosers.
IsImported	Bool		Indicates whether a receipt is imported from an external system
Type	String		The internal name for the approvable document. For example, the internal name for receipt is ariba.receiving.core.Receipt.
ANSentState	String		The state of transmission of a receipt to Ariba Network. This field can contain one of the following values: Sent (2), Sending (4), or Failed (8).
ProcurementUnit_UniqueName	String
NextVersion	String
IsUnitPriceChanged	Bool		Indicates whether the unit price of a line item on a receipt was edited.
UniqueName	String		The unique ID of a receipt. Example: RC678.
Preparer_UniqueName	String		The user who creates a requisition and submits it for approval.
IncludeInactive	Bool		By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses.
updatedDateFrom	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'.
updatedDateTo	Datetime		This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'.

ViewChildElements

Get all child elements for a specific view template.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ViewTemplateName supports the '=','IN' comparison operators. It is required to specify this column in the criteria.

For example, the following query is processed server side:

SELECT * FROM ViewChildElements WHERE ViewTemplateName='Requisition_SAP_createdRange_v2'

Columns


Name	Type	References	Description
ViewTemplateName [KEY]	String		The name of the view.
ChildElement [KEY]	String		A child element/array of documents in the view template in dot notation.
Description	String		A description of the child element.

ViewFields

Request a list of all supported document types or a list of all filter and selection fields, either for a single document type or for all document types, that can be used to create custom view templates.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ViewTemplateName supports the '=' comparison operator.
DocumentType supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM ViewFields WHERE ViewTemplateName='Contract_SAP_createdRange_v1'
SELECT * FROM ViewFields WHERE DocumentType='DirectOrder'

Columns


Name	Type	References	Description
ViewTemplateName	String		The view template name.
DocumentType	String		Supported document type.
Name	String		The name of the field.
FieldName	String		The field's formatted name.
Description	String		The field's description.
Type	String		The type of the field.
Size	Int		The maximum length in characters if this is a string field.
AllowedValues	String		Permissible values if this field accepts only specific values.
IsCustomField	Bool		Whether this field is a custom field.
Precision	String		The field's precision.
Scale	String		The field's scale.
Source	String		The field's JSON repeat path source.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

SAP Ariba Procurement Connector for CData Sync Stored Procedures


Name	Description
CreateChildElementSchema	Creates a schema file for an array of documents in the view template.

CreateChildElementSchema

Creates a schema file for an array of documents in the view template. It is possible to vertically flatten existing view templates using the Sync App's CreateChildElementSchema stored procedure.

Vertical flattening enable you to retrieve array of documents as if they were a separate table.

The schema files generated by the procedure are plain text configuration files that are easy to modify.

You can invoke the procedure using EXECUTE. It accepts these five parameters:

ViewTemplateName is the name of an existing view template.
ChildElement is a child element/array of documents in the view template in dot notation.
TableName is the name of the new table to be created.
FileName is the absolute path where you want to save the generated schema.
FileStream is an instance of an output stream where file data is written to.

The below result set and API response JSON structure show that the example view includes a LineItems child element, and, deeper in, another SplitAccountings child element.

+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| UniqueName                                                                       | LineItems                                                                        |
+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------
| PO11                                                                             | [  {    "TaxDetail.Description": "",    "BasePrice": {      "AmountInR..         |
| PO12                                                                             | [  {    "TaxDetail.Description": "",    "BasePrice": {      "AmountInR..         |
| PO13                                                                             | [  {    "TaxDetail.Description": "",    "BasePrice": {      "AmountInR..         |
| PO14                                                                             | [  {    "TaxDetail.Description": "",    "BasePrice": {      "AmountInR..         |
| PO15                                                                             | [  {    "TaxDetail.Description": "",    "BasePrice": {      "AmountInR..         |
+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------

{
    "Records": [
        {
            "ApprovedState": "Approved",
            "LineItems": [
                {
                    "SplitAccountings": [
                        {
                            "NumberInCollection": 1,
                        }
                    ],
                    "Description.Description": "Sample",

To generate a schema for the LineItems array of documents, you can execute the below query:

EXECUTE CreateChildElementSchema ViewTemplateName='View', ChildElement='LineItems', TableName = 'View_LineItems', FileName='C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View_LineItems.rsd'

To generate a schema for the LineItems.SplitAccountings array of documents, you can execute the below query:

EXECUTE CreateChildElementSchema ViewTemplateName='View', ChildElement='LineItems.SplitAccountings', TableName = 'View_LineItems_SplitAccountings', FileName='C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View_LineItems_SplitAccountings.rsd'

Additionally, you can query the ViewChildElements view to discover array of documents in a view template and valid values for the ChildElement input. For example:

SELECT * FROM ViewChildElements WHERE ViewTemplateName='OrderView'

Note that for the generated schema files to be used in queries they must be present in the API schema folder within the Location connection property.

Assuming the Location connection property points to "C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema", the generated schema file should be within an "OperationalReportingAPIForProcurement-V2" folder.

If an array or object name in the path contains a '.' (dot) character, you can escape the dot by enclosing the name in square brackets, as an example:

ChildElement='[ObjectN.ame].Array'

{
    "Records": [
        {
            "ObjectN.ame": [
                {
                    "Array": [
                        {
                            "NumberInCollection": 1,
                        }
                    ],
                    "Description.Description": "Sample",

Input


Name	Type	Description
ViewTemplateName	String	The name of an existing view template.
ChildElement	String	A child element/array of documents in the view template in dot notation. For example, 'LineItems.SplitAccountings'
TableName	String	The name for the new table. For example, 'View_LineItems_SplitAccountings'.
FileName	String	The file name, if generating relative to Location, or absolute path where you want to save the generated schema. For example, 'C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View_LineItems_SplitAccountings.rsd'.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output encoded in base64.
Result	String	The result of the operation.

CreateSchema

Creates a schema file for the specified table or view.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input


Name	Type	Description
TableName	String	The name for the new table. For example, 'View'.
FileName	String	The file name, if generating relative to Location, or absolute path where you want to save the generated schema. For example, 'C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View.rsd'.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output encoded in base64.
Result	String	The result of the operation.

DownloadProcurementDocumentAttachment

Allows you to retrieve attachment documents that are part of procurement approvables.

Input


Name	Type	Description
Realm	String	Identify requested realm.
AttachmentId	String	The unique attachment ID or attachment ID value which is provided as part of the document's attachment data. QueryType and ApprovableId must also be specified if the attachment ID instead of the unique attachment ID is specified.
QueryType	String	Specifies the document type of the historical document whose attachment you wish to retrieve. The allowed values are invoices, requisitions, receipts, directOrders, copyOrders, ERPOrders, invoiceReconciliations.
ApprovableId	String	The unique identifier specifying the historical document whose attachment you wish to retrieve, which you can get from the document's UniqueName field.
LocalPath	String	The absolute location where you want to save the file in.

Result Set Columns


Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output encoded in base64.
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

GetOAuthAccessToken

Generates an OAuth access token token for a SAP Ariba API.

Input


Name	Type	Description
GrantType	String	Authorization grant type. The allowed values are client_credentials, openapi_2lo.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with a SAP Ariba API.

Input


Name	Type	Description
OAuthRefreshToken	String	The refresh token you received with the access token you wish to refresh.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

Invoice Header Data Extraction API V1 Data Model

Overview

This section shows the available objects in the Invoice Header Data Extraction API and provides more information about using SQL with it.

Key Features

The Sync App models SAP Ariba entities like invoices as relational views, allowing you to write SQL to query SAP Ariba data.
Stored procedures allow you to execute operations to SAP Ariba.
Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Views

Views are read-only tables that model SAP Ariba invoices.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Ariba Procurement Connector for CData Sync Views


Name	Description
Invoices	Retrieves invoice header information.

Invoices

Retrieves invoice header information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

DocumentNumber supports the '=' comparison operator.
SupplierANID supports the '=' comparison operator.
BuyerANID supports the '=' comparison operator.
CreatedDate supports the '>=', '>', '=', '<', '<=' comparison operators.
RoutingStatus supports the '=' comparison operator.
DocumentStatus supports the '=' comparison operator.
DocumentStatusDate supports the '>', '<' comparison operators.
Purpose supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Invoices WHERE DocumentNumber = 'I0123'

SELECT * FROM Invoices WHERE RoutingStatus = 'Sent'

SELECT * FROM Invoices WHERE Purpose = 'creditMemo'

SELECT * FROM Invoices WHERE CreatedDate > '2000-01-01T00:00:00' AND CreatedDate < '2000-01-15T01:00:00'

Columns


Name	Type	References	Description
DocumentNumber [KEY]	String		Invoice document number.
SupplierName	String		First name and last name of the supplier.
SupplierANID	String		ANID of the supplier.
BuyerName	String		First name and last name of the buyer.
BuyerANID	String		ANID of the buyer.
CreatedDate	Datetime		Date on which the invoice is created on SAP Business Network.
DocumentDate	Datetime		Invoice date on the cXML document.
RoutingStatus	String		Routing status of the invoice.
DocumentStatus	String		Processing status of the invoice.
PayloadId	String		Payload ID of the invoice.
NetTerms	Int		Numbers of days till payment is due.
DocumentStatusComments	String		Comments about the last document status update.
DocumentStatusDate	Datetime		Date of the last status update of the document.
ExternalInvoiceNumber	String		External invoice number related to the invoice.
ExternalOrderNumber	String		External reference number related to the purchase order of the invoice.
NumberOfItems	Int		Number of items on the invoice.
Purpose	String		Purpose of the invoice.
SignFromCountry	String		Country/region of origin of the invoice.
SignToCountry	String		Country/region of destination of the invoice.
TaxAmount	Decimal		Tax amount in the invoice.
TaxCurrencyCode	String		Currency code for the tax amount in the invoice.
TotalAmount	Decimal		Total amount in the invoice.
TotalAmountCurrencyCode	String		Currency code for the total amount in the invoice.
Type	String		Type of invoice.
PaymentDueDate	Datetime		The date on which the buyer plans to make the payment to the supplier.
BuyerVatID	String		The VAT id of the buyer.
SupplierVatID	String		The VAT id of the supplier.
BuyerTaxID	String		The Tax id or VAT id of the organization that ordered the items or services.
SupplierTaxID	String		The Tax id or VAT id of the supplier.
FromAddressName	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address name.
FromAddressStreet1	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address street1.
FromAddressStreet2	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address street2.
FromAddressStreet3	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address street3.
FromAddressStreet4	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address street4.
FromAddressCity	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address city.
FromAddressState	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address state.
FromAddressPostalCode	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address postal code.
FromAddressCountry	String		The address used by supplier companies to invoice the buyer companies on the invoice header. From address country.
SoldToAddressName	String		The address of the organization that ordered the items or services. Sold-to address name.
SoldToAddressStreet1	String		The address of the organization that ordered the items or services. Sold-to address street1.
SoldToAddressStreet2	String		The address of the organization that ordered the items or services. Sold-to address street2.
SoldToAddressStreet3	String		The address of the organization that ordered the items or services. Sold-to address street3.
SoldToAddressStreet4	String		The address of the organization that ordered the items or services. Sold-to address street4.
SoldToAddressCity	String		The address of the organization that ordered the items or services. Sold-to address city.
SoldToAddressState	String		The address of the organization that ordered the items or services. Sold-to address state.
SoldToAddressPostalCode	String		The address of the organization that ordered the items or services. Sold-to address postal code.
SoldToAddressCountry	String		The address of the organization that ordered the items or services. Sold-to address country.
BillToAddressName	String		The address of the company being billed. Bill-to address name.
BillToAddressStreet1	String		The address of the company being billed. Bill-to address street1.
BillToAddressStreet2	String		The address of the company being billed. Bill-to address street2.
BillToAddressStreet3	String		The address of the company being billed. Bill-to address street3.
BillToAddressStreet4	String		The address of the company being billed. Bill-to address street4.
BillToAddressCity	String		The address of the company being billed. Bill-to address city.
BillToAddressState	String		The address of the company being billed. Bill-to address state.
BillToAddressPostalCode	String		The address of the company being billed. Bill-to address postal code.
BillToAddressCountry	String		The address of the company being billed. Bill-to address country.
RemitToAddressName	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address name.
RemitToAddressStreet1	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address street1.
RemitToAddressStreet2	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address street2.
RemitToAddressStreet3	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address street3.
RemitToAddressStreet4	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address street4.
RemitToAddressCity	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address city.
RemitToAddressState	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address state.
RemitToAddressPostalCode	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address postal code.
RemitToAddressCountry	String		The address used by buyer companies to remit payments to supplier companies. Remit-to address country.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

SAP Ariba Procurement Connector for CData Sync Stored Procedures


Name	Description

GetOAuthAccessToken

Generates an OAuth access token token for a SAP Ariba API.

Input


Name	Type	Description
GrantType	String	Authorization grant type. The allowed values are client_credentials, openapi_2lo.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with a SAP Ariba API.

Input


Name	Type	Description
OAuthRefreshToken	String	The refresh token you received with the access token you wish to refresh.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

Contract Compliance API V1 Data Model

Overview

This section shows the available objects in the Contract Compliance API and provides more information about using SQL with it.

Key Features

The Sync App models SAP Ariba entities like contract requests and contracts as relational tables and views, allowing you to write SQL to query SAP Ariba data.
Stored procedures allow you to execute operations to SAP Ariba.
Live connectivity to these objects means any changes to your account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Tables are statically defined to model resources like contract requests and contract request line items.

Views

Views are read-only tables that model resources such as items within forecasted spend breakdowns.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

Tables

The Sync App models the data in SAP Ariba as a list of tables in a relational database that can be queried using standard SQL statements.

SAP Ariba Procurement Connector for CData Sync Tables


Name	Description
ContractRequestLineItems	Retrieves contract request line item information.
ContractRequests	Retrieves contract request header information.

ContractRequestLineItems

Retrieves contract request line item information.

Table-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItems]
SELECT * FROM [ContractRequestLineItems] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Insert

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

ContractRequestUniqueName
NumberInCollection
StartDate
EndDate
AccountType
AccountCategory
ShipTo
IsHardReleaseMaximum
IsHardReleaseMinimum
IsRecurring
CompoundPricingTerms
RollUpAccumulatorsToParent
ShouldDefaultAccounting
LimitType
MaxAmount
MaxAmountCurrencyUniqueName
MaxAmountTolerancePercent
MinAmount
MinAmountCurrencyUniqueName
MaxReleaseAmount
MaxReleaseAmountCurrencyUniqueName
MinReleaseAmount
MinReleaseAmountCurrencyUniqueName
MaxQuantity
MaxQuantityTolerancePercent
MinQuantity
MaxReleaseQuantity
MinReleaseQuantity
MaxReleaseTolerancePercent
CatalogSubscription
CommodityCodeUniqueName
CommodityCodeDomain
LineTypeUniqueName
Description
DescriptionCommonCommodityCodeUniqueName
DescriptionCommonCommodityCodeDomain
DescriptionPriceAmount
DescriptionPriceCurrencyUniqueName
DescriptionSupplierPartAuxiliaryId
DescriptionSupplierPartNumber
DescriptionUnitOfMeasureUniqueName
AccountingsSplitAccountings

INSERT INTO [ContractRequestLineItems] ([ContractRequestUniqueName], [NumberInCollection], [LineTypeUniqueName], [Description], [LimitType]) VALUES ('CR19', '19', '_CatalogItem', 'Custom description.', 'Amount')

Update

You can use the following columns to update a record:

StartDate
EndDate
AccountType
AccountCategory
ShipTo
IsHardReleaseMaximum
IsHardReleaseMinimum
IsRecurring
CompoundPricingTerms
RollUpAccumulatorsToParent
ShouldDefaultAccounting
LimitType
MaxAmount
MaxAmountCurrencyUniqueName
MaxAmountTolerancePercent
MinAmount
MinAmountCurrencyUniqueName
MaxReleaseAmount
MaxReleaseAmountCurrencyUniqueName
MinReleaseAmount
MinReleaseAmountCurrencyUniqueName
MaxQuantity
MaxQuantityTolerancePercent
MinQuantity
MaxReleaseQuantity
MinReleaseQuantity
MaxReleaseTolerancePercent
CatalogSubscription
CommodityCodeUniqueName
CommodityCodeDomain
LineTypeUniqueName
Description
DescriptionCommonCommodityCodeUniqueName
DescriptionCommonCommodityCodeDomain
DescriptionPriceAmount
DescriptionPriceCurrencyUniqueName
DescriptionSupplierPartAuxiliaryId
DescriptionSupplierPartNumber
DescriptionUnitOfMeasureUniqueName
AccountingsSplitAccountings

UPDATE [ContractRequestLineItems] SET [Description] = 'test' WHERE ([ContractRequestUniqueName] = 'CR12') AND ([NumberInCollection] = 1)

Delete

You can specify the following columns to delete a record:

ContractRequestUniqueName
NumberInCollection

DELETE FROM [ContractRequestLineItems] WHERE [ContractRequestUniqueName] = 'CR12' AND [NumberInCollection] = '1'

Columns


Name	Type	ReadOnly	References	Description
ContractRequestUniqueName [KEY]	String	False	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
NumberInCollection [KEY]	Int	False		Line number within the contract request.
ParentLineNumber	Int	True		Line number of the parent line item for this line item.
ERPLineItemNumber	String	True		The line item number from the ERP system.
StartDate	Datetime	False		Start date for this line item.
EndDate	Datetime	False		End date for this line item.
AccountType	String	False		This account type of the line item.
AccountCategory	String	False		Account category name for SAP ERPs.
ItemCategory	String	True		Item category name for SAP ERPs.
BillingAddress	String	True		The corporate billing address.
ShipTo	String	False		Address where ordered items should be shipped.
HideAmount	Boolean	True		This field value determines whether the Amount value in BPOs is hidden from suppliers in the Ariba Network.
HideUnitPrice	Boolean	True		This field value determines whether the Unit Price value in BPOs is hidden from suppliers in the Ariba Network.
IsHardReleaseMaximum	Boolean	False		Specifies whether MaxReleaseAmount/MaxReleaseQuantity is a hard constraint or not.
IsHardReleaseMinimum	Boolean	False		The minimum quantity for each releases for this line item.
IsObsolete	Boolean	True		Specifies whether the item is obsolete or not. If item is obsolete, it doesn't get shown on the UI, but is retained. It is also impossible to create new releases on an obsolete item.
IsRecurring	Boolean	False		Indicates whether the review period recurs at a specified frequency within the date range specified by contract StartDate and EndDate.
CompoundPricingTerms	Boolean	False		Boolean to indicate if the subagreement wants its pricing to be compounded with the parent, this will be visible in the UI based on the parent's pricing term.
RollUpAccumulatorsToParent	Boolean	False		Indicates if subagreement spend should be rolled up to the parent.
ShouldDefaultAccounting	Boolean	False		Indicates if accounting fields should be defaulted from user profile and CEME.
LimitType	String	False		How the limit is determined (Amount or Quantity). The allowed values are Amount, Quantity.
Amount	Decimal	True		Forecasted amount for this line item. For catalog items, this value is automatically populated from the catalog.
AmountCurrencyName	String	True		Currency name for the line item amount.
AmountCurrencyUniqueName	String	True		Unique identifier of the currency for the line item amount.
MaxAmount	Decimal	False		Maximum amount for releases against this line item.
MaxAmountCurrencyName	String	True		Currency name for the maximum amount.
MaxAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the maximum amount.
MaxAmountTolerancePercent	Decimal	False		Tolerance percentage above maximum amount before moving to closed state.
MinAmount	Decimal	False		Minimum amount committed for this line item.
MinAmountCurrencyName	String	True		Currency name for the minimum amount.
MinAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the minimum amount.
MaxReleaseAmount	Decimal	False		Maximum amount per release for this line item.
MaxReleaseAmountCurrencyName	String	True		Currency name for the maximum release amount.
MaxReleaseAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the maximum release amount.
MinReleaseAmount	Decimal	False		Minimum amount per release for this line item.
MinReleaseAmountCurrencyName	String	True		Currency name for the minimum release amount.
MinReleaseAmountCurrencyUniqueName	String	False		Unique identifier of the currency for the minimum release amount.
ExpectedValueAmount	Decimal	True		Expected cost for SAP service line items.
ExpectedValueCurrencyName	String	True		Currency name for the expected value.
ExpectedValueCurrencyUniqueName	String	True		Unique identifier of the currency for the expected value.
OverallLimitAmount	Decimal	True		Maximum amount for SAP service line items.
OverallLimitCurrencyName	String	True		Currency name for the overall limit.
OverallLimitCurrencyUniqueName	String	True		Unique identifier of the currency for the overall limit.
MaxQuantity	Decimal	False		Maximum cumulative quantity for all releases of this line item.
MaxQuantityTolerancePercent	Decimal	False		Tolerance percentage above maximum quantity.
MinQuantity	Decimal	False		Minimum cumulative quantity for all releases of this line item.
MaxReleaseQuantity	Decimal	False		Maximum quantity per release for this line item.
MinReleaseQuantity	Decimal	False		Minimum quantity per release for this line item.
MaxReleaseTolerancePercent	Decimal	False		Maximum tolerance percentage per release.
CatalogSubscription	String	False		Catalog subscription name for retrieving catalog subscription.
CommodityCodeName	String	True		Name of the commodity code for this line item.
CommodityCodeUniqueName	String	False		Unique identifier of the commodity code for this line item.
CommodityCodeDomain	String	False		Domain value for the commodity code.
LineTypeName	String	True		Name of the line type.
LineTypeUniqueName	String	False		Unique identifier of the line type.
LineTypeCategory	Int	True		Category of the line type.
Description	String	False		Description text of the product.
DescriptionClassificationCodeAux	String	True		Classification code auxiliary for the product description.
DescriptionCommonCommodityCodeName	String	True		Name of the common commodity code.
DescriptionCommonCommodityCodeUniqueName	String	False		Unique identifier of the common commodity code.
DescriptionCommonCommodityCodeDomain	String	False		Domain of the common commodity code.
DescriptionContractPriceAmount	Decimal	True		Contract price amount for the product.
DescriptionContractPriceCurrencyName	String	True		Currency name for the contract price.
DescriptionContractPriceCurrencyUniqueName	String	True		Unique identifier of the currency for the contract price.
DescriptionCustomPriceAmount	Decimal	True		Custom catalog price amount for the product.
DescriptionCustomPriceCurrencyName	String	True		Currency name for the custom price.
DescriptionCustomPriceCurrencyUniqueName	String	True		Unique identifier of the currency for the custom price.
DescriptionIndexContractPriceAmount	Decimal	True		Index contract price amount for the product.
DescriptionIndexContractPriceCurrencyName	String	True		Currency name for the index contract price.
DescriptionIndexContractPriceCurrencyUniqueName	String	True		Unique identifier of the currency for the index contract price.
DescriptionLanguage	String	True		Language for the product description.
DescriptionLeadTime	Int	True		Lead time for the product.
DescriptionManName	String	True		Manufacturer name for the product.
DescriptionManPartNumber	String	True		Manufacturer part number for the product.
DescriptionManURL	String	True		Manufacturer URL for the product.
DescriptionNonContractPriceAmount	Decimal	True		Non-contract price amount for the product.
DescriptionNonContractPriceCurrencyName	String	True		Currency name for the non-contract price.
DescriptionNonContractPriceCurrencyUniqueName	String	True		Unique identifier of the currency for the non-contract price.
DescriptionPriceAmount	Decimal	False		Catalog price amount for the product.
DescriptionPriceCurrencyName	String	True		Currency name for the catalog price.
DescriptionPriceCurrencyUniqueName	String	False		Unique identifier of the currency for the catalog price.
DescriptionShortName	String	True		Short description of the product.
DescriptionSupplierPartAuxiliaryId	String	False		Supplier part auxiliary ID for the product.
DescriptionSupplierPartNumber	String	False		Supplier part number for the product.
DescriptionSupplierURL	String	True		Supplier URL for the product.
DescriptionUnitOfMeasureName	String	True		Name of the unit of measure.
DescriptionUnitOfMeasureUniqueName	String	False		Unique identifier of the unit of measure.
DescriptionCommonSupplierName	String	True		Name of the common supplier.
DescriptionCommonSupplierSystemId	String	True		System ID of the common supplier.
MilestoneNotificationDays	Int	True		Days to notify before completion.
MilestoneSupplierContact	String	True		Supplier contact that the user should contact to verify the milestone completion.
MilestoneTitle	String	True		The title of this milestone.
MilestoneVerifierGroup	String	True		Group type verifier field.
MilestoneVerifierUserName	String	True		Name of the verifier user.
MilestoneVerifierUserUniqueName	String	True		Unique identifier of the verifier user.
MilestoneVerifierUserPasswordAdapter	String	True		Password adapter of the verifier user.
AccountingsSplitAccountings	String	False		Split accounting information for this line item.
PricingInfoPricingTermsType	String	True		Pricing structure type (DiscountedPrice, DiscountedPercent, etc.).
PricingInfoDiscountedPriceAmount	Decimal	True		Amount for this term.
PricingInfoDiscountedPriceCurrencyName	String	True		Currency name for the term amount.
PricingInfoDiscountedPriceCurrencyUniqueName	String	True		Unique identifier of the currency for the term amount.
PricingInfoDiscountPercent	Decimal	True		Discount percentage applied to the base price.
TierPricingInfoPricingTermsType	String	True		Tier-based pricing structure type (TierBasedPricingTerms).
TierPricingInfoTierType	String	True		Tier basis for pricing calculation (Amount, Quantity).
TierPricingInfoTierValueType	String	True		Type of tier value calculation (Price, Percent).
TierPricingInfoIsTierPricingCumulative	String	True		Whether tier pricing applies cumulatively across tiers (Yes/No).
TierPricingInfoAmountCurrencyName	String	True		Currency name for the term amounts.
TierPricingInfoAmountCurrencyUniqueName	String	True		Unique identifier of the currency for the term amount.
TierPricingInfoTieredPricingSteps	String	True		Pricing steps with TierValue and MinTierValue thresholds.
TermPricingInfoPricingTermsType	String	True		Term-based pricing structure type (TermBasedPricingTerms).
TermPricingInfoPricingTiers	String	True		Time-period pricing with StartDate and discount/price values.
FormulaPricingInfoPricingTermsType	String	True		Formula-based pricing structure type.
FormulaPricingInfoFormula	String	True		Mathematical formula string for calculating prices.
FormulaPricingInfoGridInfos	String	True		Grid factor objects containing variables and values for formula calculation.
AdvancedPricingInfoPricingTermsType	String	True		Pricing terms type for advanced pricing structures.
AdvancedPricingInfoPricingTiers	String	True		Time-based pricing tiers with tier steps, dates, and ship-to information.
RangePricingInfoPricingTermsType	String	True		Pricing terms type for range-based pricing structures.
RangePricingInfoRangePricingTiers	String	True		Pricing tiers with minimum and maximum price ranges per period.

ContractRequests

Retrieves contract request header information.

Table-Specific Information

Select

The Sync App 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 Sync App processes other filters client-side within the Sync App.

The Sync App 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 Sync App processes ordering by other columns client-side within the Sync App.

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.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP Ariba Procurement Connector for CData Sync Views


Name	Description
ContractForecastedSpendItems	Retrieves items within the forecasted spend breakdown.
ContractLineItemAdvancedPricingTiers	Retrieves advanced pricing tiers for contract line items with complex time-based and location-based pricing.
ContractLineItemAdvancedPricingTierSteps	Retrieves tiered pricing steps for contract line items with advanced pricing.
ContractLineItemFormulaPricingGridInfoFactorCellValues	Retrieves factor cell values for grid factor information in contract line items with formula-based pricing.
ContractLineItemFormulaPricingGridInfos	Retrieves grid factor information for contract line items with formula-based pricing.
ContractLineItemRangePricingTiers	Retrieves range pricing tiers for contract line items with minimum and maximum price ranges per period.
ContractLineItems	Retrieves contract line item information.
ContractLineItemSplitAccountings	Retrieves split accounting details for contract line items.
ContractLineItemTermPricingTiers	Retrieves term-based pricing tiers for contract line items with time-period pricing.
ContractLineItemTieredPricingSteps	Retrieves tiered pricing steps for contract line items with tier-based pricing.
ContractRequestForecastedSpendItems	Retrieves items within the forecasted spend breakdown.
ContractRequestLineItemAdvancedPricingTiers	Retrieves advanced pricing tiers for contract request line items with complex time-based and location-based pricing.
ContractRequestLineItemAdvancedPricingTierSteps	Retrieves tiered pricing steps for contract request line items with advanced pricing.
ContractRequestLineItemFormulaPricingGridInfoFactorCellValues	Retrieves factor cell values for grid factor information in contract request line items with formula-based pricing.
ContractRequestLineItemFormulaPricingGridInfos	Retrieves grid factor information for contract request line items with formula-based pricing.
ContractRequestLineItemRangePricingTiers	Retrieves range pricing tiers for contract request line items with minimum and maximum price ranges per period.
ContractRequestLineItemSplitAccountings	Retrieves split accounting details for contract request line items.
ContractRequestLineItemTermPricingTiers	Retrieves term-based pricing tiers for contract request line items with time-period pricing.
ContractRequestLineItemTieredPricingSteps	Retrieves tiered pricing steps for contract request line items with tier-based pricing.
Contracts	Retrieves contract header information.

ContractForecastedSpendItems

Retrieves items within the forecasted spend breakdown.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,!=,CONTAINS' comparison operators.

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

SELECT * FROM [ContractForecastedSpendItems]
SELECT * FROM [ContractForecastedSpendItems] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract.
NumberInCollection [KEY]	Int		Position of the forecasted spend item object in the response collection.
StartDate	Datetime		Start date of the item.
EndDate	Datetime		End date of the item.
Amount	Decimal		Forecasted amount of the item.
AmountCurrencyName	String		Currency name of the forecasted amount.
AmountCurrencyUniqueName	String		Currency unique name of the forecasted amount.

ContractLineItemAdvancedPricingTiers

Retrieves advanced pricing tiers for contract line items with complex time-based and location-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemAdvancedPricingTiers]
SELECT * FROM [ContractLineItemAdvancedPricingTiers] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this advanced pricing tier period.
EndDate	Datetime		End date for this advanced pricing tier period.
TierType	String		Tier basis for pricing calculation (Amount, Quantity).
TierValueType	String		Type of tier value calculation (Price, Percent).
IsTierPricingCumulative	String		Whether tier pricing applies cumulatively across tiers (Yes/No).
ShipToUniqueName	String		Unique identifier of the ship-to location for this tier.
ShipToName	String		Name of the ship-to location for this tier.
ShipToLine1	String		Address line 1 of the ship-to location.
ShipToLine2	String		Address line 2 of the ship-to location.
ShipToLine3	String		Address line 3 of the ship-to location.
ShipToCity	String		City of the ship-to location.
ShipToState	String		State of the ship-to location.
ShipToPostalCode	String		Postal code of the ship-to location.
ShipToCountryName	String		Country name of the ship-to location.
ShipToCountryUniqueName	String		Country unique identifier of the ship-to location.
ShipToPhone	String		Phone number of the ship-to location.
ShipToFax	String		Fax number of the ship-to location.
TieredPricingSteps	String		Array of tiered pricing steps within this advanced pricing tier.

ContractLineItemAdvancedPricingTierSteps

Retrieves tiered pricing steps for contract line items with advanced pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemAdvancedPricingTierSteps]
SELECT * FROM [ContractLineItemAdvancedPricingTierSteps] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
PricingTierNumberInCollection [KEY]	Int	ContractLineItemAdvancedPricingTiers.NumberInCollection	Position of the tier object in the response collection.
NumberInCollection [KEY]	Int		Position of the pricing step object in the response collection.
MinTierValue	Decimal		Minimum tier value threshold for this pricing step.
TierValue	Decimal		Tier value (price or percentage) for this pricing step.

ContractLineItemFormulaPricingGridInfoFactorCellValues

Retrieves factor cell values for grid factor information in contract line items with formula-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemFormulaPricingGridInfoFactorCellValues]
SELECT * FROM [ContractLineItemFormulaPricingGridInfoFactorCellValues] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
GridInfoNumberInCollection [KEY]	Int	ContractLineItemFormulaPricingGridInfos.NumberInCollection	Position of the grid info object in the response collection.
NumberInCollection [KEY]	Int		Position of the factor cell value object in the response collection.
FactorValue	String		String value for the enumerated factor.
CellValue	String		String value for the enumerated factor cell.

ContractLineItemFormulaPricingGridInfos

Retrieves grid factor information for contract line items with formula-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemFormulaPricingGridInfos]
SELECT * FROM [ContractLineItemFormulaPricingGridInfos] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
NumberInCollection [KEY]	Int		Position of the grid info object in the response collection.
FactorName	String		Factor that this particular grid is representing.
FactorValueType	String		The type of the factor value (String, Boolean, Date). The allowed values are String, Boolean, Date.
GridName	String		Grid name as loaded from the import.
FactorCellValues	String		List of grid factor and cell values.

ContractLineItemRangePricingTiers

Retrieves range pricing tiers for contract line items with minimum and maximum price ranges per period.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemRangePricingTiers]
SELECT * FROM [ContractLineItemRangePricingTiers] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this range pricing tier period.
EndDate	Datetime		End date for this range pricing tier period.
RangeTierType	String		Type of range tier (Price, Percent). The allowed values are Price, Percent.
RangeFactor	Decimal		Range factor for price calculation.
MinimumPriceAmount	Decimal		Minimum price amount for this range tier.
MinimumPriceCurrencyName	String		Currency name for the minimum price.
MinimumPriceCurrencyUniqueName	String		Unique identifier of the currency for the minimum price.
MaximumPriceAmount	Decimal		Maximum price amount for this range tier.
MaximumPriceCurrencyName	String		Currency name for the maximum price.
MaximumPriceCurrencyUniqueName	String		Unique identifier of the currency for the maximum price.

ContractLineItems

Retrieves contract line item information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItems]
SELECT * FROM [ContractLineItems] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
NumberInCollection [KEY]	Int		Line number within the contract.
ParentLineNumber	Int		Line number of the parent line item for this line item.
ERPLineItemNumber	String		The line item number from the ERP system.
StartDate	Datetime		Start date for this line item.
EndDate	Datetime		End date for this line item.
AccountType	String		This account type of the line item.
AccountCategory	String		Account category name for SAP ERPs.
ItemCategory	String		Item category name for SAP ERPs.
BillingAddress	String		The corporate billing address.
ShipTo	String		Address where ordered items should be shipped.
HideAmount	Boolean		This field value determines whether the Amount value in BPOs is hidden from suppliers in the Ariba Network.
HideUnitPrice	Boolean		This field value determines whether the Unit Price value in BPOs is hidden from suppliers in the Ariba Network.
IsHardReleaseMaximum	Boolean		Specifies whether MaxReleaseAmount/MaxReleaseQuantity is a hard constraint or not.
IsHardReleaseMinimum	Boolean		The minimum quantity for each releases for this line item.
IsObsolete	Boolean		Specifies whether the item is obsolete or not. If item is obsolete, it doesn't get shown on the UI, but is retained. It is also impossible to create new releases on an obsolete item.
IsRecurring	Boolean		Indicates whether the review period recurs at a specified frequency within the date range specified by contract StartDate and EndDate.
CompoundPricingTerms	Boolean		Boolean to indicate if the subagreement wants its pricing to be compounded with the parent, this will be visible in the UI based on the parent's pricing term.
RollUpAccumulatorsToParent	Boolean		Indicates if subagreement spend should be rolled up to the parent.
LimitType	String		How the limit is determined (Amount or Quantity). The allowed values are Amount, Quantity.
Amount	Decimal		Forecasted amount for this line item. For catalog items, this value is automatically populated from the catalog.
AmountCurrencyName	String		Currency name for the line item amount.
AmountCurrencyUniqueName	String		Unique identifier of the currency for the line item amount.
MaxAmount	Decimal		Maximum amount for releases against this line item.
MaxAmountCurrencyName	String		Currency name for the maximum amount.
MaxAmountCurrencyUniqueName	String		Unique identifier of the currency for the maximum amount.
MaxAmountTolerancePercent	Decimal		Tolerance percentage above maximum amount before moving to closed state.
MinAmount	Decimal		Minimum amount committed for this line item.
MinAmountCurrencyName	String		Currency name for the minimum amount.
MinAmountCurrencyUniqueName	String		Unique identifier of the currency for the minimum amount.
MaxReleaseAmount	Decimal		Maximum amount per release for this line item.
MaxReleaseAmountCurrencyName	String		Currency name for the maximum release amount.
MaxReleaseAmountCurrencyUniqueName	String		Unique identifier of the currency for the maximum release amount.
MinReleaseAmount	Decimal		Minimum amount per release for this line item.
MinReleaseAmountCurrencyName	String		Currency name for the minimum release amount.
MinReleaseAmountCurrencyUniqueName	String		Unique identifier of the currency for the minimum release amount.
ExpectedValueAmount	Decimal		Expected cost for SAP service line items.
ExpectedValueCurrencyName	String		Currency name for the expected value.
ExpectedValueCurrencyUniqueName	String		Unique identifier of the currency for the expected value.
OverallLimitAmount	Decimal		Maximum amount for SAP service line items.
OverallLimitCurrencyName	String		Currency name for the overall limit.
OverallLimitCurrencyUniqueName	String		Unique identifier of the currency for the overall limit.
MaxQuantity	Decimal		Maximum cumulative quantity for all releases of this line item.
MaxQuantityTolerancePercent	Decimal		Tolerance percentage above maximum quantity.
MinQuantity	Decimal		Minimum cumulative quantity for all releases of this line item.
MaxReleaseQuantity	Decimal		Maximum quantity per release for this line item.
MinReleaseQuantity	Decimal		Minimum quantity per release for this line item.
MaxReleaseTolerancePercent	Decimal		Maximum tolerance percentage per release.
CatalogSubscription	String		Catalog subscription name for retrieving catalog subscription.
CommodityCodeName	String		Name of the commodity code for this line item.
CommodityCodeUniqueName	String		Unique identifier of the commodity code for this line item.
CommodityCodeDomain	String		Domain value for the commodity code.
LineTypeName	String		Name of the line type.
LineTypeUniqueName	String		Unique identifier of the line type.
LineTypeCategory	Int		Category of the line type.
Description	String		Description text of the product.
DescriptionClassificationCodeAux	String		Classification code auxiliary for the product description.
DescriptionCommonCommodityCodeName	String		Name of the common commodity code.
DescriptionCommonCommodityCodeUniqueName	String		Unique identifier of the common commodity code.
DescriptionCommonCommodityCodeDomain	String		Domain of the common commodity code.
DescriptionContractPriceAmount	Decimal		Contract price amount for the product.
DescriptionContractPriceCurrencyName	String		Currency name for the contract price.
DescriptionContractPriceCurrencyUniqueName	String		Unique identifier of the currency for the contract price.
DescriptionCustomPriceAmount	Decimal		Custom catalog price amount for the product.
DescriptionCustomPriceCurrencyName	String		Currency name for the custom price.
DescriptionCustomPriceCurrencyUniqueName	String		Unique identifier of the currency for the custom price.
DescriptionIndexContractPriceAmount	Decimal		Index contract price amount for the product.
DescriptionIndexContractPriceCurrencyName	String		Currency name for the index contract price.
DescriptionIndexContractPriceCurrencyUniqueName	String		Unique identifier of the currency for the index contract price.
DescriptionLanguage	String		Language for the product description.
DescriptionLeadTime	Int		Lead time for the product.
DescriptionManName	String		Manufacturer name for the product.
DescriptionManPartNumber	String		Manufacturer part number for the product.
DescriptionManURL	String		Manufacturer URL for the product.
DescriptionNonContractPriceAmount	Decimal		Non-contract price amount for the product.
DescriptionNonContractPriceCurrencyName	String		Currency name for the non-contract price.
DescriptionNonContractPriceCurrencyUniqueName	String		Unique identifier of the currency for the non-contract price.
DescriptionPriceAmount	Decimal		Catalog price amount for the product.
DescriptionPriceCurrencyName	String		Currency name for the catalog price.
DescriptionPriceCurrencyUniqueName	String		Unique identifier of the currency for the catalog price.
DescriptionShortName	String		Short description of the product.
DescriptionSupplierPartAuxiliaryId	String		Supplier part auxiliary ID for the product.
DescriptionSupplierPartNumber	String		Supplier part number for the product.
DescriptionSupplierURL	String		Supplier URL for the product.
DescriptionUnitOfMeasureName	String		Name of the unit of measure.
DescriptionUnitOfMeasureUniqueName	String		Unique identifier of the unit of measure.
DescriptionCommonSupplierName	String		Name of the common supplier.
DescriptionCommonSupplierSystemId	String		System ID of the common supplier.
MilestoneNotificationDays	Int		Days to notify before completion.
MilestoneSupplierContact	String		Supplier contact that the user should contact to verify the milestone completion.
MilestoneTitle	String		The title of this milestone.
MilestoneVerifierGroup	String		Group type verifier field.
MilestoneVerifierUserName	String		Name of the verifier user.
MilestoneVerifierUserUniqueName	String		Unique identifier of the verifier user.
MilestoneVerifierUserPasswordAdapter	String		Password adapter of the verifier user.
AccountingsSplitAccountings	String		Split accounting information for this line item.
PricingInfoPricingTermsType	String		Pricing structure type (DiscountedPrice, DiscountedPercent, etc.).
PricingInfoDiscountedPriceAmount	Decimal		Amount for this term.
PricingInfoDiscountedPriceCurrencyName	String		Currency name for the term amount.
PricingInfoDiscountedPriceCurrencyUniqueName	String		Unique identifier of the currency for the term amount.
PricingInfoDiscountPercent	Decimal		Discount percentage applied to the base price.
TierPricingInfoPricingTermsType	String		Tier-based pricing structure type (TierBasedPricingTerms).
TierPricingInfoTierType	String		Tier basis for pricing calculation (Amount, Quantity).
TierPricingInfoTierValueType	String		Type of tier value calculation (Price, Percent).
TierPricingInfoIsTierPricingCumulative	String		Whether tier pricing applies cumulatively across tiers (Yes/No).
TierPricingInfoAmountCurrencyName	String		Currency name for the term amounts.
TierPricingInfoAmountCurrencyUniqueName	String		Unique identifier of the currency for the term amount.
TierPricingInfoTieredPricingSteps	String		Pricing steps with TierValue and MinTierValue thresholds.
TermPricingInfoPricingTermsType	String		Term-based pricing structure type (TermBasedPricingTerms).
TermPricingInfoPricingTiers	String		Time-period pricing with StartDate and discount/price values.
FormulaPricingInfoPricingTermsType	String		Formula-based pricing structure type.
FormulaPricingInfoFormula	String		Mathematical formula string for calculating prices.
FormulaPricingInfoGridInfos	String		Grid factor objects containing variables and values for formula calculation.
AdvancedPricingInfoPricingTermsType	String		Pricing terms type for advanced pricing structures.
AdvancedPricingInfoPricingTiers	String		Time-based pricing tiers with tier steps, dates, and ship-to information.
RangePricingInfoPricingTermsType	String		Pricing terms type for range-based pricing structures.
RangePricingInfoRangePricingTiers	String		Pricing tiers with minimum and maximum price ranges per period.

ContractLineItemSplitAccountings

Retrieves split accounting details for contract line items.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemSplitAccountings]
SELECT * FROM [ContractLineItemSplitAccountings] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line item number in collection.
NumberInCollection [KEY]	Int		Number in collection for this split accounting entry.
AccountName	String		Name of the account.
AccountUniqueName	String		Unique identifier of the account.
AccountingCombinationID	String		Accounting combination identifier.
Percentage	Decimal		Percentage split for this accounting entry.
Quantity	Decimal		Quantity for this split accounting entry.
Amount	Decimal		Amount for this split accounting entry.
AmountCurrencyName	String		Currency name for the amount.
AmountCurrencyUniqueName	String		Currency unique identifier for the amount.
ActivityNumberName	String		Name of the activity number.
ActivityNumberNetwork	String		Network associated with the activity number.
ActivityNumberUniqueName	String		Unique identifier of the activity number.
AssetCompanyCode	String		Company code of the asset.
AssetName	String		Name of the asset.
AssetUniqueName	String		Unique identifier of the asset.
AssetClassName	String		Name of the asset class.
AssetClassUniqueName	String		Unique identifier of the asset class.
AssetDescription	String		Description of the asset.
AssetLocationCity	String		City of the asset location.
AssetLocationCountryName	String		Country name of the asset location.
AssetLocationCountryUniqueName	String		Country unique identifier of the asset location.
AssetLocationFax	String		Fax number of the asset location.
AssetLocationLine1	String		Address line 1 of the asset location.
AssetLocationLine2	String		Address line 2 of the asset location.
AssetLocationLine3	String		Address line 3 of the asset location.
AssetLocationName	String		Name of the asset location.
AssetLocationPhone	String		Phone number of the asset location.
AssetLocationPostalCode	String		Postal code of the asset location.
AssetLocationState	String		State of the asset location.
AssetLocationUniqueName	String		Unique identifier of the asset location.
BusinessUnitName	String		Name of the business unit.
BusinessUnitUniqueName	String		Unique identifier of the business unit.
BusinessUnitAM	String		The PeopleSoft asset management business unit.
CompanyName	String		Name of the company.
CompanyUniqueName	String		Unique identifier of the company.
CompanyCodeUniqueName	String		Unique identifier of the company code.
CostCenterCompanyCode	String		Company code of the cost center.
CostCenterName	String		Name of the cost center.
CostCenterUniqueName	String		Unique identifier of the cost center.
DepartmentName	String		Name of the department.
DepartmentUniqueName	String		Unique identifier of the department.
GLBusinessUnitName	String		Name of the GL business unit.
GLBusinessUnitUniqueName	String		Unique identifier of the GL business unit.
GeneralLedgerCompanyCode	String		Company code of the general ledger.
GeneralLedgerName	String		Name of the general ledger.
GeneralLedgerUniqueName	String		Unique identifier of the general ledger.
InternalOrderName	String		Name of the internal order.
InternalOrderUniqueName	String		Unique identifier of the internal order.
LocationCity	String		City of the location.
LocationCountryName	String		Country name of the location.
LocationCountryUniqueName	String		Country unique identifier of the location.
LocationFax	String		Fax number of the location.
LocationLine1	String		Address line 1 of the location.
LocationLine2	String		Address line 2 of the location.
LocationLine3	String		Address line 3 of the location.
LocationName	String		Name of the location.
LocationPhone	String		Phone number of the location.
LocationPostalCode	String		Postal code of the location.
LocationState	String		State of the location.
LocationUniqueName	String		Unique identifier of the location.
NetworkCompanyCode	String		Company code of the network.
NetworkName	String		Name of the network.
NetworkUniqueName	String		Unique identifier of the network.
PSProfileId	String		PS Profile identifier.
SAPLimitSplitValue	String		SAP limit split value.
SAPSerialNumber	String		SAP serial number.
ProcurementUnitName	String		Name of the procurement unit.
ProcurementUnitUniqueName	String		Unique identifier of the procurement unit.
ProductName	String		Name of the product.
ProductUniqueName	String		Unique identifier of the product.
ProjectName	String		Name of the project.
ProjectUniqueName	String		Unique identifier of the project.
RegionName	String		Name of the region.
RegionUniqueName	String		Unique identifier of the region.
StatisticsCodeName	String		Name of the statistics code.
StatisticsCodeUniqueName	String		Unique identifier of the statistics code.
SubAccountName	String		Name of the sub account.
SubAccountUniqueName	String		Unique identifier of the sub account.
TypeName	String		Name of the split accounting type.
TypeUniqueName	String		Unique identifier of the split accounting type.
WBSElementName	String		Name of the WBS element.
WBSElementUniqueName	String		Unique identifier of the WBS element.

ContractLineItemTermPricingTiers

Retrieves term-based pricing tiers for contract line items with time-period pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemTermPricingTiers]
SELECT * FROM [ContractLineItemTermPricingTiers] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this pricing tier period.
DiscountPercent	Decimal		Discount percentage applied during this time period.
DiscountedPriceAmount	Decimal		Discounted price amount for this time period.
DiscountedPriceCurrencyName	String		Currency name for the discounted price.
DiscountedPriceCurrencyUniqueName	String		Unique identifier of the currency for the discounted price.

ContractLineItemTieredPricingSteps

Retrieves tiered pricing steps for contract line items with tier-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractLineItemTieredPricingSteps]
SELECT * FROM [ContractLineItemTieredPricingSteps] WHERE [ContractUniqueName] = 'C10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractUniqueName [KEY]	String	Contracts.UniqueName	The unique identifier of the contract that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractLineItems.NumberInCollection	Line number within the contract.
NumberInCollection [KEY]	Int		Position of the pricing step object in the response collection.
MinTierValue	Decimal		Minimum tier value threshold for this pricing step.
TierValue	Decimal		Tier value (price or percentage) for this pricing step.

ContractRequestForecastedSpendItems

Retrieves items within the forecasted spend breakdown.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,!=,CONTAINS' comparison operators.

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

SELECT * FROM [ContractRequestForecastedSpendItems]
SELECT * FROM [ContractRequestForecastedSpendItems] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request.
NumberInCollection [KEY]	Int		Position of the forecasted spend item object in the response collection.
StartDate	Datetime		Start date of the item.
EndDate	Datetime		End date of the item.
Amount	Decimal		Forecasted amount of the item.
AmountCurrencyName	String		Currency name of the forecasted amount.
AmountCurrencyUniqueName	String		Currency unique name of the forecasted amount.

ContractRequestLineItemAdvancedPricingTiers

Retrieves advanced pricing tiers for contract request line items with complex time-based and location-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemAdvancedPricingTiers]
SELECT * FROM [ContractRequestLineItemAdvancedPricingTiers] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this advanced pricing tier period.
EndDate	Datetime		End date for this advanced pricing tier period.
TierType	String		Tier basis for pricing calculation (Amount, Quantity).
TierValueType	String		Type of tier value calculation (Price, Percent).
IsTierPricingCumulative	String		Whether tier pricing applies cumulatively across tiers (Yes/No).
ShipToUniqueName	String		Unique identifier of the ship-to location for this tier.
ShipToName	String		Name of the ship-to location for this tier.
ShipToLine1	String		Address line 1 of the ship-to location.
ShipToLine2	String		Address line 2 of the ship-to location.
ShipToLine3	String		Address line 3 of the ship-to location.
ShipToCity	String		City of the ship-to location.
ShipToState	String		State of the ship-to location.
ShipToPostalCode	String		Postal code of the ship-to location.
ShipToCountryName	String		Country name of the ship-to location.
ShipToCountryUniqueName	String		Country unique identifier of the ship-to location.
ShipToPhone	String		Phone number of the ship-to location.
ShipToFax	String		Fax number of the ship-to location.
TieredPricingSteps	String		Array of tiered pricing steps within this advanced pricing tier.

ContractRequestLineItemAdvancedPricingTierSteps

Retrieves tiered pricing steps for contract request line items with advanced pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemAdvancedPricingTierSteps]
SELECT * FROM [ContractRequestLineItemAdvancedPricingTierSteps] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
PricingTierNumberInCollection [KEY]	Int	ContractRequestLineItemAdvancedPricingTiers.NumberInCollection	Position of the tier object in the response collection.
NumberInCollection [KEY]	Int		Position of the pricing step object in the response collection.
MinTierValue	Decimal		Minimum tier value threshold for this pricing step.
TierValue	Decimal		Tier value (price or percentage) for this pricing step.

ContractRequestLineItemFormulaPricingGridInfoFactorCellValues

Retrieves factor cell values for grid factor information in contract request line items with formula-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemFormulaPricingGridInfoFactorCellValues]
SELECT * FROM [ContractRequestLineItemFormulaPricingGridInfoFactorCellValues] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
GridInfoNumberInCollection [KEY]	Int	ContractRequestLineItemFormulaPricingGridInfos.NumberInCollection	Position of the grid info object in the response collection.
NumberInCollection [KEY]	Int		Position of the factor cell value object in the response collection.
FactorValue	String		String value for the enumerated factor.
CellValue	String		String value for the enumerated factor cell.

ContractRequestLineItemFormulaPricingGridInfos

Retrieves grid factor information for contract request line items with formula-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemFormulaPricingGridInfos]
SELECT * FROM [ContractRequestLineItemFormulaPricingGridInfos] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
NumberInCollection [KEY]	Int		Position of the grid info object in the response collection.
FactorName	String		Factor that this particular grid is representing.
FactorValueType	String		The type of the factor value (String, Boolean, Date). The allowed values are String, Boolean, Date.
GridName	String		Grid name as loaded from the import.
FactorCellValues	String		List of grid factor and cell values.

ContractRequestLineItemRangePricingTiers

Retrieves range pricing tiers for contract request line items with minimum and maximum price ranges per period.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemRangePricingTiers]
SELECT * FROM [ContractRequestLineItemRangePricingTiers] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this range pricing tier period.
EndDate	Datetime		End date for this range pricing tier period.
RangeTierType	String		Type of range tier (Price, Percent). The allowed values are Price, Percent.
RangeFactor	Decimal		Range factor for price calculation.
MinimumPriceAmount	Decimal		Minimum price amount for this range tier.
MinimumPriceCurrencyName	String		Currency name for the minimum price.
MinimumPriceCurrencyUniqueName	String		Unique identifier of the currency for the minimum price.
MaximumPriceAmount	Decimal		Maximum price amount for this range tier.
MaximumPriceCurrencyName	String		Currency name for the maximum price.
MaximumPriceCurrencyUniqueName	String		Unique identifier of the currency for the maximum price.

ContractRequestLineItemSplitAccountings

Retrieves split accounting details for contract request line items.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemSplitAccountings]
SELECT * FROM [ContractRequestLineItemSplitAccountings] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line item number in collection.
NumberInCollection [KEY]	Int		Number in collection for this split accounting entry.
AccountName	String		Name of the account.
AccountUniqueName	String		Unique identifier of the account.
AccountingCombinationID	String		Accounting combination identifier.
Percentage	Decimal		Percentage split for this accounting entry.
Quantity	Decimal		Quantity for this split accounting entry.
Amount	Decimal		Amount for this split accounting entry.
AmountCurrencyName	String		Currency name for the amount.
AmountCurrencyUniqueName	String		Currency unique identifier for the amount.
ActivityNumberName	String		Name of the activity number.
ActivityNumberNetwork	String		Network associated with the activity number.
ActivityNumberUniqueName	String		Unique identifier of the activity number.
AssetCompanyCode	String		Company code of the asset.
AssetName	String		Name of the asset.
AssetUniqueName	String		Unique identifier of the asset.
AssetClassName	String		Name of the asset class.
AssetClassUniqueName	String		Unique identifier of the asset class.
AssetDescription	String		Description of the asset.
AssetLocationCity	String		City of the asset location.
AssetLocationCountryName	String		Country name of the asset location.
AssetLocationCountryUniqueName	String		Country unique identifier of the asset location.
AssetLocationFax	String		Fax number of the asset location.
AssetLocationLine1	String		Address line 1 of the asset location.
AssetLocationLine2	String		Address line 2 of the asset location.
AssetLocationLine3	String		Address line 3 of the asset location.
AssetLocationName	String		Name of the asset location.
AssetLocationPhone	String		Phone number of the asset location.
AssetLocationPostalCode	String		Postal code of the asset location.
AssetLocationState	String		State of the asset location.
AssetLocationUniqueName	String		Unique identifier of the asset location.
BusinessUnitName	String		Name of the business unit.
BusinessUnitUniqueName	String		Unique identifier of the business unit.
BusinessUnitAM	String		The PeopleSoft asset management business unit.
CompanyName	String		Name of the company.
CompanyUniqueName	String		Unique identifier of the company.
CompanyCodeUniqueName	String		Unique identifier of the company code.
CostCenterCompanyCode	String		Company code of the cost center.
CostCenterName	String		Name of the cost center.
CostCenterUniqueName	String		Unique identifier of the cost center.
DepartmentName	String		Name of the department.
DepartmentUniqueName	String		Unique identifier of the department.
GLBusinessUnitName	String		Name of the GL business unit.
GLBusinessUnitUniqueName	String		Unique identifier of the GL business unit.
GeneralLedgerCompanyCode	String		Company code of the general ledger.
GeneralLedgerName	String		Name of the general ledger.
GeneralLedgerUniqueName	String		Unique identifier of the general ledger.
InternalOrderName	String		Name of the internal order.
InternalOrderUniqueName	String		Unique identifier of the internal order.
LocationCity	String		City of the location.
LocationCountryName	String		Country name of the location.
LocationCountryUniqueName	String		Country unique identifier of the location.
LocationFax	String		Fax number of the location.
LocationLine1	String		Address line 1 of the location.
LocationLine2	String		Address line 2 of the location.
LocationLine3	String		Address line 3 of the location.
LocationName	String		Name of the location.
LocationPhone	String		Phone number of the location.
LocationPostalCode	String		Postal code of the location.
LocationState	String		State of the location.
LocationUniqueName	String		Unique identifier of the location.
NetworkCompanyCode	String		Company code of the network.
NetworkName	String		Name of the network.
NetworkUniqueName	String		Unique identifier of the network.
PSProfileId	String		PS Profile identifier.
SAPLimitSplitValue	String		SAP limit split value.
SAPSerialNumber	String		SAP serial number.
ProcurementUnitName	String		Name of the procurement unit.
ProcurementUnitUniqueName	String		Unique identifier of the procurement unit.
ProductName	String		Name of the product.
ProductUniqueName	String		Unique identifier of the product.
ProjectName	String		Name of the project.
ProjectUniqueName	String		Unique identifier of the project.
RegionName	String		Name of the region.
RegionUniqueName	String		Unique identifier of the region.
StatisticsCodeName	String		Name of the statistics code.
StatisticsCodeUniqueName	String		Unique identifier of the statistics code.
SubAccountName	String		Name of the sub account.
SubAccountUniqueName	String		Unique identifier of the sub account.
TypeName	String		Name of the split accounting type.
TypeUniqueName	String		Unique identifier of the split accounting type.
WBSElementName	String		Name of the WBS element.
WBSElementUniqueName	String		Unique identifier of the WBS element.

ContractRequestLineItemTermPricingTiers

Retrieves term-based pricing tiers for contract request line items with time-period pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemTermPricingTiers]
SELECT * FROM [ContractRequestLineItemTermPricingTiers] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
NumberInCollection [KEY]	Int		Position of the pricing tier object in the response collection.
StartDate	Datetime		Start date for this pricing tier period.
DiscountPercent	Decimal		Discount percentage applied during this time period.
DiscountedPriceAmount	Decimal		Discounted price amount for this time period.
DiscountedPriceCurrencyName	String		Currency name for the discounted price.
DiscountedPriceCurrencyUniqueName	String		Unique identifier of the currency for the discounted price.

ContractRequestLineItemTieredPricingSteps

Retrieves tiered pricing steps for contract request line items with tier-based pricing.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions that are built with the following column and operators:

ContractRequestUniqueName supports the '=,IN' comparison operators.

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

SELECT * FROM [ContractRequestLineItemTieredPricingSteps]
SELECT * FROM [ContractRequestLineItemTieredPricingSteps] WHERE [ContractRequestUniqueName] = 'CR10'

The Sync App processes other filters client-side within the Sync App.

Columns


Name	Type	References	Description
ContractRequestUniqueName [KEY]	String	ContractRequests.UniqueName	The unique identifier of the contract request that contains these line items.
LineItemNumberInCollection [KEY]	Int	ContractRequestLineItems.NumberInCollection	Line number within the contract request.
NumberInCollection [KEY]	Int		Position of the pricing step object in the response collection.
MinTierValue	Decimal		Minimum tier value threshold for this pricing step.
TierValue	Decimal		Tier value (price or percentage) for this pricing step.

Contracts

Retrieves contract header information.

View-Specific Information

Select

The Sync App 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 Sync App processes other filters client-side within the Sync App.

The Sync App 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 Sync App processes ordering by other columns client-side within the Sync App.

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.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

SAP Ariba Procurement Connector for CData Sync Stored Procedures


Name	Description
CreateAdvancedPricing	Creates advanced pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateDiscountedPercentPricing	Creates discount percentage-based pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateDiscountedPricePricing	Creates discounted price-based pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateFormulaPricing	Creates formula pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateRangePricing	Creates range pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateTermBasedPricing	Creates term-based pricing terms for a specified contract request line item in the SAP Ariba solution.
CreateTieredPricing	Creates tiered pricing terms for a specified contract request line item in the SAP Ariba solution.
DeletePricing	Deletes all pricing terms for a specified contract request line item from the SAP Ariba solution.
UpdateAdvancedPricing	Updates advanced pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateContractAccumulators	Updates contract accumulators for specified transaction documents in the SAP Ariba solution.
UpdateDiscountedPercentPricing	Updates discount percentage-based pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateDiscountedPricePricing	Updates discounted price-based pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateFormulaPricing	Updates formula pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateRangePricing	Updates range pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateTermBasedPricing	Updates term-based pricing terms for a specified contract request line item in the SAP Ariba solution.
UpdateTieredPricing	Updates tiered pricing terms for a specified contract request line item in the SAP Ariba solution.

CreateAdvancedPricing

Creates advanced pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

PricingTiers references the ContractRequestLineItemAdvancedPricingTiers.rsd temporary table.

ContractRequestLineItemAdvancedPricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this advanced pricing tier period.
EndDate	Datetime	End date for this advanced pricing tier period.
TierType	String	Tier basis for pricing calculation (Amount, Quantity).
TierValueType	String	Type of tier value calculation (Price, Percent).
IsTierPricingCumulative	String	Whether tier pricing applies cumulatively across tiers (Yes/No).
ShipToUniqueName	String	Unique identifier of the ship-to location for this tier.
ShipToName	String	Name of the ship-to location for this tier.
ShipToLine1	String	Address line 1 of the ship-to location.
ShipToLine2	String	Address line 2 of the ship-to location.
ShipToLine3	String	Address line 3 of the ship-to location.
ShipToCity	String	City of the ship-to location.
ShipToState	String	State of the ship-to location.
ShipToPostalCode	String	Postal code of the ship-to location.
ShipToCountryName	String	Country name of the ship-to location.
ShipToCountryUniqueName	String	Country unique identifier of the ship-to location.
ShipToPhone	String	Phone number of the ship-to location.
ShipToFax	String	Fax number of the ship-to location.
TieredPricingSteps (references ContractRequestLineItemAdvancedPricingTierSteps)	String	Array of tiered pricing steps within this advanced pricing tier.

ContractRequestLineItemAdvancedPricingTierSteps Temporary Table Columns


Column Name	Type	Description
MinTierValue	Decimal	Minimum tier value threshold for this pricing step.
TierValue	Decimal	Tier value (price or percentage) for this pricing step.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
PricingTiers	String	Advanced pricing tier data with dates, locations, and tiered pricing steps.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateDiscountedPercentPricing

Creates discount percentage-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
DiscountPercent	Decimal	Discount percentage applied to the base price for this line item.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateDiscountedPricePricing

Creates discounted price-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
DiscountedPriceAmount	Decimal	The discounted price amount for this line item.
DiscountedPriceCurrencyUniqueName	String	The unique identifier of the currency for the discounted price.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateFormulaPricing

Creates formula pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

GridInfos references the ContractRequestLineItemFormulaPricingGridInfos.rsd temporary table.

ContractRequestLineItemFormulaPricingGridInfos Temporary Table Columns


Column Name	Type	Description
FactorName	String	Factor that this particular grid is representing.
FactorValueType	String	The type of the factor value (String, Boolean, Date).
GridName	String	Grid name as loaded from the import.
FactorCellValues (references ContractRequestLineItemFormulaPricingGridInfoFactorCellValues)	String	List of grid factor and cell values.

ContractRequestLineItemFormulaPricingGridInfoFactorCellValues Temporary Table Columns


Column Name	Type	Description
FactorValue	String	String value for the enumerated factor.
CellValue	String	String value for the enumerated factor cell.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
Formula	String	The formula string for calculating pricing terms.
GridInfos	String	Grid factor information objects used in the formula calculation.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateRangePricing

Creates range pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

RangePricingTiers references the ContractRequestLineItemRangePricingTiers.rsd temporary table.

ContractRequestLineItemRangePricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this range pricing tier period.
EndDate	Datetime	End date for this range pricing tier period.
RangeTierType	String	Type of range tier (Price, Percent).
RangeFactor	Decimal	Range factor for price calculation.
MinimumPriceAmount	Decimal	Minimum price amount for this range tier.
MinimumPriceCurrencyName	String	Currency name for the minimum price.
MinimumPriceCurrencyUniqueName	String	Unique identifier of the currency for the minimum price.
MaximumPriceAmount	Decimal	Maximum price amount for this range tier.
MaximumPriceCurrencyName	String	Currency name for the maximum price.
MaximumPriceCurrencyUniqueName	String	Unique identifier of the currency for the maximum price.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
RangePricingTiers	String	Range pricing tier data with minimum and maximum price ranges per period.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateTermBasedPricing

Creates term-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

PricingTiers references the ContractRequestLineItemTermPricingTiers.rsd temporary table.

ContractRequestLineItemTermPricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this pricing tier period.
DiscountPercent	Decimal	Discount percentage applied during this time period.
DiscountedPriceAmount	Decimal	Discounted price amount for this time period.
DiscountedPriceCurrencyName	String	Currency name for the discounted price.
DiscountedPriceCurrencyUniqueName	String	Unique identifier of the currency for the discounted price.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
PricingTiers	String	Term-based pricing tier data with time periods and discount values.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

CreateTieredPricing

Creates tiered pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

TieredPricingSteps references the ContractRequestLineItemTieredPricingSteps.rsd temporary table.

ContractRequestLineItemTieredPricingSteps Temporary Table Columns


Column Name	Type	Description
MinTierValue	Decimal	Minimum tier value threshold for this pricing step.
TierValue	Decimal	Tier value (price or percentage) for this pricing step.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
TierType	String	Tier basis for pricing calculation (Amount, Quantity). The allowed values are Amount, Quantity.
TierValueType	String	Type of tier value calculation (Price, Percent). The allowed values are Price, Percent.
IsTierPricingCumulative	String	Whether tier pricing applies cumulatively across tiers (Yes/No). The allowed values are Yes, No.
AmountCurrencyUniqueName	String	The unique identifier of the currency for tier amounts.
TieredPricingSteps	String	Tiered pricing step data with tier values and thresholds.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

DeletePricing

Deletes all pricing terms for a specified contract request line item from the SAP Ariba solution.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

GetOAuthAccessToken

Generates an OAuth access token token for a SAP Ariba API.

Input


Name	Type	Description
GrantType	String	Authorization grant type. The allowed values are client_credentials, openapi_2lo.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

RefreshOAuthAccessToken

Refreshes the OAuth access token when it expires.

Input


Name	Type	Description

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The token to be included in each request for access to protected resources.
OAuthRefreshToken	String	The token to be included in a request for a new access token when your current access token has expired.
ExpiresIn	String	The duration in seconds before the token expires. The default is 1440 seconds, or 24 minutes.
TimeUpdated	String	The time when the access token was created.
TokenType	String	The access token type.

UpdateAdvancedPricing

Updates advanced pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

PricingTiers references the ContractRequestLineItemAdvancedPricingTiers.rsd temporary table.

ContractRequestLineItemAdvancedPricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this advanced pricing tier period.
EndDate	Datetime	End date for this advanced pricing tier period.
TierType	String	Tier basis for pricing calculation (Amount, Quantity).
TierValueType	String	Type of tier value calculation (Price, Percent).
IsTierPricingCumulative	String	Whether tier pricing applies cumulatively across tiers (Yes/No).
ShipToUniqueName	String	Unique identifier of the ship-to location for this tier.
ShipToName	String	Name of the ship-to location for this tier.
ShipToLine1	String	Address line 1 of the ship-to location.
ShipToLine2	String	Address line 2 of the ship-to location.
ShipToLine3	String	Address line 3 of the ship-to location.
ShipToCity	String	City of the ship-to location.
ShipToState	String	State of the ship-to location.
ShipToPostalCode	String	Postal code of the ship-to location.
ShipToCountryName	String	Country name of the ship-to location.
ShipToCountryUniqueName	String	Country unique identifier of the ship-to location.
ShipToPhone	String	Phone number of the ship-to location.
ShipToFax	String	Fax number of the ship-to location.
TieredPricingSteps (references ContractRequestLineItemAdvancedPricingTierSteps)	String	Array of tiered pricing steps within this advanced pricing tier.

ContractRequestLineItemAdvancedPricingTierSteps Temporary Table Columns


Column Name	Type	Description
MinTierValue	Decimal	Minimum tier value threshold for this pricing step.
TierValue	Decimal	Tier value (price or percentage) for this pricing step.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
PricingTiers	String	Advanced pricing tier data with dates, locations, and tiered pricing steps.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateContractAccumulators

Updates contract accumulators for specified transaction documents in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

ContractAccumulators references the Internal_ContractAccumulators.rsd temporary table.

ContractAccumulators Temporary Table Columns


Column Name	Type	Description
MaNumberInCollection	Int	Unique number to identify the contract line item number in collection.
MaUniqueName	String	Unique name associated with Master Agreement.
TxnDocLineQuantity	Decimal	Quantity associated with transaction document line.
TxnDocNumberInCollection	Int	Unique number to identify transaction document line item number.
TxnDocLineAmountContractAmount	Decimal	Transaction document line amount in contract currency.
TxnDocLineAmountContractCurrencyUniqueName	String	Transaction document line amount contract currency unique name.
TxnDocLineAmountContractCurrencyName	String	Transaction document line amount contract currency name.
TxnDocLineAmountProcurementAmount	Decimal	Transaction document line amount in procurement currency.
TxnDocLineAmountProcurementCurrencyUniqueName	String	Transaction document line amount procurement currency unique name.
TxnDocLineAmountProcurementCurrencyName	String	Transaction document line amount procurement currency name.
TxnDocLineChargeAmountContractAmount	Decimal	Transaction document line charge amount in contract currency.
TxnDocLineChargeAmountContractCurrencyUniqueName	String	Transaction document line charge amount contract currency unique name.
TxnDocLineChargeAmountContractCurrencyName	String	Transaction document line charge amount contract currency name.
TxnDocLineChargeAmountProcurementAmount	Decimal	Transaction document line charge amount in procurement currency.
TxnDocLineChargeAmountProcurementCurrencyUniqueName	String	Transaction document line charge amount procurement currency unique name.
TxnDocLineChargeAmountProcurementCurrencyName	String	Transaction document line charge amount procurement currency name.
TxnDocLineDiscountAmountContractAmount	Decimal	Transaction document line discount amount in contract currency.
TxnDocLineDiscountAmountContractCurrencyUniqueName	String	Transaction document line discount amount contract currency unique name.
TxnDocLineDiscountAmountContractCurrencyName	String	Transaction document line discount amount contract currency name.
TxnDocLineDiscountAmountProcurementAmount	Decimal	Transaction document line discount amount in procurement currency.
TxnDocLineDiscountAmountProcurementCurrencyUniqueName	String	Transaction document line discount amount procurement currency unique name.
TxnDocLineDiscountAmountProcurementCurrencyName	String	Transaction document line discount amount procurement currency name.
TxnDocLineTaxAmountContractAmount	Decimal	Transaction document line tax amount in contract currency.
TxnDocLineTaxAmountContractCurrencyUniqueName	String	Transaction document line tax amount contract currency unique name.
TxnDocLineTaxAmountContractCurrencyName	String	Transaction document line tax amount contract currency name.
TxnDocLineTaxAmountProcurementAmount	Decimal	Transaction document line tax amount in procurement currency.
TxnDocLineTaxAmountProcurementCurrencyUniqueName	String	Transaction document line tax amount procurement currency unique name.
TxnDocLineTaxAmountProcurementCurrencyName	String	Transaction document line tax amount procurement currency name.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
Validate	Boolean	Set validate to true for validation only. By default updates accumulators along with validation.
Action	String	Action to perform on the contract accumulator. The allowed values are Requisition:Submitted, Requisition:Withdrawn, Requisition:Denied, Requisition:Edited, Requisition:Approved, Requisition:Canceled, Order:Ordered, Order:Canceled, Receipt:Received, Invoice:Invoiced, Invoice:Reconciled, InvoiceReconciliation:Paid, Approver:Requisition:Edited, PaymentRequest:Canceled.
TxnIdentifier	String	Transaction identifier for the accumulator update.
TxnDocUniqueName	String	Unique name of the transaction document.
ContractAccumulators	String	Array of accumulator data to update for the contract.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateDiscountedPercentPricing

Updates discount percentage-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
DiscountPercent	Decimal	Discount percentage applied to the base price for this line item.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateDiscountedPricePricing

Updates discounted price-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
DiscountedPriceAmount	Decimal	The discounted price amount for this line item.
DiscountedPriceCurrencyUniqueName	String	The unique identifier of the currency for the discounted price.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateFormulaPricing

Updates formula pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

GridInfos references the ContractRequestLineItemFormulaPricingGridInfos.rsd temporary table.

ContractRequestLineItemFormulaPricingGridInfos Temporary Table Columns


Column Name	Type	Description
FactorName	String	Factor that this particular grid is representing.
FactorValueType	String	The type of the factor value (String, Boolean, Date).
GridName	String	Grid name as loaded from the import.
FactorCellValues (references ContractRequestLineItemFormulaPricingGridInfoFactorCellValues)	String	List of grid factor and cell values.

ContractRequestLineItemFormulaPricingGridInfoFactorCellValues Temporary Table Columns


Column Name	Type	Description
FactorValue	String	String value for the enumerated factor.
CellValue	String	String value for the enumerated factor cell.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
Formula	String	The formula string for calculating pricing terms.
GridInfos	String	Grid factor information objects used in the formula calculation.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateRangePricing

Updates range pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

RangePricingTiers references the ContractRequestLineItemRangePricingTiers.rsd temporary table.

ContractRequestLineItemRangePricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this range pricing tier period.
EndDate	Datetime	End date for this range pricing tier period.
RangeTierType	String	Type of range tier (Price, Percent).
RangeFactor	Decimal	Range factor for price calculation.
MinimumPriceAmount	Decimal	Minimum price amount for this range tier.
MinimumPriceCurrencyName	String	Currency name for the minimum price.
MinimumPriceCurrencyUniqueName	String	Unique identifier of the currency for the minimum price.
MaximumPriceAmount	Decimal	Maximum price amount for this range tier.
MaximumPriceCurrencyName	String	Currency name for the maximum price.
MaximumPriceCurrencyUniqueName	String	Unique identifier of the currency for the maximum price.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
RangePricingTiers	String	Range pricing tier data with minimum and maximum price ranges per period.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateTermBasedPricing

Updates term-based pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

PricingTiers references the ContractRequestLineItemTermPricingTiers.rsd temporary table.

ContractRequestLineItemTermPricingTiers Temporary Table Columns


Column Name	Type	Description
StartDate	Datetime	Start date for this pricing tier period.
DiscountPercent	Decimal	Discount percentage applied during this time period.
DiscountedPriceAmount	Decimal	Discounted price amount for this time period.
DiscountedPriceCurrencyName	String	Currency name for the discounted price.
DiscountedPriceCurrencyUniqueName	String	Unique identifier of the currency for the discounted price.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
PricingTiers	String	Term-based pricing tier data with time periods and discount values.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

UpdateTieredPricing

Updates tiered pricing terms for a specified contract request line item in the SAP Ariba solution.

Procedure-Specific Information

The following input can accept either a temporary table name or an API JSON aggregate as a value.

TieredPricingSteps references the ContractRequestLineItemTieredPricingSteps.rsd temporary table.

ContractRequestLineItemTieredPricingSteps Temporary Table Columns


Column Name	Type	Description
MinTierValue	Decimal	Minimum tier value threshold for this pricing step.
TierValue	Decimal	Tier value (price or percentage) for this pricing step.

Input


Name	Type	Description
Realm	String	SAP Ariba realm identifier for the tenant.
ContractRequestUniqueName	String	The unique identifier of the contract request that contains the line item.
LineItemNumberInCollection	Int	The line item number within the contract request collection.
TierType	String	Tier basis for pricing calculation (Amount, Quantity). The allowed values are Amount, Quantity.
TierValueType	String	Type of tier value calculation (Price, Percent). The allowed values are Price, Percent.
IsTierPricingCumulative	String	Whether tier pricing applies cumulatively across tiers (Yes/No). The allowed values are Yes, No.
AmountCurrencyUniqueName	String	The unique identifier of the currency for tier amounts.
TieredPricingSteps	String	Tiered pricing step data with tier values and thresholds.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether or not the operation was successful.
Details	String	Any extra details on the operation's execution.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
ANID	Specify your SAP Ariba Network ID.
API	Specify which API you would like the provider to retrieve SAP Ariba data from.
APIKey	Your OAuth application key.
AuthScheme	Set the type of authentication to use when connecting to SAP Ariba.
Environment	The environment to use when connecting to SAP Ariba.
DataCenter	The data center where your account's data is hosted.
Realm	Specify the realm from which you would like to access data.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimezone	The time zone of the SAP Ariba API.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
ANID	Specify your SAP Ariba Network ID.
API	Specify which API you would like the provider to retrieve SAP Ariba data from.
APIKey	Your OAuth application key.
AuthScheme	Set the type of authentication to use when connecting to SAP Ariba.
Environment	The environment to use when connecting to SAP Ariba.
DataCenter	The data center where your account's data is hosted.
Realm	Specify the realm from which you would like to access data.

ANID

Specify your SAP Ariba Network ID.

Remarks

To find your ID as a buyer: https://support.ariba.com/item/view/187831

To find your ID as a supplier: https://support.ariba.com/item/view/KB0392438

API

Specify which API you would like the provider to retrieve SAP Ariba data from.

Remarks

Specify which API you would like the Sync App to retrieve SAP Ariba data from.

APIKey

Your OAuth application key.

Remarks

SAP Ariba OAuth application keys are generated when an OAuth application is first created. See Creating a Custom OAuth App for more information

AuthScheme

Set the type of authentication to use when connecting to SAP Ariba.

Remarks

OAuthClient: Set to this to perform OAuth 2.0 with client credentials grant type authentication.

Environment

The environment to use when connecting to SAP Ariba.

Remarks

The production environment returns real data and is tied to your application.

The test environment returns mock data and is tied to your application.

DataCenter

The data center where your account's data is hosted.

Remarks

The data center where your account's data is hosted.

Realm

Specify the realm from which you would like to access data.

Remarks

Specify the realm from which you would like to access data.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to SAP Ariba. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to SAP Ariba. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to SAP Ariba. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

BASIC: The Sync App performs HTTP basic authentication.
DIGEST: The Sync App performs HTTP digest authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\SAPAribaProcurement Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimezone	The time zone of the SAP Ariba API.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

IncludeCustomFields

Determines whether the provider exposes custom fields in SAP Ariba tables as columns.

Remarks

Determines whether the Sync App exposes custom fields in SAP Ariba tables as columns.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

MaxThreads

Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

Using more concurrent threads improves performance at the cost of additional memory usage.

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting


Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.

Remarks

When processing a query, instead of requesting all of the queried data at once from SAP Ariba, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

ServerTimezone

The time zone of the SAP Ariba API.

Remarks

This property is used to format timestamps for data modification and filtering operations. By default, the Sync App infers the time zone from timestamps in the response data.

Possible values include "GMT", "America/New_York", etc.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

SAP Ariba Procurement Connector for CData Sync

SAP Ariba Procurement Connector for CData Sync

Overview

SAP Ariba Version Support

Establishing a Connection

Adding a Connection to SAP Ariba

Connecting to SAP Ariba

Authenticating to SAP Ariba

OAuthClient

Automatic OAuth

Manual OAuth

Creating a Custom OAuth App

Create a Custom OAuth App

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Using Purchase Orders Buyer API V1

Using Purchase Orders Supplier API V1

Using Operational Reporting API For Procurement V2

Using Invoice Header Data Extraction API V1

Using Contract Compliance API V1

Purchase Orders Buyer API V1 Data Model

Overview

Key Features

Views

Stored Procedures

Views

SAP Ariba Procurement Connector for CData Sync Views

LineItems

View-Specific Information

Select

Columns

Orders

View-Specific Information

Select

Columns

Stored Procedures

SAP Ariba Procurement Connector for CData Sync Stored Procedures

GetOAuthAccessToken

Input

Result Set Columns

RefreshOAuthAccessToken

Input

Result Set Columns

Purchase Orders Supplier API V1 Data Model

Overview

Key Features

Views

Stored Procedures

Views

SAP Ariba Procurement Connector for CData Sync Views

LineItems

View-Specific Information

Select

Columns

Orders

View-Specific Information

Select

Columns

Stored Procedures

SAP Ariba Procurement Connector for CData Sync Stored Procedures

GetOAuthAccessToken

Input

Result Set Columns

RefreshOAuthAccessToken

Input

Result Set Columns

Operational Reporting API For Procurement V2 Data Model

Overview

Key Features