SAP Ariba Procurement Connector for CData Sync

Build 24.0.9175
  • SAP Ariba Procurement
    • Establishing a Connection
      • Creating a Custom OAuth App
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Purchase Orders Buyer API V1 Data Model
        • Views
          • LineItems
          • Orders
      • Purchase Orders Supplier API V1 Data Model
        • Views
          • LineItems
          • Orders
      • Operational Reporting API For Procurement V2 Data Model
        • Tables
          • Views
        • Views
          • ContractSAPcreatedRangev1
          • ContractSAPupdatedRangev1
          • CopyOrderSAPcreatedRange
          • CopyOrderSAPupdatedRange
          • DirectOrderSAPcreatedRange
          • DirectOrderSAPupdatedRange
          • ERPOrderSAPcreatedRange
          • ERPOrderSAPupdatedRange
          • InvoiceReconciliationSAPcreatedRange
          • InvoiceReconciliationSAPupdatedRange
          • ReceiptSAPcreatedRange
          • ReceiptSAPupdatedRange
          • ViewChildElements
          • ViewFields
    • Connection String Options
      • Authentication
        • ANID
        • API
        • APIKey
        • AuthScheme
        • Environment
        • DataCenter
        • Realm
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • MaxThreads
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UserDefinedViews

SAP Ariba Procurement Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your SAP Ariba Procurement data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The SAP Ariba connector can be used from the CData Sync application to pull data from SAP Ariba and move it to any of the supported destinations.

SAP Ariba Version Support

The Sync App leverages V1 of the SAP Ariba Purchase Orders Buyer API and Purchase Orders Supplier API to enable access to SAP Ariba data.

SAP Ariba Procurement Connector for CData Sync

Establishing a Connection

Adding a Connection to SAP Ariba

To add a connection to SAP Ariba:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. 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:

  • ANID: Your Ariba Network ID.
  • API: Specify which API you would like the Sync App to retrieve SAP Ariba data from. Select the Buyer or Supplier API based on your business role.
  • 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:

  1. The Sync App obtains an access token from SAP Ariba and uses it to request data.
  2. The Sync App refreshes the access token automatically when it expires.
  3. 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.

SAP Ariba Procurement Connector for CData Sync

Creating a Custom OAuth App

Create a Custom OAuth App

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

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

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

The Sync App uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Sync App processes ordering by other columns client-side within the Sync App.

  • SupplierANID
  • BuyerANID
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'

SELECT * FROM Orders ORDER BY BuyerANID ASC

SELECT * FROM Orders ORDER BY SupplierANID DESC

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

The Sync App uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Sync App processes ordering by other columns client-side within the Sync App.

  • SupplierANID
  • BuyerANID
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'

SELECT * FROM Orders ORDER BY BuyerANID ASC

SELECT * FROM Orders ORDER BY SupplierANID DESC

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.

SAP Ariba Procurement Connector for CData Sync

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 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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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

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.
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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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'.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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 Supported document type.
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.

SAP Ariba Procurement Connector for CData Sync

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


PropertyDescription
ANIDSpecify your SAP Ariba Network ID.
APISpecify which API you would like the provider to retrieve SAP Ariba data from.
APIKeyYour OAuth application key.
AuthSchemeSet the type of authentication to use when connecting to SAP Ariba.
EnvironmentThe environment to use when connecting to SAP Ariba.
DataCenterThe data center where your account's data is hosted.
RealmSpecify the realm from which you would like to access data.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


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

Schema


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
SAP Ariba Procurement Connector for CData Sync

Authentication

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


PropertyDescription
ANIDSpecify your SAP Ariba Network ID.
APISpecify which API you would like the provider to retrieve SAP Ariba data from.
APIKeyYour OAuth application key.
AuthSchemeSet the type of authentication to use when connecting to SAP Ariba.
EnvironmentThe environment to use when connecting to SAP Ariba.
DataCenterThe data center where your account's data is hosted.
RealmSpecify the realm from which you would like to access data.
SAP Ariba Procurement Connector for CData Sync

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

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

DataCenter

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

Remarks

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

SAP Ariba Procurement Connector for CData Sync

Realm

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

Remarks

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

SAP Ariba Procurement Connector for CData Sync

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecretSpecifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
SAP Ariba Procurement Connector for CData Sync

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SAP Ariba Procurement Connector for CData Sync

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SAP Ariba Procurement Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
SAP Ariba Procurement Connector for CData Sync

SSLServerCert

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

SAP Ariba Procurement Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
SAP Ariba Procurement Connector for CData Sync

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

SAP Ariba Procurement Connector for CData Sync

ProxyServer

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

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

SAP Ariba Procurement Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

SAP Ariba Procurement Connector for CData Sync

ProxyAuthScheme

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

Remarks

The authentication type can be one of the following:

  • 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: Set this when 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.

SAP Ariba Procurement Connector for CData Sync

ProxyUser

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 user name of a user registered with the proxy server.
DIGEST The user name 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.

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

SAP Ariba Procurement Connector for CData Sync

ProxyPassword

The password associated with 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.

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

SAP Ariba Procurement Connector for CData Sync

ProxySSLType

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 :

AUTODefault 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.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe 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.

SAP Ariba Procurement Connector for CData Sync

ProxyExceptions

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 that 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.

SAP Ariba Procurement Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
SAP Ariba Procurement Connector for CData Sync

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

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

SAP Ariba Procurement Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies 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.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
SAP Ariba Procurement Connector for CData Sync

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

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

Miscellaneous

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


PropertyDescription
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

SAP Ariba Procurement Connector for CData Sync

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.

SAP Ariba Procurement Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

SAP Ariba Procurement Connector for CData Sync

Pagesize

Specifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

SAP Ariba Procurement Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

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: "*=*"

SAP Ariba Procurement Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

SAP Ariba Procurement Connector for CData Sync

UserDefinedViews

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

Remarks

This property 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175