Skip to main content

SAP Ariba

SAP Ariba is a cloud procurement, sourcing, and spend management platform covering the full procure-to-pay and source-to-pay lifecycle. It connects buyers and suppliers through the Ariba Network — the world's largest B2B commerce network — for sourcing events, contract management, requisition and order processing, invoice reconciliation, and supplier risk monitoring. It gives organizations spend visibility and policy compliance.

SAP Ariba icon

Power end-to-end data operations for your SAP Ariba API with Nexla. Our bi-directional SAP Ariba connector is purpose-built for SAP Ariba, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to SAP Ariba or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your SAP Ariba workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to the SAP Ariba APIs, your organization must be enrolled to use SAP Ariba's Open APIs and you must have an application registered in the SAP Ariba Developer Portal. The credential requires an OAuth 2.0 Client ID and Client Secret, an Application API Key, and your Ariba Realm identifier.

Register Your Organization for SAP Ariba Open APIs

SAP Ariba's Open APIs are available to customers and partners who have been granted API access for their Ariba realm. To request access, contact your SAP Ariba account representative or visit the SAP Ariba Developer Portal. An Organization Admin for your Ariba account is required to complete the registration process and approve API access requests.

Create an Application in the SAP Ariba Developer Portal

Each integration that calls SAP Ariba APIs must be backed by a registered application in the Developer Portal. Creating the application generates the Application Key and OAuth credentials required by Nexla.

  1. Sign in to the SAP Ariba Developer Portal using your SAP credentials. Select the correct data center region (for example, US or EU) when prompted.

  2. From the top navigation, click Manage, then click the + icon next to the application search field to open the Create Application dialog.

  3. Enter a descriptive name in the Application Name field (for example, Nexla Integration) and provide a brief description in the Description field.

  4. Associate the application with the API products your integration will use. Select from the available APIs — such as Operational Reporting for Procurement, Master Data, Sourcing Reporting, and Analytics Reporting — and click Save to create the application.

  5. In the My Applications list, locate and select the newly created application. The Application Key (also called the API Key) is displayed on the application detail page. Copy and save this value — it is required for the API Key field in Nexla.

    SAP Ariba permits one application registration per realm-and-API-product combination per customer. If an existing application already covers the same realm and APIs you need, use the credentials from that application instead of creating a new one.

Request API Access for Your Realm

After creating the application, you must request API access to link it with your Ariba realm.

  1. From the application detail page, click Actions and select Request API Access.

  2. Select the API products to which you need access, then select your Ariba realm from the realm list, and click Submit.

  3. API access requests are typically reviewed within 12 to 24 hours. You will receive an email notification when access has been approved.

Generate the OAuth Client Secret

The OAuth Client Secret is generated separately after API access is approved, and must be performed by a user with the Organization Admin role.

  1. From the My Applications list, select the approved application.

  2. Click Actions and select Generate OAuth Secret.

  3. A dialog displays the OAuth Client ID and OAuth Secret (Client Secret). Copy both values immediately and store them in a secure location such as a password manager.

    Important

    The OAuth Client Secret is displayed only once at the time of generation. If the secret is lost or not copied, a new one must be generated — which invalidates the previous secret and requires updating any existing integrations that use it.

Find Your Realm Identifier

The Realm is the unique identifier for your SAP Ariba tenant. It is passed as a query parameter in all API calls and is required to scope requests to your organization's data.

  • Realm names follow the format s1-<companyname>-T for test/sandbox environments and s1-<companyname> for production environments.

  • Your realm can be found in the Environment Details section of the SAP Ariba Developer Portal when viewing your application, in your SAP Ariba administrative account profile, or in the URL when you are logged in to the SAP Ariba buyer portal.

For additional step-by-step setup guidance, refer to Steps to Start Using the SAP Ariba APIs and Finding Your Application's API Key and OAuth Client ID in the SAP Help Portal.

Authenticate

Credentials required

Client credentials flow with additional API key header for authentication.

FieldRequiredSecretDescription
Client IDYesNoOAuth 2.0 Client ID from SAP Ariba Developer Portal
Client SecretYesYesOAuth 2.0 Client Secret from SAP Ariba Developer Portal
API KeyYesYesApplication API Key from SAP Ariba Developer Portal (sent in apiKey header)
RealmYesNoSAP Ariba realm/tenant identifier (e.g., s1-acme-T)
Base URLYesNoSAP Ariba API base URL

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

