Cloud

Build 25.0.9434
  • SAP Ariba Procurement
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリの作成
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Purchase Orders Buyer API V1 データモデル
        • ビュー
          • LineItems
          • Orders
        • ストアドプロシージャ
      • Purchase Orders Supplier API V1 データモデル
        • ビュー
          • LineItems
          • Orders
        • ストアドプロシージャ
      • Operational Reporting API For Procurement V2 データモデル
        • テーブル
          • Views
        • ビュー
          • ContractSAPcreatedRangev1
          • ContractSAPupdatedRangev1
          • CopyOrderSAPcreatedRange
          • CopyOrderSAPupdatedRange
          • DirectOrderSAPcreatedRange
          • DirectOrderSAPupdatedRange
          • ERPOrderSAPcreatedRange
          • ERPOrderSAPupdatedRange
          • InvoiceReconciliationSAPcreatedRange
          • InvoiceReconciliationSAPupdatedRange
          • ReceiptSAPcreatedRange
          • ReceiptSAPupdatedRange
          • ViewChildElements
          • ViewFields
        • ストアドプロシージャ
          • CreateChildElementSchema
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • ANID
        • API
        • APIKey
        • AuthScheme
        • Environment
        • DataCenter
        • Realm
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • MaxThreads
        • Pagesize
        • PseudoColumns
        • Timeout
    • Third Party Copyrights

SAP Ariba Procurement - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSAP Ariba へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSAP Ariba に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、SAP Ariba への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:SAP Ariba は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのSAP Ariba への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

SAP Ariba への接続

接続の確立 は、CData Cloud にデータベースを作成するためのSAP Ariba への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してSAP Ariba からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、SAP Ariba に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

SAP Ariba への接続

接続するには以下を設定します。

  • ANID:Ariba Network ID。
  • API:Cloud にSAP Ariba データを取得させたいAPI を指定。ビジネスロールに基づき、Buyer またはSupplier API を選択します。
  • Environment:接続に使用する開発環境。

SAP Ariba への認証

SAP Ariba API への認証はOAuth 経由で行われます。SAP Ariba のOAuth フローは、ユーザーインタラクションを必要としません。

OAuthClient

AuthScheme をOAuthClient に設定します。

サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。

アプリケーションの作成については、カスタムOAuth アプリの作成 を参照してください。

InitiateOAuth のデフォルトは、OAuthClient 認証スキームのGETANDREFRESH です。

OAuth の自動リフレッシュ

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • APIKey:アプリケーション設定のApplication key。
  • OAuthClientId:アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret:アプリケーション設定のOAuth Secret。

接続すると、Cloud は自動でOAuth プロセスを完了します。

  1. Cloud はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
  2. Cloud はアクセストークンの期限が切れると自動的にリフレッシュします。
  3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます。

OAuth の手動リフレッシュ

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • APIKey:アプリケーション設定のApplication key。
  • OAuthClientId:アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret:アプリケーション設定のOAuth Secret。

次に、GetOAuthAccessToken ストアドプロシージャを呼び出します。GrantType インプットをclient_credentials またはopenapi_2lo(レガシーユーザーで利用可能)に設定します。指定されていない場合、GrantType のデフォルトはclient_credentials になります。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

  • InitiateOAuth:REFRESH。
  • APIKey:アプリケーション設定のApplication key。
  • OAuthClientId:アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret:アプリケーション設定のOAuth Secret。
  • OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
  • OAuthRefreshToken:GetOAuthAccessToken によって返されたリフレッシュトークン。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

  • APIKey:アプリケーション設定のApplication key。
  • OAuthClientId:アプリケーション設定のOAuth Client Id。
  • OAuthClientSecret:アプリケーション設定のOAuth Secret。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムOAuth アプリの作成

カスタムOAuth アプリの作成

APIKey、OAuthClientId、およびOAuthClientSecret を取得するには、次の手順を実行してください。

  1. https://developer.ariba.com に移動してサインインします。
  2. Manage(左下のアイコン)をクリックします。
  3. 検索フィールドの隣にある+ ボタンをクリックします。
  4. Application Name およびDescription を入力し、Submit をクリックします。
  5. Actions -> Request API Access をクリックします。
  6. データを取得したいAPI を選択します。これはAPI 接続プロパティに対応します。
  7. レルムを選択します。
  8. Submit をクリックします。
  9. リクエストが承認されるのを待ちます。
  10. 承認されたら、Actions -> Generate OAuth Secret をクリックします。
  11. 表示されるApplication key、OAuth Client Id、およびOAuth Secret を保存します。

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

CData Cloud

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にCloud が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

CData Cloud

データモデル

CData Cloud は、SAP Ariba API のエンティティをビューおよびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。

Purchase Orders Buyer API V1 の利用

Purchase Orders Buyer API V1 で利用可能なエンティティについては、Purchase Orders Buyer API V1 データモデル を参照してください。

