The Lists API allows you to view your configured lists within SAP Concur products, and create new lists. The lists are shared between multiple SAP Concur products. Use the List Items API to manage the items in the lists.

Products and Editions

  • Concur Expense Professional Edition
  • Concur Expense Standard Edition
  • Concur Invoice Professional Edition
  • Concur Invoice Standard Edition
  • Concur Request Professional Edition
  • Concur Request Standard Edition

Scope Usage

Name Description Endpoint
LIST Use and update lists configured by your company. GET, POST

Get All Lists

Returns all lists based on the search criteria.

Parameters

Name Type Format Description
limit integer The default is 25 and the maximum is 100. Optional. The number of records to return.
offset string - Optional. The start of the page offset. The default is from the beginning.

Request

GET https://www.concursolutions.com/api/v3.0/common/lists HTTP/1.1
Host: www.concursolutions.com
Accept: application/json
 const headers = {
  'Accept':'application/json'

};

fetch('https://www.concursolutions.com/api/v3.0/common/lists',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Response

200 Response

{
  "Items": {
    "ConnectorID": "string",
    "DisplayCodeFirst": true,
    "ExternalThreshold": 0,
    "ID": "string",
    "IsVendorList": true,
    "Name": "string",
    "SearchCriteriaCode": "string",
    "URI": "string"
  },
  "NextPage": "string"
}

Create a New List

Creates a new list.

Parameters

Name Type Format Description
content ListPost - Required. List object to create.

Request

POST https://www.concursolutions.com/api/v3.0/common/lists HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json
const inputBody = '{
  "ConnectorID": "string",
  "DisplayCodeFirst": true,
  "ExternalThreshold": 0,
  "IsVendorList": true,
  "Name": "string",
  "SearchCriteriaCode": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://www.concursolutions.com/api/v3.0/common/lists',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Response

200 Response

{
  "ID": "string",
  "URI": "string"
}

Get a Single List by ID

Returns a list by ID.

Parameters

Name Type Format Description
id string - Required.The unique identifier for the list.

Request

GET https://www.concursolutions.com/api/v3.0/common/lists/{id} HTTP/1.1
Host: www.concursolutions.com
Accept: application/json


const headers = {
  'Accept':'application/json'

};

fetch('https://www.concursolutions.com/api/v3.0/common/lists/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Response

200 Response

{
  "ConnectorID": "string",
  "DisplayCodeFirst": true,
  "ExternalThreshold": 0,
  "ID": "string",
  "IsVendorList": true,
  "Name": "string",
  "SearchCriteriaCode": "string",
  "URI": "string"
}

Update List

DEPRECATED: 05/19/2016 UNSUPPORTED: 11/19/2016. Updates list specified in the URL. Only the fields provided in the supplied object will be updated, missing fields will not be altered.

Parameters

Name Type Format Description
id string - Required. The unique identifier for the list.
content ListPut - Required. The list object to update.

Request

PUT https://www.concursolutions.com/api/v3.0/common/lists/{id} HTTP/1.1
Host: www.concursolutions.com
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "DisplayCodeFirst": true,
  "Name": "string",
  "SearchCriteriaCode": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://www.concursolutions.com/api/v3.0/common/lists/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Schema

CreateResponse

Name Type Format Description
ID string -  
URI string -  

ListGet

Name Type Format Description
ConnectorID string - Optional. Defines the encrypted ConnectorID. If not provided then the list isn’t associated with a connector.
DisplayCodeFirst Boolean - Required. Defines whether code should appear before text, or vice versa.
ExternalThreshold integer - Optional. Default value is 1. Defines the threshold from where the level starts being external. This value can only be set if a ConnectorID is provided.
ID string - The unique identifier of the resource.
IsVendorList Boolean - Required. Defines whether it is a vendor list.
Name string - Required. Defines a name for the list. This name must be unique.
SearchCriteriaCode string - Required. Defines whether the search criteria should apply to the code or to the text.
URI string - The URI to the resource.

ListGetCollection

Name Type Format Description
Items ListGet -  
NextPage string - The URI of the next page of results, if any.

ListPost

Name Type Format Description
ConnectorID string - Optional. Defines the encrypted ConnectorID. If not provided then the list isn’t associated with a connector.
DisplayCodeFirst Boolean - Required. Defines whether code should appear before text, or vice versa.
ExternalThreshold integer - Optional. Default value is 1. Defines the threshold from where the level starts being external. This value can only be set if a ConnectorID is provided.
IsVendorList Boolean - Required. Defines whether it is a vendor list.
Name string - Required. Defines a name for the list. This name must be unique.
SearchCriteriaCode string - Required. Defines whether the search criteria should apply to the code or to the text.

ListPut

Name Type Format Description
DisplayCodeFirst Boolean - Optional. Defines whether code should appear before text, or vice versa.
Name string - Optional. Defines a name for the list. This name must be unique.
SearchCriteriaCode string - Optional. Defines whether the search criteria should apply to the code or to the text.