Welcome to Push Operations' API endpoints.
\nAll API endpoints require a bearer token for authentication over HTTPS. Only approved partners will be issued tokens.
\nAuthorization: Bearer <token>\n\nOur API implements rate limiting and pagination to ensure optimal performance, fair resource usage, and system reliability.
\nAll endpoints support pagination using page and limit query parameters:
Default limit: 100 records per page (maximum)
\nLabour endpoints: Use date range pagination with a 2-day maximum range instead of standard pagination
\nExample request:
\nGET /api/v1/employees?page=1&limit=50\n\nRate limits are enforced at both minute and hourly intervals and automatically reset at the start of each period.
\nLimits:
\nPer minute: 50 requests
\nPer hour: 600 requests
\nMulti-company management
For users managing multiple companies, include a Push-Company-Uuid header in your requests to apply rate limits per company. Without this header, limits apply per API token.
Company UUIDs can be retrieved from the Get Companies endpoint.
\nRate limit headers:
When a limit is reached, the response includes:
X-RateLimit-Retry-After: Wait time in seconds before retryingCompany ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"start","value":"2021-09-02"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"end","value":"2021-09-03"},{"description":{"content":"Location ID (optional)
\n","type":"text/plain"},"key":"locationId","value":"123"},{"description":{"content":"Optional relationships
\n","type":"text/plain"},"key":"include","value":"employee,employee.costCenter,position,status,breaks,location"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"f807745f-aaaf-4f17-bf8e-90540b9087df","name":"Read Clocks","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/clocks?start=2021-09-02&end=2021-09-03&company=12345&locationId=123&include=employee,employee.costCenter,position,status,breaks,location","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","clocks"],"query":[{"key":"start","value":"2021-09-02"},{"key":"end","value":"2021-09-03"},{"key":"company","value":"12345"},{"key":"locationId","value":"123"},{"key":"include","value":"employee,employee.costCenter,position,status,breaks,location"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 342144712,\n \"employeeId\": 319695,\n \"employeePositionId\": 508756,\n \"businessDate\": \"2021-09-02\",\n \"clockIn\": \"2021-09-02 01:29:30\",\n \"clockOut\": \"2021-09-02 09:00:19\",\n \"hoursApproved\": 7.5,\n \"breakMinutes\": 15,\n \"isApproved\": true,\n \"isCurrent\": 0,\n \"isAutoClockout\": 0,\n \"clockInComments\": \"The bus was delayed\",\n \"clockOutComments\": \"All doors are locked\",\n \"managerComments\": \"\",\n \"approvedTime\": \"Missed Clockout\",\n \"regularHours\": 1.5,\n \"overtimeHours\": 1,\n \"doubletimeHours\": 2,\n \"overtimeWeekly\": 3,\n \"statutoryHolidayWork\": 1,\n \"breaks\": [\n {\n \"id\": 367471,\n \"clockId\": 342144712,\n \"breakTypeId\": 707,\n \"isCurrent\": false,\n \"start\": \"2021-09-02 06:38:05\",\n \"end\": \"2021-09-02 07:08:43\",\n \"formatted\": {\n \"start\": \"06:38AM\",\n \"end\": \"07:08AM\"\n }\n }\n ],\n \"breakTypes\": [\n {\n \"id\": 707,\n \"description\": \"1st Break - coffee\",\n \"durationMinutes\": 15,\n \"start\": \"2021-09-02 01:29:00\",\n \"end\": \"2021-09-02 01:28:00\"\n },\n {\n \"id\": 708,\n \"description\": \"2nd Break - lunch\",\n \"durationMinutes\": 15,\n \"start\": \"2021-09-02 01:29:00\",\n \"end\": \"2021-09-02 01:28:00\"\n }\n ],\n \"status\": {\n \"general\": [],\n \"clockIn\": [\n \"Early\"\n ],\n \"clockOut\": [\n \"Left Late\"\n ]\n },\n \"employee\": {\n \"id\": 319695,\n \"name\": \"Richard Jackson\",\n \"firstname\": \"Richard\",\n \"lastname\": \"Jackson\",\n \"uuid\": \"d6afb39e-e321-4a0d-84a5-4b0e8afe0d95\",\n \"uuid2\": \"d6afb39e-e321-4a0d-84a5-4b0e8afe0d95\",\n \"email\": \"richard.jackson@pushoperations.com\",\n \"costCenter\": {\n \"id\": 123,\n \"name\": \"FOH\"\n },\n },\n \"position\": {\n \"id\": 82871,\n \"name\": \"Cook\",\n \"companyId\": 12345\n }\n }\n ]\n}"}],"_postman_id":"1a6f792c-7cf7-48c0-9882-07444e0c9a5f"}],"id":"5a0e5a33-d59c-44ea-baac-bce8dc01047e","description":"Get clock punches from Push Operations' time attendance.
\n","_postman_id":"5a0e5a33-d59c-44ea-baac-bce8dc01047e"},{"name":"Company","item":[{"name":"Get Companies","id":"b705b4a8-dafc-49c2-aa5b-532b76044285","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Optional Relationships
\n","type":"text/plain"},"key":"include","value":"organization,location"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"9d4ad231-ee28-4b53-925c-990ee1f1c40d","name":"Get Companies","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/companies?include=organization,location&locationId=123","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","companies"],"query":[{"key":"include","value":"organization,location","description":"Optional Relationships"},{"key":"locationId","value":"123","description":"Optional parameter","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Feb 2023 01:16:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IjEzcWxtXC90UVBpR1FkbGtLTTJ4eW1nPT0iLCJ2YWx1ZSI6ImcrWlBmQU1wSVo3QXZqUENMVnBJd09sWWE1RXdzOXpjM2lFUHJxNlNibHVCXC9MMWlKbGJzdlptWXJMQkZhcUNrVW9MY3lrZ2picGlvKzRuMngzcUxyQT09IiwibWFjIjoiNzU3YTdlOGE3ZThlNmQ2YTVkNjVlZDMwN2U3N2Q2MGY3MTFkZjg2Zjg3N2YwYWI1YmRhMjNjMDM2MzUxZDVkNCJ9; expires=Tue, 28-Feb-2023 01:16:46 GMT; Max-Age=86400; path=/; domain=pushoperations.com; secure; HttpOnly"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; report-uri https://app-elb.pushoperations.com/_csp"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"uuid\": \"2f218e00-9932-48a1-a681-2782abad56db\",\n \"name\": \"ABC Restaurant\",\n \"address\": \"123 Main Street\",\n \"city\": \"Vancouver\",\n \"provinceState\": \"BC\",\n \"country\": \"Canada\",\n \"storeNumber\": \"101\",\n \"organization\": {\n \"id\": 10110,\n \"name\": \"ABC Org\"\n }\n },\n {\n \"id\": 2,\n \"uuid\": \"2aa5cedb-9feb-4fd5-a217-53e946810509\",\n \"name\": \"Tasty Cafe\",\n \"address\": \"555 West Broadway\",\n \"city\": \"Vancouver\",\n \"provinceState\": \"BC\",\n \"country\": \"Canada\",\n \"storeNumber\": \"102\",\n \"organization\": {\n \"id\": 10212,\n \"name\": \"Tasty Cafe Org\"\n }\n }\n ]\n}"}],"_postman_id":"b705b4a8-dafc-49c2-aa5b-532b76044285"},{"name":"Get File Categories","id":"bd2cc04f-42f0-4dcf-8bab-dbb00fdefe5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This endpoint returns a list of the file categories that belong to the specified company.
\n","urlObject":{"protocol":"https","path":["platform","api","v1","file-categories"],"host":["api","pushoperations","com"],"query":[{"description":{"content":"Company ID at Push
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"3222f2a0-3543-4504-866b-3875cb375f21","name":"Get File Categories","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/file-categories?company=12345&page=1&limit=1","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","file-categories"],"query":[{"key":"company","value":"12345"},{"key":"page","value":"1"},{"key":"limit","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Feb 2023 01:16:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IjEzcWxtXC90UVBpR1FkbGtLTTJ4eW1nPT0iLCJ2YWx1ZSI6ImcrWlBmQU1wSVo3QXZqUENMVnBJd09sWWE1RXdzOXpjM2lFUHJxNlNibHVCXC9MMWlKbGJzdlptWXJMQkZhcUNrVW9MY3lrZ2picGlvKzRuMngzcUxyQT09IiwibWFjIjoiNzU3YTdlOGE3ZThlNmQ2YTVkNjVlZDMwN2U3N2Q2MGY3MTFkZjg2Zjg3N2YwYWI1YmRhMjNjMDM2MzUxZDVkNCJ9; expires=Tue, 28-Feb-2023 01:16:46 GMT; Max-Age=86400; path=/; domain=pushoperations.com; secure; HttpOnly"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; report-uri https://app-elb.pushoperations.com/_csp"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Applicant Records\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"previous\": null,\n \"current\": 1,\n \"next\": 2,\n \"pageCount\": 1,\n \"totalCount\": 2\n }\n }\n}"}],"_postman_id":"bd2cc04f-42f0-4dcf-8bab-dbb00fdefe5b"}],"id":"d5e3c37b-321e-4bf8-b3b3-e48523e2adf9","description":"Get a list of companies that you have access for.
\n","_postman_id":"d5e3c37b-321e-4bf8-b3b3-e48523e2adf9"},{"name":"Departments","item":[{"name":"Get Departments List","id":"d8533b0b-a663-44ce-8857-bdca7ec2931e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"caf4eba3-60b7-47d0-877a-b925ae7de5c4","name":"Get Departments List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/departments?company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","departments"],"query":[{"key":"company","value":"12345","description":"Company ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 2928,\n \"name\": \"FOH\"\n },\n {\n \"id\": 2929,\n \"name\": \"BOH\"\n },\n {\n \"id\": 2930,\n \"name\": \"Management\"\n },\n {\n \"id\": 4042,\n \"name\": \"Skybar\"\n },\n {\n \"id\": 4043,\n \"name\": \"Z Cafe\"\n }\n ]\n}"}],"_postman_id":"d8533b0b-a663-44ce-8857-bdca7ec2931e"}],"id":"75e13140-a76e-4aa5-b810-b5c3dcb1d153","description":"Get a list of departments
\n","_postman_id":"75e13140-a76e-4aa5-b810-b5c3dcb1d153"},{"name":"Employees","item":[{"name":"Get Employees","id":"6cd34bef-02c2-4985-bfcb-49bff1013c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"start","value":"2021-09-02"},{"description":{"content":"Optional relationships
\n","type":"text/plain"},"key":"include","value":"positions,employeePositions,employeePositions.salary,costCenter,employeeGroups,employeeContacts,employeeAttributes,employmentPeriods,workPermit,roe,location"},{"description":{"content":"Location ID (optional)
\n","type":"text/plain"},"key":"locationId","value":"123"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"8b1a428e-aae8-41ad-a7c4-63e26719cf7d","name":"Get Employees","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/employees?start=2021-09-02&company=12345&include=positions,employeePositions,employeePositions.salary,costCenter,employeeGroups,employeeContacts,employeeAttributes,employmentPeriods,workPermit,roe,location&locationId=123","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","employees"],"query":[{"key":"start","value":"2021-09-02","description":"Start date"},{"key":"company","value":"12345","description":"Company ID"},{"key":"include","value":"positions,employeePositions,employeePositions.salary,costCenter,employeeGroups,employeeContacts,employeeAttributes,employmentPeriods,workPermit,roe,location","description":"Optional relationships"},{"key":"locationId","value":"123","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 212030,\n \"name\": \"Ollie Pope\",\n \"firstname\": \"Ollie\",\n \"lastname\": \"Pope\",\n \"legalFirstName\": \"Ollie\",\n \"legalLastName\": \"Pope\",\n \"uuid\": \"6fd7cdeb-abbf-4a33-a200-460cc8aad328\",\n \"email\": \"ollie@pushoperations.com\",\n \"sin\": \"999-999-998\",\n \"status\": \"Active\",\n \"employmentType\": \"employee\",\n \"phoneNumber\": \"\",\n \"hireDate\": \"2018-06-08\",\n \"alternatePhoneNumber\": \"\",\n \"clockId\": \"1264\",\n \"birthday\": \"1990-01-01\",\n \"address\": \"\",\n \"address2\": \"\",\n \"unit\": \"\",\n \"city\": \"Vancouver\",\n \"province\": \"BC\",\n \"country\": \"Canada\",\n \"postalCode\": \"A1A 1A1\",\n \"totalizationAgreement\": 0,\n \"positions\": [\n {\n \"id\": 64995,\n \"name\": \"Server\"\n }\n ],\n \"employeePositions\": [\n {\n \"id\": 329626,\n \"positionId\": 64995,\n \"name\": \"Server\",\n \"locationId\": null,\n \"salary\": [\n {\n \"id\": 38952064,\n \"salaryRate\": 14,\n \"salaryPeriod\": \"hourly\",\n \"effectiveStartDate\": \"0000-01-01\",\n \"effectiveEndDate\": \"2020-09-30\"\n },\n {\n \"id\": 118989757,\n \"salaryRate\": 14.25,\n \"salaryPeriod\": \"hourly\",\n \"effectiveStartDate\": \"2020-10-01\",\n \"effectiveEndDate\": \"9999-01-01\"\n }\n ]\n }\n ],\n \"costCenter\": {\n \"id\": 5259,\n \"name\": \"FOH\"\n },\n \"employeeGroups\": [\n {\n \"id\": 19909,\n \"name\": \"Server\"\n }\n ],\n \"employeeContacts\": [\n {\n \"id\": 14540,\n \"firstname\": \"Duncan\",\n \"lastname\": \"Pope\",\n \"relationship\": \"Sibling\",\n \"phoneNumber\": \"999-999-9999\",\n \"alternatePhoneNumber\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"province\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n }\n ],\n \"employeeAttributes\": [\n {\n \"id\": 54749,\n \"value\": \"Yes\",\n \"attribute\": {\n \"id\": 3057,\n \"type\": \"select\",\n \"name\": \"Permit\",\n \"onboarding\": true,\n \"required\": true\n }\n }\n ],\n \"employmentPeriods\": [\n {\n \"id\": 324710,\n \"start\": \"2018-06-08\",\n \"end\": \"2022-06-27\",\n \"reason\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"6cd34bef-02c2-4985-bfcb-49bff1013c79"},{"name":"Update Employee","id":"0bf93a82-3395-46f0-a0f6-f22c1afdedfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This endpoint retrieves a list of all the employee files data, including a download URL with an expiration time of 5 minutes.
\n","urlObject":{"protocol":"https","path":["platform","api","v1","employees","{employeeId}","files"],"host":["api","pushoperations","com"],"query":[{"description":{"content":"Optional relationship. There is a dedicated file categories endpoint under the company resource.
\n","type":"text/plain"},"key":"include","value":"fileCategory"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"8e99d084-8991-46a4-9beb-20c4bd8d062a","name":"Get Employee Files","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/employees/1234567?includes=fileCategory","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","employees","1234567"],"query":[{"key":"includes","value":"fileCategory"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1325467,\n \"fileName\": \"employee_cv.pdf\",\n \"contentType\": \"application/pdf\",\n \"employeeViewable\": true,\n \"teamAdminViewable\": true,\n \"downloadUrl\": \"https://s3.amazonaws.com/example/file-download\",\n \"fileCategory\": {\n \"id\": 123,\n \"name\": \"Applicant Records\"\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"previous\": null,\n \"current\": 1,\n \"next\": null,\n \"pageCount\": 1,\n \"totalCount\": 1\n }\n }\n}"}],"_postman_id":"0e99734e-6f2a-4bfd-8cb2-99579bca1d89"},{"name":"Create Employee File","id":"75e856c6-ccb5-4436-b3f0-3a2f72b29df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This endpoint allows you to upload a file for an employee.
\nThis endpoint is used to delete an employee file.
\n","urlObject":{"protocol":"https","path":["platform","api","v1","employees","{employeeId}","files","{fileId}"],"host":["api","pushoperations","com"],"query":[{"disabled":true,"description":{"content":"[int] Employee ID at Push
\n","type":"text/plain"},"key":"employeeId","value":"12345678"},{"disabled":true,"description":{"content":"[int] File ID at Push
\n","type":"text/plain"},"key":"fileId","value":"123234456"}],"variable":[]}},"response":[{"id":"dd1a6007-9472-47a0-bba0-b89395598d4f","name":"Delete Employee File","originalRequest":{"method":"DELETE","header":[],"url":"https://api.pushoperations.com/platform/api/v1/employees/1234567/files/1236747"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"}],"_postman_id":"a5b6acdd-ca77-4090-93d3-feb5f528deca"}],"id":"084abc96-4db5-4ae4-8345-9a6cd606579f","description":"Endpoints for retrieving employees data and updating employees.
\n","_postman_id":"084abc96-4db5-4ae4-8345-9a6cd606579f"},{"name":"Labour","item":[{"name":"Get Labour By Department","id":"a6983eec-70e0-44f4-8f67-9ddc40b9876c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"start","value":"2022-02-01"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"end","value":"2022-02-02"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"vacation","value":"true"},{"description":{"content":"Optional [true, false]
\n","type":"text/plain"},"key":"earnings-deductions","value":"true"}],"variable":[]}},"response":[{"id":"7d69bbb5-3dd8-445d-928b-765b85984460","name":"Get Labour By Department","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/analytics/summary/labour-actuals?start=2022-05-18&end=2022-05-18&company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","analytics","summary","labour-actuals"],"query":[{"key":"start","value":"2022-05-18","description":"Start date"},{"key":"end","value":"2022-05-18","description":"End date"},{"key":"company","value":"12345","description":"Company ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Mar 2022 01:34:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"pushoperationsci_session=OpTleuvlKv0rrYf7LjCn03lvJGFoRMCI7Egv6RBeqhyVlR5dsg0TUyIu4LGgePVxs%2FXttk1VaC6lk3RXBM4%2FINvxjoob5eb%2BgTKbsvSuqiT4H%2F8z6bvgcua6IlQLjMfnS9%2BnaSlUG5xIv4DRllfhefQqLeigJ3uIQ3en8HYXQYA2rvvdIqNk5SUqfw%2BWe%2B%2FjuE5su7d8CJy788nyJ4uSvzCuTm6YJc9aLd8UzkBHMgpycNVBA9DnpxwFSqRziO0udUF1Kol3PB7axvWtzmAL2hdnNhSzeH30tXB3MhKS9dI%3D; expires=Wed, 30-Mar-2022 01:34:09 GMT; Max-Age=86400; path=/; domain=.pushoperations.com; secure"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlNNNjE1OFpPcFkxZTc3dVIrOFdGSHc9PSIsInZhbHVlIjoiYVp5dUc4SEZPXC8zamxicktQK0NcL2d3U3NSY2pWQzFaZjkxMGhrTXNBbWxTbkRFUHRGQUVET0pLYlE5UzFMaEhPdFFycUxpZGtlU2UzMzRHTnhYcFBaZz09IiwibWFjIjoiNDUwZDM0MWQyOTg2ZGM1ZDlkYjEyZDVhMjUxMDU5YTYxZWY0YWE4ZjU2OWIxNGE5NmMxMWE3MGVhODBmZDRlZSJ9; expires=Wed, 30-Mar-2022 01:34:09 GMT; Max-Age=86400; path=/; domain=pushoperations.com; secure; HttpOnly"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; report-uri https://app-elb.pushoperations.com/_csp"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"companyId\": 12345,\n \"totalCosts\": 1233.23,\n \"totalHours\": 65.60,\n \"labourActualByDate\": [\n {\n \"date\": \"2022-02-01\",\n \"costs\": 139.29,\n \"hours\": 5.71,\n \"departmentId\": 7328,\n \"departmentName\": \"FOH-S\"\n },\n {\n \"date\": \"2022-02-01\",\n \"costs\": 150,\n \"hours\": 5.71,\n \"departmentId\": 7331,\n \"departmentName\": \"BOH-S\"\n },\n {\n \"date\": \"2022-02-01\",\n \"costs\": 588.67,\n \"hours\": 38.51,\n \"departmentId\": 7329,\n \"departmentName\": \"FOH-H\"\n },\n {\n \"date\": \"2022-02-02\",\n \"costs\": 139.28,\n \"hours\": 5.71,\n \"departmentId\": 7328,\n \"departmentName\": \"FOH-S\"\n },\n {\n \"date\": \"2022-02-02\",\n \"costs\": 150,\n \"hours\": 5.71,\n \"departmentId\": 7331,\n \"departmentName\": \"BOH-S\"\n },\n {\n \"date\": \"2022-02-02\",\n \"costs\": 65.99,\n \"hours\": 4.23,\n \"departmentId\": 7329,\n \"departmentName\": \"FOH-H\"\n }\n ]\n }\n}"}],"_postman_id":"a6983eec-70e0-44f4-8f67-9ddc40b9876c"},{"name":"Get Labour Scheduled By Department","id":"16a95b2e-141c-4054-b37d-9ef956f86878","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"start","value":"2022-05-18"},{"description":{"content":"yyyy-mm-dd
\n","type":"text/plain"},"key":"end","value":"2022-05-18"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"vacation","value":"true"}],"variable":[]}},"response":[{"id":"d5ff5af3-7f23-442f-b105-fb3b5ab7e509","name":"Get Labour Scheduled By Department","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/analytics/summary/labour-scheduled?start=2022-05-18&end=2022-05-18&company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","analytics","summary","labour-scheduled"],"query":[{"key":"start","value":"2022-05-18","description":"Start Date"},{"key":"end","value":"2022-05-18","description":"End Date"},{"key":"company","value":"12345","description":"Company ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"companyId\": 12345,\n \"totalCosts\": 2167.1,\n \"totalHours\": 135.41666666667,\n \"labourScheduledByDate\": [\n {\n \"date\": \"2022-05-18\",\n \"costs\": 815.1,\n \"hours\": 130,\n \"departmentId\": 2928,\n \"departmentName\": \"FOH\"\n },\n {\n \"date\": \"2022-05-18\",\n \"costs\": 439.4,\n \"hours\": 0,\n \"departmentId\": 2929,\n \"departmentName\": \"BOH\"\n },\n {\n \"date\": \"2022-05-18\",\n \"costs\": 912.6,\n \"hours\": 5.4166666666667,\n \"departmentId\": 2930,\n \"departmentName\": \"Management\"\n }\n ]\n }\n}"}],"_postman_id":"16a95b2e-141c-4054-b37d-9ef956f86878"},{"name":"Get Labour By Employee","id":"38f416cb-736c-4da3-bb34-54dc93cb0378","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Please try to refrain from using long date ranges (More than 1 week) per request.
\n","urlObject":{"protocol":"https","path":["platform","api","v1","labour","employee"],"host":["api","pushoperations","com"],"query":[{"description":{"content":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"key":"start","value":"2022-01-01"},{"description":{"content":"[date string]
\n","type":"text/plain"},"key":"end","value":"2022-01-01"},{"description":{"content":"Location ID (Optional)
\n","type":"text/plain"},"key":"locationId","value":"123"},{"description":{"content":"Optional parameter
\n","type":"text/plain"},"key":"include","value":"location"},{"description":{"content":"Optional [true, false]
\n","type":"text/plain"},"key":"earnings-deductions","value":"true"}],"variable":[]}},"response":[{"id":"cfd0c4d0-339e-40ec-88ca-4ede7be36248","name":"Get Labour By Employee","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/labour/employee?start=2022-01-01&end=2022-01-01&company=12345&locationId=123&include=location","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","labour","employee"],"query":[{"key":"start","value":"2022-01-01"},{"key":"end","value":"2022-01-01"},{"key":"company","value":"12345"},{"key":"locationId","value":"123"},{"key":"include","value":"location"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 20 Sep 2022 20:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"pushoperationsci_session=CCzjLPiEvMQR9OQcErH0Xv2MutOcnGw6IvF3vhDHfTfLQAdGlKAJh1oKG8%2Ba39hvA9zAyUt%2BAnXfe40AjyAAVKyPvgSJyONhJfOWVjfrrgwfdzcFwQDsutlwU96fI2sGbDLetSbU2b6itSUnXVluGXkPYkdlKGsy5PglwQz5gzuFw6BdJ9MNDzSnI8fWQb%2Bd19TF9NPFOhRkr6IfKaz%2Btl7QWpwYwqF%2BHwCEwQ1JZIPg3WhAzYhy1S922ckbRqpx2iuVl%2Fi7rmVQy0BM7B0Lo7AFoMe7aa%2B8nD0jzAlTCc4NQFtzMGmqRj5WemvvLA%2Be158CuBv85EOUpuQXZtL%2Fpw%3D%3D; expires=Wed, 21-Sep-2022 20:16:49 GMT; Max-Age=86400; path=/; domain=.pushoperations.com; secure"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlI4U29QODBLaWNPQ0xoZGhCNFliS0E9PSIsInZhbHVlIjoiNHRjU2I0MXR0Q2ZKMVlzbVM0SllOdk16VFExQnlNbkhKR053VjdXN0VFSUNkR2J4d2t4SU9CNEFRczA5cTNxZHNcLzU3NjFjaVFuMTcrNGhlY3hPaG5BPT0iLCJtYWMiOiIxNTRlZmZmM2RmZTdhZmQyYjI5MDg2MmYwNTRjOWFkYmQ5NDRkMTcxZjI5MmQ3YTQwNzE0MjBkZmEwMDA2OTI5In0%3D; expires=Wed, 21-Sep-2022 20:16:50 GMT; Max-Age=86400; path=/; domain=pushoperations.com; secure; HttpOnly"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; report-uri https://app-elb.pushoperations.com/_csp"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"date\": \"2022-01-01\",\n \"costs\": 100,\n \"hours\": 2,\n \"labourType\": \"reg\",\n \"employeeId\": 123,\n \"employeeName\": \"John Doe\",\n \"positionId\": 1234,\n \"positionName\": \"Server\",\n \"costCenterId\": 100,\n \"costCenterName\": \"FOH\"\n },\n {\n \"date\": \"2022-01-01\",\n \"costs\": 100,\n \"hours\": 2,\n \"labourType\": \"ot\",\n \"employeeId\": 123,\n \"employeeName\": \"John Doe\",\n \"positionId\": 1234,\n \"positionName\": \"Server\",\n \"costCenterId\": 100,\n \"costCenterName\": \"FOH\"\n },\n {\n \"date\": \"2022-01-01\",\n \"costs\": 100,\n \"hours\": 2,\n \"labourType\": \"otw\",\n \"employeeId\": 123,\n \"employeeName\": \"John Doe\",\n \"positionId\": 1234,\n \"positionName\": \"Server\",\n \"costCenterId\": 100,\n \"costCenterName\": \"FOH\"\n }\n ]\n}"}],"_postman_id":"38f416cb-736c-4da3-bb34-54dc93cb0378"}],"id":"5306fa82-28f5-4df9-9382-18ff6019e9b2","auth":{"type":"bearer","bearer":{"token":"Get a list of sales filtered by business dates
\n","urlObject":{"protocol":"https","path":["platform","api","v1","sales",""],"host":["api","pushoperations","com"],"query":[{"description":{"content":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"key":"start","value":"2022-05-02"},{"key":"end","value":"2022-05-02"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"description":{"content":"Optional relationships
\n","type":"text/plain"},"key":"include","value":"details"}],"variable":[]}},"response":[{"id":"66900f57-a3f1-47c8-ba50-a6c34e93c965","name":"Get Sales","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/?start=2022-05-02&end=2022-05-02&company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales",""],"query":[{"key":"start","value":"2022-05-02","description":"Start date"},{"key":"end","value":"2022-05-02","description":"End date"},{"key":"company","value":"12345","description":"[int] Company ID"},{"key":"limit","value":"100","description":"Response Per Page (Max 100)","type":"text","disabled":true},{"key":"page","value":"1","description":"Page Number","type":"text","disabled":true},{"key":"include","value":"details","description":"Optional relationships","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1234567,\n \"revenueCenter\": 1234,\n \"posId\": null,\n \"amount\": 242.55,\n \"businessDate\": \"2022-05-02\",\n \"startDateTime\": \"2022-05-02 16:30:00\",\n \"endDateTime\": \"2022-05-02 16:45:00\",\n \"details\": {\n \"employeeId\": null,\n \"tips\": 120.45\n }\n },\n {\n \"id\": 1234568,\n \"revenueCenter\": 1234,\n \"posId\": null,\n \"amount\": 216.75,\n \"businessDate\": \"2022-05-02\",\n \"startDateTime\": \"2022-05-02 17:15:00\",\n \"endDateTime\": \"2022-05-02 17:30:00\",\n \"details\": {\n \"employeeId\": 12345,\n \"tips\": 57.45\n }\n },\n ...\n ],\n \"meta\": {\n \"page\": {\n \"previous\": null,\n \"current\": 1,\n \"next\": 2,\n \"count\": 100\n }\n }\n}"}],"_postman_id":"7591ce7c-5f90-49c6-bee3-eba2d02d4ff8"},{"name":"Create Sale","id":"c591e267-ab70-4cf6-8105-8a30f7ac13df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Company ID
\n","type":"text/plain"},"key":"company","value":"1236456"},{"disabled":true,"description":{"content":"[int] Revenue Center ID
\n","type":"text/plain"},"key":"revenueCenter","value":"1234"},{"disabled":true,"description":{"content":"[int|string] External POS ID (optional)
\n","type":"text/plain"},"key":"posId","value":"12345"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"start","value":"2023-09-09 01:23:45"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"end","value":"2023-09-09 01:26:54"},{"disabled":true,"description":{"content":"[date string]
\n","type":"text/plain"},"key":"businessDate","value":"2023-09-09"},{"disabled":true,"description":{"content":"[float] Sale Amount
\n","type":"text/plain"},"key":"amount","value":"123.45"},{"disabled":true,"description":{"content":"[int] Employee ID (optional)
\n","type":"text/plain"},"key":"employeeId","value":"56789"},{"disabled":true,"description":{"content":"[float] Tips Amount (optional)
\n","type":"text/plain"},"key":"tips","value":"123.45"}],"variable":[]}},"response":[{"id":"a58249c9-ef33-4536-9164-97a4486578e3","name":"Create Sale","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"company\": 123456,\n \"revenueCenter\": 1234,\n \"posId\": 12345,\n \"start\": \"2023-09-09 01:23:45\",\n \"end\": \"2023-09-09 01:26:54\",\n \"businessDate\": \"2023-09-09\",\n \"amount\": 123.45,\n \"employeeId\": 56789,\n \"tips\": 123.45\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales",""],"query":[{"key":"revenueCenter","value":"1234","description":"[int] Revenue Center ID","type":"text","disabled":true},{"key":"posId","value":"12345","description":"[int|string] External POS ID (optional)","type":"text","disabled":true},{"key":"start","value":"2023-09-09 01:23:45","description":"[datetime string] Sale start date-time in local time","type":"text","disabled":true},{"key":"end","value":"2023-09-09 01:26:54","description":"[datetime string] Sale end date-time in local time","type":"text","disabled":true},{"key":"businessDate","value":"2023-09-09","description":"[date string]","type":"text","disabled":true},{"key":"amount","value":"123.45","description":"[float] Sale Amount","type":"text","disabled":true},{"key":"company","value":"1234","description":"[int] Company ID","type":"text","disabled":true},{"key":"employeeId","value":"56789","description":"[int] Employee ID (optional)","disabled":true},{"key":"tips","value":"123.45","description":"[float] Tips Amount","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1234567\n }\n}"}],"_postman_id":"c591e267-ab70-4cf6-8105-8a30f7ac13df"},{"name":"Update Sale","id":"96c7ac3f-aeed-48de-903d-5f2a4580a041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Sale ID
\n","type":"text/plain"},"key":"saleId","value":"1234567"},{"disabled":true,"description":{"content":"[int] Company ID
\n","type":"text/plain"},"key":"company","value":"1236456"},{"disabled":true,"description":{"content":"[int] Revenue Center ID
\n","type":"text/plain"},"key":"revenueCenter","value":"1234"},{"disabled":true,"description":{"content":"[int|string] External POS ID (optional)
\n","type":"text/plain"},"key":"posId","value":"12345"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"startDatetime","value":"2023-09-09 01:23:45"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"endDatetime","value":"2023-09-09 01:26:54"},{"disabled":true,"description":{"content":"[date string]
\n","type":"text/plain"},"key":"businessDate","value":"2023-09-09"},{"disabled":true,"description":{"content":"[float] Sale Amount
\n","type":"text/plain"},"key":"amount","value":"123.45"},{"disabled":true,"description":{"content":"[int] Employee ID (optional)
\n","type":"text/plain"},"key":"employeeId","value":"56789"},{"disabled":true,"description":{"content":"[float] Tips Amount (optional)
\n","type":"text/plain"},"key":"tips","value":"123.45"}],"variable":[]}},"response":[{"id":"535df199-4a2e-4591-bdcf-46cd5ce28d81","name":"Update Sale","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"revenueCenter\": 1234,\n \"posId\": 12345,\n \"startDatetime\": \"2023-09-09 01:23:45\",\n \"endDatetime\": \"2023-09-09 01:26:54\",\n \"businessDate\": \"2023-09-09\",\n \"amount\": 123.45\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/{saleId}","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales","{saleId}"],"query":[{"key":"saleId","value":"1234567","description":"[int] Sale ID","type":"text","disabled":true},{"key":"revenueCenter","value":"1234","description":"[int] Revenue Center ID","type":"text","disabled":true},{"key":"posId","value":"12345","description":"[int|string] External POS ID (optional)","type":"text","disabled":true},{"key":"startDatetime","value":"2023-09-09 01:23:45","description":"[datetime string] Sale start date-time in local time","type":"text","disabled":true},{"key":"endDatetime","value":"2023-09-09 01:26:54","description":"[datetime string] Sale end date-time in local time","type":"text","disabled":true},{"key":"businessDate","value":"2023-09-09","description":"[date string]","type":"text","disabled":true},{"key":"amount","value":"123.45","description":"[float] Sale Amount","type":"text","disabled":true},{"key":"employeeId","value":"56789","description":"[int] Employee ID (optional)","type":"text","disabled":true},{"key":"tips","value":"123.45","description":"[float] Tips Amount","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"}],"_postman_id":"96c7ac3f-aeed-48de-903d-5f2a4580a041"},{"name":"Delete Sale","id":"9f8fa55e-827e-451e-9fa4-db9664244885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Sale ID
\n","type":"text/plain"},"key":"saleId","value":"1234567"}],"variable":[]}},"response":[{"id":"ae41b7d5-8958-4859-b874-2415f561c78a","name":"Delete Sale","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/{saleId}","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales","{saleId}"],"query":[{"key":"saleId","value":"1234567","description":"[int] Sale ID","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"}],"_postman_id":"9f8fa55e-827e-451e-9fa4-db9664244885"},{"name":"Get Sales Forecast","id":"f2086c41-768c-4269-a98f-e2cfe1e9078a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[date string]
\n","type":"text/plain"},"key":"start","value":"2022-05-02"},{"description":{"content":"[date string]
\n","type":"text/plain"},"key":"end","value":"2022-05-02"},{"description":{"content":"[int] Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"[int] Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"[int] Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"0a41445e-147c-4d73-9a8e-5beecee60738","name":"Get Sales Forecast","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/forecast?start=2022-05-02&end=2022-05-02&company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales","forecast"],"query":[{"key":"start","value":"2022-05-02","description":"Start date"},{"key":"end","value":"2022-05-02","description":"End date"},{"key":"company","value":"12345","description":"Company ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Mar 2022 01:34:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Set-Cookie","value":"pushoperationsci_session=OpTleuvlKv0rrYf7LjCn03lvJGFoRMCI7Egv6RBeqhyVlR5dsg0TUyIu4LGgePVxs%2FXttk1VaC6lk3RXBM4%2FINvxjoob5eb%2BgTKbsvSuqiT4H%2F8z6bvgcua6IlQLjMfnS9%2BnaSlUG5xIv4DRllfhefQqLeigJ3uIQ3en8HYXQYA2rvvdIqNk5SUqfw%2BWe%2B%2FjuE5su7d8CJy788nyJ4uSvzCuTm6YJc9aLd8UzkBHMgpycNVBA9DnpxwFSqRziO0udUF1Kol3PB7axvWtzmAL2hdnNhSzeH30tXB3MhKS9dI%3D; expires=Wed, 30-Mar-2022 01:34:09 GMT; Max-Age=86400; path=/; domain=.pushoperations.com; secure"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IlNNNjE1OFpPcFkxZTc3dVIrOFdGSHc9PSIsInZhbHVlIjoiYVp5dUc4SEZPXC8zamxicktQK0NcL2d3U3NSY2pWQzFaZjkxMGhrTXNBbWxTbkRFUHRGQUVET0pLYlE5UzFMaEhPdFFycUxpZGtlU2UzMzRHTnhYcFBaZz09IiwibWFjIjoiNDUwZDM0MWQyOTg2ZGM1ZDlkYjEyZDVhMjUxMDU5YTYxZWY0YWE4ZjU2OWIxNGE5NmMxMWE3MGVhODBmZDRlZSJ9; expires=Wed, 30-Mar-2022 01:34:09 GMT; Max-Age=86400; path=/; domain=pushoperations.com; secure; HttpOnly"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'; report-uri https://app-elb.pushoperations.com/_csp"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"75.53\",\n \"startDateTime\": \"2022-05-02 09:00:00\",\n \"endDateTime\": \"2022-05-02 09:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"208.18\",\n \"startDateTime\": \"2022-05-02 10:00:00\",\n \"endDateTime\": \"2022-05-02 10:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"37.27\",\n \"startDateTime\": \"2022-05-02 11:00:00\",\n \"endDateTime\": \"2022-05-02 11:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"95.20\",\n \"startDateTime\": \"2022-05-02 12:00:00\",\n \"endDateTime\": \"2022-05-02 12:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"380.04\",\n \"startDateTime\": \"2022-05-02 13:00:00\",\n \"endDateTime\": \"2022-05-02 13:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"165.22\",\n \"startDateTime\": \"2022-05-02 14:00:00\",\n \"endDateTime\": \"2022-05-02 14:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"81.85\",\n \"startDateTime\": \"2022-05-02 15:00:00\",\n \"endDateTime\": \"2022-05-02 15:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"212.33\",\n \"startDateTime\": \"2022-05-02 16:00:00\",\n \"endDateTime\": \"2022-05-02 16:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"257.98\",\n \"startDateTime\": \"2022-05-02 17:00:00\",\n \"endDateTime\": \"2022-05-02 17:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"222.16\",\n \"startDateTime\": \"2022-05-02 18:00:00\",\n \"endDateTime\": \"2022-05-02 18:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"136.12\",\n \"startDateTime\": \"2022-05-02 19:00:00\",\n \"endDateTime\": \"2022-05-02 19:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"85.15\",\n \"startDateTime\": \"2022-05-02 20:00:00\",\n \"endDateTime\": \"2022-05-02 20:59:59\"\n },\n {\n \"revenueCenterName\": \"Restaurant\",\n \"total\": \"86.17\",\n \"startDateTime\": \"2022-05-02 21:00:00\",\n \"endDateTime\": \"2022-05-02 21:59:59\"\n }\n ]\n}"}],"_postman_id":"f2086c41-768c-4269-a98f-e2cfe1e9078a"},{"name":"Create Sales Forecast","id":"b662d51e-ebb3-4175-ba4d-8b6033bf296c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Company ID
\n","type":"text/plain"},"key":"company","value":"123456"},{"disabled":true,"description":{"content":"[int] Revenue Center ID
\n","type":"text/plain"},"key":"revenueCenter","value":"1234"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"start","value":"2023-09-09 01:23:45"},{"disabled":true,"description":{"content":"[datetime string] Date and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"end","value":"2023-09-09 01:26:54"},{"disabled":true,"description":{"content":"[float] Sales Amount
\n","type":"text/plain"},"key":"amount","value":"123.45"}],"variable":[]}},"response":[{"id":"2a652f69-a734-4094-8e98-9ed22cd3b4a8","name":"Create Sale Forecast","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"company\": 123456,\n \"revenueCenter\": 1234,\n \"start\": \"2023-09-09 01:23:45\",\n \"end\": \"2023-09-09 01:26:54\",\n \"amount\": 123.45\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/forecast","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales","forecast"],"query":[{"key":"company","value":"123456","description":"[int] Company ID","type":"text","disabled":true},{"key":"revenueCenter","value":"1234","description":"[int] Revenue Center ID","type":"text","disabled":true},{"key":"start","value":"2023-09-09 01:23:45","description":"[datetime string]","type":"text","disabled":true},{"key":"end","value":"2023-09-09 01:26:54","description":"[datetime string]","type":"text","disabled":true},{"key":"amount","value":"123.45","description":"[float] Sale Amount","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1234567\n }\n}"}],"_postman_id":"b662d51e-ebb3-4175-ba4d-8b6033bf296c"},{"name":"Update Sales Forecast","id":"8352592f-f65c-4f4a-b834-ad2e7b1c08cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Sales Forecast ID
\n","type":"text/plain"},"key":"id","value":"1234567"},{"disabled":true,"description":{"content":"[int] Company ID
\n","type":"text/plain"},"key":"company","value":"1236456"},{"disabled":true,"description":{"content":"[int] Revenue Center ID
\n","type":"text/plain"},"key":"revenueCenter","value":"1234"},{"disabled":true,"description":{"content":"[datetime string]\nDate and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"start","value":"2023-09-09 01:23:45"},{"disabled":true,"description":{"content":"[datetime string] \nDate and time in local timezone (UTC is not supported).
\n","type":"text/plain"},"key":"end","value":"2023-09-09 01:26:54"},{"disabled":true,"description":{"content":"[float] Sale Amount
\n","type":"text/plain"},"key":"amount","value":"123.45"}],"variable":[]}},"response":[{"id":"f3f68f36-bbff-4b04-a59e-316cf6e206ff","name":"Update Sale Forecast","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 1234567,\n \"company\": 123456,\n \"revenueCenter\": 1234,\n \"start\": \"2023-09-09 01:23:45\",\n \"end\": \"2023-09-09 01:26:54\",\n \"amount\": 123.45\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.pushoperations.com/platform/api/v1/sales/forecast/{saleForecastId}","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","sales","forecast","{saleForecastId}"],"query":[{"key":"id","value":"1234567","description":"[int] Sale Forecast ID","type":"text","disabled":true},{"key":"company","value":"123456","description":"[int] Company ID","disabled":true},{"key":"revenueCenter","value":"1234","description":"[int] Revenue Center ID","type":"text","disabled":true},{"key":"start","value":"2023-09-09 01:23:45","description":"[datetime string]","disabled":true},{"key":"end","value":"2023-09-09 01:26:54","description":"[datetime string]","type":"text","disabled":true},{"key":"amount","value":"123.45","description":"[float] Sale Amount","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"}],"_postman_id":"8352592f-f65c-4f4a-b834-ad2e7b1c08cb"}],"id":"30f8285a-1659-478f-b560-3b3fd3580bdd","description":"Get sales forecasts and manage actual sales
\nAll date and time values are interpreted as local time (based on the client’s timezone) and not UTC.
\n","_postman_id":"30f8285a-1659-478f-b560-3b3fd3580bdd"},{"name":"Schedules","item":[{"name":"Get Schedules","id":"e1c2d946-74f8-4cbc-b4cc-ab4958a85e7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Location ID
\n","type":"text/plain"},"key":"locationId","value":"123"},{"key":"start","value":"2021-09-02"},{"key":"end","value":"2021-09-03"},{"description":{"content":"Optional relationships
\n","type":"text/plain"},"key":"include","value":"tag,preset,breaks,employee,position,position.department,colour"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"b9185655-176e-4bbe-b9de-eb050e911655","name":"Get Schedules","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/shifts?start=2021-09-02&end=2021-09-03&company=12345&locationId=123&include=tag,preset,breaks,employee,position,position.department,colour","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","shifts"],"query":[{"key":"start","value":"2021-09-02","description":"Start date"},{"key":"end","value":"2021-09-03","description":"End date"},{"key":"company","value":"12345","description":"Company ID"},{"key":"locationId","value":"123","description":"Location iD"},{"key":"include","value":"tag,preset,breaks,employee,position,position.department,colour","description":"Optional relationships"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 24732076,\n \"presetId\": 82077,\n \"employeeId\": 353772,\n \"positionId\": 83248,\n \"businessDate\": \"2021-09-02\",\n \"date\": {\n \"start\": \"2021-09-02 08:00:00\",\n \"end\": \"2021-09-02 16:00:00\"\n },\n \"time\": {\n \"start\": {\n \"hour\": 8,\n \"minute\": 0,\n \"formatted\": \"8:00AM\"\n },\n \"end\": {\n \"hour\": 16,\n \"minute\": 0,\n \"formatted\": \"4:00PM\"\n }\n },\n \"comments\": null,\n \"breakMinutes\": 0,\n \"tagId\": 12515,\n \"preset\": {\n \"id\": 82077,\n \"name\": \"Morning Shift - Prep\"\n },\n \"tag\": {\n \"id\": 12515,\n \"name\": \"Fish Station\",\n \"colourHex\": \"#ad1457\"\n },\n \"employee\": {\n \"id\": 353772,\n \"name\": \"Philip Johnson\",\n \"firstname\": \"Philip\",\n \"lastname\": \"Johnson\",\n \"uuid\": \"2335513a-2e61-4ee5-8181-2b8aafe373b1\",\n \"uuid2\": \"2335513a-2e61-4ee5-8181-2b8aafe373b1\",\n \"email\": \"philip.johnson@pushoperations.com\"\n },\n \"position\": {\n \"id\": 83248,\n \"name\": \"Sous Chef\",\n \"companyId\": 12345,\n \"department\": {\n \"id\": 7329,\n \"name\": \"FOH\",\n \"locationId\": 123\n }\n }\n }\n ]\n}"}],"_postman_id":"e1c2d946-74f8-4cbc-b4cc-ab4958a85e7d"}],"id":"37244fe8-a6e8-4968-8886-d53d7a3774f5","description":"Get employee scheduled shifts.
\n","_postman_id":"37244fe8-a6e8-4968-8886-d53d7a3774f5"},{"name":"Payroll","item":[{"name":"Get Journal Entries","id":"609138fc-f443-406f-9c8d-ed735c240e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Date string
\n","type":"text/plain"},"key":"date","value":"2023-07-02"},{"description":{"content":"[int] Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"[int] Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"9ae63061-6dcb-4ab2-8841-bcf934250554","name":"Get Journal Entries","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/journal-entries?company=12345&date=2023-07-02","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","journal-entries"],"query":[{"key":"company","value":"12345"},{"key":"date","value":"2023-07-02"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"type\": \"debit\",\n \"description\": \"Vacation Payable\",\n \"amount\": 899.73,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Salary and Wages\",\n \"amount\": 17609.48,\n \"costCenterName\": \"Back of House\",\n \"code\": \"9835\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"CPP\",\n \"amount\": 1367.86,\n \"costCenterName\": \"Back of House\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"EI\",\n \"amount\": 573.77,\n \"costCenterName\": \"Back of House\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Vacation Pay\",\n \"amount\": 1005.72,\n \"costCenterName\": \"Back of House\",\n \"code\": \"9917\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Statutory Holiday Work Pay\",\n \"amount\": 3606.11,\n \"costCenterName\": \"Back of House\",\n \"code\": \"\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Statutory Holiday Pay\",\n \"amount\": 3927.6,\n \"costCenterName\": \"Back of House\",\n \"code\": \"\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Salary and Wages\",\n \"amount\": 13838.35,\n \"costCenterName\": \"Front of House\",\n \"code\": \"810\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"CPP\",\n \"amount\": 886.51,\n \"costCenterName\": \"Front of House\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"EI\",\n \"amount\": 485.95,\n \"costCenterName\": \"Front of House\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Vacation Pay\",\n \"amount\": 815.83,\n \"costCenterName\": \"Front of House\",\n \"code\": \"9917\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Statutory Holiday Work Pay\",\n \"amount\": 2852.08,\n \"costCenterName\": \"Front of House\",\n \"code\": \"\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Statutory Holiday Pay\",\n \"amount\": 3705.11,\n \"costCenterName\": \"Front of House\",\n \"code\": \"\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Salary and Wages\",\n \"amount\": 9940.37,\n \"costCenterName\": \"Management\",\n \"code\": \"9823\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"CPP\",\n \"amount\": 407.88,\n \"costCenterName\": \"Management\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"EI\",\n \"amount\": 116.95,\n \"costCenterName\": \"Management\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"debit\",\n \"description\": \"Vacation Pay\",\n \"amount\": 534.62,\n \"costCenterName\": \"Management\",\n \"code\": \"9917\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Net Pay (Push)\",\n \"amount\": 43497.91,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Net Pay (Company Cheques)\",\n \"amount\": 765.21,\n \"costCenterName\": \"Front of House\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Federal Tax\",\n \"amount\": 6008.43,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"CPP\",\n \"amount\": 5324.5,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"EI\",\n \"amount\": 2017.13,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Other Payroll Tax Deduction\",\n \"amount\": 1113.67,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Benefits Deductions\",\n \"amount\": 290.9,\n \"costCenterName\": \"\",\n \"code\": \"9818\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Other Deductions\",\n \"amount\": 1200,\n \"costCenterName\": \"\",\n \"code\": \"\"\n },\n {\n \"type\": \"credit\",\n \"description\": \"Vacation Payable\",\n \"amount\": 2356.17,\n \"costCenterName\": \"\",\n \"code\": \"\"\n }\n ]\n}"}],"_postman_id":"609138fc-f443-406f-9c8d-ed735c240e25"},{"name":"Get Earnings / Deductions Codes","id":"928eecdb-e00b-4ca7-ba57-a0d0cc536f09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"525b46b8-4f36-4040-b7c2-423e18965eda","name":"Get Earnings / Deductions Codes","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/earnings-deductions-codes?company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","earnings-deductions-codes"],"query":[{"key":"company","value":"12345"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"description\": \"Regular Pay\",\n \"type\": \"earnings\"\n },\n {\n \"id\": 2,\n \"description\": \"Overtime Pay\",\n \"type\": \"earnings\"\n },\n {\n \"id\": 3,\n \"description\": \"Income Tax Regular\",\n \"type\": \"deductions\"\n },\n {\n \"id\": 3,\n \"description\": \"Income Tax Regular\",\n \"type\": \"deductions\"\n },\n {\n \"id\": 4,\n \"description\": \"CPP Employee Contribution\",\n \"type\": \"deductions\"\n },\n {\n \"id\": 5,\n \"description\": \"EI Employee Contribution\",\n \"type\": \"deductions\"\n },\n {\n \"id\": 6,\n \"description\": \"Advance Deductions\",\n \"type\": \"deductions\"\n },\n {\n \"id\": 7,\n \"description\": \"Dental Benefit\",\n \"type\": \"taxable_benefit\"\n },\n {\n \"id\": 8,\n \"description\": \"Health Benefit\",\n \"type\": \"taxable_benefit\"\n }\n ]\n}"}],"_postman_id":"928eecdb-e00b-4ca7-ba57-a0d0cc536f09"},{"name":"Get Earnings / Deductions","id":"58c26e8e-42de-4133-a297-4faddebd9675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"[Date] Payrun End Date
\n","type":"text/plain"},"key":"payPeriodEndDate","value":"2023-10-15"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"ecd297a7-7b18-489c-b79f-a80741a48866","name":"Get Earnings / Deductions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/earnings-deductions?company=12345&payPeriodEndDate=2023-10-15&limit=50&page=1","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","earnings-deductions"],"query":[{"key":"company","value":"12345","description":"[int] Company ID"},{"key":"payPeriodEndDate","value":"2023-10-15","description":"[Date] Payrun End Date"},{"key":"limit","value":"50","description":"[int] Result Per Page (optional)"},{"key":"page","value":"1","description":"[int] Page Number (optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"data\": [\n\t\t{\n\t\t\t\"id\": 1234567,\n\t\t\t\"employeeId\": 12345,\n\t\t\t\"employeePositionId\": 12345,\n\t\t\t\"frequency\": \"one_time\",\n\t\t\t\"type\": \"earnings\",\n\t\t\t\"date\": \"2023-11-14\",\n\t\t\t\"presetId\": 12345,\n\t\t\t\"payPeriodEndDate\": \"2023-10-15\",\n\t\t\t\"taxable\": true,\n\t\t\t\"ei\": true,\n\t\t\t\"cpp\": true,\n\t\t\t\"vacation\": true,\n\t\t\t\"statutoryHoliday\": true,\n\t\t\t\"remit\": false,\n\t\t\t\"amount\": \"500.99\",\n\t\t\t\"hours\": 24\n\t\t},\n ...\n ]\n}"}],"_postman_id":"58c26e8e-42de-4133-a297-4faddebd9675"},{"name":"Create Earnings / Deductions","id":"8c7eccb2-0577-4617-ae18-5872572b210c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Employee ID
\n","type":"text/plain"},"key":"employeeId","value":"12345"},{"disabled":true,"description":{"content":"[int] Employee Position ID (optional)
\n","type":"text/plain"},"key":"employeePositionId","value":"123456"},{"disabled":true,"description":{"content":"[double] Hours
\n","type":"text/plain"},"key":"hours","value":"24"},{"disabled":true,"description":{"content":"[float] Earnings / Deductions Amount
\n","type":"text/plain"},"key":"amount","value":"123.45"},{"disabled":true,"description":{"content":"[date string] Pay Run Schedule End Date
\n","type":"text/plain"},"key":"payPeriodEndDate","value":"\"2023-12-05\""},{"disabled":true,"description":{"content":"[int] Earning / Dededuction Preset ID
\n","type":"text/plain"},"key":"presetId","value":"12345"},{"disabled":true,"description":{"content":"[date string] Earning / Deduction Optional Date (optional)
\n","type":"text/plain"},"key":"date","value":"\"2023-12-10\""}],"variable":[]}},"response":[{"id":"0bac925e-494a-45c1-b767-8ca88debccb0","name":"Create Earnings / Deducation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"employeeId\": 12345,\n\t\"employeePositionId\": 123456,\n\t\"hours\": 12,\n\t\"amount\": 12.00,\n\t\"payPeriodEndDate\": \"2023-12-03\",\n\t\"presetId\": 12345,\n\t\"date\": \"2023-12-15\"\n}"},"url":{"raw":"https://api.pushoperations.com/platform/api/v1/earnings-deductions","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","earnings-deductions"],"query":[{"key":"employeeId","value":"12345","description":"[int] Employee ID","disabled":true},{"key":"employeePositionId","value":"123456","description":"[int] Employee Positino ID (optional)","disabled":true},{"key":"hours","value":"24","description":"[double] Hours","disabled":true},{"key":"amount","value":"123.45","description":"[float] Earnings / Deductions Amount ","disabled":true},{"key":"payPeriodEndDate","value":"\"2023-12-05\"","description":"[date string] Pay Run Schedule End Date","disabled":true},{"key":"presetId","value":"12345","description":"[int] Earning / Dededuction Preset ID","disabled":true},{"key":"date","value":"\"2023-12-10\"","description":"[date string] Earning / Deduction Optional Date (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"data\": {\n\t\t\"id\": 123456 // Earning/Deduction ID\n\t}\n}"}],"_postman_id":"8c7eccb2-0577-4617-ae18-5872572b210c"},{"name":"Update Earnings / Deductions","id":"ceb62271-76ef-4a69-b111-fa891e6ca5d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"[int] Earnings / Deductions ID
\n","type":"text/plain"},"key":"id","value":"123456"},{"disabled":true,"description":{"content":"[int] Employee Position ID (optional)
\n","type":"text/plain"},"key":"employeePositionId","value":"123456"},{"disabled":true,"description":{"content":"[double] Hours (optional)
\n","type":"text/plain"},"key":"hours","value":"12"},{"disabled":true,"description":{"content":"[float] Earnings / Deductions Amount (optional)
\n","type":"text/plain"},"key":"amount","value":"200"},{"disabled":true,"description":{"content":"[date string] Pay Run Schedule End Date (optional)
\n","type":"text/plain"},"key":"payPeriodEndDate","value":"\"2023-12-05\""}],"variable":[]}},"response":[{"id":"0af6e218-032f-4984-ac31-ff632f7d4566","name":"Update Earnings / Deductions","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"employeePositionId\": 12345,\n\t\"hours\": 55,\n\t\"amount\": 66,\n\t\"payPeriodEndDate\": \"2023-12-03\"\n}"},"url":"https://api.pushoperations.com/platform/api/v1/earnings-deductions/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": []\n}"}],"_postman_id":"ceb62271-76ef-4a69-b111-fa891e6ca5d0"},{"name":"Get Payrun Schedules","id":"75cb29b1-3895-40e5-8430-3f1d9832e5d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"},{"disabled":true,"key":null,"value":null}],"variable":[]}},"response":[{"id":"0343f4e9-494c-4e02-9e6c-5330f2069ab3","name":"Get Payrun Schedules","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"data\": [\n\t\t{\n\t\t\t\"id\": 12345,\n\t\t\t\"start\": \"2023-05-08\",\n\t\t\t\"end\": \"2023-05-21\",\n\t\t\t\"payDate\": \"2023-05-26\",\n\t\t\t\"frequency\": \"biweekly\",\n\t\t\t\"isPaid\": false\n\t\t},\n\t\t{\n\t\t\t\"id\": 123456,\n\t\t\t\"start\": \"2023-05-22\",\n\t\t\t\"end\": \"2023-06-04\",\n\t\t\t\"payDate\": \"2023-06-09\",\n\t\t\t\"frequency\": \"biweekly\",\n\t\t\t\"isPaid\": false\n\t\t},\n ]\n}"}],"_postman_id":"75cb29b1-3895-40e5-8430-3f1d9832e5d9"}],"id":"696c143a-3461-4d2b-87e5-fce0eb934a8c","_postman_id":"696c143a-3461-4d2b-87e5-fce0eb934a8c","description":""},{"name":"Revenue Centers","item":[{"name":"Create Revenue Center","id":"720b235c-73b5-4e98-8976-4300431b1cf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"disabled":true,"description":{"content":"Optional alias for the revenue center
\n","type":"text/plain"},"key":"alias","value":"RC1"},{"disabled":true,"description":{"content":"Revenue Center name
\n","type":"text/plain"},"key":"name","value":"Abc"},{"disabled":true,"description":{"content":"Filter to include/exclude total sales
\n","type":"text/plain"},"key":"totalSales","value":"true"},{"disabled":true,"description":{"content":"LocationId
\n","type":"text/plain"},"key":"location","value":"123"}],"variable":[]}},"response":[],"_postman_id":"720b235c-73b5-4e98-8976-4300431b1cf3"},{"name":"Get Revenue Centers","id":"80e13ab3-f4dc-4400-a077-107c0bb1c87b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Get a list of revenue centers for a company.
\nOptionally filter to revenue centers active during a specific period of time with start and end date parameters
totalSales in response indicates whether the sales associated to that revenue center are used in reporting of total sales.
Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"disabled":true,"description":{"content":"Location ID (optional)
\n","type":"text/plain"},"key":"location","value":"123"},{"disabled":true,"description":{"content":"[date string] (optional)
\n","type":"text/plain"},"key":"start","value":"2023-01-01"},{"disabled":true,"description":{"content":"[date string] (optional)
\n","type":"text/plain"},"key":"end","value":"2023-02-01"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"51464443-2dd1-4750-831c-65233b610a47","name":"Get Revenue Centers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/revenue-centers?company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","revenue-centers"],"query":[{"key":"company","value":"12345","description":"Company ID"},{"key":"location","value":"123","type":"text","description":"Location ID","disabled":true},{"key":"start","value":"2023-01-01","type":"text","description":"Start date to filter for active revenue centers","disabled":true},{"key":"end","value":"2023-02-01","type":"text","description":"End date to filter for active revenue centers","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 12345,\n \"name\": \"Restaurant\",\n \"locationId\": null,\n \"totalSales\": 1\n },\n {\n \"id\": 12346,\n \"name\": \"Bar\",\n \"locationId\": null,\n \"totalSales\": 1\n }\n ]\n}"},{"id":"6ee63d6d-4b2a-48b0-b9de-0f56ba5260e8","name":"Get Revenue Centers with Location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/revenue-centers?company=12346&location=123","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","revenue-centers"],"query":[{"key":"company","value":"12346","description":"Company ID"},{"key":"location","value":"123","description":"Location ID"},{"key":"start","value":"2023-01-01","type":"text","description":"Start date to filter for active revenue centers","disabled":true},{"key":"end","value":"2023-02-01","type":"text","description":"End date to filter for active revenue centers","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 54321,\n \"name\": \"Patio\",\n \"locationId\": 123,\n \"totalSales\": 1\n },\n {\n \"id\": 54322,\n \"name\": \"Lounge\",\n \"locationId\": 123,\n \"totalSales\": 1\n }\n ]\n}"}],"_postman_id":"80e13ab3-f4dc-4400-a077-107c0bb1c87b"},{"name":"Update Revenue Center","id":"76795e9c-9642-4b68-b07c-d3aa196ea087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"https://api.pushoperations.com/platform/api/v1/revenue-centers/123456","auth":{"type":"bearer","bearer":{"token":"Company ID
\n","type":"text/plain"},"key":"company","value":"12345"},{"description":{"content":"Optional. Can be one of published, closed, paused or draft. If not provided, all job postings returned.
\n","type":"text/plain"},"key":"status","value":"published"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Pagination parameter
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"54a8fff7-e8c8-4d74-a98c-c8390175a42c","name":"Get Job Postings","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.pushoperations.com/platform/api/v1/job-postings?company=12345","protocol":"https","host":["api","pushoperations","com"],"path":["platform","api","v1","job-postings"],"query":[{"key":"company","value":"12345"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 12353234,\n \"url\": \"https://url-to-job-posting.com/postingid\",\n \"region\": \"Vancouver, BC\",\n \"country\": \"CA\",\n \"title\": \"Test Job Position\",\n \"body\": \"Summary
You surprise and delight our guests with unique cocktails and unusual flavours. You build genuine and authentic connections with every guest with your extensive knowledge of our food and drink menus, all while crafting drinks, pouring wine and serving beer.
Growth Opportunities
Give direction and make an impact when you delegate
Learn about cleanliness and organization
Learn about restaurant operations and managing liquor, wine and beer costs
Execute cocktails and enhance your knowledge of liquor, wine and beers
Learn the precision and care for preparing ingredients for the bar
\",\n \"status\": \"published\",\n \"salaryInformation\": {\n \"min\": 20.50,\n \"max\": 22.75,\n \"type\": \"hourly\"\n },\n \"createdAt\": \"2024-01-01 15:00:00\",\n \"updatedAt\": \"2024-01-01 15:00:00\"\n }\n ],\n \"meta\": {\n \"page\": {\n \"previous\": null,\n \"current\": 1,\n \"next\": null,\n \"pageCount\": 1,\n \"totalCount\": 1\n }\n }\n}"}],"_postman_id":"167e2118-c266-4079-9cff-ba12fe2893a9"}],"id":"0e927342-0714-4632-8b96-b71e71ff3af9","description":"Endpoints for retrieving Job Posting data.
\n","_postman_id":"0e927342-0714-4632-8b96-b71e71ff3af9"}]}