SAP Ariba uses a two-part authentication model for all Open API requests: OAuth 2.0 Client Credentials to obtain a short-lived Bearer access token, combined with a static Application API Key sent as the apiKey request header on every call. Both components are required and must be configured in this credential.

  1. Enter your OAuth 2.0 Client ID in the Client ID field. This is the OAuth Client ID value displayed after generating the OAuth secret in the SAP Ariba Developer Portal, as described in Prerequisites.

  2. Enter your OAuth Client Secret in the Client Secret field. This is the secret generated via the Generate OAuth Secret action in the Developer Portal. This field is masked for security.

    Nexla uses the Client ID and Client Secret to request a Bearer access token from the SAP Ariba token endpoint (https://api.ariba.com/v2/oauth/token) using the OAuth 2.0 Client Credentials (2-legged) flow. Access tokens are automatically refreshed as needed during data ingestion — no manual token management is required.

  3. Enter your Application API Key in the API Key field. This is the Application Key shown on the application detail page in the SAP Ariba Developer Portal. The API Key is sent as the apiKey header on every API request to identify which registered application is calling the API.

  4. Enter your SAP Ariba Realm identifier in the Realm field. This is the tenant identifier for your Ariba environment (for example, s1-acme-T for a test environment or s1-acme for production). The realm is appended as a query parameter to all API calls to scope data retrieval to your organization.

  5. Enter the Base URL for the SAP Ariba API in the Base URL field. The default value is https://openapi.ariba.com/api and is correct for most environments. This field is pre-populated with the default value. Update it only if your SAP Ariba environment uses a different regional or custom API gateway endpoint.

    The Base URL, combined with the specific API path and Realm, forms the root of all API calls. For example, Procurement Reporting job submissions use the path https://openapi.ariba.com/api/procurement-reporting-job/v2/prod/jobs?realm=<your-realm>. Contact your SAP Ariba administrator or check the API documentation at the SAP Help Portal if you are unsure which base URL applies to your deployment.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the SAP Ariba connector tile, then select the credential that will be used to connect to the SAP Ariba instance, and click Next; or, create a new SAP Ariba credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common SAP Ariba endpoints. Each template is designed specifically for the corresponding SAP Ariba API, making data source setup easy and efficient. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Requisitions

This endpoint extracts requisition documents from SAP Ariba, including full header and line item details such as requestor, commodity, cost center, and approval status. Use this endpoint to analyze purchase request activity, monitor approval cycle times, and track spend commitments before purchase orders are issued.

This endpoint uses SAP Ariba's asynchronous Operational Reporting API: Nexla submits a reporting job, polls until the job completes, then downloads the result file. A view template must be configured in SAP Ariba before data can be extracted.

  • Enter the name of the view template that will be used to define the fields and filters for this report in the View Template Name field. View templates are created and managed in the SAP Ariba UI under Manage > View Templates, or via the SAP Ariba View Management API. The template name is case-sensitive and must already be in "published" status in your Ariba realm.

  • Enter the start date for the extraction window in the Updated Date From field. The date must be in ISO 8601 format (for example, 2024-01-01T00:00:00Z). The default value is {now-30}, which represents the date 30 days before the current run date. Nexla will replace this macro with the appropriate date value at runtime.

  • Enter the end date for the extraction window in the Updated Date To field. The date must be in ISO 8601 format (for example, 2024-01-31T23:59:59Z). The default value is {now}, which represents the current run date and time.

The Updated Date From and Updated Date To parameters filter records by last-updated timestamp, not by creation date. For initial historical loads, set the date range to cover the full period of interest. For incremental loads, use the Nexla scheduling feature with the {'{now-N}'} macro pattern to move the window forward automatically on each run. Additional documentation on SAP Ariba view templates is available at the SAP Help Portal.

Purchase Orders

This endpoint extracts purchase order documents from SAP Ariba, including supplier details, line items, pricing, delivery schedules, and order status. Use this endpoint to monitor PO activity, reconcile orders with receipts and invoices, analyze supplier performance, and track open commitments.

This endpoint uses the asynchronous Operational Reporting API and requires a published view template in your Ariba realm to define the output fields and filters.

  • Enter the name of the published view template for PurchaseOrder documents in the View Template Name field. The template must be configured for the Purchase Order document type in the SAP Ariba UI or via the View Management API.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value {now-30} covers the prior 30 days.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value {now} is the current run date and time.

Purchase Order data extracted through this endpoint reflects records updated within the specified date range. To capture all POs regardless of update date, use a wide date range for the initial extraction, then narrow the window for subsequent incremental runs.

Invoices (Invoice Reconciliation)

This endpoint extracts invoice reconciliation documents from SAP Ariba, including payment status, reconciliation details, GL coding, tax information, and exceptions. Use this endpoint to analyze invoice processing cycle times, identify bottlenecks in the AP workflow, and reconcile invoices against purchase orders and receipts.

  • Enter the name of the published view template for InvoiceReconciliation documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-30}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Invoice Reconciliation records include both matched and exception invoices. This endpoint is particularly useful for accounts payable automation and three-way match (PO / receipt / invoice) validation workflows.

