Attendees v3

Limitations

Access to this documentation does not provide access to the API. 

Retrieve all attendees owned by the specified user

Request

URI

Template
GET /api/v3.0/expense/attendees
Parameters
Name Type Format Description
externalID string query The external ID of an attendee. By entering a value for this parameter, you can limit the results to the attendees who match the specified external ID. Up to 10 comma-separated external IDs may be specified.
attendeeTypeID string query The ID of an attendee type. By entering a value for this parameter, you can limit the results to the attendees who match the specified type.
offset string query The starting point of the next set of results, after the limit specified in the limit field has been reached.
limit Int32 query The number of records to return. Default value: 25
user string query The login ID of the user that is making the request (this must also be the owner if the attendee type is private) . The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter

Payload

None

Response

Payload

Example

Request

GET https://www.concursolutions.com/api/v3.0/expense/attendees?limit=15

Response

{
  "Items": [
    {
      "AttendeeTypeCode": "NOSHOWS",
      "AttendeeTypeID": "gWjYOjoCmOo2Ua$pH4qnCsQxgS8Z0E",
      "FirstName": null,
      "LastName": "No Show Attendee",
      "MiddleInitial": null,
      "Suffix": null,
      "Company": null,
      "Title": null,
      "ExternalID": null,
      "HasExceptionsPrevYear": false,
      "HasExceptionsYTD": false,
      "TotalAmountPrevYear": 0,
      "TotalAmountYTD": 0,
      "VersionNumber": 1,
      "OwnerName": "System, Concur",
      "OwnerLoginID": "ConcurSystem",
      "CurrencyCode": "USD",
      "Custom1": null,
      "Custom2": null,
      "Custom3": null,
      "Custom4": null,
      "Custom5": null,
      "Custom6": null,
      "Custom7": null,
      "Custom8": null,
      "Custom9": null,
      "Custom10": null,
      "Custom11": null,
      "Custom12": null,
      "Custom13": null,
      "Custom14": null,
      "Custom15": null,
      "Custom16": null,
      "Custom17": null,
      "Custom18": null,
      "Custom19": null,
      "Custom20": null,
      "Custom21": null,
      "Custom22": null,
      "Custom23": null,
      "Custom24": null,
      "Custom25": null,
      "ID": "gWj3IHRYiHZGUtIO83ILhbNHqCsjMmkvj$pQ",
      "URI": "https://www.concursolutions.com/api/v3.0/expense/attendees/gWj3IHRYiHZGUtIO83ILhbNHqCsjMmkvj$pQ"
    }
  ]
}

Retrieve a single attendee by ID

Request

URI

Template
/api/v3.0/expense/attendees/{id}
Parameters
Name Type Format Description
id string path Required The attendee object to retrieve.
user string query The login ID of the user that is making the request (this must also be the owner if the attendee type is private). The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter

Payload

None

Response

Payload

Example

Request

GET https://www.concursolutions.com/api/v3.0/expense/attendees/gWj3IHRYiHZGd0HJy%24p5Uk0zITlsMX0ymT%24pA

Response

{
  "AttendeeTypeCode": "PRIVATE",
  "AttendeeTypeID": "gWjYOjoa7Fe0HsTGEk417OCzqUf1A",
  "FirstName": "Diego",
  "LastName": "Rodriguez",
  "MiddleInitial": null,
  "Suffix": null,
  "Company": "Contoso",
  "Title": null,
  "ExternalID": "1",
  "HasExceptionsPrevYear": false,
  "HasExceptionsYTD": false,
  "TotalAmountPrevYear": 0,
  "TotalAmountYTD": 0,
  "VersionNumber": 1,
  "OwnerName": "System, Concur",
  "OwnerLoginID": "ConcurSystem",
  "CurrencyCode": "USD",
  "Custom1": null,
  "Custom2": null,
  "Custom3": null,
  "Custom4": null,
  "Custom5": null,
  "Custom6": null,
  "Custom7": null,
  "Custom8": null,
  "Custom9": null,
  "Custom10": null,
  "Custom11": null,
  "Custom12": null,
  "Custom13": null,
  "Custom14": null,
  "Custom15": null,
  "Custom16": null,
  "Custom17": null,
  "Custom18": null,
  "Custom19": null,
  "Custom20": null,
  "Custom21": null,
  "Custom22": null,
  "Custom23": null,
  "Custom24": null,
  "Custom25": null,
  "ID": "gWj3IHRYiHZGd0HJy$p5Uk0zITlsMX0ymT$pA",
  "URI": "https://www.concursolutions.com/api/v3.0/expense/attendees/gWj3IHRYiHZGd0HJy$p5Uk0zITlsMX0ymT$pA"
}

