Docs
Open Lodol
DocumentationIntegrationsAPI

SAP Ariba

App · 15 actions

Read SAP Ariba procurement and sourcing: approvals waiting and the changes feed, requisitions and invoices, operational reports, sourcing projects and events with supplier bids, and procurement master data.

Actions

ActionWhat it does
Count report view recordsCount the documents a reporting view template matches for the same filters as 'Run report view', and how many pages that is.
Get approvableRead one requisition, invoice or user profile by its approvable id: totals, requester, line items, comments, attachments and approval requests.
Get sourcing eventRead one sourcing event - RFI, RFP or auction - with its state, owner and dates, and optionally its line items, supplier invitations, teams, owners and custom fields.
Get sourcing projectRead one sourcing project: title, status, owner, dates, commodities, regions, baseline spend and savings.
List approvablesList requisitions, invoices or user profiles with their totals, requester, status, line items and approval requests, up to 10 at a time.
List approval changesList changes to approvable documents - approvals activated, withdrawn, edited, fully approved or denied, and approvers added, removed or reassigned - oldest first.
List approval group membersList the users in an approval group with their names and email addresses.
List approval groupsList the groups that approval rules assign approvals to, or find one by its exact name (case and spaces matter).
List event supplier bidsList the bids suppliers placed on a sourcing event's items, with each bid's terms and amounts.
List event supplier invitationsList the suppliers invited to a sourcing event, with their organization and main contact.
List master data recordsList procurement master data - users, groups, suppliers, currencies, units of measure, commodity codes, countries and more - with an optional OData filter and sort.
List pending approvalsList requisitions, invoices and user profiles waiting for approval, one row per approver, with a link to each.
List project documentsList a sourcing project's documents and events, with their type, version, owner and lock status.
List project tasksList a sourcing project's tasks with their owner, status, document and approvers.
Run report viewRead one page of procurement documents - requisitions, orders, receipts, invoices - through a reporting view template, filtered by a date window of up to 31 days, status or document numbers.

Count report view records

Count the documents a reporting view template matches for the same filters as 'Run report view', and how many pages that is.

Inputs

View templateview_template_nametextRequired
The reporting view template to run, such as 'Requisition_SAP_createdRange'. System templates are named DocumentType_SAP|PeopleSoft|Generic_createdRange|updatedRange.
Date to filter ondate_fieldtext
Which date 'From' and 'To' apply to. It must match the template: a 'createdRange' template filters on the created date, an 'updatedRange' one on the updated date.One of: created (Created date), updated (Updated date), approval (Approval date). Default: created.
Fromdate_fromdate and time
Start of the window. SAP Ariba reads at most 31 days at a time; with no dates and no document ids, the last 31 days are read.
Todate_todate and time
End of the window, at most 31 days after 'From'.
Statusstatustext
Only include documents with this status, such as Approved or Ordered.
Document idsunique_nameslist
Only these documents, by number (such as PR123), up to 40. With ids and no dates, no date window is applied.

Outputs

How many records a report view matches

filtersobject
The filters sent
max_records_per_pagenumber
Records per page
total_pagesnumber
Pages of results
total_recordsnumber
Records matching the filters
Example output
{
  "filters": {},
  "max_records_per_page": 50,
  "total_pages": 1,
  "total_records": 42
}

Get approvable

Read one requisition, invoice or user profile by its approvable id: totals, requester, line items, comments, attachments and approval requests.

Inputs

Approvable typeapprovable_typetextRequired
Which kind of document to read.One of: requisitions, invoices, userprofiles (User profiles). Default: requisitions.
Approvable idapprovable_idtextRequired
The approvable id, as 'List approvables' returns it in 'approvableId'.

Outputs

An approvable document

activeApprovalRequestIdslist
Active request ids
activeApproverCountnumber
Active approvers
approvableIdtext
Approvable id
approvalRequestslist
Approval requests
attachmentslist
Attachments
commentslist
Comments
firstActiveApproverNametext
First active approver
fullURLtext
Link to the approvable in SAP Ariba
lastModifiedtext
Last modified
lineItemCountnumber
Line items
lineItemslist
Line items
realmtext
Realm
requesterobject
Requester
requesterNametext
Requester name
statusStringtext
Status
submitDatetext
Submitted
timeUpdatedtext
Updated
titletext
Title
totalCostobject
An amount
uniqueNametext
Document number, such as PR123
versionnumber
Version
Example output
{
  "approvableId": "AAAKAYXEeOY",
  "lineItemCount": 2,
  "requesterName": "Jane Smith",
  "statusString": "Submitted",
  "title": "Laptops for new hires",
  "totalCost": {
    "amount": 4200.0,
    "currency": "USD"
  },
  "uniqueName": "PR123"
}

