Cash Advance v4

The Cash Advance API can be used to create, view, and issue a cash advance.

Limitations

This API is only available to clients who have been granted access by us. Access to this documentation does not provide access to the API. This API is not available in Implementation environments. Cash Advance APIs supports single Cash Advance Creation, Retrieval and Issuance. Create Cash Advance API currently does not support receipt upload.

Process Flow

Process Flow for Cash Advance v4

Products and Editions

  • Concur Expense Professional Edition
  • Concur Expense Standard Edition

Scope Usage

Name Description Endpoint
cashadvance.write Create, Retrieve and Issue a cash advance. GET, POST
cashadvance.read Retrieve a cash advance. GET

Dependencies

The client may use the following APIs to get information:

Access Token Usage

This API supports user and company level access tokens only.

Create a Cash Advance

Creates a cash advance.

Scopes

cashadvance.write - Refer to Scope Usage for full details.

Request

URI

Template
https://{datacenterURI}/cashadvance/v4/cashadvances
Parameters

None.

Headers

Payload

Response

Status Codes

Payload

Example

Request

  https://us.api.concursolutions.com/cashadvance/v4/cashadvances \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'concur-correlationid: create-cash-advance-test' \
  -d '{
  "accountCode": "employee account code",
  "amountRequested": {
    "currency": "USD",
    "amount": 100
  },
  "comment": "Cash Advance of local trips",
  "name": "Cash Advance for Chicago",
  "purpose": "Trip to home office",
  "userId": "9FED321D-3484-49F3-A514-84CB2590DFC4"
}

Response

201 Created
{
    "cashAdvanceId": "C0550587A7D7DF4AB41CA8EF72F6F3D1"
}

Retrieve a Cash Advance

Retrieve a cash advance.

Scopes

cashadvance.write,cashadvance.read - Refer to Scope Usage for full details.

Request

URI

Template
https://{datacenterURI}/cashadvance/v4/cashadvances/{cashAdvanceId}
Parameters
Name Type Format Description
cashAdvanceId string - Required Cash advance ID.

Headers

Response

Status Codes

Payload

Example

Request

  https://us.api.concursolutions.com/cashadvance/v4/cashadvances/C0550587A7D7DF4AB41CA8EF72F6F3D1 \
  -H 'Authorization: Bearer {access_token}' \
  -H 'concur-correlationid: create-cash-advance-test' \
  -d '{
}

Response

200 OK

{
    "paymentType": {
        "description": "Payment in cash",
        "paymentCode": "CASH"
    },
    "exchangeRate": {
        "operation": "MULTIPLY",
        "value": "1.00000000000000"
    },
    "amountRequested": {
        "amount": "100.000000",
        "value": "100.000000",
        "currency": "USD"
    },
    "availableBalance": {
        "amount": "0.0",
        "currency": "USD"
    },
    "approvalStatus": {
        "name": "Not Submitted",
        "code": "C_NOTF"
    },
    "cashAdvanceId": "83C46E6ADBD7D647B1AC34D1C0574E87",
    "requestDate": "2020-10-29 18:28:11.0",
    "name": "Cash Advance for Chicago",
    "purpose": "Trip to home office",
    "issuedDate": null,
    "accountCode": "employee account cod",
    "comment": "Cash Advance of local trips",
    "lastModifiedDate": "2020-10-29 18:28:11.0",
    "hasReceipts": false,
    "reimbursementCurrency": "USD"
}

Issue a Cash Advance

Issues a cash advance.

Scopes

cashadvance.write - Refer to Scope Usage for full details.

Request

URI

Template
https://{datacenterURI}/cashadvance/v4/cashadvances/{cashAdvanceId}/issue
Parameters
Name Type Format Description
cashAdvanceId string - Required Cash advance ID.

Headers

Payload

Response

Status Codes

Payload

Example

Request

  https://us.api.concursolutions.com/cashadvance/v4/cashadvances/C0550587A7D7DF4AB41CA8EF72F6F3D1/issue \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -H 'concur-correlationid: create-cash-adavance-test' \
  -d '{
  "accountCode": "employee account code",
  "comment": "Issuing Cash Advance of employee local trips",
  "exchangeRate": 1.00000
}

Response

200 OK

{
    "issuedDate": "2020-10-29",
    "status": {
        "code": "C_ISSU",
        "name": "Issued"
    }
}

Schema

Create Cash Advance Request

Name Type Format Description
accountCode string - The account code, if not provided, will be read from the employee profile configuration data. Maximum characters: 48
amountRequested - amount Required The amount of the cash advance.
comment string - Comment while creating a cash advance. Maximum characters: 2000
name string - Required Cash advance name. Maximum characters: 40
purpose string - Purpose of raising a cash advance. Maximum characters: 2000
userID string - Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID. Maximum characters: 16

Amount

Name Type Format Description
currency string - Required The 3-letter ISO 4217 currency code. Maximum characters: 3
amount number - Required The amount value. Maximum characters: 23

Create Cash Advance Response

Name Type Format Description
cashAdvanceId string - Unique cash advance identifier.

Get Cash Advance Response

Name Type Format Description
paymentType - payment Details on type of the payment used.
exchangeRate - exchangeRate Details on the exchange rate. Maximum characters: 23
amountRequested - amountRequested Details on the amount requested.
availableBalance - availableBalance Details on the available balance.
approvalStatus - approvalStatus Details on the approval status.
cashAdvanceId string - Unique cash advance identifier.
requestDate string YYYY-MM-DD The date the cash advance was requested.
name string - Cash advance name. Maximum characters: 40
purpose string - Purpose of raising a cash advance. Maximum characters: 2000
issuedDate string YYYY-MM-DD The date the cash advance was issued.
accountCode string - Account code linked to the employee.
comment string - Comment while creating a cash advance. Maximum characters: 2000
lastModifiedDate string YYYY-MM-DD The date the cash advance was last modified.
hasReceipts string - If the cash advance has receipts.
reimbursementCurrency string - The 3-letter ISO 4217 currency code. Maximum characters: 3

payment

Name Type Format Description
description string - The payment method for the cash advance.
paymentCode string - The ID of the payment type for the cash advance.

exchangeRate

Name Type Format Description
operation string - Exchange rate operation. Supported values: MULTIPLY
value number - Exchange rate value.

amountRequested

Name Type Format Description
amount number - Requested cash advance amount. Maximum characters: 23
value number - Deprecated (Use amount).
currency number - The 3-letter ISO 4217 currency code. Maximum characters: 3

availableBalance

Name Type Format Description
amount number - Unsubmitted balance. Maximum characters: 23
currency number - The 3-letter ISO 4217 currency code. Maximum characters: 3

approvalStatus

Name Type Format Description
name string - Cash advance status name. Maximum characters: 40
code string - Cash advance status key.

Issue Cash Advance Request

Name Type Format Description
accountCode string - Account code linked to the employee.
comment string - Comment while issuing a cash advance. Maximum characters: 2000
exchangeRate number - The exchange rate that applies to the expected expense.If no exchange rate is provided system exchange rate will be considered. Maximum characters: 23

Issue Cash Advance Response

Name Type Format Description
status - status Details on type of payment used.
issuedDate string YYYY-MM-DD The date the cash advance was issued.

status

Name Type Format Description
code string - Cash advance status key.
name string - Cash advance status name. Maximum characters: 40

Error

Name Type Format Description
errorCode string - The unique identifier of the error.
errorMessage string - Message associated with the error.

On this page