Contracts

This endpoint extracts contract documents from SAP Ariba, including contract terms, effective and expiration dates, counterparty information, pricing tiers, and amendment history. Use this endpoint to monitor contract compliance, track expiring contracts, and analyze contract coverage across spend categories.

  • Enter the name of the published view template for Contract documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-90} (90 days prior), reflecting the longer-lived nature of contract records.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Receipts

This endpoint extracts goods receipt documents from SAP Ariba, including received quantities, receipt dates, line item details, and quality inspection results. Use this endpoint to track delivery performance, identify discrepancies between ordered and received quantities, and support three-way match processes.

  • Enter the name of the published view template for Receipt documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-7} (7 days prior), reflecting the high-frequency update pattern typical for receiving activity.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Payments

This endpoint extracts payment documents from SAP Ariba, including payment amounts, payment methods, payment dates, bank account details, and payment status. Use this endpoint to analyze payment timing, identify early-payment discount opportunities, and reconcile payments against invoices for cash flow reporting.

  • Enter the name of the published view template for Payment documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-30}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Payment Requests

This endpoint extracts payment request documents from SAP Ariba, which are used to initiate disbursements outside of the standard PO-based procurement flow. Use this endpoint to track non-PO payment requests through approval workflows, monitor disbursement status, and analyze spending patterns for categories such as employee reimbursements or direct supplier payments.

  • Enter the name of the published view template for PaymentRequest documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-30}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Contract Workspaces

This endpoint extracts contract workspace collaboration data from SAP Ariba, including contract drafts, revisions, approval events, negotiation history, and associated documents. Use this endpoint to audit contract authoring and negotiation activity, measure contract cycle times from initiation to execution, and identify bottlenecks in the contracting process.

  • Enter the name of the published view template for ContractWorkspace documents in the View Template Name field.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-90}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Master Data - Suppliers

This endpoint retrieves supplier master data from SAP Ariba, including contact information, banking details, certifications, diversity classifications, and risk ratings. Use this endpoint to maintain an up-to-date supplier registry, populate supplier portals, enrich spend analytics with supplier attributes, and support supplier risk management programs.

  • This endpoint retrieves all suppliers registered in your Ariba realm using offset-based pagination with a page size of 100 records. No date range parameters are required — Nexla automatically handles pagination to retrieve the complete supplier list.
  • The endpoint returns all suppliers in the Records array of each paginated response. Nexla treats each entry as an individual supplier record in the output Nexset.

Supplier master data in SAP Ariba is managed via the Supplier Management module and the Ariba Network. The API returns the current state of each supplier record at the time of extraction; it does not provide a change history. For supplier change tracking, consider scheduling incremental extractions and comparing snapshots downstream.

Master Data - Commodities

This endpoint retrieves the commodity (spend category) code master data from SAP Ariba, including hierarchical category structures and UNSPSC (United Nations Standard Products and Services Code) classifications. Use this endpoint to build category hierarchies for spend analytics, enrich transaction data with standardized category codes, and map internal commodity codes to industry standards.

  • This endpoint retrieves all commodity records using offset-based pagination with a page size of 100. No date range or additional parameters are required.
  • The response Records array contains individual commodity entries. Each record includes the commodity code, description, parent code (for hierarchy traversal), and UNSPSC mapping where available.

