ProRoster - Get calculated cost for employees in a plan

API Url

Used to get the calculated cost for all accounts in the Payroll code profile attached to each employee in a plan

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/cost

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.
cost	Object[]
accountId	Number	The account Id that the cost is calculated for.
cost	Boolean	Calculated cost.
date	String	Date of the calculated cost.
empId	String	Employee Id.
shiftSeq	String	Shift sequence that the calculated cost relates to.
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",
                 "date": "20-05-2020",
                 "cost": 50,
                 "shiftSeq": 0,
                 "accountId": "T001",
             }
         ]   
      },
      "erorCode": 0,
      "errorMessage": ""
   }
}