Skip to content

v4.expense-cash-advance-associations.markdown

Latest commit

 

History

History
270 lines (182 loc) · 9.14 KB

v4.expense-cash-advance-associations.markdown

File metadata and controls

270 lines (182 loc) · 9.14 KB
title Cash Advance Associations v4
layout reference

Cash Advance Associations v4

The Cash Advance Associations v4 API can be used for operations related to associating and disassociating cash advances with an expense report.

Limitations

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

Products and Editions

  • Concur Expense Professional Edition
  • Concur Expense Standard Edition

Scope Usage

Name Description Endpoint
expense.report.read Read information about cash advances associated with a report. GET
expense.report.readwrite Read and write information about cash advances associated with a report. GET, POST, DELETE

Dependencies

SAP Concur clients must purchase the Concur Expense cash advance feature in order to use this API and use the Cash Advance v4.1 APIs to create cash advances.

Please contact your SAP Concur representative for more information.

Access Token Usage

This API supports both company level and user level access tokens.

Get Cash Advance Associations

Returns cash advance IDs associated with the specified report.

Scopes

expense.report.read - Refer to Scope Usage for full details.

URI

https://{datacenterURI}/expensereports/v4/reports/{reportId}/cashAdvances

Parameters

Name Type Format Description
reportId string path The unique identifier of the report.
contextType string query The access level of the Concur user, which determines the form fields they can view/modify. Only used with User JWT. Available values : traveler, manager, processor. Default is traveler.

Payloads

Headers

Response

Status Codes

Examples

Request

curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/cashAdvances' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json'

Response

200 OK

{
  "cashAdvances": [
    {
      "id": "4a205b23-9d47-413f-9eeb-cd7245b75a6a"
    },
    {
      "id": "75e1fbe2-7de8-467f-9f6f-67073908459b"
    }
  ]
}

Associate Cash Advances with a Report

Associates the specified cash advance(s) with the specified report. Replaces all existing associated cash advance(s) of the report with the provided payload.

Any invalid Cash Advance Ids will result in a failed action and no update will occur.

Scopes

expense.report.readwrite - Refer to Scope Usage for full details.

URI

https://{datacenterURI}/expensereports/v4/reports/{reportId}/cashAdvances

Parameters

Name Type Format Description
reportId string path The unique identifier of the report.
body CashAdvanceRequest application/json The request body containing the cash advances to associate.

Payloads

Headers

Response

Status Codes

Examples

Request

curl --location --request POST 'https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/cashAdvances' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cashAdvanceIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Response

201 Created

201 Created

{
  "uri": "https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/cashAdvances"
}

Disassociate Cash Advances with Report

Disassociate the specified cash advance(s) from the specified report.

Scopes

expense.report.readwrite - Refer to Scope Usage for full details.

URI

https://{datacenterURI}/expensereports/v4/reports/{reportId}/cashAdvances?cashAdvanceIds={cashAdvanceId}

Parameters

Name Type Format Description
reportId string path The unique identifier of the report.
cashAdvanceIds List<String> query The unique identifier(s) of the cash advances to disassociate with the report

Payloads

  • Request: None
  • Response: None

Headers

Response

Status Codes

Examples

Request

curl --request DELETE 'https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/cashAdvances?cashAdvanceIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&cashAdvanceIds=75e1fbe2-7de8-467f-9f6f-67073908459b' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json'

Response

204 Created

204 No Content

Schema

CashAdvanceResponse

Name Type Format Description
id string uuid The associated cash advance Id.

CashAdvancesResponse

Name Type Format Description
cashAdvances array CashAdvanceResponse List of the associated cash advance objects.

CashAdvanceRequest

Name Type Format Description
cashAdvanceIds array uuid List of the associated cash advance ids

CashAdvancePostResponse

Name Type Format Description
uri string - The href to retrieve the cash advance associations