Master Data - Users

This endpoint retrieves the user directory from SAP Ariba, including user roles, permissions, organizational unit assignments, and approval authority limits. Use this endpoint to audit user access controls, synchronize Ariba user data with HR or identity management systems, and validate approval delegation structures.

  • This endpoint retrieves all users in your Ariba realm using offset-based pagination. No additional parameters are required beyond the credential's realm configuration.

User records include role assignments and approval limits that are configured within the SAP Ariba application. This data is particularly useful for access governance audits and ensuring that approval authority aligns with organizational policies.

Master Data - Cost Centers

This endpoint retrieves cost center master data from SAP Ariba for general ledger account assignment and financial reporting. Use this endpoint to synchronize cost center structures with ERP systems, enrich procurement transaction data with financial coding, and validate that cost center assignments in procurement documents are current and accurate.

  • This endpoint retrieves all cost centers in your realm using offset-based pagination. No additional parameters are required.

Master Data - Departments

This endpoint retrieves the organizational department structure from SAP Ariba for spend analysis and user assignment. Use this endpoint to build organizational hierarchies for spend reporting, assign procurement transactions to departments, and validate that department configurations in Ariba reflect current organizational structure.

  • This endpoint retrieves all department records using offset-based pagination. No additional parameters are required.

Master Data - Locations

This endpoint retrieves company location data from SAP Ariba, including delivery addresses and site management details. Use this endpoint to populate ship-to address lists, validate delivery locations on purchase orders, and synchronize facility data with facilities management or ERP systems.

  • This endpoint retrieves all location records using offset-based pagination. No additional parameters are required.

Master Data - Accounts (GL Accounts)

This endpoint retrieves general ledger (GL) account master data from SAP Ariba for financial coding and reporting. Use this endpoint to validate GL account assignments in procurement documents, synchronize the Ariba chart of accounts with ERP systems, and enrich spend data with account-level financial classifications.

  • This endpoint retrieves all GL account records using offset-based pagination. No additional parameters are required.

Master Data - Projects

This endpoint retrieves project code master data from SAP Ariba for project-based accounting and spend allocation. Use this endpoint to synchronize Ariba project codes with project management or ERP systems, validate project assignments on requisitions and purchase orders, and enable project-level spend reporting.

  • This endpoint retrieves all project records using offset-based pagination. No additional parameters are required.

Master Data - Payment Terms

This endpoint retrieves payment terms master data from SAP Ariba for supplier contracts and invoice processing. Use this endpoint to audit payment terms assigned to suppliers, identify opportunities to standardize or optimize payment terms across the supply base, and synchronize payment terms data with ERP or treasury systems.

  • This endpoint retrieves all payment terms records using offset-based pagination. No additional parameters are required.

Master Data - Currencies

This endpoint retrieves currency master data from SAP Ariba, including supported currency codes and associated exchange rate information. Use this endpoint to validate currency configurations, support multi-currency spend normalization workflows, and synchronize exchange rate data with financial reporting systems.

  • This endpoint retrieves all currency records using offset-based pagination. No additional parameters are required.

Master Data - Units of Measure

This endpoint retrieves units of measure (UOM) master data from SAP Ariba for quantity conversions and standardization. Use this endpoint to validate UOM assignments in purchase order line items, normalize quantities across different units for spend analysis, and synchronize UOM configurations with ERP systems.

  • This endpoint retrieves all UOM records using offset-based pagination. No additional parameters are required.

Sourcing Projects

This endpoint extracts sourcing project data from SAP Ariba, including RFx events, reverse auctions, negotiation details, awarded suppliers, and sourcing project status. Use this endpoint to analyze sourcing cycle times, track savings achieved through competitive events, and report on sourcing pipeline and activity.

This endpoint uses the SAP Ariba Sourcing Reporting View API, which returns results synchronously (no job submission or polling required).

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-90}, reflecting the longer duration of sourcing projects.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

This endpoint uses the SourcingProject view from the Sourcing Reporting View API. Additional sourcing-related views may be available depending on your SAP Ariba configuration and API access. Refer to the SAP Ariba API documentation for the full list of available sourcing views.

