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
| Field | Type | Description |
|---|---|---|
dateoptional | Date | The transaction date (default is Today). |
empIdoptional | String | The employee ID who requests the supplements (default is session employee). |
typeoptional | String | Filter supplements by type (1: Mileage supplement 1; 2: Mileage supplement 2, 3: Travel Detail supplement 4: Loose Time supplement) |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| supplements | Object[] | Collection of mileage supplements. |
| description | String | Description of supplement. |
| favorite | Boolean | If the supplement is favorite. |
| id | String | Unique identifier for the mileage supplement. |
| type | Number | Supplement type. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"supplements": [{"id": "Supplement1","description": "Traveling abroad","type": 1}]},"errorCode": 0,"errorMessage": ""}}
Error 4xx
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data (empty). |
| errorCode | Number | Error code. |
| errorMessage | String | Error description. |
Error example:
{"response": {"errorCode": 5,"errorMessage": "No employees"}}