Get sourcing event

Read one sourcing event - RFI, RFP or auction - with its state, owner and dates, and optionally its line items, supplier invitations, teams, owners and custom fields.

Inputs

Sourcing eventevent_idtextRequired
The event id, such as Doc12345, as shown on the event in SAP Ariba or in a project's documents.
Includeexpandlist
Also return these parts of the event.One or more of: all (Everything), items (Line items), supplierInvitations (Supplier invitations), teams, owners, customFields (Custom fields).

Outputs

A sourcing event

baselineSpendobject
An amount
createDatetext
Created
currencytext
Currency
descriptiontext
Description
eventStateNametext
Event state
eventTypeNametext
Event type
hasAwardtrue/false
Awarded
internalIdtext
Event id, such as Doc12345
isTesttrue/false
Test event
itemslist
Line items (when expanded)
lastModifiedtext
Last modified
ownerobject
Owner
statustext
Status
supplierInvitationslist
Invitations (when expanded)
teamslist
Teams (when expanded)
titletext
Title
webJumperURLtext
Link to the event in SAP Ariba
Example output
{
  "currency": "USD",
  "eventTypeName": "RFP",
  "internalId": "Doc12345678",
  "status": "Open",
  "title": "Office furniture RFP"
}

Get sourcing project

Read one sourcing project: title, status, owner, dates, commodities, regions, baseline spend and savings.

Inputs

Sourcing projectproject_idtextRequired
The project id, such as WS12345, as shown on the project in SAP Ariba ('internalId').

Outputs

A sourcing project

actualSavingobject
An amount
baselineSpendobject
An amount
beginDatetext
Begin date
commoditieslist
Commodities
createDatetext
Created
currencytext
Currency
departmentslist
Departments
descriptiontext
Description
dueDatetext
Due date
internalIdtext
Project id
isTesttrue/false
Test project
lastModifiedtext
Last modified
ownerobject
Owner
regionslist
Regions
statetext
State
statustext
Status
targetSavingPctnumber
Target saving, percent
templateProjectTitletext
Template
titletext
Title
Example output
{
  "createDate": "2026-01-10T09:00:00Z",
  "currency": "USD",
  "internalId": "WS12345678",
  "lastModified": "2026-02-01T12:00:00Z",
  "status": "Active",
  "title": "Office furniture 2026"
}

List approvables

List requisitions, invoices or user profiles with their totals, requester, status, line items and approval requests, up to 10 at a time. Filter by document number.

Inputs

Approvable typeapprovable_typetextRequired
Which kind of document to read.One of: requisitions, invoices, userprofiles (User profiles). Default: requisitions.
Document numberunique_nametext
Only the document with exactly this number, such as PR123.
Number of resultslimitnumber
How many records to return, 1-10. Defaults to 10.From 1 to 10. Default: 10.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Approvables

approvableslist
Approvables
countnumber
Records on this page
has_moretrue/false
Whether another page follows
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
total_countnumber
Records matching, across every page
Example output
{
  "approvables": [
    {
      "approvableId": "AAAKAYXEeOY",
      "lineItemCount": 2,
      "requesterName": "Jane Smith",
      "statusString": "Submitted",
      "title": "Laptops for new hires",
      "totalCost": {
        "amount": 4200.0,
        "currency": "USD"
      },
      "uniqueName": "PR123"
    }
  ],
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "total_count": 1
}

List approval changes

List changes to approvable documents - approvals activated, withdrawn, edited, fully approved or denied, and approvers added, removed or reassigned - oldest first. Pass the last run's 'last_change_sequence_id' as 'After change' to read only what is new, or filter by when the change happened. SAP Ariba keeps changes for 180 days.

Inputs

After changeafter_change_idtext
Only changes after this change sequence id.
Created aftercreated_afterdate and time
Only changes after this.
Created beforecreated_beforedate and time
Only changes before this; needs 'Created after' too.
Number of resultslimitnumber
How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Approval changes