Purchase Orders Supplier API V1 の利用

Purchase Orders Supplier API V1 で利用可能なエンティティについては、Purchase Orders Supplier API V1 データモデル を参照してください。

Operational Reporting API For Procurement V2 の利用

Operational Reporting API For Procurement V2 で利用可能なエンティティおよびビューテンプレート例については、Operational Reporting API For Procurement V2 データモデル を参照してください。

CData Cloud

Purchase Orders Buyer API V1 データモデル

概要

このセクションでは、Purchase Orders Buyer API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのSAP Ariba エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
  • ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとアカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー は、SAP Ariba オーダーをモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - SAP Ariba Procurement ビュー

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

CData Cloud

LineItems

Retrieves line-item information from purchase orders.

View-Specific Information

Select

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

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

CData Cloud

Orders

Retrieves purchase-order header information.

View-Specific Information

Select

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

  • 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 Cloud uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Cloud processes ordering by other columns client-side within the Cloud.

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

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Procurement ストアドプロシージャ

Name Description

CData Cloud

Purchase Orders Supplier API V1 データモデル

概要

このセクションでは、Purchase Orders Supplier API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのSAP Ariba エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
  • ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとアカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー は、SAP Ariba オーダーをモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - SAP Ariba Procurement ビュー

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

CData Cloud

LineItems

Retrieves line-item information from purchase orders.

View-Specific Information

Select

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

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

CData Cloud

Orders

Retrieves purchase-order header information.

View-Specific Information

Select

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

  • 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 Cloud uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Cloud processes ordering by other columns client-side within the Cloud.

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

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Procurement ストアドプロシージャ

Name Description

CData Cloud

Operational Reporting API For Procurement V2 データモデル

概要

このセクションでは、Operational Reporting API For Procurement で利用可能なオブジェクト例を示し、SQL の使用についての詳細を説明します。

これは動的スキーマです。ここに挙げたビューテンプレートは、ドキュメント用の例です。

主要機能

  • Cloud はドキュメント、フォルダ、およびグループなどのSAP Ariba エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
  • ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Cloud を使用するとアカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Views のようなリソースを静的にモデル化するように定義されています。

ビュー

ビュー は、SAP Ariba のトランザクションデータをモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。

CData Cloud

テーブル

Cloud はSAP Ariba のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - SAP Ariba Procurement テーブル

Name Description
Views Get all view templates for a realm.

CData Cloud

Views

Get all view templates for a realm.

View-Specific Information

Select

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

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

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - SAP Ariba Procurement ビュー

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.

CData Cloud

ContractSAPcreatedRangev1

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

View-Specific Information

Select

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

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

CData Cloud

ContractSAPupdatedRangev1

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

View-Specific Information

Select

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

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

CData Cloud

CopyOrderSAPcreatedRange

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

View-Specific Information

Select

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

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

CData Cloud

CopyOrderSAPupdatedRange

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

View-Specific Information

Select

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

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

CData Cloud

DirectOrderSAPcreatedRange

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

View-Specific Information

Select

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

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

CData Cloud

DirectOrderSAPupdatedRange

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

View-Specific Information

Select

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

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

CData Cloud

ERPOrderSAPcreatedRange

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

View-Specific Information

Select

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

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

CData Cloud

ERPOrderSAPupdatedRange

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

View-Specific Information

Select

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

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

CData Cloud

InvoiceReconciliationSAPcreatedRange

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

View-Specific Information

Select

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

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

CData Cloud

InvoiceReconciliationSAPupdatedRange

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

View-Specific Information

Select

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

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

CData Cloud

ReceiptSAPcreatedRange

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

View-Specific Information

Select

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

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

CData Cloud

ReceiptSAPupdatedRange

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

View-Specific Information

Select

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

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

CData Cloud

ViewChildElements

Get all child elements for a specific view template.

View-Specific Information

Select

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

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

CData Cloud

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 Cloud uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Cloud processes other filters client-side within the Cloud.

  • ViewTemplateName supports the '=' comparison operator.
  • DocumentType supports the '=' comparison operator.
For example, the following queries are processed server side:
SELECT * FROM ViewFields WHERE ViewTemplateName='Contract_SAP_createdRange_v1'
SELECT * FROM ViewFields WHERE DocumentType='DirectOrder'

Columns

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

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Procurement ストアドプロシージャ

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

CData Cloud

CreateChildElementSchema

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

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

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

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

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

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

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

