Expense - Get mileage supplements

API Url

Used to load supplements related to mileage registrations.

GET
http://localhost:16010/ProMarkREST/rest/Mileage/supplements

Permissions: user

Query parameters

FieldTypeDescription
dateoptionalDate

The transaction date (default is Today).

empIdoptionalString

The employee ID who requests the supplements (default is session employee).

typeoptionalString

Filter supplements by type (1: Mileage supplement 1; 2: Mileage supplement 2, 3: Travel Detail supplement 4: Loose Time supplement)

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    supplementsObject[]

Collection of mileage supplements.

      descriptionString

Description of supplement.

      favoriteBoolean

If the supplement is favorite.

      idString

Unique identifier for the mileage supplement.

      typeNumber

Supplement type.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"supplements": [
{
"id": "Supplement1",
"description": "Traveling abroad",
"type": 1
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

{
"response": {
"errorCode": 5,
"errorMessage": "No employees"
}
}