Sourcing Requests (RFx)

This endpoint extracts RFI, RFP, and RFQ sourcing request documents from SAP Ariba, including bid responses from suppliers, evaluation scores, and award decisions. Use this endpoint to analyze competitive bidding activity, track supplier participation rates in sourcing events, and measure the effectiveness of sourcing strategies.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-90}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Sourcing Project Audit Trail

This endpoint extracts audit trail data for sourcing projects from SAP Ariba, capturing all user actions and system events associated with sourcing project activity. Use this endpoint for compliance reporting, to investigate sourcing process deviations, and to produce an auditable record of procurement decisions.

  • Enter the start date for the audit trail extraction in the Updated Date From field using ISO 8601 format. The default value is {now-90}.

  • Enter the end date for the audit trail extraction in the Updated Date To field using ISO 8601 format. The default value is {now}.

This endpoint uses the ProjectAuditInfo_SpendOverview view from the Sourcing Reporting View API. Audit trail data can be extensive for active sourcing environments — consider narrowing the date range if response times are slow or payload sizes are large.

Supplier Bid Responses

This endpoint extracts supplier bid and quote responses from SAP Ariba sourcing events, including pricing, proposed terms, and delivery commitments submitted by suppliers. Use this endpoint to analyze competitive pricing across sourcing events, benchmark supplier responses, and support strategic category management decisions.

  • Enter the start date for the extraction window in the Updated Date From field using ISO 8601 format. The default value is {now-90}.

  • Enter the end date for the extraction window in the Updated Date To field using ISO 8601 format. The default value is {now}.

Analytical Fact - Spend

This endpoint extracts aggregated spend analytics fact data from SAP Ariba, organized by supplier, commodity category, department, cost center, and time period. Use this endpoint to build spend dashboards, identify savings opportunities by category, analyze supplier concentration risk, and benchmark organizational spend patterns.

This endpoint uses the SAP Ariba Analytics Reporting Fact API and returns pre-aggregated spend records. Unlike the Operational Reporting endpoints, no view template is required.

  • Enter the start date for the analytics extraction in the Updated Date From field using ISO 8601 format. The default value is {now-365}, providing a full year of spend data for trend analysis.

The Analytics Reporting Fact API returns spend data that has been processed and enriched by SAP Ariba's analytics engine. Data availability may lag behind transactional data by 24 to 48 hours depending on your Ariba analytics configuration. For real-time transactional data, use the Operational Reporting endpoints (Requisitions, Purchase Orders, Invoices, etc.) instead.

Analytical Fact - Savings

This endpoint extracts savings analytics fact data from SAP Ariba, capturing savings achieved through sourcing events, contract negotiations, and procurement optimization initiatives. Use this endpoint to report on realized and pipeline savings, demonstrate procurement ROI, and track savings performance against targets.

  • Enter the start date for the analytics extraction in the Updated Date From field using ISO 8601 format. The default value is {now-365}.

Analytical Fact - Contracts

This endpoint extracts contract analytics fact data from SAP Ariba for contract performance and compliance tracking. Use this endpoint to measure contract utilization (spend on-contract vs. off-contract), monitor contract expiration timelines, analyze contract compliance rates by supplier and category, and report on the value of the managed contract portfolio.

  • Enter the start date for the analytics extraction in the Updated Date From field using ISO 8601 format. The default value is {now-365}.

Analytical Fact - Supplier Performance

This endpoint extracts supplier performance analytics fact data from SAP Ariba, including on-time delivery rates, quality ratings, and compliance metrics. Use this endpoint to score and rank suppliers, identify underperforming suppliers requiring corrective action, support supplier development programs, and produce supplier scorecards.

  • Enter the start date for the analytics extraction in the Updated Date From field using ISO 8601 format. The default value is {now-365}.

Supplier performance data in SAP Ariba is sourced from assessments, scorecards, and operational performance metrics configured in the Supplier Management module. The availability and content of this data depends on your organization's Ariba configuration and the performance management programs you have enabled.

List View Templates