changeslist
Approval changes
countnumber
Records on this page
has_moretrue/false
Whether another page follows
last_change_sequence_idtext
The newest change read; pass it as 'After change' next time
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
total_countnumber
Records matching, across every page
Example output
{
  "changes": [
    {
      "approvableId": "AAAKAYXEeOY",
      "approvableUniqueName": "PR123",
      "approvers": [
        {
          "uniqueName": "jsmith"
        }
      ],
      "changeSequenceId": "1001",
      "changeType": "ApprovableFullyApproved",
      "realm": "mytestrealm",
      "restResourceName": "requisitions"
    }
  ],
  "count": 1,
  "has_more": false,
  "last_change_sequence_id": "1001",
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "total_count": 1
}

List approval group members

List the users in an approval group with their names and email addresses.

Inputs

Approval groupgroup_idtextRequired
The group id, as 'List approval groups' returns it in 'id'.

Outputs

Group members

countnumber
Members returned
memberslist
Members
Example output
{
  "count": 1,
  "members": [
    {
      "emailAddress": "jane@example.com",
      "name": "Jane Smith",
      "uniqueName": "jsmith"
    }
  ]
}

List approval groups

List the groups that approval rules assign approvals to, or find one by its exact name (case and spaces matter).

Inputs

Group namegroup_nametext
Only the group with exactly this name.

Outputs

Approval groups

countnumber
Groups returned
groupslist
Groups
Example output
{
  "count": 1,
  "groups": [
    {
      "id": "G1",
      "uniqueName": "Purchasing Agent"
    }
  ]
}

List event supplier bids

List the bids suppliers placed on a sourcing event's items, with each bid's terms and amounts. Narrow to one supplier's invitation, and to one item.

Inputs

Sourcing eventevent_idtextRequired
The event id, such as Doc12345, as shown on the event in SAP Ariba or in a project's documents.
Supplier invitationinvitation_idtext
Only this supplier's bids, by the 'invitationId' from 'List event supplier invitations'.
Itemitem_idtext
Only bids on this item id; needs 'Supplier invitation'.

Outputs

Supplier bids

bidslist
Bids
countnumber
Bids returned
event_idtext
The event read
Example output
{
  "bids": [
    {
      "eventId": "Doc12345678",
      "invitationId": "INV1",
      "itemId": "1"
    }
  ],
  "count": 1,
  "event_id": "Doc12345678"
}

List event supplier invitations

List the suppliers invited to a sourcing event, with their organization and main contact.

Inputs

Sourcing eventevent_idtextRequired
The event id, such as Doc12345, as shown on the event in SAP Ariba or in a project's documents.
Fields to returnfieldslist
Only return these fields. Leave empty for all.One or more of: submissionDate (Submission date), supplierBidStatus (Supplier bid status).

Outputs

Supplier invitations

countnumber
Invitations returned
event_idtext
The event read
invitationslist
Invitations
Example output
{
  "count": 1,
  "event_id": "Doc12345678",
  "invitations": [
    {
      "invitationId": "INV1",
      "orgId": "AN0100000001"
    }
  ]
}

List master data records

List procurement master data - users, groups, suppliers, currencies, units of measure, commodity codes, countries and more - with an optional OData filter and sort.

Inputs

Entityentity_nametextRequired
Which master data to read, such as users or currency.
Filterodata_filtertext
An OData $filter expression on the entity's fields.
Fields to returnfieldslist
Only return these fields, by name.
Sort byorder_bytext
An OData $orderby expression, such as 'UniqueName asc'.
Include inactiveinclude_inactivetrue/false
Also include inactive records.
Languagelanguagetext
Language code for translated names, such as en or de. Defaults to en.
Number of resultslimitnumber
How many records to return, 1-1000. Defaults to 50.From 1 to 1000. Default: 50.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Master data records

countnumber
Records on this page
entity_nametext
The entity read
has_moretrue/false
Whether another page follows
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
recordslist
Records
total_countnumber
Records matching, across every page
Example output
{
  "count": 1,
  "entity_name": "users",
  "has_more": false,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "records": [
    {
      "Active": "true",
      "SystemId": "SYS1",
      "UniqueName": "jsmith"
    }
  ],
  "total_count": 1
}

List pending approvals

List requisitions, invoices and user profiles waiting for approval, one row per approver, with a link to each. Filter by approvable type or by approver - SAP Ariba applies only one of the two.

Inputs

Approvable typeapprovable_typetext
Only this kind of document. Leave empty to filter by approver.One of: requisitions, invoices, userprofiles (User profiles).
Approverapprovertext
Only documents waiting for this Ariba user id. Leave empty when filtering by type.
Number of resultslimitnumber
How many records to return, 1-100. Defaults to 50.From 1 to 100. Default: 50.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Pending approvals

