Approval - Get expense approval registrations

API Url

Used for loading mileage and expense approval registrations.

GET

http://localhost:16010/ProMarkREST/rest/Approval/expenses

Permissions: user

Query parameters

Field	Type	Description
approvalGroup`optional`	String	Approval Group ID. If not defined all valid approval groups are taken by default.
approvalStatus`optional`	Number	Approval status to filter data (1: Untreated, 2: Approved, 3: Rejected). In not defined then untreated transactions are returned. Size range: `1-3`
expand`optional`	String	Expand specified properties (comma delimiter) with descriptions. (Not implemented yet)
fields`optional`	String	List of fields to be returned in the collection. Used for limiting amount of data.(Not implemented yet)
from`optional`	Date	Start date for loading registrations.
to`optional`	Date	End date for loading registrations.

Success 200

Field	Type	Description
mileages`optional`	Object[]	Collection of mileages if it is mileage registration
accountDesc`optional`	String	Mileage account description.
accountId`optional`	String	Mileage account id.
carRegNo`optional`	String	License plate of the car.
carType`optional`	Number	0: Company car, 1: Private car.
comment`optional`	String	A comment for the mileage.
distance`optional`	Number	Distance of a route.
from`optional`	String	Starting position of a route.
roundtrip`optional`	Boolean	If the mileage includes the return trip too.
supplements`optional`	Object[]	A colection of mileage supplements.
id`optional`	String	Supplement unique id.
supplementDesc`optional`	String	Supplement description.
type`optional`	Number	Supplement type (1: Mileage supplement 1; 2: Mileage supplement 2, 3: Travel Detail supplement 4: Loose Time supplement).
to`optional`	String	Ending position of a route.
via`optional`	String	Alternate route.
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
expenses	Object[]	Collection of employee expense approval registrations.
approvalStatus	Number	Approval Status
approvalTime`optional`	Date	Approval Date Time
approvedBy`optional`	String	Approved By
avatarURI`optional`	String	URI used for loading the employee avatar.
empId	String	Employee identifier
empName	String	Employee first name.
empNo	String	Employee No.
initials	String	Employee initials.
outlays`optional`	Object[]	Collection of outlay expenses, if it is outlay expense registration
date`optional`	Date	Registration date.
receipts`optional`	Object[]	Collection of receipts , if it is outlay expense registration
accountDesc`optional`	String	Account description.
accountId`optional`	String	Account ID.
comment`optional`	String	Remarks in connection with the receipt.
date`optional`	date	Receipt date.
entry`optional`	integer	Entry number.
id`optional`	string	Receipt identifier/number.
value`optional`	Integer	Value on the receipt.
registrationTime	Date	Registration Date
rejectedHigherLevel`optional`	Boolean	If it is rejected at higher level?
rejectionCode`optional`	String	Rejection Code
rejectionText`optional`	String	Rejection Text
sortEmpNo	String	Sort employee No.
transSeq	Number	Transaction Sequence
travels`optional`	Object[]	Collection of travel expenses, if it is travel expense registration
endDate`optional`	Date	Travel end date-time.
startDate`optional`	Date	Travel start date-time.
travelDetails`optional`	Object[]	Collection of travel details
comment`optional`	String	Optional comments about the travel.
endTime`optional`	Datetime	End date.
entryNo`optional`	Integer	Travel detail unique number per transaction.
meals`optional`	Boolean[3]	Collection of booleans representing if a meal has been taken or not.
startTime`optional`	Datetime	Start date.
supplementDesc`optional`	String	Supplement description.
supplementId`optional`	String	Supplement id if exist.
treatedByFirst`optional`	String	First approved By
treatedTimeFirst`optional`	Date	First approval Date Time
type	Number	Expens registration type (0: All, 1: Mileage, 2: Travel).
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example for rest/Approval/expenses?approvalStatus=1&approvalGroup="XXX:"

HTTP/1.1 200 OK
{
    "response": {
        "data": {
            "expenses": [
                {
                    "empNo": "055",
                    "sortEmpNo": "!!!!!055",
                    "empName": "Constantine Great Emperor",
                    "initials": "CGE",
                    "type": 1,
                    "transSeq": 2078866,
                    "registrationTime": "2014-10-26",
                    "empId": "545",
                    "approvalStatus": 1
                    "mileages": [
                        {
                            "accountId": "MILEAGE",
                            "accountDesc": "Mileage",
                            "carRegNo": "ab12345",
                            "carType": 1,
                            "comment": "",
                            "from": "Ballerup vest",
                            "to": "Ballerup nord",
                            "via": "Taastrup",
                            "distance": 10,
                            "roundtrip": false
                        }
                    ]
                },
                {
                    "empNo": "4880",
                    "sortEmpNo": "!!!!4880",
                    "empName": "Extended Approval Test",
                    "initials": "EAT",
                    "type": 2,
                    "transSeq": 2314633,
                    "registrationTime": "2018-03-20",
                    "empId": "831",
                    "approvalStatus": 1
                    "travels": [
                        {
                            "startTime": "2018-03-19T08:00:00.000",
                            "endTime": "2018-03-20T00:00:00.000",
                            "travelDetails": [
                                {
                                    "entryNo": 0,
                                    "meals": [
                                        false,
                                        false,
                                        false
                                    ],
                                    "startTime": "2018-03-19T08:00:00.000",
                                    "endTime": "2018-03-20T00:00:00.000",
                                    "comment": "Company Meet"
                                }
                            ]
                        }
                    ]
                },
                {
                    "empNo": "XJWS",
                    "sortEmpNo": "!!!!XJWS",
                    "empName": "John Wick Sr.",
                    "initials": "JWS",
                    "type": 3,
                    "transSeq": 2413694,
                    "registrationTime": "2019-01-17",
                    "empId": "762",
                    "approvalStatus": 1,
                    "outlays": [
                        {
                            "date": "2019-01-17",
                            "empId": "762",
                            "receipts": [
                                {
                                    "accountId": "OUTLAY1",
                                    "accountDesc": "Expenses",
                                    "date": "2019-01-08",
                                    "entry": 1,
                                    "comment": "",
                                    "id": "34535",
                                    "value": "12",
                                }
                            ]
                        }
                    ]
                    
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}