Create a new attendee

Request

URI

Template
/api/v3.0/expense/attendees
Parameters
Name Type Format Description
user string query The login ID of the user that is adding the attendee. If the attendee type is (private), the user is also made the owner, otherwise the owner is “ConcurSystem” (shared) . The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter

Payload

Response

Payload

Example

Request

POST https://www.concursolutions.com/api/v3.0/expense/attendees

Note

  • Creation of NOSHOWS attendee types are not allowed.

Response

{
  "ID": "gWj3IHRYiHZOQ2T9NNdJ$plN$s7$sG8LhZwjoQ",
  "URI": "https://www.concursolutions.com/api/v3.0/expense/attendees/gWj3IHRYiHZOQ2T9NNdJ$plN$s7$sG8LhZwjoQ"
}

Update existing attendees

Request

URI

Template
/api/v3.0/expense/attendees/{id}
Parameters
Name Type Format Description
id string path Required The attendee ID
user string query The login ID of the user that is updating the attendee(s). If the attendee type is (private), the user must also be the owner of the attendee being updated. The user who is performing this API request must have the Web Services Admin (Professional) or Can Administer (Standard) user role to use this parameter

Payload

Response

Payload

Example

Request

  • Showing developers exactly what they can expect in request and response values when using is perhaps the simplest way to complete this portion of the documentation.
  • Use triple backticks to create fenced code blocks and a language identifier for syntax highlighting.
  • See Creating and highlighting code blocks
PUT https://www.concursolutions.com/api/v3.0/expense/attendees/gWj3IHRYiHZOQ2T9NNdJ%24plN%24s7%24sG8LhZwjoQ

Note

  • Updates to NOSHOWS attendees are not allowed.
  • Updates to employee attendees type ID are not allowed.
  • Updates to employee attendees configured as type SYSEMP are not allowed.

Response

ToDo

Schema

Attendees

Name Type Format Description
Items array Attendee The result collection.
NextPage string - The URI of the next page of results, if any.

Attendee

Name Type Format Description
AttendeeTypeCode string - A code that indicates the type of attendee. Examples: EMPLOYEE, SPOUSE, BUSGUEST. Maximum length: 40 characters
AttendeeTypeID string - The ID of the attendee type. To obtain the attendee type ID value, use the GET /expense/attendeetypes endpoint. The value of the ID element in the response is the attendee type ID. An attendee’s type cannot be updated.
Company string - The name of the attendee’s company. Maximum length: 150 characters
CurrencyCode string - The 3-letter ISO 4217 currency code for monetary amounts related to an attendee.
Custom1 through Custom25 CustomField - A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured. Maximum length: Custom 1-20: 100 characters, Custom 21-25: 48 characters
ExternalID string - A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters NOTE: For HCP connectors where information returned to Concur represents one record per attendee+address pair, this value should be a unique identifier for that pair, and the unique identifier for the individual should be placed into a custom field.
FirstName string - The attendee’s first name. Maximum length: 50 characters
HasExceptionsPrevYear Boolean - Determines whether the attendee had exceptions in the previous year, based on yearly total limits for attendees. Format: true or false
HasExceptionsYTD Boolean - Determines whether the attendee has exceptions in the current year, based on yearly total limits for attendees. Format: true or false
ID string - The unique identifier of the resource.
LastName string - The attendee’s last name. Maximum length: 132 characters
MiddleInitial string - The attendee’s middle initial. Maximum length: 1 character
OwnerLoginID string - The login ID of the user who owns the attendee record.
OwnerName string - The name of the user who owns the attendee record.
Suffix string - The attendee’s name suffix. Maximum length: 32 characters
Title string - The attendee’s title. Maximum length: 32 characters
TotalAmountPrevYear Decimal - The total amount spent on the attendee in the previous calendar year.
TotalAmountYTD Decimal - The total amount spent on the attendee in the current calendar year.
URI string - The URI to the resource.
VersionNumber Int32 - The attendee’s version number.

Custom Field

Name Type Format Description
Code string - For list fields, this is the list item code.
ListItemID string - For list fields, this is the list item ID.
Type string - The custom field type. Possible values: Amount, Boolean, ConnectedList, Date, Integer, List, Number, Text
Value string - The value in the Org Unit or Custom field. For list fields, this is the name of the list item. Maximum length: 48 characters

On this page