ProRoster - Account balances multiple empl.

API Url

Used to get all account balances for a list of employees, According to each plan setup, it gets current , primo, ultimo ,delta.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{id}/account-balances

Permissions: user

Path parameters

Field	Type	Description
id	Number	The plan Id.

Query parameters

Field	Type	Description
empIds`optional`	String	Comma seperated list of employee ids. if not sent the employees of the current plans are loaded.
from`optional`	Date	If not sent it is set to the beginning of the current week.
to`optional`	Date	If not sent it is set to the end of the current week.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
accountBalances	Object[]	Collection with account balance data.
accountId	String	Account ID.
currentBalance	String	The current balance for the account.
delta	Number	The difference between ultimo and primo.
empId	String	Employee Id.
format	Number	Account format ("HH:MM", "HH.CC", ".1", ".2" and so on).
isGroup	Boolean	If true the accountId is the Id of an account group.
primo	Number	The first balance of the period.
ultimo	String	The last balance of the period.
unit	Number	Account unit (1: Hours, 2: Days, 3: Pieces).
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 with a single shift:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "accountBalances": [
             {
                 "empId": "1000",
                 "accountId": "T001",
                 "isGroup": false,
                 "currentBalance": 0,
                 "primo": null,
                 "ultimo": null,
                 "delta": null,
                 "unit": 1,
                 "format": "HH:MM"
             }
         ]   
      },
      "erorCode": 0,
      "errorMessage": ""
   }
}