{
    "Records": [
        {
            "ApprovedState": "Approved",
            "LineItems": [
                {
                    "SplitAccountings": [
                        {
                            "NumberInCollection": 1,
                        }
                    ],
                    "Description.Description": "Sample",
To generate a schema for the LineItems array of documents, you can execute the below query:
EXECUTE CreateChildElementSchema ViewTemplateName='View', ChildElement='LineItems', TableName = 'View_LineItems', FileName='C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View_LineItems.rsd'
To generate a schema for the LineItems.SplitAccountings array of documents, you can execute the below query:
EXECUTE CreateChildElementSchema ViewTemplateName='View', ChildElement='LineItems.SplitAccountings', TableName = 'View_LineItems_SplitAccountings', FileName='C:/Users/User/AppData/Roaming/CData/SAPAribaProcurement Data Provider/Schema/OperationalReportingAPIForProcurement-V2/View_LineItems_SplitAccountings.rsd'

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

SELECT * FROM ViewChildElements WHERE ViewTemplateName='OrderView'
Note that for the generated schema files to be used in queries they must be present in the API schema folder within the Location connection property.

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

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

ChildElement='[ObjectN.ame].Array'

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

Input

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

Result Set Columns

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

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、SAP Ariba のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Orders テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのSAP Ariba プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Orders テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
ANIDSAP Ariba Network ID を指定。
APIprovider にSAP Ariba データを取得させたいAPI を指定。
APIKey使用するOAuth アプリケーションキー。
AuthSchemeSAP Ariba に接続する際に使用する認証の種類に設定。
EnvironmentSAP Ariba への接続に使用する環境。
DataCenterアカウントのデータがホストされているデータセンター。
Realmデータにアクセスするレルムを指定。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous


プロパティ説明
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Pagesizeprovider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
ANIDSAP Ariba Network ID を指定。
APIprovider にSAP Ariba データを取得させたいAPI を指定。
APIKey使用するOAuth アプリケーションキー。
AuthSchemeSAP Ariba に接続する際に使用する認証の種類に設定。
EnvironmentSAP Ariba への接続に使用する環境。
DataCenterアカウントのデータがホストされているデータセンター。
Realmデータにアクセスするレルムを指定。
CData Cloud

ANID

SAP Ariba Network ID を指定。

データ型

string

デフォルト値

""

解説

バイヤーとしてのID を見つけるには: https://support.ariba.com/item/view/187831

サプライヤーとしてのID を見つけるには: https://support.ariba.com/item/view/KB0392438

CData Cloud

API

provider にSAP Ariba データを取得させたいAPI を指定。

Possible Values

PurchaseOrdersBuyerAPI-V1, PurchaseOrdersSupplierAPI-V1, OperationalReportingAPIForProcurement-V2

データ型

string

デフォルト値

"PurchaseOrdersBuyerAPI-V1"

解説

Cloud にSAP Ariba データを取得させたいAPI を指定。

CData Cloud

APIKey

使用するOAuth アプリケーションキー。

データ型

string

デフォルト値

""

解説

SAP Ariba OAuth アプリケーションキーは、OAuth アプリケーションが最初に作成されたときに生成されます。詳しくは、カスタムOAuth アプリの作成 を参照してください。

CData Cloud

AuthScheme

SAP Ariba に接続する際に使用する認証の種類に設定。

Possible Values

OAuthClient

データ型

string

デフォルト値

"OAuthClient"

解説

  • OAuthClient:OAuth 2.0 クライアントクレデンシャルグラントタイプ認証を実行する場合に設定。

CData Cloud

Environment

SAP Ariba への接続に使用する環境。

Possible Values

PRODUCTION, TEST

データ型

string

デフォルト値

"PRODUCTION"

解説

PRODUCTION 環境は実際のデータを返し、アプリケーションに関連付けられます。

TEST 環境はモックデータを返し、アプリケーションに関連付けられます。

CData Cloud

DataCenter

アカウントのデータがホストされているデータセンター。

Possible Values

US, EU, RU, CN, UAE, KSA, AU, JP

データ型

string

デフォルト値

"US"

解説

アカウントのデータがホストされているデータセンター。

CData Cloud

Realm

データにアクセスするレルムを指定。

データ型

string

デフォルト値

""

解説

データにアクセスするレルムを指定。

CData Cloud

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
CData Cloud

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

CData Cloud

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Pagesizeprovider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

IncludeCustomFields

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

データ型

bool

デフォルト値

false

解説

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

CData Cloud

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

CData Cloud

MaxThreads

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

データ型

string

デフォルト値

"5"

解説

このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。

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

CData Cloud

Pagesize

provider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

100

解説

クエリを処理する際、SAP Ariba でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

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

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

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

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

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

NSIS 3.10

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

1. DEFINITIONS

"Contribution" means:

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

i) changes to the Program, and

ii) additions to the Program;

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

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

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

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

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

2. GRANT OF RIGHTS

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

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

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

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

3. REQUIREMENTS

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

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

b) its license agreement:

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

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

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

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

When the Program is made available in source code form:

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

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

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

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

4. COMMERCIAL DISTRIBUTION

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

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

5. NO WARRANTY

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

6. DISCLAIMER OF LIABILITY

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

7. GENERAL

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

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

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

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

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

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