This endpoint retrieves a list of all configured view templates in your SAP Ariba realm that are available for use in procurement reporting jobs and synchronous queries. Use this endpoint to discover the view templates available in your environment before configuring Operational Reporting endpoints that require a view template name.

  • This endpoint requires no additional parameters beyond the credential's realm configuration. It returns all view templates registered in your realm, including their names, document types, and publication status.
  • The view template name values returned by this endpoint are used as the View Template Name parameter in Operational Reporting endpoints such as Requisitions, Purchase Orders, and Invoices.

Only view templates with a status of "published" can be used in reporting job submissions. Draft or deactivated templates will appear in this list but will fail if used as the view template name in a reporting job. Run this endpoint first when setting up a new Operational Reporting source to identify the correct template names available in your realm.

Procurement Field Metadata

This endpoint retrieves field metadata for SAP Ariba procurement document types, enabling you to discover all available fields, their data types, and available filter criteria for a given document type. Use this endpoint to understand the schema of each document type before configuring view templates, to identify custom fields added to your Ariba configuration, and to build dynamic field mapping logic in downstream pipelines.

  • Select or enter the procurement document type for which to retrieve metadata in the Document Type field. The default value is Requisition. Available document types are:

    • Requisition — Requisition documents
    • PurchaseOrder — Purchase order documents
    • InvoiceReconciliation — Invoice reconciliation documents
    • Contract — Contract documents
    • Payment — Payment documents
    • Receipt — Receipt documents
    • PaymentRequest — Payment request documents
    • ContractWorkspace — Contract workspace documents

The metadata response includes both standard SAP Ariba fields and any custom fields configured for your organization's Ariba instance (returned when includeCustomFields=true, which is set automatically by this template). Use the field names returned by this endpoint to configure the correct field selections in your view templates.

Document Approval Flows

This endpoint retrieves approval workflow data for specific SAP Ariba procurement documents, including the list of approvers, their approval status, comments, timestamps, and the complete approval chain history. Use this endpoint to audit approval processes, measure approval cycle times for individual documents, and investigate procurement documents that are stalled in approval.

  • Select or enter the document type for which to retrieve the approval flow in the Document Type field. The default value is Requisition. Supported document types are:

    • Requisition — Purchase requisitions
    • PurchaseOrder — Purchase orders
    • InvoiceReconciliation — Invoice reconciliation documents
    • Contract — Contract documents
  • Enter the unique document ID of the specific procurement document for which to retrieve the approval flow in the Document ID field. The document ID is the internal Ariba identifier for the document (for example, PR123456 for a requisition or PO987654 for a purchase order). This value can be obtained from the Ariba UI, from other Nexla data flows that extract the relevant document type, or from the SAP Ariba operational reporting endpoints.

This endpoint retrieves the approval flow for a single document per execution. To retrieve approval flows for multiple documents, configure separate data sources for each document, or use a Nexla lookup-based macro in the manual configuration to iterate over a list of document IDs sourced from another Nexset.

Master Data - Entity Types Discovery

This endpoint lists all available master data entity types in your SAP Ariba realm, enabling discovery of which master data objects are configured and accessible via the Master Data API. Use this endpoint when setting up a new SAP Ariba integration to understand which entity types are available before configuring individual master data extraction endpoints.

  • This endpoint requires no additional parameters. It returns the full list of entity types available in your realm along with their API identifiers, which correspond to the path segments used in the individual Master Data endpoints (for example, suppliers, commodities, users).

The entity types returned by this endpoint reflect the master data modules enabled for your SAP Ariba subscription. Entity types that are not included in your subscription or have not been configured in your realm will not appear in the response.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

SAP Ariba data sources can also be manually configured to ingest data from any valid SAP Ariba API endpoint, including endpoints not covered by the pre-built templates, chained API calls (such as job submission followed by async polling and result download), or custom request parameters and headers. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

All SAP Ariba Open API URLs begin with the base URL https://openapi.ariba.com/api, followed by the API-specific path, version, and environment segment. The realm is a required query parameter on every call (for example, ?realm=s1-acme-T) and is automatically included by Nexla based on the Realm value configured in your SAP Ariba credential. SAP Ariba API responses typically wrap data records in a Records array — enter $.Records[*] as the Path to Data for most list endpoints, or $ to capture the entire response for job status polling steps. You do not need to include the apiKey or Authorization headers — these are automatically applied by Nexla based on the credentials configured in your SAP Ariba credential.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new SAP Ariba data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.