countnumber
Records on this page
has_moretrue/false
Whether another page follows
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
pending_approvalslist
Pending approvals
total_countnumber
Records matching, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "pending_approvals": [
    {
      "approvableId": "AAAKAYXEeOY",
      "approvableType": "requisitions",
      "approvableUniqueName": "PR123",
      "approver": "jsmith"
    }
  ],
  "total_count": 1
}

List project documents

List a sourcing project's documents and events, with their type, version, owner and lock status.

Inputs

Sourcing projectproject_idtextRequired
The project id, such as WS12345, as shown on the project in SAP Ariba ('internalId').
Number of resultslimitnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Project documents

countnumber
Records on this page
documentslist
Documents
has_moretrue/false
Whether another page follows
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
project_idtext
The project read
total_countnumber
Records matching, across every page
Example output
{
  "count": 1,
  "documents": [
    {
      "internalId": "Doc12345678",
      "title": "Office furniture RFP"
    }
  ],
  "has_more": false,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "project_id": "WS12345678",
  "total_count": 1
}

List project tasks

List a sourcing project's tasks with their owner, status, document and approvers.

Inputs

Sourcing projectproject_idtextRequired
The project id, such as WS12345, as shown on the project in SAP Ariba ('internalId').
Number of resultslimitnumber
How many records to return, 1-500. Defaults to 50.From 1 to 500. Default: 50.
Skipoffsetnumber
How many records to skip; use 'next_offset' from the previous run to read the next page. Defaults to 0.From 0 to 10000000. Default: 0.

Outputs

Project tasks

countnumber
Records on this page
has_moretrue/false
Whether another page follows
limitnumber
Page size used
next_offsetnumber
The 'Skip' value that reads the next page
offsetnumber
Records skipped
project_idtext
The project read
taskslist
Tasks
total_countnumber
Records matching, across every page
Example output
{
  "count": 1,
  "has_more": false,
  "limit": 50,
  "next_offset": 1,
  "offset": 0,
  "project_id": "WS12345678",
  "tasks": [
    {
      "internalId": "TSK1",
      "status": "Active",
      "title": "Review RFP"
    }
  ],
  "total_count": 1
}

Run report view

Read one page of procurement documents - requisitions, orders, receipts, invoices - through a reporting view template, filtered by a date window of up to 31 days, status or document numbers. Pass 'page_token' back to read the next page.

Inputs

View templateview_template_nametextRequired
The reporting view template to run, such as 'Requisition_SAP_createdRange'. System templates are named DocumentType_SAP|PeopleSoft|Generic_createdRange|updatedRange.
Date to filter ondate_fieldtext
Which date 'From' and 'To' apply to. It must match the template: a 'createdRange' template filters on the created date, an 'updatedRange' one on the updated date.One of: created (Created date), updated (Updated date), approval (Approval date). Default: created.
Fromdate_fromdate and time
Start of the window. SAP Ariba reads at most 31 days at a time; with no dates and no document ids, the last 31 days are read.
Todate_todate and time
End of the window, at most 31 days after 'From'.
Statusstatustext
Only include documents with this status, such as Approved or Ordered.
Document idsunique_nameslist
Only these documents, by number (such as PR123), up to 40. With ids and no dates, no date window is applied.
Include inactiveinclude_inactivetrue/false
Also include inactive documents.
Page tokenpage_tokentext
The 'page_token' from the previous run, to read the next page.

Outputs

One page of a report view

countnumber
Records on this page
filtersobject
The filters sent
has_moretrue/false
Whether another page follows
page_tokentext
Pass as 'Page token' to read the next page
recordslist
Records
Example output
{
  "count": 1,
  "filters": {
    "createdDateFrom": "2026-01-01T00:00:00Z",
    "createdDateTo": "2026-01-31T00:00:00Z"
  },
  "has_more": false,
  "page_token": null,
  "records": [
    {
      "Name": "Laptops",
      "UniqueName": "PR123"
    }
  ]
}

Salesforce

Previous Page

SAP S/4HANA

Next Page

On this page

ActionsCount report view recordsGet approvableGet sourcing eventGet sourcing projectList approvablesList approval changesList approval group membersList approval groupsList event supplier bidsList event supplier invitationsList master data recordsList pending approvalsList project documentsList project tasksRun report view