\n\nThe Sage 300 People API will allow customers to integrate with 3rd party applications to allow them to input data into the Sage 300 People system. The data is then still validated using the applications business logic. The Sage 300 People API is a Self-Hosted API service and it is the customer’s responsibility to ensure that traffic sent to and from the API is encrypted using a valid SSL certificate provided to them by a trusted authority.
\n
\n\nThe Sage 300 People API uses the same API service as Web Self Service or can be deployed as a stand-alone service by means of the Public API. Installation of this is covered in the Installations Instructions guide and can be provided.
\n
\n\nAn API Key is needed for the authentication protocol to pass successfully when integrating with the Sage 300 People application’s API service. The API Key and Key Access is setup within the Sage 300 People System. The API key can be configured using two Authentication methods:
\n
\n\nA Sage 300 People User is required for the API Key, this account can be setup under the Sage 300 People Security section, the security groups granted to this account will apply to the interactions that the API Key can perform.
\n
\n\nNote
\nEach API can also be managed from within the Sage 300 People application on the API Administration screen. This screen will allow the user to view the API and the details submitted, as well as Validate, Process and Stop any of the API's.
\n
\n\nNote
\nAll detail references using {{ }} are variable place holders determined by the environmental setup and therefore to be replaced with the correct data required.
\nIndividual API Data Models will be listed with each API's section.
\n
Always Use
\n"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)
\n"},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)
\n"},{"key":"scope","value":"apiKey={{APIKey}}","type":"text","description":"Always Use
\n"}]},"url":"http://{{HostName}}:{{APIPort}}/token","description":"Token request utilizing the Username and Password authentication as setup within the Sage 300 People system.
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["token"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"f1af2293-d1fd-499b-964e-ff09f2182825","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Always Use"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)"},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)"},{"key":"scope","value":"apiKey={{APIKey}}","type":"text","description":"Always Use"}]},"url":"http://{{HostName}}:{{APIPort}}/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"899"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Set-Cookie","value":"PeopleEssUser=AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAIqpraB5QpUOjAqZV9j1KuQAAAAACAAAAAAAQZgAAAAEAACAAAABNPBGzwgM8JgNNYvdUk95bH9RKVql4rZeu8-plZUXK2gAAAAAOgAAAAAIAACAAAAB7OZcpXpbpXVQ9gOgu5kSjqDcs2bq-l27WUDngTx5iF8ABAADMSK8vAuUzITEP9l-0mbXK1I7hXDDUlOQczDyZN7VBliyAqvCYuJEEUy62lhxgiGWh4ddrEoXu1Q3eJvgqzV8CDkrAI1EHrrAsneEjQ9WhPDfbCwCjE_HeZqtM8DOMiU7nZf_q0PhpwRuF-RlF7rOSG4NvwbeQiIZWwpLQNlCVlAJrL1Bf2LVIObQug7b-W1FQkpracNJSlkfiWtc2ir9m9BjcxOIex4jZmfKKMSzhdg4qedlEFioaszH8wZ5UXY6jjquXxxMFNAyA4RFU3DJyxWIcUDxvw_SxECckhQl3X_QwPkTuCp6gBOC4I1rIWbsQyr5cF_5Xl8aakvvbaz9l3_AkmMMFIBrKYXfXM8V2208-U10L8nU1kteHrLnsGx6U1K3PT5MFDg7Tj9D1bSsZZQrMqrMJIcepBWhERBOgRelEl5UQXhjBQ4Ct0afrrB20CI6ZVJJADCwM-oi1ww3Ne1HCWsuMEXd3njIZhuW0tAvCojMuPlVzo0GhAZY_cjuanKLpDWCHBaRKiJlH2SKrCXosyv9S03mFtI1vBOVXsKiEG0O1mCV6zxmYU0ezmNZzyWI3xlRqICjZz80JmfL_QAAAADKwiPHga898fTgDnPZyOY7PLhIZ1xiaCzcD24B8HPAmDH5ybWsm0OEeGfaWIQlHkFaQxt_Abk7eGIWkB2c3760; path=/; expires=Sat, 24-Jul-2021 14:18:58 GMT; HttpOnly; SameSite=Lax"},{"key":"Set-Cookie","value":"XSRF-TOKEN=CnWMUHTuh7BUjAFF6vnBak9BCHYaQ3nphwZ5UZP9agmXHtqyG0JS_17epf6ziMNl6Mvb7_hNVfA2TqX-5ZarXA2; path=/; SameSite=Strict"},{"key":"X-XSRF-TOKEN","value":"CnWMUHTuh7BUjAFF6vnBak9BCHYaQ3nphwZ5UZP9agmXHtqyG0JS_17epf6ziMNl6Mvb7_hNVfA2TqX-5ZarXA2"},{"key":"Date","value":"Thu, 22 Jul 2021 12:18:58 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAIqpraB5QpUOjAqZV9j1KuQAAAAACAAAAAAAQZgAAAAEAACAAAACyl8nUMFaS-NFvxWCCPFt9Gk11F0EF3w-TNz03egCYMQAAAAAOgAAAAAIAACAAAADKfTLv0s9o_bvU6lZ0kogepG5qm7ZUJBFpsMXa-eQs0qABAADfDamsQNBLjcvZzNt71SH7tWlL805B2zre2aQ4kNFsfV1RUfFXyEW0ys6j-6W7ztGTxaa3-9JDcAPSGqJphQGwIwspSZrXfVd8Tv26Bi-9OpyoASM3weaF7Ed6KoRFXNxs0GOa09jA2Z4XHKgSCLfrdwcRGX2tuzrC3hVgM_3iQJ-nvGpeVEEtkJNxj9p9rJHF0csUQYfVKhRRr78zutrkNDqhshenx4YYOpYu1kC1tXuRjrlCQ_KIH1kuNSZTXjW9JapjZtW59s9r1-9xddEnt01wRnOg3kYjlgTJDeLhuGdezIjcn0W66URVQRoc74zfolRfNQV-Rd-99WBoDphqT97t7IC8aj0VHBDrftQp96SIV6pUSOZHWOZQNQMU2aG4NcXNz0u9Fr_Y7yckXLFq5pI4JoKM2cf3gtyzTo1e5evB3IpM3_2bu20Hea1JGmpboMYzw18iLcTn29CIT8YNPaIU3K0nR88tIHLtkbaO6NKOltZbDhufNO7hKfoaWrxg0Z8X5N7kTZFzlRWfFGL0L6rL9BLrEHtoeiqni4E-MEAAAAC28aSZmhlmRIN5jE5clysZUa9AJTfEQhrDE4CrekSpm4aPe62WfeKgrPmDqedbZFC1APXIs8G6JHYjzBHX73Rx\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199\n}"},{"id":"4eb7912e-4dcd-4995-88fc-0783a9b0dee7","name":"Fail - Username or Password Incorrect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Always Use"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)"},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)"},{"key":"scope","value":"apiKey={{APIKey}}","type":"text","description":"Always Use"}]},"url":"http://{{HostName}}:{{APIPort}}/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"165"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 20 Jul 2021 11:11:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_grant\",\n \"error_description\": \"Username or password incorrect. Your account will be locked if you exceed the maximum allowable unsuccessful attempts\"\n}"},{"id":"ae49b521-8a27-4efb-95ac-494fe4b7d5be","name":"Fail - APIKey Invalid","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Always Use"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)"},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)"},{"key":"scope","value":"apiKey=invalid","type":"text","description":"Always Use"}]},"url":"http://{{HostName}}:{{APIPort}}/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"27"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 20 Jul 2021 11:18:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid API Key\"\n}"}],"_postman_id":"2071def6-6800-46e5-ac97-3b03152c9d79"},{"name":"Token Request - APIKey Only","event":[{"listen":"test","script":{"id":"560903c4-1542-4e41-b535-fdb099996ad4","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","pm.test(\"Grant bearer token == true\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.token_type).to.eql(\"bearer\");","});","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"64f54e2b-fe85-431f-a928-3c77ab3c07ca","exec":[""],"type":"text/javascript","packages":{}}}],"id":"846bfbe2-0ed8-4d13-825b-062943c9c30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Examples included for Successful and Failed requests
\n
Always Use
\n"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)
\n","disabled":true},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in Sage 300 People)
\n","disabled":true},{"key":"scope","value":"apiKey={{APIKey}}","type":"text","description":"Always Use
\n"}]},"url":"http://{{HostName}}:{{APIPort}}/token","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["token"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"d06d742b-3bae-4be0-87f4-5bc4202a3d23","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Always Use"},{"key":"username","value":"{{username}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)","disabled":true},{"key":"password","value":"{{password}}","type":"text","description":"Use if \"Authenticate Using Token Only\" = False (API Key Access in 300 People)","disabled":true},{"key":"scope","value":"apiKey={{APIKey}}","type":"text","description":"Always Use"}]},"url":"http://{{HostName}}:{{APIPort}}/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"899"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Set-Cookie","value":"PeopleEssUser=AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAIqpraB5QpUOjAqZV9j1KuQAAAAACAAAAAAAQZgAAAAEAACAAAACnr68AYvXi7wsrh14qHp9s2IuoJpKoNqIr3SyU0N09sQAAAAAOgAAAAAIAACAAAABbfnPAwlDC8dbH_prysd8CgWO5ONlMyJKn32ZS6qyPV8ABAACAQWX59VOc6xqhedAlBKvIbv2uuGeQt6xuERkeTQif18gsRtyMqh5I3TDETF_nQr_hCRiyOo-bCeZonuEB4wWamPP3IQHHVMDP5onkf-GUiDqAOScQpyWzefX2nrwd5M-XQlp_qQsPdvJpF3DYGpjFbaBVPjNbJEjCsyN4tR70hMEopiUwiBZKN4Nsn0lpxxcZ47MioNIxYjO2eLQq_SIHwskumRyXAxp85cr-_4jOLipEhBFncTW7wV6nIkydeRdrRuzOIO9qO9OgjBPC4jaHMuFJJ5FglwAojSortIAVxO0bXwneYqRTa365s2j99DcgCBPzy7Rq9SUTaka0LnheZTNWWgSK_kBOYN6ZQQkBRTV2HwOEURZeuuvQ8pRUGayLvVy-8CTh7Sd_fChMGoU0qKwyHA1-1jlnnezPZulGixhh4TEqvf8Ng65QIinsUp1WOc8yRYSRGVCMFu31na40rEmnEGqrZ0l6CB0pVsloJ31IU4QyYsZXK33n5-RG-DzmZkpuTGpl-IzeqepLzy6dsKvXMYh6HMyzHc2pjFCVj2Y49aepkPWqniJo0LzjtRg1iTULI8NEbttlX9J5zRdQQAAAAAHBHLcTFe9EqpsxS4SS5WUgowvLQ8RycOhrFqcKpcXn3Gy-5EAMa_YKwRTG4dAMqpyNfKuhhqOeScyekblgwQs; path=/; expires=Thu, 22-Jul-2021 13:20:41 GMT; HttpOnly; SameSite=Lax"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eOJekf7EVVO3A20H3jz_RhE9VGQTc20vTjyoqH_FfojZo6rWV1_HNMnOJN_ZFtXF1zZEXOlNU1qF40iBHbIrqA2; path=/; SameSite=Strict"},{"key":"X-XSRF-TOKEN","value":"eOJekf7EVVO3A20H3jz_RhE9VGQTc20vTjyoqH_FfojZo6rWV1_HNMnOJN_ZFtXF1zZEXOlNU1qF40iBHbIrqA2"},{"key":"Date","value":"Tue, 20 Jul 2021 11:20:41 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAIqpraB5QpUOjAqZV9j1KuQAAAAACAAAAAAAQZgAAAAEAACAAAACGhHZav5uZJLoCmaJLKsbrtSQG62kqZSuepKHuKqvEQgAAAAAOgAAAAAIAACAAAACY7CBOLhG9OlgXvFvoKt7EZTxYc5XftJa5-_6PvsDVxaABAABiS6Ce8nP5iAfIX0Z02vam7k1jwfqN7lJAga3WfAxMbSM1dkywbncdFr64yz3eFNyd2KU_KW9KlsBigeWJ9fk4LXmnUWRtZ8sNhGHFGfI-F42IZofdj-wzrH6btYENETheIHrj8MjJ7BR0s0UyBa3lROKuUqeMdCtSmZ-Rzrhp7KAUMTI8glcHE5hYQ-DLRaExR8xklsEXA4rvgH4INMCZCuNV6fZ0qXAsj-Xw8k_bUXfuKswWASOFx25Z_Ogwwq1pZ6GniCjKFd8uarWGPpuwEp7447LrpzM7MGETtythOStRX_TQZWE_9g6hnUC-EuYxO5Yksj9VFCBN3iAq48GtWxvS1Xr99nWdAeMD1LW7820OyyaGSOio3oxy5mCi8rhLQw6eOLPt3SL3QTi07G5rrVqwiaRvNgJMWj-Xd0Qw97j_4ILjdoEzhmo44U-WeUcO_KCWijV7Rl5BmItnxx5hUEO33IahoNcmmEGogV7dUnLeS5TfE6SpONQtpbjBiXUZdhy7xCY9fxAVAQ3V4BctFcMmbRadS7aLy-sy_a3t-kAAAADmhCUVqYlzfnLR5dgqX1GZYggiqrnUhnkvQO9pCnSnLS1uP2JWD21jbp0Li28yNA6skD31oigNvv3uOWMDmI7c\",\n \"token_type\": \"bearer\",\n \"expires_in\": 7199\n}"}],"_postman_id":"846bfbe2-0ed8-4d13-825b-062943c9c30c"}],"id":"1782b431-926a-4349-b829-fff072dfb19d","description":"An API Key is needed for the authentication protocol to pass successfully when integrating with the Sage 300 People application’s API service. The API Key and Key Access is setup within the Sage 300 People System. The API key can be configured using two Authentication methods:
\n\n\n","_postman_id":"1782b431-926a-4349-b829-fff072dfb19d"},{"name":"Consuming the API","item":[{"name":"Generate Header and Line Data","item":[{"name":"Add Header","event":[{"listen":"test","script":{"id":"df0b8204-836e-4f47-afa9-9c0600d9fd00","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"8240f426-d0f4-4a54-a393-99ca2387e75e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/REPORTSTOEMP","description":"Note
\nA Sage 300 People User is required for the API Key, this account can be setup under the Sage 300 People Security section, the security groups granted to this account will apply to the interactions that the API Key can perform.
\n
Example header used for the API \"Reports To Employee\".
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","REPORTSTOEMP"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"53724040-e983-4386-b98a-6634190385d9","name":"Successful","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/REPORTSTOEMP"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 12:01:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"apiObjectID\": \"1478a359-83d2-488c-9857-2b456f6d6eae\"\n }\n}"},{"id":"71543b10-7d76-4a36-a69f-8f225618020b","name":"Fail - Invalid Header Type","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/INVALID"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"56"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 12:03:44 GMT"}],"cookie":[],"responseTime":null,"body":"Access for this request has been denied by the API Key. "},{"id":"8e1b4297-72ce-439b-b6f4-b9b75132e0dd","name":"Fail - URL Incorrect","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/INVALID/Header/REPORTSTOEMP"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 12:06:30 GMT"}],"cookie":[],"responseTime":null,"body":null},{"id":"0d4db9b1-a081-4b55-9c99-dae2e2fd7f67","name":"Fail - API Key Access Denied","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/REPORTSTOEMP"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"56"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 12:23:22 GMT"}],"cookie":[],"responseTime":null,"body":"Access for this request has been denied by the API Key. "}],"_postman_id":"8240f426-d0f4-4a54-a393-99ca2387e75e"},{"name":"Add Input Line data","event":[{"listen":"test","script":{"id":"29ab7d0b-16d5-49f5-aada-f189ee399880","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript"}}],"id":"f9771bb6-4a2c-4848-9f58-e374a73ec266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t//API: Reports To - Employee\n\t\"FromCompanyCode\": \"Co001\",\n\t\"EmployeeCode\": \"TRN_API_001\",\n\t\"ToCompanyCode\": \"Co001\",\n\t\"ReportsToCode\": \"MNG01\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","description":"Note
\nPostman Tests used to store the apiObjectID response as the {{ APIHeaderID }} which is used in the Line data call URL as to post the correct data into the required Header.
\nThis is then again used in the Validate and Process calls.
\n
Each line item can only be sent for 1 employee. The line could contain multiple records for the employee on the specific section. This will be defined in each Line Item section.
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"a822f8ee-2ec1-4e34-bb6d-01113c8c6f47","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t//API: Reports To - Employee\n\t\"FromCompanyCode\": \"Co001\",\n\t\"EmployeeCode\": \"TRN_API_001\",\n\t\"ToCompanyCode\": \"Co001\",\n\t\"ReportsToCode\": \"MNG01\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 12:32:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"apiObjectID\": \"a0189f09-4de2-44cd-b4aa-e4a0b643cf0f\"\n }\n}"},{"id":"26455c70-4db4-4240-a607-9dfbcd12f54b","name":"Fail - Incorrect Header Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t//API: Reports To - Employee\n\t\"FromCompanyCode\": \"Co001\",\n\t\"EmployeeCode\": \"TRN_API_001\",\n\t\"ToCompanyCode\": \"Co001\",\n\t\"ReportsToCode\": \"MNG01\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/a0189f09-4de2-44cd-b4aa-e4a0b643cf0f"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"90"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:20:55 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No Header found matching the supplied Identifier\"\n}"},{"id":"045f1931-7d8e-4c71-a16e-eebe3fd575c8","name":"Fail - URL Incorrect","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t//API: Reports To - Employee\n\t\"FromCompanyCode\": \"Co001\",\n\t//\"EmployeeCode\": \"TRN_API_001\",\n\t\"ToCompanyCode\": \"Co001\",\n\t\"ReportsToCode\": \"MNG01\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/INVALIDline/{{APIHeaderID}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"270"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:22:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No HTTP resource was found that matches the request URI 'http://localhost:9000/api/apibase/INVALIDline/d01cebd4-0414-4335-8e3f-464743f7536f'.\",\n \"messageDetail\": \"No action was found on the controller 'APIBase' that matches the name 'INVALIDline'.\"\n}"},{"id":"94786477-b9a7-4885-96a9-264c587fdc1e","name":"Fail - Request Type not allowed","originalRequest":{"method":"PURGE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t//API: Reports To - Employee\n\t\"FromCompanyCode\": \"Co001\",\n\t\"EmployeeCode\": \"TRN_API_001\",\n\t\"ToCompanyCode\": \"Co001\",\n\t\"ReportsToCode\": \"MNG01\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Allow","value":"POST,PUT,DELETE"},{"key":"Content-Length","value":"81"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:24:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requested resource does not support http method 'PURGE'.\"\n}"}],"_postman_id":"f9771bb6-4a2c-4848-9f58-e374a73ec266"}],"id":"a783fe11-d632-4fef-b43a-291d16e8a3c8","description":"Note
\nPostman Tests used to store the apiObjectID response as the {{APILineID}} which can then be Validated individually with the Validate Line call or collectively with the Validate Header Call.
\nEach Line item is validated in the Validate Header process whether they were individually validated or not.
\n
Each Header has a unique end point which contains the specific validations for the section. Once the Header record is generated, the response apiObjectID must be used for the applicable Line data sent.
\nOnly 1 employee per Line Data is allowed. Each section has different requirements and could allow for multiple items in the section, but it will always be limited to 1 employee record per line.
\nOnce all Line data has been added to the applicable Header record, the Header must be Validated before it can be Processed. Line Data can't be added to a Header Record that is Validated or Processed.
\n\n\n","_postman_id":"a783fe11-d632-4fef-b43a-291d16e8a3c8"},{"name":"Edit / Update Line Data","item":[{"name":"Update Line Data","event":[{"listen":"test","script":{"id":"734f5c5e-d501-4eb1-a3f6-ee29ec950686","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript"}}],"id":"69bbeddf-3ed8-460e-aa74-599a642e8d13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t//API: Reports To - Employee\r\n\t\"FromCompanyCode\": \"Co001\",\r\n\t\"EmployeeCode\": \"TRN_API_001\",\r\n\t\"ToCompanyCode\": \"Co001\",\r\n\t\"ReportsToCode\": \"MNG03\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/{{APILineID}}","description":"Note
\nThe API Key Access setup within the Sage 300 People system determines whether the Key used is authorised to Create, Validate and Process the specified API.
\n
To update a line, provide the APIObjectID generated when the line was created.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Line","{{APILineID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"40064226-6950-40d0-9277-0849a730129e","name":"Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t//API: Reports To - Employee\r\n\t\"FromCompanyCode\": \"Co001\",\r\n\t\"EmployeeCode\": \"TRN_API_001\",\r\n\t\"ToCompanyCode\": \"Co001\",\r\n\t\"ReportsToCode\": \"MNG03\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/{{APILineID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"23"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:42:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"135597c5-4fd6-4c70-af4d-2d41ecb1d895","name":"Fail - Incorrect apiObjectID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t//API: Reports To - Employee\r\n\t\"FromCompanyCode\": \"Co001\",\r\n\t\"EmployeeCode\": \"TRN_API_001\",\r\n\t\"ToCompanyCode\": \"Co001\",\r\n\t\"ReportsToCode\": \"MNG03\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/1478a359-83d2-488c-9857-2b456f6d6eae"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"93"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:43:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No Line Item found matching the supplied Identifier\"\n}"},{"id":"1cea4111-604e-46dd-a046-0956cd47e009","name":"Fail - Invalid apiObjectID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t//API: Reports To - Employee\r\n\t\"FromCompanyCode\": \"Co001\",\r\n\t\"EmployeeCode\": \"TRN_API_001\",\r\n\t\"ToCompanyCode\": \"Co001\",\r\n\t\"ReportsToCode\": \"MNG03\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/InvalidApiObjectID"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"449"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 22 Jul 2021 13:45:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The request is invalid.\",\n \"messageDetail\": \"The parameters dictionary contains a null entry for parameter 'Identifier' of non-nullable type 'System.Guid' for method 'System.Threading.Tasks.Task`1[System.Web.Http.IHttpActionResult] updateLine(System.Guid, System.Object)' in 'Sage.People.SageAPI.Base.APIBaseController'. An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter.\"\n}"}],"_postman_id":"69bbeddf-3ed8-460e-aa74-599a642e8d13"}],"id":"cb2de271-14d0-4a05-889c-cb0784de7f23","description":"Once a Line item has been successfully sent to the system, a unique apiObjectID is generated for the line.
\nUtilizing that apiObjectID you can Edit the values initially sent by using the PUT Request type while specifying the apiObjectID to be manipulated.
\n","_postman_id":"cb2de271-14d0-4a05-889c-cb0784de7f23"},{"name":"Delete Header or Line Data","item":[{"name":"DeleteLine","id":"2dcc6f5d-6344-4af5-8154-7a666f7bfd2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/{{APILineID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Line","{{APILineID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"37621ee9-70c6-4522-a936-ea1cd5176011","name":"Successful","originalRequest":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/{{APILineID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"23"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:37:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"982f46a6-5bdb-42f9-928d-9610d324c80f","name":"Fail - Invalid Line ID","originalRequest":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Line/F095506E-FC48-4927-99D1-291B406F8BF7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"93"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:38:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No Line Item found matching the supplied Identifier\"\n}"}],"_postman_id":"2dcc6f5d-6344-4af5-8154-7a666f7bfd2f"},{"name":"DeleteHeader","id":"5a9eff8f-3f2d-4495-a7c9-ee29ba9484eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"48594a0c-8330-445f-bebb-b92c7885d26e","name":"Successful","originalRequest":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"23"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:39:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"187dea4c-261e-4a22-afa0-5f232082f871","name":"Fail - Invalid Header ID","originalRequest":{"method":"DELETE","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/E18977E9-CE9A-4D28-83CC-59B872F4238B"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"118"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:40:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No Header found matching the supplied Identifier that was created by user: 1\"\n}"}],"_postman_id":"5a9eff8f-3f2d-4495-a7c9-ee29ba9484eb"}],"id":"fc6817ea-6485-4564-8f7c-542d8a1d91e9","description":"Once a Header or Line item has been successfully sent to the system, a unique apiObjectID is generated for the item.
\nUtilizing that apiObjectID you can Delete Header or Line item by using the DELETE Request type while specifying the apiObjectID to be deleted.
\n\n\n","_postman_id":"fc6817ea-6485-4564-8f7c-542d8a1d91e9"},{"name":"Validate and Process","item":[{"name":"Validate - Line (optional)","event":[{"listen":"test","script":{"id":"d253c41d-bf51-43c1-af82-4115a7c3be4b","exec":["pm.test(\"Test For Succesful Validation\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"48a921b0-546e-4a54-9bac-436c5adc24d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/{{APILineID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","validateline","{{APILineID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"003233c1-8299-4eca-9588-1f97c1e9ea2b","name":"Successful","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/{{APILineID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"121"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:52:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"00000000-0000-0000-0000-000000000000\"\n }\n}"},{"id":"87218fd4-08fd-4b85-a843-2ee80b1cecdf","name":"Fail - API Key Access Denied","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/{{APILineID}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"56"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:49:03 GMT"}],"cookie":[],"responseTime":null,"body":"Access for this request has been denied by the API Key. "},{"id":"f3952d99-4236-4d6f-8f62-c92e43656e9a","name":"Fail - Data failed business rules","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/{{APILineID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"153"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:51:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": {\n \"apiObjectID\": \"426d7d06-214f-4541-8b7e-b94156f6309f\"\n },\n \"message\": \"TRN_API_001 Invalid Employee Code\"\n}"},{"id":"7ced8b20-c569-45e5-8cc3-70052998a8b7","name":"Fail - Invalid Line ID","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/3D9E8508-8F12-4E41-999F-5B7682BD8822"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"56"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:56:49 GMT"}],"cookie":[],"responseTime":null,"body":"Access for this request has been denied by the API Key. "},{"id":"22110e7e-6641-4edf-abd6-63b920b1b67c","name":"Fail - No apiObjectId sent","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateline/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"236"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:13:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No HTTP resource was found that matches the request URI 'http://localhost:9000/api/apibase/validateline/'.\",\n \"messageDetail\": \"No action was found on the controller 'APIBase' that matches the name 'validateline'.\"\n}"}],"_postman_id":"48a921b0-546e-4a54-9bac-436c5adc24d9"},{"name":"Validate - Header","event":[{"listen":"test","script":{"id":"2d6fa0ec-40a5-492a-ad43-3d8e42aa6e5b","exec":["pm.test(\"Test For Succesful Validation\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData[0].success).to.eql(true);","});","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript"}}],"id":"cbd60a95-1e97-4d99-99af-b112617bcc1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","validateHeader","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"8524f838-f1d3-4027-8310-0f3c007e63b6","name":"Successful","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"141"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:16:51 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 1,\n \"apiObjectID\": \"f5bdd4f7-f12d-4e79-843a-8caaf86e3a54\"\n }\n }\n]"},{"id":"7b5607af-0beb-4f67-a1ed-06efa45ee3a3","name":"Successful - Line data pass and fail business rules","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"365"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:53:19 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"575cce07-5d11-44cc-aa07-860a199d299e\"\n }\n },\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"575cce07-5d11-44cc-aa07-860a199d299e\"\n }\n },\n {\n \"success\": false,\n \"message\": \"TRN_API_001 Invalid Employee Code\"\n }\n]"},{"id":"ace82339-94f3-4bd4-82af-2ce4c2ef8e76","name":"Fail - No line data","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"87"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:55:05 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"No Line Items Found to Validate\"\n }\n]"},{"id":"4db02f79-c32c-4777-abb9-9bde3e38110c","name":"Fail - Invalid Header ID","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/3D9E8508-8F12-4E41-999F-5B7682BD8822"},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"56"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 08:56:15 GMT"}],"cookie":[],"responseTime":null,"body":"Access for this request has been denied by the API Key. "},{"id":"990a753e-d358-47f7-94a3-bdb0f97f2db0","name":"Fail - No apiObjectID sent","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"240"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:12:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No HTTP resource was found that matches the request URI 'http://localhost:9000/api/apibase/validateHeader/'.\",\n \"messageDetail\": \"No action was found on the controller 'APIBase' that matches the name 'validateHeader'.\"\n}"},{"id":"f872d4f9-dd8c-4b54-bb89-5048a5c69827","name":"Fail - Data failed business rules","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"91"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:15:32 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"MNG01 Invalid Reports Employee Code\"\n }\n]"},{"id":"37b89ef7-ec62-4f15-a5fb-3f40798fcb0a","name":"Fail - Company Rule status = Stop All","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"115"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 29 Jul 2021 11:13:04 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"The period status is set to Stop All Entry for this period.\"\n }\n]"}],"_postman_id":"cbd60a95-1e97-4d99-99af-b112617bcc1e"},{"name":"Process - Header","event":[{"listen":"test","script":{"id":"5409adad-8385-4cb2-8744-5a58a96d1480","exec":["pm.test(\"Test For Succesful Process\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData[0].success).to.eql(true);\r","});\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"50ea52f3-a265-42dd-9448-13834ff95fb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","process","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"16039ee7-d498-42e0-8646-2a02581134b9","name":"Successful","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"141"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:17:28 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 1,\n \"apiObjectID\": \"f5bdd4f7-f12d-4e79-843a-8caaf86e3a54\"\n }\n }\n]"},{"id":"a029ffeb-11dc-413b-b79e-b11e1937de9d","name":"Fail - Header not Validated","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"201"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:14:03 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"data\": {\n \"apiObjectID\": \"ffd4b1e8-e7d7-4aec-a655-51fd0e1e5289\"\n },\n \"message\": \"This header needs to be Validated before it can be Processed.\"\n }\n]"},{"id":"2dea4371-78d7-4d13-ab4b-06255d440ed8","name":"Fail - Header already Processed","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"179"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:17:57 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"data\": {\n \"apiObjectID\": \"40178dc2-693a-4e08-827e-72b107a92d7f\"\n },\n \"message\": \"This header has already been Processed.\"\n }\n]"},{"id":"52285a13-d571-41da-bc53-f65e87c84651","name":"Successful and Fail - Line item passed validation but failed processing","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"845"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Fri, 23 Jul 2021 09:19:44 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"3a241d88-4628-4102-92ce-942544596f80\"\n }\n },\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"3a241d88-4628-4102-92ce-942544596f80\"\n }\n },\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 8,\n \"apiObjectID\": \"b97a15bd-92e4-4a7e-842d-9c7af08bc7ce\"\n }\n },\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 7,\n \"apiObjectID\": \"3a241d88-4628-4102-92ce-942544596f80\"\n }\n },\n {\n \"success\": true,\n \"data\": {\n \"objectID\": 8,\n \"apiObjectID\": \"b97a15bd-92e4-4a7e-842d-9c7af08bc7ce\"\n }\n },\n {\n \"success\": false,\n \"message\": \"An Error Occured while Processing the Training Transaction: Object is not valid and cannot be saved\"\n }\n]"}],"_postman_id":"50ea52f3-a265-42dd-9448-13834ff95fb2"}],"id":"c1a002bc-7e72-4532-a376-16e08e459f45","description":"Note
\nThis cannot be undone. A deleted item will permanently be removed from the Database.
\n
For each API the Line items as well as the Header records needs to be Validated against the Sage 300 People business rules before it can be Processed into the system.
\nAPI Key access is applied to the Key used as to authorise whether it is allowed to Validate and/or process the given call.
\nEach API can also be viewed within the Sage 300 People system. The API Administration screen also allows for the signed in user to Validate, Process or even Stop the API of required.
\n\n\n","_postman_id":"c1a002bc-7e72-4532-a376-16e08e459f45"}],"id":"f5112ff8-9eaf-484a-b1d9-1bc8fbb7425a","description":"Note
\nThe Validate Header process also validates every line contained within the Header record. Therefore the Validate Line process is an optional process.
\n
A Header is required for all Lines that are required to be processed.
\nThe Header determines the type of Line data allowed to be added by the API request/s. Available Header Types are listed in the [API].[APIHeaderType] Table in the Sage 300 People Database.
\n\n\nNote
\nA Header defines the type of data that will be processed by the API. If an invalid Line type is added to a Header the validation and processing of the data will subsequently fail.
\n\n\nURL Requirements could differ for each Header and subsequent Line items. Each API item will define the URL requirements individually.
\n
Example Parameters that are available:
\nhttp://LocalHost:9000/api/apibase/Header/{{HeaderType}}
\nOnce the Token request has been generated, the received response will include a response body that shows an \"access_token\" value as well as a \"token_type\" as confirmation of successful handshake.
Used as PeopleEssUser=Token Value.
The response also includes the Generated Cookies which needs to be set on all following calls as the Cookies.
\n* 200 – OK (Result.Success will indicate Success of the Request)
* 400 – Bad Request
* 401 – Unauthorised
* 500 – Internal Server Error
* 550 – Unknown Error
* 551 – Generic Exception
public class ResultModel : IResultModel\n{\npublic bool Success { get; set; } // Flag to indicate the Success of the Request.\npublic object Data { get; set; } // Data Associated with the Success of the Request. \nCould be ResultDataModel:\npublic string Message { get; set; } // A Message regarding the Success of the Request.\npublic List BusinessRules { get; set; } // A list of Bussiness Rules.\nEG. Validation Rules, Errors, Warnings or Information.\n}\npublic interface IPropertyRulesCollectionModel\n{\nstring PropertyName { get; set; } // The Actual Property Name.\nstring PropertyFriendlyName { get; set; } // The Friendly Name of the Property.\nList ErrorRulesCollection { get; set; } // All Errors Related to the Property.\nList SuccessRulesCollection { get; set; } // All Informational Messages Related to the Property.\nList WarningRulesCollection { get; set; } // All Warnings Related to the Property.\n}\npublic interface IBusinessRuleModel\n{\nstring Message { get; set; } // The actual Message of the Property.\n}\npublic class ResultDataModel\n{\npublic int? ObjectID { get; set; } // The DB Issued ID related to the Object that was Created.\nEG. LeaveTransactionID for Leave Transactions\npublic Guid? APIObjectID { get; set; } \nThe APIObjectID: \nFor Headers it will be the APIHeaderID, \nFor Lines it will be the APILineID\npublic List LinkedLines { get; set; } // The list of all other APILines linked to the specific APILine\n\nCookie Value
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/LEAVE","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","LEAVE"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ea53fd8-a7fd-4f8d-810d-8c122518d90d"},{"name":"Leave - Add Line","event":[{"listen":"prerequest","script":{"id":"212dd285-537e-40dc-ad0c-fe424c808065","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"3f672b50-b293-4c0a-8200-19f0e5f2afb9","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript"}}],"id":"13d5771b-33c5-44ae-bb0f-ae8c9ec610a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"00005\",\r\n\t//\"EmployeeID\": 5,\r\n\t//\"LeaveTypeID\": \"1\",\r\n\t\"LeaveTypeCode\": \"ANN\",\r\n\t\"PayoutRate\": \"O\",\r\n\t\"FromDate\": \"2021-01-01\",\r\n\t\"ToDate\": \"2021-01-02\",\r\n\t\"UnitsTaken\": \"2\",\r\n\t\"UnitsCapture\": \"2\",\r\n\t//\"LeaveReasonID\": \"1\",\r\n\t\"LeaveReasonCode\": \"ANNUAL_LEAVE\",\r\n\t\"NoteReceived\": \"False\",\r\n\t//\"DoctorName\": \"Dr A JACKSON\",\r\n\t//\"PracticeNumber\": \"0123456789\",\r\n\t\"Comment\": \"Annual leave from API\",\r\n\t\"ReferenceNumber\": \"API 12345-Test\",\r\n\t\"TakeonTransaction\": \"False\"\r\n\t//\"AMPMOptionType\": 1\r\n\t\t/* \r\n\t\t1; AM To PM\r\n\t\t2; PM to AM\r\n\t\t3; AM to AM\r\n\t\t4; PM to PM\r\n\t\t5; All days are AM\r\n\t\t6; All days are PM \r\n\t\t*/\r\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"13d5771b-33c5-44ae-bb0f-ae8c9ec610a6"}],"id":"9e05facc-3b63-43e5-b555-7e683963a69f","description":"This API was designed to allow the capture of Leave transactions and the required details. Depending on the setup of the Leave Type the requirements for the payload may differ.
Refer to the system setup for requirements on each Leave Type.
\n\nWhen a leave type has note requirements with a severity = stop, the system's business rules requires a check on \"File Extension\". This is to confirm an attachment has been loaded on the leave request.
\n
\n\nCurrently the API can't cater for this check (including an attachment) and will fail validation. Ensure that the Severity is set to \"Warn\" if the API is to be used for leave request that meet the Note Requirements.
\n
Data Model:
\npublic class LeaveTransactionModel\n{\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 People. \n(Alternatively Use EmployeeCode + CompanyRuleCode and CompanyCode)\npublic string EmployeeCode { get; set; } // Employee Code.\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300 People.\npublic string CompanyCode { get; set; } // Company Code in Sage 300 People.\npublic int LeaveTypeID { get; set; } // Leave Type ID \n(Alternatively use LeaveTypeCode)\npublic string LeaveTypeCode { get; set; } // Leave Type Code.\npublic string PayoutRate { get; set; } // Payout Rate. \n(N - Normal rate, T - Termination rate, O - None(Defualt))\npublic DateTime FromDate { get; set; } // Date the Leave Starts.\npublic DateTime ToDate { get; set; } // Date the Leave Ends on.\npublic decimal UnitsTaken { get; set; } // Units taken \n(In entitlement units defined on Leave Definition)\npublic decimal UnitsCapture { get; set; } // Units captured \n(In capture units defined on Leave Definition)\npublic int? LeaveReasonID { get; set; } // Leave Reason ID. \n(Alternatively use LeaveReasonCode)\npublic string LeaveReasonCode { get; set; } // Leave Reason Code.\npublic string DoctorName { get; set; } // Doctor name for types where Sick Leave and Note Required is set.\npublic string PracticeNumber { get; set; } // Practice number for types where Sick Leave and Note Required is set.\npublic string Comment { get; set; } // Comments for the Leave Transaction.\npublic string ReferenceNumber { get; set; } // Reference Number \n(null - Auto Generated, but can be specified Manually)\npublic bool NoteReceived { get; set; } // Flag indicating if a note was received.\npublic bool TakeonTransaction { get; set; } // Flag indicating if it is a Take-On Transaction.\n(True - Transaction will not effect leave balances. False - Balances decreased by transaction value)\npublic int AMPMOptionType { get; set; } // An indicator for AM/PM Leave to indicate what the Start and End day Types are:\npublic const int AMPMOPTION_AMTOPM = 1; AM To PM\npublic const int AMPMOPTION_PMTOAM = 2; PM to AM\npublic const int AMPMOPTION_AMTOAM = 3; AM to AM\npublic const int AMPMOPTION_PMTOPM = 4; PM to PM\npublic const int AMPMOPTION_AM_ALL = 5; All days are AM\npublic const int AMPMOPTION_PM_ALL = 6; All days are PM\n\npublic class CancelLeaveTransactionModel\n{\npublic int LeaveTransactionID { get; set; } // Leave Transaction ID. \n(Alternatively use EmployeeID + ReferenceNumber)\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 People.\npublic string ReferenceNumber { get; set; } // Leave Transaction Reference Number.\nThe Leave Adjustment API will Post data to the Employee Leave screen for the applicable leave line. The API will use the Leave Line and not the Leave Type as there could be multiple leave lines under one leave type.
\nThe API can be set to Accumulate (Adds the given values to any existing values) or Override (will override any existing values with the newly supplied values).
\n\n\nNote: This API's no longer follow the previously used methods of creating a \"Header\" then a \"Line\" item and then the final process steps of \"Validation\" and \"Process\", this is a true direct API.
\nSending the API call will directly send the data to the system
\n
\n\nData Model:
\n
public class LeaveAdjustmentModel : APIBaseModel\n{\npublic string CompanyCode { get; set; } // Company Code in Sage 300\npublic int CompanyID { get; set; }\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic int CompanyRuleID { get; set; }\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic int LeaveDefinitionID { get; set; } // Leave Definition ID\npublic string LeaveDefinitionCode { get; set; } // Leave Type Code\npublic bool? Override { get; set; } // Set whether to Override or Accumulate on the line item\npublic decimal? Adjustment { get; set; } // Adjustment amount to increase or decrease\npublic string Note { get; set; } // Extra info as to why adjustment was made\n}\n\nCookie Value
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/PAYSLIPDEF","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","PAYSLIPDEF"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cef6b4f6-f050-4396-9a29-71c09937b1f0"},{"name":"Payslip Definition - Line","event":[{"listen":"test","script":{"id":"6e423efd-ed62-4c42-84b9-18fc9d95513c","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"true\");","});","","","let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript"}}],"id":"5b373dde-573d-4276-bdd4-23ad9b8f9de7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmployeeCode\": \"00002\",\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\t\"CreateLine\": true,\n\t\"DefinitionLines\": [\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"2\",\n\t\t\t// 1 - Earning\n\t\t\t// 2 - Deduction\n\t\t\t// 3 - Company Contribution\n\t\t\t// 4 - Fringe Benefit\n\t\t\t// 5 - Private Contribution\n\t\t\t// 6 - Provision\n\t\t\t// 7 - Additional\n\t\t\t\"PayrollDefinitionCode\": \"PROV\",\n\t\t\t\"FixedAmount\": 22.00,\n\t\t\t\"Balance\": 44.00, // Only available for LineType = 2, 4, 6 and 7\n\t\t\t\"Note\": \"Note field\",\n\t\t\t\"Reference\": \"Reference Field\",\n\t\t\t\"IncludeInPackage\": true,\n\t\t\t\"EmpCalculationStatusCode\": \"OVERRIDE\", // Field not used \"default\" will be applied.\n\t\t\t// OVERRIDE\n\t\t\t// DEFAULT\n\t\t\t// NOCALC\n \"CalculationEntryCode\": \"LINKCALC\" //Used If OVERRIDE status code\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"1\",\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"FixedAmount\": 22.00,\n\t\t\t\"Note\": \"Note field\",\n\t\t\t\"Reference\": \"Reference Field\"\n\t\t}\n\t]\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"3b07b9a0-6eec-4f40-bb77-642833216c04","name":"Successful","originalRequest":{"method":"POST","header":[{"description":"Cookie Value","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmployeeCode\": \"00001\",\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\t\"DefinitionLines\": [\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"1\",\n\t\t\t// 1 - Earning\n\t\t\t// 2 - Deduction\n\t\t\t// 3 - Company Contribution\n\t\t\t// 4 - Fringe Benefit\n\t\t\t// 5 - Private Contribution\n\t\t\t// 6 - Provision\n\t\t\t// 7 - Additional\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"FixedAmount\": \"123\"\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"2\",\n\t\t\t\"PayrollDefinitionCode\": \"MED_AID\",\n\t\t\t\"FixedAmount\": \"456\"\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"3\",\n\t\t\t\"PayrollDefinitionCode\": \"MED_AID\",\n\t\t\t\"FixedAmount\": \"798\"\n\t\t}\n\t]\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 27 Jul 2021 13:25:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"apiObjectID\": \"7ca607fc-b390-40ba-9d05-b6c584acb502\"\n }\n}"},{"id":"6355e867-de88-44ef-80e4-05188ddf46e9","name":"Fail - Invalid Line Data (, at line 4 missing)","originalRequest":{"method":"POST","header":[{"description":"Cookie Value","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmployeeCode\": \"00001\",\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\"\n\t\"DefinitionLines\": [\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"1\",\n\t\t\t// 1 - Earning\n\t\t\t// 2 - Deduction\n\t\t\t// 3 - Company Contribution\n\t\t\t// 4 - Fringe Benefit\n\t\t\t// 5 - Private Contribution\n\t\t\t// 6 - Provision\n\t\t\t// 7 - Additional\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"FixedAmount\": \"123\"\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"2\",\n\t\t\t\"PayrollDefinitionCode\": \"MED_AID\",\n\t\t\t\"FixedAmount\": \"456\"\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"3\",\n\t\t\t\"PayrollDefinitionCode\": \"MED_AID\",\n\t\t\t\"FixedAmount\": \"798\"\n\t\t}\n\t]\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"69"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 27 Jul 2021 13:26:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Invalid Line Data Received.\"\n}"},{"id":"9ee937d2-4e2f-44a0-aa84-4c21b2dd376a","name":"Validate - Header: Payslip Definition - Successful with Warnings","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"682"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 27 Jul 2021 13:28:19 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"businessRules\": [\n {\n \"PropertyName\": \"EmpEarningDef.Fixed\",\n \"PropertyFriendlyName\": \"Fixed\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n },\n {\n \"PropertyName\": \"EmpEarningDef.Reference\",\n \"PropertyFriendlyName\": \"Reference\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n }\n ],\n \"data\": {\n \"apiObjectID\": \"e2c2544b-54f4-4658-96f1-78aceaeafa43\"\n }\n }\n]"},{"id":"01568413-1609-463e-b40b-2e5fbd5aaffb","name":"Process - Header: Payslip Definition - Successful with Warnings","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/process/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"704"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 27 Jul 2021 13:28:32 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"businessRules\": [\n {\n \"PropertyName\": \"EmpEarningDef.Fixed\",\n \"PropertyFriendlyName\": \"Fixed\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n },\n {\n \"PropertyName\": \"EmpEarningDef.Reference\",\n \"PropertyFriendlyName\": \"Reference\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n }\n ],\n \"data\": {\n \"objectID\": 1,\n \"apiObjectID\": \"e2c2544b-54f4-4658-96f1-78aceaeafa43\"\n }\n }\n]"}],"_postman_id":"5b373dde-573d-4276-bdd4-23ad9b8f9de7"}],"id":"61a3795b-10a1-44dd-b82a-7f7c698f4022","description":"\n\nNon Mandatory Field
\n
\n\n\"CreateLine\": false - If the Payslip line does not exist on the employee's record, the validation will fail and nothing processed. If the line does exist, processing will happen as normal.
\n
\n\nNon Mandatory Field
\n
\n\n\"IncludeInPackage\": false - If the Payslip Definition line does not allow for Include in Package, a \"Warning\" will be received but processing will be allowed as normal.
\n
\n\nNon Mandatory Fields
\n
\n\n\"EmpCalculationStatusCode\": NOCALC - Will de-activate any calculations applied on this Payslip Definition, including system defaults as well as employee specific override calculations selected.
\n
\n\nNote
\n
public class PayslipDefEmployeeModel : PayrollBaseModel\n{\npublic List DefinitionLines { get; set; }\n}\npublic class PayslipDefLineModel\n{\npublic int PayRunDefinitonID { get; set; } // Pay Run Definition ID.\n(Alternatively use PayRunDefinitionCode)\npublic string PayRunDefinitionCode { get; set; } // Pay Run Definition Code.\npublic int LineType { get; set; } // Payslip Line Type:\npublic const int LineType = 1 - Earning \npublic const int LineType = 2 - Deduction \npublic const int LineType = 3 - Company Contribution\npublic const int LineType = 4 - Fringe Benefit \npublic const int LineType = 5 - Private Contribution\npublic const int LineType = 6 - Provision \npublic const int LineType = 7 - Additional \npublic int PayrollDefinitionID { get; set; } // Payroll Definition ID. \n(Alternatively use PayrollDefinitionCode)\npublic string PayrollDefinitionCode { get; set; } // Payroll Definition Code.\npublic decimal FixedAmount { get; set; } // Fixed Amount\npublic decimal? Balance { get; set; } // Balance\npublic bool? CreateLine { get; set; } // Set whether to create the line item of not\npublic string Note { get; set; } // Note\npublic string Reference { get; set; } // Reference\n\nCookie Value
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/PAYSLIPLINEAMT","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","PAYSLIPLINEAMT"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fa203e5-6748-4176-b400-b24c456719bf"},{"name":"Payslip Line Amount - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript","id":"f81729b5-c349-4ca1-b0fa-aa8f507ff618"}}],"id":"afda5688-5dda-4ca9-b7b7-421a9cf932b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"EmployeeCode\": \"00001\",\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\t\"CreateLine\": true,\n\t\"LineAmounts\": [\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t//\"PayRunDefinitionID\": 1,\n\t\t\t\"LineType\": \"1\",\n\t\t\t// 1 - Earning\n\t\t\t// 2 - Deduction\n\t\t\t// 3 - Company Contribution\n\t\t\t// 4 - Fringe Benefit\n\t\t\t// 5 - Private Contribution\n\t\t\t// 6 - Provision\n\t\t\t// 7 - Additional\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"Amount\": \"100\",\n\t\t\t\"IsProRata\": true\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"1\",\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"Amount\": \"10\",\n\t\t\t\"IsProRata\": false\n\t\t},\n\t\t{\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\n\t\t\t\"LineType\": \"1\",\n\t\t\t\"PayrollDefinitionCode\": \"OVERTIME15\",\n\t\t\t\"Amount\": \"1\"\n\t\t}\n\t]\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"0613c2c2-a136-4ff0-a605-904790cb3d42","name":"Validate - IS Pro Rata: Warning","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/validateHeader/{{APIHeaderID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"972"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Mon, 20 Jun 2022 11:27:26 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"businessRules\": [\n {\n \"PropertyName\": \"PayslipEarnLine.IsProRata\",\n \"PropertyFriendlyName\": \"Is Pro Rata\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n },\n {\n \"PropertyName\": \"PayslipEarnLine.IsProRata\",\n \"PropertyFriendlyName\": \"Is Pro Rata\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n },\n {\n \"PropertyName\": \"PayslipEarnLine.IsProRata\",\n \"PropertyFriendlyName\": \"Is Pro Rata\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Insufficient field access rights : MAIN - OVERTIME15\"\n }\n ]\n }\n ],\n \"data\": {\n \"apiObjectID\": \"28f158e0-84c5-4940-988e-96b13a9c23b3\"\n }\n }\n]"}],"_postman_id":"afda5688-5dda-4ca9-b7b7-421a9cf932b7"}],"id":"33b5c489-7336-49f4-baba-a56b21b12d25","description":"\n\nNon Mandatory Field
\n\"CreateLine\": true - If the Payslip line does not exist on the employee's payrun and is available, it will create the line and process the given data. If the line does exist, processing will happen as normal.
\n
\n\n\"CreateLine\": false - If the payslip line does not exist on the employee's record, the validation will fail and nothing processed. If the line does exist, processing will happen as normal.
\n
The \"Is ProRata\" field will depend on the setup of the line item on whether or not it will be allowed. The field is non mandatory.
\n\n\nNon Mandatory Field
\n\"IsProRata\": true - If the Payslip line allows for Pro Rata, the defined Pro Rata calculation will be activated and the effect calculated on the Payslip. If the Line does not allow for Pro Rata, the input will be treated as normal and no Pro Rata effect activated.
\n
\n\n\"IsProRata\": false - The API will run as normal and no additional actions taken.
\n
public class PayslipLineEmployeeModel : PayrollBaseModel\n{\npublic List LineAmounts { get; set; } \n}\npublic class PayslipLineAmountModel\n{\npublic int PayRunDefinitonID { get; set; } // Pay Run Definition ID (Alternatively use PayRunDefinitionCode)\npublic string PayRunDefinitionCode { get; set; } // Pay Run Definition Code\npublic int LineType { get; set; } // Payslip Line Type:\npublic const int LineType = 1 - Earning \npublic const int LineType = 2 - Deduction \npublic const int LineType = 3 - Company Contribution\npublic const int LineType = 4 - Fringe Benefit \npublic const int LineType = 5 - Private Contribution\npublic const int LineType = 6 - Provision \npublic const int LineType = 7 - Additional \npublic int PayrollDefinitionID { get; set; } // Payroll Definition ID (Alternatively use PayrollDefinitionCode)\npublic string PayrollDefinitionCode { get; set; } // Payroll Definition Code\npublic decimal Amount { get; set; } // Amount to Update on the Payslip Line\npublic boolean IsProRata { get; set; } // Flag the line for Pro Rata Calculation\n\n\n\n","_postman_id":"33b5c489-7336-49f4-baba-a56b21b12d25"},{"name":"Transaction Code Input","item":[{"name":"Payslip Transaction Code Input- Header","event":[{"listen":"test","script":{"exec":["let firstResponse = pm.response.json();\r","let APIHeaderID = firstResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Create Header == true\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"9688ee08-4887-44e9-a668-379cf3168da8"}}],"id":"2631086a-4ff3-4873-a3fd-5b3939c9c14d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/TXCODEINPUT","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","TXCODEINPUT"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"52c20628-6730-4d7c-becb-46550e599f1f","name":"Successful - Payslip Transaction Code Input- Header","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/TXCODEINPUT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 29 Jul 2021 11:19:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"apiObjectID\": \"c62b7683-bc2e-4965-949f-412de0db6466\"\n }\n}"}],"_postman_id":"2631086a-4ff3-4873-a3fd-5b3939c9c14d"},{"name":"Payslip Transaction Code Input - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APILineID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APILineID\", APILineID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"1b2788f7-0708-47d8-b23c-a08af3d4cb9a"}}],"id":"265e34c6-4b43-44f9-a4b1-dc63faac29c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMP123\",\r\n\t\"CreateLine\": true,\r\n\t\"UnitLines\": [\r\n\t\t{\r\n\t\t\t\"PayRunDefinitionCode\": \"MAIN\",\r\n\t\t\t//\"PayRunDefinitionID\": 1,\r\n\t\t\t\"TransactionCode\": \"RATE\",\r\n\t\t\t//\"TransactionCodeID\": 3,\r\n\t\t\t\"DateWorked\": \"2021-05-18\",\r\n\t\t\t\"Units\": 25,\r\n\t\t\t\"Rate\": 10.5,\r\n\t\t\t\"ChargeOutRate\": 15.50,\r\n\t\t\t\"InputAmount\": 33.55,\r\n\t\t\t\"Note\": \"Test - MAIN\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"PayRunDefinitionCode\": \"BONUS\",\r\n\t\t\t\"TransactionCode\": \"RATE\",\r\n\t\t\t\"Units\": 10,\r\n\t\t\t\"Rate\": 15.5,\r\n\t\t\t\"ChargeOutRate\": 20.50,\r\n\t\t\t\"Note\": \"Test - BONUS\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"PayRunDefinitionCode\": \"ONCEOFF\",\r\n\t\t\t\"TransactionCode\": \"RATE\",\r\n\t\t\t\"Units\": 15,\r\n\t\t\t\"Rate\": 20.5,\r\n\t\t\t\"ChargeOutRate\": 25.50,\r\n\t\t\t\"Note\": \"Test - ONCEOFF\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"265e34c6-4b43-44f9-a4b1-dc63faac29c8"}],"id":"7f95622f-ecf8-4881-9691-a996a00c8709","description":"Note
\nThe API allows for multiple entries per employee record.
\nThe system setup will define which Payroll Definitions are available for the Company and Company Rule as well as on which Pay Run. The Payroll Definition setup will determine the type of input allowed on the specified Line.
\n\n\nThe input for an Amount field follows the payroll input rule – Amounts are overridden with the new input and values in the Amount field are not accumulated. Sending multiple input to the same Amount field will only display the last processed value as previous input is overridden.
\n
This API was designed to do Unit Input on the Employee Payslip screen. It utilises the functionality of the Transaction Code Linking setup on the Payroll Definition type of the Company Rule. A transaction code has to be linked for this functionality to be used.
\n\n\n\"CreateLine\": true - If the Payslip line does not exist on the employee's payrun and is available, it will create the line and process the given data. If the line does exist, processing will happen as normal.
\n
\n\n\"CreateLine\": false - If the payslip line does not exist on the employee's record, the validation will fail and nothing processed. If the line does exist, processing will happen as normal.
\n
public class PayslipTransactionCodeEmployeeModel : PayrollBaseModel\n{\npublic List UnitLines { get; set; } // Collection of Payslip Transaction Code Lines\n}\npublic class PayslipTransactionCodeLineModel\n{\npublic int PayRunDefinitonID { get; set; } // Pay Run Definition ID (Alternatively use PayRunDefinitionCode)\npublic string PayRunDefinitionCode { get; set; } // Pay Run Definition Code\npublic int TransactionCodeID { get; set; } // Transaction Code ID (Alternatively use TransactionCode)\npublic string TransactionCode { get; set; } // Transaction Code\npublic DateTime? DateWorked { get; set; } // Date Worked\npublic decimal Units { get; set; } // Units\npublic decimal? Rate { get; set; } // Rate\npublic decimal? ChargeOutRate { get; set; } // Charge Out Rate\npublic decimal? InputAmount { get; set; } // Input Amount\npublic string JobCostCode { get; set; } // Job Cost Code\npublic string Note { get; set; } // Note\n\n\n\n","_postman_id":"7f95622f-ecf8-4881-9691-a996a00c8709"},{"name":"Job Costing Input","item":[{"name":"Job Costing Input - Header","event":[{"listen":"test","script":{"id":"cf40f48f-d7ed-4d50-b048-05fe4961d26a","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"bc3d5129-92fa-4496-8366-e344b46417a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/JOBCOSTINGINPUT","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","JOBCOSTINGINPUT"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc3d5129-92fa-4496-8366-e344b46417a2"},{"name":"Job Costing Input - Line","event":[{"listen":"test","script":{"id":"c42b5b57-80a4-4b9a-bb3d-72357dfda512","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});"],"type":"text/javascript"}}],"id":"86cd0052-8c29-4fa7-8d5c-4ca6afb2064f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyCode\": \"SOUTHAFRICA\",\n \"CompanyRuleCode\": \"SOUTHAFRICA\",\n \"EmployeeCode\": \"00002\",\n \"UnitLines\": [\n {\n \"PayRunDefinitionCode\": \"MAIN\",\n \"HierarchyList\": [\n {\n \"HierarchyHeaderCode\": \"FARM\",\n \"HierarchyCode\": \"TWO_OAKS\"\n },\n {\n \"HierarchyHeaderCode\": \"PRODUCE\",\n \"HierarchyCode\": \"ORANGES\"\n },\n {\n \"HierarchyHeaderCode\": \"JOB\",\n \"HierarchyCode\": \"PICKER\"\n },\n {\n \"HierarchyHeaderCode\": \"TEAM\",\n \"HierarchyCode\": \"BLUE\"\n }\n ],\n \"JobGrade\": {\n \"JobGradeCode\": \"JG_2\"\n },\n \"JobTitle\": {\n \"JobTitleCode\": \"JT_1\"\n },\n \"TransactionCode\": \"AMOUNT\",\n \"Units\": 9999,\n \"Rate\": 9999,\n \"ChargeOutRate\": 9999,\n \"AdditionalUnits\": 9999,\n \"InputAmount\": 9999,\n \"Note\": \"Example\",\n \"DateWorked\": \"2019/03/01\",\n \"EndDate\": \"2019/03/01\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86cd0052-8c29-4fa7-8d5c-4ca6afb2064f"}],"id":"7dc35c28-6576-44b0-ac61-1aafb6d4c885","description":"Note
\n
public class JobCostingEmployeeModel : PayrollBaseModel\n{\npublic List<JobCostingLineModel> UnitLines { get; set; } // Collection of Job Costing Lines\n}\n\npublic class HierarchyHeaderModel\n{\npublic int HierarchyHeaderID { get; set; } // Hierarchy Header ID (Alternatively use Hierarchy Header Code)\npublic string HierarchyHeaderCode { get; set; } // Hierarchy Header Code\npublic int HierarchyID { get; set; } // Hierarchy ID (Alternatively use Hierarchy Code)\npublic string HierarchyCode { get; set; } // Hierarchy Code\n}\n\npublic class JobGradeModel\n{\npublic int JobGradeID { get; set; } // Job Grade ID (Alternatively use Job Grade Code)\npublic string JobGradeCode { get; set; } // Job Grade Code\n}\n\npublic class JobTitleModel\n{\npublic int JobTitleID { get; set; } // Job Title ID (Alternatively use Job Title Code)\npublic string JobTitleCode { get; set; } // Job Title Code\n}\n\npublic class JobCostingLineModel\n{\npublic int PayRunDefinitonID { get; set; } // Pay Run Definition ID (Alternatively use PayRunDefinitionCode)\npublic string PayRunDefinitionCode { get; set; } // Pay Run Definition Code\npublic int TransactionCodeID { get; set; } // Transaction Code ID (Alternatively use TransactionCode)\npublic string TransactionCode { get; set; } // Transaction Code\n\npublic List<HierarchyHeaderModel> HierarchyList { get; set; } \npublic JobGradeModel JobGrade { get; set; }\npublic JobTitleModel JobTitle { get; set; } \npublic DateTime? DateWorked { get; set; } // Date Worked\npublic decimal Units { get; set; } // Units\npublic decimal? Rate { get; set; } // Rate\npublic decimal? ChargeOutRate { get; set; } // Charge Out Rate\npublic decimal? InputAmount { get; set; } // Input Amount\npublic string JobCostCode { get; set; } // Job Cost Code\npublic string Note { get; set; } // Note\npublic decimal? AdditionalUnits { get; set; } // Additional Units\npublic DateTime? EndDate { get; set; } // End Date\nThe Entity Create / Update API consists of 3 API's; Create, Update and Retrieve Entity details.
The purpose of this API is to allow an Entity record to be Created or Updated without having to use the Employee API's where employment details are also required. This API will only effect the Entity details.
Entity API:
\nThere is a multitude of business logic behind the Entity Create and Update process. The API will have different requirements depending on the system configuration. The system setup influences what data is mandatory and which is not. For full details refer to the Sage 300 People system documentation on New Entity.
\nOnly the follow Entity Type and Sub Types are permitted:
\n\n\nNote:
\nThese API's no longer follow the previously used methods of creating a Header then a Line item and then the final process steps of Validation and Process, this is a true direct API. Only 1 Entity record per API call is allowed.
\n
\n\nAll API calls follow the Method = POST
\n
\n\nBanking details can't be updated due to system restrictions for auditing, you are only allowed to change the status or add new records.
\n
\n\nEntity Code can't be updated as it is an identifying requirement on the Update process.
\n
public class EntityModel\n {\n public int? GenEntityID { get; set; }\n public string EntityCode { get; set; }\n public int? GenEntityTypeID { get; set; }\n public string GenEntityTypeCode { get; set; }\n public int? GenEntitySubTypeID { get; set; }\n public string GenEntitySubTypeCode { get; set; }\n public int? TitleTypeID { get; set; }\n public string TitleTypeCode { get; set; }\n public string Initials { get; set; }\n public string FirstName { get; set; }\n public string SecondName { get; set; }\n public string OtherNames { get; set; }\n public string KnownAsName { get; set; }\n public string LastName { get; set; }\n public string MaidenName { get; set; }\n public string IDNumber { get; set; }\n public int IdentityTypeID { get; set; }\n public string IdentityTypeCode { get; set; }\n public DateTime? BirthDate { get; set; }\n public string BirthCertificateNumber { get; set; }\n public string CityOfBirth { get; set; }\n public string Gender { get; set; }\n public int? LanguageTypeID { get; set; }\n public string LanguageTypeCode { get; set; }\n public string NationalityCountryCode { get; set; }\n public string CountryOfBirth { get; set; }\n public string PassportNo { get; set; }\n public string PassportCountryCode { get; set; }\n public bool? Disabled { get; set; }\n public int? DisabilityTypeID { get; set; }\n public string DisabilityTypeCode { get; set; }\n public int? EthnicTypeID { get; set; }\n public string EthnicTypeCode { get; set; }\n public string RacialGroup { get; set; }\n public int? RaceGroupID { get; set; }\n public string RaceGroupCode { get; set; }\n public int? ReligionID { get; set; }\n public string ReligionCode { get; set; }\n public string BloodGroup { get; set; }\n public string HomeNumber { get; set; }\n public string WorkNumber { get; set; }\n public string FaxNumber { get; set; }\n public string CellNumber { get; set; }\n public string EmailAddress { get; set; }\n public int? MaritalStatusTypeID { get; set; }\n public string MaritalStatusTypeCode { get; set; }\n public List Addresses { get; set; }\n public List Contacts { get; set; }\n public List BankAccounts { get; set; }\n }\n public class EntityAddressModel\n {\n public int? AddressID { get; set; }\n public bool? UseWork { get; set; }\n public bool? UsePhysical { get; set; }\n public bool? UsePostal { get; set; }\n public int? AddressServiceTypeID { get; set; }\n public string AddressServiceTypeCode { get; set; }\n public bool? CorrespondenceAddress { get; set; }\n public string UnitPostalNumber { get; set; }\n public string Complex { get; set; }\n public string LevelFloor { get; set; }\n public string Block { get; set; }\n public string StreetNumber { get; set; }\n public string StreetFarmName { get; set; }\n public string SuburbDistrict { get; set; }\n public int? DistrictID { get; set; }\n public string DistrictCode { get; set; }\n public string CityTown { get; set; }\n public string Province { get; set; }\n public string PostalCode { get; set; }\n public string PostalAgency { get; set; }\n public string PostOffice { get; set; }\n public string PostalOffice { get { return PostOffice; } set { PostOffice = value; } }\n public string PostalAddressNumber { get; set; }\n public string OtherServiceType { get; set; }\n public bool? CareOf { get; set; }\n public string CareOfName { get; set; }\n public string CountryCode { get; set; }\n }\n public class EntityContactModel\n {\n public int? ContactID { get; set; }\n public int ContactTypeID { get; set; }\n public string ContactTypeCode { get; set; }\n public string ContactDetail { get; set; }\n }\n public class EntityBankDetailModel\n {\n public string AccountHolderRelationship { get; set; }\n public string AccountName { get; set; }\n public int BankID { get; set; }\n public string BankCode { get; set; }\n public int AccountTypeID { get; set; }\n public string AccountTypeCode { get; set; }\n public string AccountNo { get; set; }\n public int BankBranchID { get; set; }\n public string BankBranchCode { get; set; }\n public string Ccy { get; set; }\n public bool DefaultInd { get; set; }\n public string NedInformCreditLineNumber { get; set; }\n public int? BankDetailID { get; set; }\n public string Status { get; set; }\n }\n\nRetrieves the required information for an employee in the system.
\nThe unique identifier of the Employee ID is used in the URL and therefore no Body Details required.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Employee","Get","{{EmployeeID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"638c83c2-aae2-45f2-8c35-600b3f0f69de","name":"GET Emp - ID Example response","originalRequest":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Employee/Get/{{EmployeeID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"4613"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 17 Nov 2021 11:48:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"EmployeeCode\": \"EMP_GET_API\",\n \"CompanyCode\": \"SOUTHAFRICA\",\n \"DateEngaged\": \"2021/03/01 00:00:00\",\n \"UIFStatusCode\": \"UIF\",\n \"UIFStartDate\": \"2021/03/01 00:00:00\",\n \"JobTitleTypeCode\": \"ANANLYST\",\n \"JobGradeCode\": \"JOBGRADE_TIER4\",\n \"TerminationDate\": \"2021/09/30 00:00:00\",\n \"TerminationReasonCode\": \"AB\",\n \"FinalCalcNow\": \"2\",\n \"DateJoinedGroup\": \"2021/03/01 00:00:00\",\n \"LeaveStartDate\": \"2021/03/01 00:00:00\",\n \"NatureOfContractCode\": \"APPLICANT\",\n \"EntityCode\": \"1200\",\n \"TitleTypeCode\": \"SIR\",\n \"Initials\": \"A\",\n \"FirstName\": \"API First Name\",\n \"SecondName\": \"Second Name\",\n \"OtherNames\": \"Other Name\",\n \"KnownAsName\": \"Known As\",\n \"LastName\": \"Surname\",\n \"MaidenName\": \"Maiden\",\n \"MaritalStatusTypeCode\": \"MRD\",\n \"IDNumber\": \"9009135800086\",\n \"BirthDate\": \"1990/09/13 00:00:00\",\n \"BirthCertificateNumber\": \"Birth Cert no13\",\n \"CityOfBirth\": \"City Birth\",\n \"Gender\": \"M\",\n \"LanguageTypeCode\": \"ENG\",\n \"NationalityCountryCode\": \"ZAF\",\n \"CountryOfBirth\": \"ABW\",\n \"PassportNo\": \"Passport No123\",\n \"PassportCountryCode\": \"ZAF\",\n \"Disabled\": \"True\",\n \"DisabilityTypeCode\": \"EMFN\",\n \"EthnicTypeCode\": \"XHO\",\n \"RacialGroup\": \"I\",\n \"ReligionCode\": \"TAO\",\n \"BloodGroup\": \"AB+\",\n \"HomeNumber\": \"0129911789\",\n \"WorkNumber\": \"0124207000\",\n \"FaxNumber\": \"08601122321\",\n \"CellNumber\": \"0841234321\",\n \"EmailAddress\": \"EmpAPI@Webtest.com\",\n \"CompanyRuleCode\": \"RSA\",\n \"HoursPerPeriod\": \"173,3600\",\n \"HoursPerDay\": \"8,0000\",\n \"AnnualSalary\": \"1234500,0000\",\n \"PeriodSalary\": \"102875,0000\",\n \"OverrideAnnualBonusCalcRecurrence\": \"False\",\n \"CalendarMonth\": \"12\",\n \"PeriodInMonth\": \"L\",\n \"RatePerDay\": \"4747,3464\",\n \"RatePerHour\": \"593,4183\",\n \"PensionFundStartDate\": \"2021/10/14 00:00:00\",\n \"ProvidentFundStartDate\": \"2021/10/15 00:00:00\",\n \"ZoneCodes\": \"\",\n \"MedicalStartDate\": \"2021/10/16 00:00:00\",\n \"SDLExempt\": \"False\",\n \"LegallyRetiredforTaxPurpose\": \"False\",\n \"ForeignIncome\": \"False\",\n \"TaxStatusCode\": \"ST\",\n \"TaxStartDate\": \"2021/03/01 00:00:00\",\n \"TaxCalculation\": \"A\",\n \"LeavePolicyCode\": \"SA_START\",\n \"Addresses\": [\n {\n \"UseWork\": \"True\",\n \"UsePhysical\": \"True\",\n \"UsePostal\": \"False\",\n \"CorrespondenceAddress\": \"False\",\n \"UnitPostalNumber\": \"Unt 1\",\n \"Complex\": \"Cmplx name\",\n \"LevelFloor\": \"12\",\n \"StreetNumber\": \"Str123\",\n \"StreetFarmName\": \"Str Name\",\n \"SuburbDistrict\": \"Suburb\",\n \"CityTown\": \"City\",\n \"Province\": \"Provinceeee\",\n \"PostalCode\": \"0011\",\n \"PostalAgency\": \"pst agency\",\n \"PostOffice\": \"pst office\",\n \"PostalAddressNumber\": \"pst adrs\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n },\n {\n \"UseWork\": \"False\",\n \"UsePhysical\": \"False\",\n \"UsePostal\": \"True\",\n \"AddressServiceTypeCode\": \"PO\",\n \"CorrespondenceAddress\": \"True\",\n \"SuburbDistrict\": \"pstal\",\n \"CityTown\": \"postal line\",\n \"Province\": \"pst prov\",\n \"PostalCode\": \"2211\",\n \"PostalAgency\": \"postal agency\",\n \"PostOffice\": \"post office\",\n \"PostalAddressNumber\": \"2nd addr\",\n \"OtherServiceType\": \"othr srvc tp\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n }\n ],\n \"Contacts\": [\n {\n \"ContactTypeCode\": \"CELL\",\n \"ContactDetail\": \"0884567788\"\n },\n {\n \"ContactTypeCode\": \"MAIL\",\n \"ContactDetail\": \"addmail@webtest.com\"\n }\n ],\n \"BankAccounts\": [\n {\n \"AccountHolderRelationship\": \"O\",\n \"AccountName\": \"Sir A Surname\",\n \"BankCode\": \"ABSA\",\n \"AccountTypeCode\": \"CA\",\n \"AccountNo\": \"123456789\",\n \"BankBranchCode\": \"632005\",\n \"Ccy\": \"ZAR\",\n \"DefaultInd\": \"True\"\n }\n ],\n \"DriversLicenses\": [\n {\n \"IssueDate\": \"2021/01/19 00:00:00\",\n \"ExpiryDate\": \"2022/12/22 00:00:00\",\n \"LicenseNumber\": \"lic65432\",\n \"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\n \"LicenseRestrictionsTypeCode\": \"LIC_REST_1\",\n \"CountryCode\": \"ASM\"\n }\n ],\n \"Hierarchies\": [\n {\n \"HierarchyHeaderCode\": \"DEPARTMENT\",\n \"HierarchyCode\": \"FINANCE\"\n },\n {\n \"HierarchyHeaderCode\": \"FACTION\",\n \"HierarchyCode\": \"CANDOR\"\n }\n ]\n }\n}"}],"_postman_id":"a85edc00-551a-4cb2-8bac-ee1222478285"},{"name":"GET Emp - Body: CR and ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Details - EmployeeID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"employeeID\");\r","});\r","pm.test(\"Test for Response Details - companyID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"companyID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});"],"type":"text/javascript","id":"fde29983-ed26-4631-9cab-b76fe1179927"}}],"id":"0c7250bb-0807-4345-8489-ba4d4b354dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"IDNumber\": \"8012138012080\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Employee/Get","description":"Retrieves the required information for an employee in the system.
\nThe required employee is defined by sending the Company Code, Company Rule Code and Employee ID Number.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Employee","Get"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"4da93839-2aae-4a2b-a7d2-5312b31f99b3","name":"GET Emp - Body: CR and ID Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"IDNumber\": \"9009135800086\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Employee/Get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"4613"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 17 Nov 2021 11:57:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"EmployeeCode\": \"EMP_GET_API\",\n \"CompanyCode\": \"SOUTHAFRICA\",\n \"DateEngaged\": \"2021/03/01 00:00:00\",\n \"UIFStatusCode\": \"UIF\",\n \"UIFStartDate\": \"2021/03/01 00:00:00\",\n \"JobTitleTypeCode\": \"ANANLYST\",\n \"JobGradeCode\": \"JOBGRADE_TIER4\",\n \"TerminationDate\": \"2021/09/30 00:00:00\",\n \"TerminationReasonCode\": \"AB\",\n \"FinalCalcNow\": \"2\",\n \"DateJoinedGroup\": \"2021/03/01 00:00:00\",\n \"LeaveStartDate\": \"2021/03/01 00:00:00\",\n \"NatureOfContractCode\": \"APPLICANT\",\n \"EntityCode\": \"1200\",\n \"TitleTypeCode\": \"SIR\",\n \"Initials\": \"A\",\n \"FirstName\": \"API First Name\",\n \"SecondName\": \"Second Name\",\n \"OtherNames\": \"Other Name\",\n \"KnownAsName\": \"Known As\",\n \"LastName\": \"Surname\",\n \"MaidenName\": \"Maiden\",\n \"MaritalStatusTypeCode\": \"MRD\",\n \"IDNumber\": \"9009135800086\",\n \"BirthDate\": \"1990/09/13 00:00:00\",\n \"BirthCertificateNumber\": \"Birth Cert no13\",\n \"CityOfBirth\": \"City Birth\",\n \"Gender\": \"M\",\n \"LanguageTypeCode\": \"ENG\",\n \"NationalityCountryCode\": \"ZAF\",\n \"CountryOfBirth\": \"ABW\",\n \"PassportNo\": \"Passport No123\",\n \"PassportCountryCode\": \"ZAF\",\n \"Disabled\": \"True\",\n \"DisabilityTypeCode\": \"EMFN\",\n \"EthnicTypeCode\": \"XHO\",\n \"RacialGroup\": \"I\",\n \"ReligionCode\": \"TAO\",\n \"BloodGroup\": \"AB+\",\n \"HomeNumber\": \"0129911789\",\n \"WorkNumber\": \"0124207000\",\n \"FaxNumber\": \"08601122321\",\n \"CellNumber\": \"0841234321\",\n \"EmailAddress\": \"EmpAPI@Webtest.com\",\n \"CompanyRuleCode\": \"RSA\",\n \"HoursPerPeriod\": \"173,3600\",\n \"HoursPerDay\": \"8,0000\",\n \"AnnualSalary\": \"1234500,0000\",\n \"PeriodSalary\": \"102875,0000\",\n \"OverrideAnnualBonusCalcRecurrence\": \"False\",\n \"CalendarMonth\": \"12\",\n \"PeriodInMonth\": \"L\",\n \"RatePerDay\": \"4747,3464\",\n \"RatePerHour\": \"593,4183\",\n \"PensionFundStartDate\": \"2021/10/14 00:00:00\",\n \"ProvidentFundStartDate\": \"2021/10/15 00:00:00\",\n \"ZoneCodes\": \"\",\n \"MedicalStartDate\": \"2021/10/16 00:00:00\",\n \"SDLExempt\": \"False\",\n \"LegallyRetiredforTaxPurpose\": \"False\",\n \"ForeignIncome\": \"False\",\n \"TaxStatusCode\": \"ST\",\n \"TaxStartDate\": \"2021/03/01 00:00:00\",\n \"TaxCalculation\": \"A\",\n \"LeavePolicyCode\": \"SA_START\",\n \"Addresses\": [\n {\n \"UseWork\": \"True\",\n \"UsePhysical\": \"True\",\n \"UsePostal\": \"False\",\n \"CorrespondenceAddress\": \"False\",\n \"UnitPostalNumber\": \"Unt 1\",\n \"Complex\": \"Cmplx name\",\n \"LevelFloor\": \"12\",\n \"StreetNumber\": \"Str123\",\n \"StreetFarmName\": \"Str Name\",\n \"SuburbDistrict\": \"Suburb\",\n \"CityTown\": \"City\",\n \"Province\": \"Provinceeee\",\n \"PostalCode\": \"0011\",\n \"PostalAgency\": \"pst agency\",\n \"PostOffice\": \"pst office\",\n \"PostalAddressNumber\": \"pst adrs\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n },\n {\n \"UseWork\": \"False\",\n \"UsePhysical\": \"False\",\n \"UsePostal\": \"True\",\n \"AddressServiceTypeCode\": \"PO\",\n \"CorrespondenceAddress\": \"True\",\n \"SuburbDistrict\": \"pstal\",\n \"CityTown\": \"postal line\",\n \"Province\": \"pst prov\",\n \"PostalCode\": \"2211\",\n \"PostalAgency\": \"postal agency\",\n \"PostOffice\": \"post office\",\n \"PostalAddressNumber\": \"2nd addr\",\n \"OtherServiceType\": \"othr srvc tp\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n }\n ],\n \"Contacts\": [\n {\n \"ContactTypeCode\": \"CELL\",\n \"ContactDetail\": \"0884567788\"\n },\n {\n \"ContactTypeCode\": \"MAIL\",\n \"ContactDetail\": \"addmail@webtest.com\"\n }\n ],\n \"BankAccounts\": [\n {\n \"AccountHolderRelationship\": \"O\",\n \"AccountName\": \"Sir A Surname\",\n \"BankCode\": \"ABSA\",\n \"AccountTypeCode\": \"CA\",\n \"AccountNo\": \"123456789\",\n \"BankBranchCode\": \"632005\",\n \"Ccy\": \"ZAR\",\n \"DefaultInd\": \"True\"\n }\n ],\n \"DriversLicenses\": [\n {\n \"IssueDate\": \"2021/01/19 00:00:00\",\n \"ExpiryDate\": \"2022/12/22 00:00:00\",\n \"LicenseNumber\": \"lic65432\",\n \"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\n \"LicenseRestrictionsTypeCode\": \"LIC_REST_1\",\n \"CountryCode\": \"ASM\"\n }\n ],\n \"Hierarchies\": [\n {\n \"HierarchyHeaderCode\": \"DEPARTMENT\",\n \"HierarchyCode\": \"FINANCE\"\n },\n {\n \"HierarchyHeaderCode\": \"FACTION\",\n \"HierarchyCode\": \"CANDOR\"\n }\n ]\n }\n}"}],"_postman_id":"0c7250bb-0807-4345-8489-ba4d4b354dee"},{"name":"GET Emp - Body: CR and Emp Code","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Details - EmployeeID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"employeeID\");\r","});\r","pm.test(\"Test for Response Details - companyID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"companyID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});"],"type":"text/javascript","id":"3fa15cfc-ed12-475c-9363-dfd8debd511d"}}],"id":"0d24b80b-a513-4ab9-a51e-824468d24521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"00004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Employee/Get","description":"Retrieves the required information for an employee in the system.
\nThe required employee is defined by sending the Company Code, Company Rule Code and Employee Code.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Employee","Get"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"a85bf2dd-8f69-4ef9-995b-9776a9a46063","name":"GET Emp - Body: CR and Emp Code Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMP_GET_API\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Employee/Get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"4613"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 17 Nov 2021 11:58:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"EmployeeCode\": \"EMP_GET_API\",\n \"CompanyCode\": \"SOUTHAFRICA\",\n \"DateEngaged\": \"2021/03/01 00:00:00\",\n \"UIFStatusCode\": \"UIF\",\n \"UIFStartDate\": \"2021/03/01 00:00:00\",\n \"JobTitleTypeCode\": \"ANANLYST\",\n \"JobGradeCode\": \"JOBGRADE_TIER4\",\n \"TerminationDate\": \"2021/09/30 00:00:00\",\n \"TerminationReasonCode\": \"AB\",\n \"FinalCalcNow\": \"2\",\n \"DateJoinedGroup\": \"2021/03/01 00:00:00\",\n \"LeaveStartDate\": \"2021/03/01 00:00:00\",\n \"NatureOfContractCode\": \"APPLICANT\",\n \"EntityCode\": \"1200\",\n \"TitleTypeCode\": \"SIR\",\n \"Initials\": \"A\",\n \"FirstName\": \"API First Name\",\n \"SecondName\": \"Second Name\",\n \"OtherNames\": \"Other Name\",\n \"KnownAsName\": \"Known As\",\n \"LastName\": \"Surname\",\n \"MaidenName\": \"Maiden\",\n \"MaritalStatusTypeCode\": \"MRD\",\n \"IDNumber\": \"9009135800086\",\n \"BirthDate\": \"1990/09/13 00:00:00\",\n \"BirthCertificateNumber\": \"Birth Cert no13\",\n \"CityOfBirth\": \"City Birth\",\n \"Gender\": \"M\",\n \"LanguageTypeCode\": \"ENG\",\n \"NationalityCountryCode\": \"ZAF\",\n \"CountryOfBirth\": \"ABW\",\n \"PassportNo\": \"Passport No123\",\n \"PassportCountryCode\": \"ZAF\",\n \"Disabled\": \"True\",\n \"DisabilityTypeCode\": \"EMFN\",\n \"EthnicTypeCode\": \"XHO\",\n \"RacialGroup\": \"I\",\n \"ReligionCode\": \"TAO\",\n \"BloodGroup\": \"AB+\",\n \"HomeNumber\": \"0129911789\",\n \"WorkNumber\": \"0124207000\",\n \"FaxNumber\": \"08601122321\",\n \"CellNumber\": \"0841234321\",\n \"EmailAddress\": \"EmpAPI@Webtest.com\",\n \"CompanyRuleCode\": \"RSA\",\n \"HoursPerPeriod\": \"173.3600\",\n \"HoursPerDay\": \"8.0000\",\n \"AnnualSalary\": \"1234500.0000\",\n \"PeriodSalary\": \"102875.0000\",\n \"OverrideAnnualBonusCalcRecurrence\": \"False\",\n \"CalendarMonth\": \"12\",\n \"PeriodInMonth\": \"L\",\n \"RatePerDay\": \"4747.3464\",\n \"RatePerHour\": \"593.4183\",\n \"PensionFundStartDate\": \"2021/10/14 00:00:00\",\n \"ProvidentFundStartDate\": \"2021/10/15 00:00:00\",\n \"ZoneCodes\": \"\",\n \"MedicalStartDate\": \"2021/10/16 00:00:00\",\n \"SDLExempt\": \"False\",\n \"LegallyRetiredforTaxPurpose\": \"False\",\n \"ForeignIncome\": \"False\",\n \"TaxStatusCode\": \"ST\",\n \"TaxStartDate\": \"2021/03/01 00:00:00\",\n \"TaxCalculation\": \"A\",\n \"LeavePolicyCode\": \"SA_START\",\n \"Addresses\": [\n {\n \"UseWork\": \"True\",\n \"UsePhysical\": \"True\",\n \"UsePostal\": \"False\",\n \"CorrespondenceAddress\": \"False\",\n \"UnitPostalNumber\": \"Unt 1\",\n \"Complex\": \"Cmplx name\",\n \"LevelFloor\": \"12\",\n \"StreetNumber\": \"Str123\",\n \"StreetFarmName\": \"Str Name\",\n \"SuburbDistrict\": \"Suburb\",\n \"CityTown\": \"City\",\n \"Province\": \"Provinceeee\",\n \"PostalCode\": \"0011\",\n \"PostalAgency\": \"pst agency\",\n \"PostOffice\": \"pst office\",\n \"PostalAddressNumber\": \"pst adrs\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n },\n {\n \"UseWork\": \"False\",\n \"UsePhysical\": \"False\",\n \"UsePostal\": \"True\",\n \"AddressServiceTypeCode\": \"PO\",\n \"CorrespondenceAddress\": \"True\",\n \"SuburbDistrict\": \"pstal\",\n \"CityTown\": \"postal line\",\n \"Province\": \"pst prov\",\n \"PostalCode\": \"2211\",\n \"PostalAgency\": \"postal agency\",\n \"PostOffice\": \"post office\",\n \"PostalAddressNumber\": \"2nd addr\",\n \"OtherServiceType\": \"othr srvc tp\",\n \"CareOf\": \"False\",\n \"CountryCode\": \"ZAF\"\n }\n ],\n \"Contacts\": [\n {\n \"ContactTypeCode\": \"CELL\",\n \"ContactDetail\": \"0884567788\"\n },\n {\n \"ContactTypeCode\": \"MAIL\",\n \"ContactDetail\": \"addmail@webtest.com\"\n }\n ],\n \"BankAccounts\": [\n {\n \"AccountHolderRelationship\": \"O\",\n \"AccountName\": \"Sir A Surname\",\n \"BankCode\": \"ABSA\",\n \"AccountTypeCode\": \"CA\",\n \"AccountNo\": \"123456789\",\n \"BankBranchCode\": \"632005\",\n \"Ccy\": \"ZAR\",\n \"DefaultInd\": \"True\"\n }\n ],\n \"DriversLicenses\": [\n {\n \"IssueDate\": \"2021/01/19 00:00:00\",\n \"ExpiryDate\": \"2022/12/22 00:00:00\",\n \"LicenseNumber\": \"lic65432\",\n \"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\n \"LicenseRestrictionsTypeCode\": \"LIC_REST_1\",\n \"CountryCode\": \"ASM\"\n }\n ],\n \"Hierarchies\": [\n {\n \"HierarchyHeaderCode\": \"DEPARTMENT\",\n \"HierarchyCode\": \"FINANCE\"\n },\n {\n \"HierarchyHeaderCode\": \"FACTION\",\n \"HierarchyCode\": \"CANDOR\"\n }\n ]\n }\n}"}],"_postman_id":"0d24b80b-a513-4ab9-a51e-824468d24521"},{"name":"Emp Batch - Create (POST)","id":"6643e1cd-13a0-4205-85d8-19708a02b437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CompanyCode\": \"SOUTHAFRICA\",\r\n \"CompanyRuleCode\": \"RSA\",\r\n \"EmployeeCode\": \"EMPAPI_B142\",\r\n \"EntityCode\": \"API142\", //null = system generates code\r\n \"GenEntityTypeCode\": \"INDV\",\r\n \"GenEntitySubTypeCode\": \"EMPL\",\r\n \"TaxOffice\": \"PTA\",\r\n \"TaxNo\": \"1231239846\",\r\n \"TaxRegistrationDate\": \"2017/09/15\",\r\n \"TitleTypeCode\": \"ADV\",\r\n \"Gender\": \"F\",\r\n \"Initials\": \"F\",\r\n \"FirstName\": \"1st Name\",\r\n \"LastName\": \"Surname\",\r\n \"SecondName\": \"2nd Name\",\r\n \"OtherNames\": \"Other Name\",\r\n \"KnownAsName\": \"Knwn as\",\r\n \"MaritalStatusTypeCode\": \"MRD\",\r\n \"BirthDate\": \"2000/11/17\",\r\n \"BirthCertificateNumber\": \"Birth1234\",\r\n \"CityOfBirth\": \"Pretoria\",\r\n \"CountryOfBirth\": \"ZAF\",\r\n \"Disabled\": \"True\",\r\n \"DisabilityType\": \"VI _BROEKN_ SL\",\r\n \"EthnicTypeCode\": \"EU\",\r\n \"LanguageTypeCode\": \"ENG\",\r\n \"NationalityCountryCode\": \"ZAF\",\r\n \"RacialGroup\": \"W\",\r\n \"RaceGroup\": \"AFR\",\r\n \"IDNumber\": \"3409294800081\",\r\n \"PassportNo\": \"123456789101234\",\r\n \"PassportCountryCode\": \"ZAF\",\r\n \"LeavePolicyCode\": \"SA_START\",\r\n \"LeaveStartDate\": \"2019/03/01\",\r\n \"RemunerationEarnDefCode\": \"SALARY\",\r\n \"PaymentRunDefCode\": \"SA_ACB\",\r\n // Only one of: \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n //\t\"AnnualSalary\": \"900000.0000\", \r\n //\t\"PeriodSalary\": \"33333.3333\",\r\n //\t\"RatePerDay\": \"321\",\r\n \"RatePerHour\": \"123.4321\",\r\n \"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n \"JobTitleTypeCode\": \"TEAMLEAD\",\r\n \"TaxStatusCode\": \"ST\",\r\n \"TaxCalculation\": \"A\",\r\n \"TaxStartDate\": \"2021/03/01\",\r\n \"NatureOfContractCode\": \"PERM\",\r\n \"ProbationPeriodEndDate\": \"2021/05/01\",\r\n \"ReligionCode\": \"TAO\",\r\n \"BloodGroup\": \"O+\",\r\n \"DateEngaged\": \"2021/03/01\",\r\n \"DateJoinedGroup\": \"2021/03/01\",\r\n \"TerminationDate\": \"2021/12/31\",\r\n //\"TerminationReasonCode\": \"EC\",\r\n //\"FinalCalcNow\": \"2\", // 1 - Current Period, 2 - Termination Period (if future date)\r\n \"UIFStatusCode\": \"UIF\",\r\n \"UIFStartDate\": \"2021/03/01\",\r\n \"MedicalStartDate\": \"2019/03/01\",\r\n \"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n \"CalendarMonth\": \"12\",\r\n \"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n \"ForeignIncome\": \"TRUE\",\r\n \"HomeNumber\": \"0129911739\",\r\n \"WorkNumber\": \"0124207000\",\r\n \"FaxNumber\": \"0863334444\",\r\n \"CellNumber\": \"0811112233\",\r\n \"EmailAddress\": \"API_NewBatch@WebTest.com\",\r\n \"Addresses\": [\r\n {\r\n \"UseWork\": \"True\",\r\n \"UsePhysical\": \"True\",\r\n \"UsePostal\": \"True\",\r\n \"UnitPostalNumber\": \"1204\",\r\n \"StreetNumber\": \"29\",\r\n \"StreetFarmName\": \"Long Street\",\r\n \"LevelFloor\": \"3\",\r\n \"Complex\": \"Super Fun Complex\",\r\n \"CityTown\": \"Pretoria\",\r\n \"Province\": \"Gauteng\",\r\n \"PostalCode\": \"0156\",\r\n \"CountryCode\": \"ZAF\"\r\n },\r\n {\r\n \"UseWork\": \"True\",\r\n \"UsePhysical\": \"False\",\r\n \"UsePostal\": \"False\",\r\n \"CorrespondenceAddress\": \"False\",\r\n \"UnitPostalNumber\": \"Unt 1\",\r\n \"Complex\": \"Cmplx name\",\r\n \"LevelFloor\": \"12\",\r\n \"StreetNumber\": \"Str123\",\r\n \"StreetFarmName\": \"Str Name\",\r\n \"SuburbDistrict\": \"Suburb\",\r\n \"CityTown\": \"City\",\r\n \"Province\": \"Provinceeee\",\r\n \"PostalCode\": \"0011\",\r\n \"PostalAgency\": \"pst agency\",\r\n \"PostOffice\": \"pst office\",\r\n \"PostalAddressNumber\": \"pst adrs\",\r\n \"DistrictCode\": \"DST9\",\r\n \"CareOf\": \"False\",\r\n \"CountryCode\": \"ZAF\"\r\n }\r\n ],\r\n \"BankAccounts\": [\r\n {\r\n \"AccountName\": \"Mrs E FULL\",\r\n \"AccountNo\": \"6249994975\",\r\n \"AccountTypeCode\": \"CA\",\r\n \"BankCode\": \"ABSA\",\r\n \"BankBranchCode\": \"632005\",\r\n \"DefaultInd\": true,\r\n \"Status\": \"A\"\r\n }\r\n ],\r\n \"DriversLicenses\": [\r\n {\r\n \"IssueDate\": \"2021/01/19 00:00:00\",\r\n \"ExpiryDate\": \"2022/12/22 00:00:00\",\r\n \"LicenseNumber\": \"lic65432\",\r\n \"LicenseCategoriesTypeCode\": \"STD_VEHICLE\",\r\n \"LicenseRestrictionsTypeCode\": \"LIMB\",\r\n \"CountryCode\": \"ASM\"\r\n }\r\n ],\r\n \"Contacts\": [ // This is the Additional Contact fields (If no main contact details provided these will be duplicated to the main contact as well)\r\n {\r\n \"ContactTypeCode\": \"CELL\",\r\n \"ContactDetail\": \"0826823789\"\r\n },\r\n {\r\n \"ContactTypeCode\": \"HOME\",\r\n \"ContactDetail\": \"0124643789\"\r\n },\r\n {\r\n \"ContactTypeCode\": \"MAIL\",\r\n \"ContactDetail\": \"API.CreateAdd@WebTest.com\"\r\n },\r\n {\r\n \"ContactTypeCode\": \"FAX\",\r\n \"ContactDetail\": \"0123654859\"\r\n },\r\n {\r\n \"ContactTypeCode\": \"HOME\",\r\n \"ContactDetail\": \"0124589632\"\r\n }\r\n ],\r\n \"Hierarchies\": [\r\n {\r\n \"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n \"HierarchyCode\": \"FINANCE\"\r\n },\r\n {\r\n \"HierarchyHeaderCode\": \"FACTION\",\r\n \"HierarchyCode\": \"CANDOR\"\r\n }\r\n ],\r\n \"GenericFields\": [\r\n {\r\n \"GenericfieldHeading\": \"Social Security Number\",\r\n \"GenericfieldType\": \"GenericStringField1\",\r\n \"GenericfieldValue\": \"ABC123\"\r\n },\r\n {\r\n \"GenericfieldHeading\": \"Secondary Employement\",\r\n \"GenericfieldType\": \"GenericBitField1\",\r\n \"GenericfieldValue\": \"true\"\r\n },\r\n {\r\n \"GenericfieldHeading\": \"User defined annual basic salary\",\r\n \"GenericfieldType\": \"GenericDecimalField1\",\r\n \"GenericfieldValue\": 150000.00\r\n },\r\n {\r\n \"GenericfieldHeading\": \"Staff Category\",\r\n \"GenericfieldType\": \"GenericLookupField1\",\r\n \"GenericfieldValue\": \"CANDOR\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee","description":"\n\nEntity Code - \"Null\" the system will then assign an Entity code on based on the next available entity code according to the system setup.
\n
\n\nEntityType and EntitySubType - Only Employee and Individual types allowed. Recruit, PSP, etc. will not be allowed.
\n
\n\nGender - Defaulted from TitleType selection, becomes mandatory where titles don't define gender.
\n
\n\nAdditional contact details will duplicate to the standard contact details if they are Blank/Null.
\n
\n\nOnly one of: \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.
\n
\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","employee"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"735bad9d-7598-42ed-b399-ea51ceef5482","name":"Create Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B142\",\r\n\t\"EntityCode\": \"API142\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxOffice\": \"PTA\",\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"ADV\",\r\n\t\"Gender\": \"M\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"1st Name\",\r\n\t\"LastName\": \"Surname\",\r\n\t\"SecondName\": \"2nd Name\",\r\n\t\"OtherNames\": \"Other Name\",\r\n\t\"KnownAsName\": \"Knwn as\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"2000/11/17\",\r\n\t\"BirthCertificateNumber\": \"Birth1234\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"True\",\r\n\t\"DisabilityType\": \"VISL\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"RaceGroup\": \"AFR\",\r\n\t\"IDNumber\": \"3409294800081\", \r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_ACB\",\r\n// Only one of \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"900000.0000\", \r\n//\t\"PeriodSalary\": \"33333.3333\",\r\n//\t\"RatePerDay\": \"321\",\r\n//\t\"RatePerHour\": \"123\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\",\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"TAO\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t//\"TerminationReasonCode\": \"EC\",\r\n\t//\"FinalCalcNow\": \"2\", // 1 - Current Period, 2 - Termination Period (if future date)\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"API_NewBatch@WebTest.com\",\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t\t\"UsePostal\": \"True\",\r\n\t\t\t\"UnitPostalNumber\": \"1204\",\r\n\t\t\t\"StreetNumber\": \"29\",\r\n\t\t\t\"StreetFarmName\": \"Long Street\",\r\n\t\t\t\"LevelFloor\": \"3\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\t\"UseWork\": \"True\",\r\n\t\t\t\t\"UsePhysical\": \"False\",\r\n\t\t\t\t\"UsePostal\": \"False\",\r\n\t\t\t\t\"CorrespondenceAddress\": \"False\",\r\n\t\t\t\t\"UnitPostalNumber\": \"Unt 1\",\r\n\t\t\t\t\"Complex\": \"Cmplx name\",\r\n\t\t\t\t\"LevelFloor\": \"12\",\r\n\t\t\t\t\"StreetNumber\": \"Str123\",\r\n\t\t\t\t\"StreetFarmName\": \"Str Name\",\r\n\t\t\t\t\"SuburbDistrict\": \"Suburb\",\r\n\t\t\t\t\"CityTown\": \"City\",\r\n\t\t\t\t\"Province\": \"Provinceeee\",\r\n\t\t\t\t\"PostalCode\": \"0011\",\r\n\t\t\t\t\"PostalAgency\": \"pst agency\",\r\n\t\t\t\t\"PostOffice\": \"pst office\",\r\n\t\t\t\t\"PostalAddressNumber\": \"pst adrs\",\r\n\t\t\t\t\"DistrictCode\": \"DST9\",\r\n\t\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t\t],\r\n\t\"DriversLicenses\": [\r\n\t\t\t{\r\n\t\t\t\t\"IssueDate\": \"2021/01/19 00:00:00\",\r\n\t\t\t\t\"ExpiryDate\": \"2022/12/22 00:00:00\",\r\n\t\t\t\t\"LicenseNumber\": \"lic65432\",\r\n\t\t\t\t\"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\r\n\t\t\t\t\"LicenseRestrictionsTypeCode\": \"LIC_REST_1\",\r\n\t\t\t\t\"CountryCode\": \"ASM\"\r\n\t\t\t}\r\n\t\t],\r\n\t\"Contacts\": [ //Additional Contact fields (If no main contact details provided these will be duplicated to the main contact as well)\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0826823789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"API.Create@WebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"FACTION\",\r\n\t\t\t\"HierarchyCode\": \"CANDOR\"\r\n\t\t}\r\n\t\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"102"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Fri, 19 Nov 2021 07:57:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Employee with Employee Code EMPAPI_B142 created successfully.\"\n}"},{"id":"25203143-a122-4abe-b7de-f07fe1e88a5b","name":"Fail - example response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B\",\r\n\t\"EntityCode\": \"API_1A\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"Full\",\r\n\t\"LastName\": \"Employee\",\r\n\t\"SecondName\": \"Full\",\r\n\t\"OtherNames\": \"Full\",\r\n\t\"KnownAsName\": \"Full\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"FALSE\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"IDNumber\": \"850920584400081\", //Male ID\r\n\t\"PassportNo\": \"1234567891012345\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n\t\"AnnualSalary\": \"25000.0000\",\r\n\t//\"PeriodSalary\": \"\",\r\n\t//\"RatePerDay\": \"300\",\r\n\t//\"RatePerHour\": \"10\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\", // Null = Defaults as per standard rules\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"john.doe@WebTest.com\",\r\n\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t\t\"UnitPostalNumber\": \"1204\",\r\n\t\t\t\"StreetNumber\": \"29\",\r\n\t\t\t\"StreetFarmName\": \"Long Street\",\r\n\t\t\t\"LevelFloor\": \"3\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\",\r\n\t\t\t\"UsePhysical\": true\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"DRV123466\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t}\r\n\t],\r\n\t\"Contacts\": [ //additional contact details?\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0826823789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"API.Create@WebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"2967"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 26 Oct 2021 13:29:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"businessRules\": [\n {\n \"PropertyName\": \"EmployeeStatusID\",\n \"PropertyFriendlyName\": \"Employee Status\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"Status cannot be : New. Payslip definitions are invalid or required for a New status.\"\n }\n ]\n },\n {\n \"PropertyName\": \"UIFStatusID\",\n \"PropertyFriendlyName\": \"UIF Status\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"UIF Status is required\"\n }\n ]\n },\n {\n \"PropertyName\": \"TaxStatusID\",\n \"PropertyFriendlyName\": \"Tax Status\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"TaxCalculation\",\n \"PropertyFriendlyName\": \"Tax Calculation\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"LeavePolicyID\",\n \"PropertyFriendlyName\": \"Leave Policy\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"BirthDate\",\n \"PropertyFriendlyName\": \"Birth Date\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"IDNumber\",\n \"PropertyFriendlyName\": \"IDNumber\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"RSA ID number invalid\"\n }\n ]\n },\n {\n \"PropertyName\": \"PassportNo\",\n \"PropertyFriendlyName\": \"Passport No\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"Passport No cannot exceed 15 characters\"\n }\n ]\n },\n {\n \"PropertyName\": \"AccountNo\",\n \"PropertyFriendlyName\": \"Account Number\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n },\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"AccountTypeID\",\n \"PropertyFriendlyName\": \"Account Type\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n },\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"BankID\",\n \"PropertyFriendlyName\": \"Bank\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n },\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n },\n {\n \"PropertyName\": \"BankBranchID\",\n \"PropertyFriendlyName\": \"Bank Branch\",\n \"ErrorRulesCollection\": [\n {\n \"Message\": \"This is a mandatory field\"\n },\n {\n \"Message\": \"This is a mandatory field\"\n }\n ]\n }\n ]\n}"},{"id":"0202a23d-2210-4e00-a3a4-352365ee910a","name":"Fail - Existing Entity with Same ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B3\",\r\n\t\"EntityCode\": \"API_A3\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\r\n\t\"TaxOffice\": \"PTA\", // Not working - bug logged\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"1st Name\",\r\n\t\"LastName\": \"Surname\",\r\n\t\"SecondName\": \"2nd Name\",\r\n\t\"OtherNames\": \"Other Name\",\r\n\t\"KnownAsName\": \"Knwn as\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"Birth1234\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"True\",\r\n\t\"DisabilityType\": \"VISL\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"RaceGroup\": \"AFR\",\r\n\t\"IDNumber\": \"3409294800081\", \r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n// Only one of \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"900000.0000\", \r\n//\t\"PeriodSalary\": \"33333.3333\",\r\n//\t\"RatePerDay\": \"321\",\r\n//\t\"RatePerHour\": \"123\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"MAN001\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\", // Null = Defaults as per standard rules\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"API_NewBatch@WebTest.com\",\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t//\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t//\t\"UsePostal\": \"True\",\r\n\t\t\t\"UnitPostalNumber\": \"1204\",\r\n\t\t\t\"StreetNumber\": \"29\",\r\n\t\t\t\"StreetFarmName\": \"Long Street\",\r\n\t\t\t\"LevelFloor\": \"3\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\"UseWork\": \"True\",\r\n\t\t\t//\"UsePhysical\": \"True\",\r\n\t\t\t//\"UsePostal\": \"True\",\r\n\t\t\t//\"AddressServiceType\": \"STREET\", // Not Working only the below is working\r\n\t\t\t//\"AddressServiceTypeCode\": \"STREET\", // Not Working only the below is working\r\n\t\t\t\"AddressServiceTypeID\": \"4\",\r\n\t\t\t\"UnitPostalNumber\": \"2222\",\r\n\t\t\t\"StreetNumber\": \"111\",\r\n\t\t\t\"StreetFarmName\": \"Postal Street\",\r\n\t\t\t\"LevelFloor\": \"22\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"DRV123466\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t}\r\n\t\t],\r\n\t/*\"Contacts\": [ //additional contact details?\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0826823789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"API.Create@WebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t\t],*/\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"FACTION\",\r\n\t\t\t\"HierarchyCode\": \"CANDOR\"\r\n\t\t}\r\n\t\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"62"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 09 Nov 2021 14:11:16 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Entity with same ID number already exists\"\n}"},{"id":"9d1646bc-c468-4328-9ae7-415ff75afdd5","name":"Fail - Company Rule on \"Stop All\"","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B3\",\r\n\t//\"EntityCode\": \"API3\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\r\n\t\"TaxOffice\": \"PTA\", // Not working - bug logged\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"1st Name\",\r\n\t\"LastName\": \"Surname\",\r\n\t\"SecondName\": \"2nd Name\",\r\n\t\"OtherNames\": \"Other Name\",\r\n\t\"KnownAsName\": \"Knwn as\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"Birth1234\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"True\",\r\n\t\"DisabilityType\": \"VISL\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"RaceGroup\": \"AFR\",\r\n\t\"IDNumber\": \"3409294800081\", \r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n// Only one of \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"900000.0000\", \r\n//\t\"PeriodSalary\": \"33333.3333\",\r\n//\t\"RatePerDay\": \"321\",\r\n//\t\"RatePerHour\": \"123\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"MAN001\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\", // Null = Defaults as per standard rules\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"API_NewBatch@WebTest.com\",\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t//\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t//\t\"UsePostal\": \"True\",\r\n\t\t\t\"UnitPostalNumber\": \"1204\",\r\n\t\t\t\"StreetNumber\": \"29\",\r\n\t\t\t\"StreetFarmName\": \"Long Street\",\r\n\t\t\t\"LevelFloor\": \"3\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\"UseWork\": \"True\",\r\n\t\t\t//\"UsePhysical\": \"True\",\r\n\t\t\t//\"UsePostal\": \"True\",\r\n\t\t\t//\"AddressServiceType\": \"STREET\", // Not Working only the below is working\r\n\t\t\t//\"AddressServiceTypeCode\": \"STREET\", // Not Working only the below is working\r\n\t\t\t\"AddressServiceTypeID\": \"4\",\r\n\t\t\t\"UnitPostalNumber\": \"2222\",\r\n\t\t\t\"StreetNumber\": \"111\",\r\n\t\t\t\"StreetFarmName\": \"Postal Street\",\r\n\t\t\t\"LevelFloor\": \"22\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"DRV123466\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t}\r\n\t\t],\r\n\t\"Contacts\": [ //additional contact details?\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0826823789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"API.Create@WebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"FACTION\",\r\n\t\t\t\"HierarchyCode\": \"CANDOR\"\r\n\t\t}\r\n\t\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"66"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 10 Nov 2021 06:37:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Pay Period Capture Status is set to Stop All.\"\n}"},{"id":"3649a5eb-6c9d-4d22-a527-e7f8f3653e18","name":"Fail - Pay Run Processed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B3\",\r\n\t//\"EntityCode\": \"API3\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxOffice\": \"PTA\", // Not working - bug logged\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"1st Name\",\r\n\t\"LastName\": \"Surname\",\r\n\t\"SecondName\": \"2nd Name\",\r\n\t\"OtherNames\": \"Other Name\",\r\n\t\"KnownAsName\": \"Knwn as\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"Birth1234\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"True\",\r\n\t\"DisabilityType\": \"VISL\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"RaceGroup\": \"AFR\",\r\n\t\"IDNumber\": \"3409294800081\", \r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n// Only one of \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"900000.0000\", \r\n//\t\"PeriodSalary\": \"33333.3333\",\r\n//\t\"RatePerDay\": \"321\",\r\n//\t\"RatePerHour\": \"123\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"MAN001\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\",\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"API_NewBatch@WebTest.com\",\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t//\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t//\t\"UsePostal\": \"True\",\r\n\t\t\t\"UnitPostalNumber\": \"1204\",\r\n\t\t\t\"StreetNumber\": \"29\",\r\n\t\t\t\"StreetFarmName\": \"Long Street\",\r\n\t\t\t\"LevelFloor\": \"3\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\"UseWork\": \"True\",\r\n\t\t\t//\"UsePhysical\": \"True\",\r\n\t\t\t//\"UsePostal\": \"True\",\r\n\t\t\t//\"AddressServiceType\": \"STREET\", // Not Working only the below is working\r\n\t\t\t//\"AddressServiceTypeCode\": \"STREET\", // Not Working only the below is working\r\n\t\t\t\"AddressServiceTypeID\": \"4\",\r\n\t\t\t\"UnitPostalNumber\": \"2222\",\r\n\t\t\t\"StreetNumber\": \"111\",\r\n\t\t\t\"StreetFarmName\": \"Postal Street\",\r\n\t\t\t\"LevelFloor\": \"22\",\r\n\t\t\t\"Complex\": \"Super Fun Complex\",\r\n\t\t\t\"CityTown\": \"Pretoria\",\r\n\t\t\t\"Province\": \"Gauteng\",\r\n\t\t\t\"PostalCode\": \"0156\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"DRV123466\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t}\r\n\t\t],\r\n\t\"Contacts\": [ //additional contact details?\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0826823789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"API.Create@WebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"FACTION\",\r\n\t\t\t\"HierarchyCode\": \"CANDOR\"\r\n\t\t}\r\n\t\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"107"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Thu, 11 Nov 2021 13:14:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Status cannot be : New. Payslip definitions are invalid or required for a New status.\"\n}"}],"_postman_id":"6643e1cd-13a0-4205-85d8-19708a02b437"},{"name":"Emp Batch - Update (PUT)","id":"ae1c38bc-d488-4cf6-bf65-5f1fed75d950","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CompanyCode\": \"SOUTHAFRICA\",\r\n \"CompanyRuleCode\": \"RSA\",\r\n \"EmployeeCode\": \"EMPAPI_B142\",\r\n //\"NewEmployeeCode\": \"M001\",\r\n \"EntityCode\": \"API_UP145\",\r\n \"GenEntityTypeCode\": \"INDV\",\r\n \"GenEntitySubTypeCode\": \"EMPL\",\r\n \"TaxNo\": \"1231239846\",\r\n \"TaxRegistrationDate\": \"2017/09/15\",\r\n \"TitleTypeCode\": \"MS\",\r\n \"Initials\": \"F\",\r\n \"FirstName\": \"New First\",\r\n \"LastName\": \"New Surname\",\r\n //\"SecondName\": \"\",\r\n \"OtherNames\": \"Updated\",\r\n \"KnownAsName\": \"Full\",\r\n \"MaritalStatusTypeCode\": \"MRD\",\r\n \"BirthDate\": \"1999/01/01\",\r\n \"BirthCertificateNumber\": \"\",\r\n \"CityOfBirth\": \"Pretoria\",\r\n \"CountryOfBirth\": \"ZAF\",\r\n \"Disabled\": \"FALSE\",\r\n \"EthnicTypeCode\": \"EU\",\r\n \"LanguageTypeCode\": \"ENG\",\r\n \"NationalityCountryCode\": \"ZAF\",\r\n \"RacialGroup\": \"W\",\r\n \"IDNumber\": \"3409294800081\",\r\n \"PassportNo\": \"123456789101234\",\r\n \"PassportCountryCode\": \"ZAF\",\r\n \"LeavePolicyCode\": \"SA_START\",\r\n \"LeaveStartDate\": \"2019/03/01\",\r\n \"RemunerationEarnDefCode\": \"SALARY\",\r\n \"PaymentRunDefCode\": \"SA_CASH\",\r\n // Only one of: \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n \"AnnualSalary\": \"25000.0000\",\r\n //\"PeriodSalary\": \"\",\r\n //\"RatePerDay\": \"300\",\r\n //\"RatePerHour\": \"10\",\r\n \"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n \"JobTitleTypeCode\": \"TEAMLEAD\",\r\n \"PrimaryPosition\": \"\",\r\n \"TaxStatusCode\": \"ST\",\r\n \"TaxCalculation\": \"A\",\r\n \"TaxStartDate\": \"2021/03/05\",\r\n \"NatureOfContractCode\": \"PERM\",\r\n \"ProbationPeriodEndDate\": \"2021/05/01\",\r\n \"ReligionCode\": \"\",\r\n \"BloodGroup\": \"O+\",\r\n \"DateEngaged\": \"2021/03/01\",\r\n \"DateJoinedGroup\": \"2021/03/01\",\r\n \"TerminationDate\": \"2021/12/31\",\r\n \"TerminationReasonCode\": \"EC\",\r\n \"FinalCalcNow\": \"2\",\r\n \"UIFStatusCode\": \"UIF\",\r\n \"UIFStartDate\": \"2021/03/01\",\r\n \"MedicalStartDate\": \"2019/03/01\",\r\n \"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n \"CalendarMonth\": \"12\",\r\n \"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n \"ForeignIncome\": \"TRUE\",\r\n \"HomeNumber\": \"0129911777\",\r\n \"WorkNumber\": \"0124207000\",\r\n \"FaxNumber\": \"0863334444\",\r\n \"CellNumber\": \"0811112233\",\r\n \"EmailAddress\": \"john.doe@WebTest.com\",\r\n \"Addresses\": [\r\n {\r\n \"AddressID\": \"147\", // No ID Provided will add new record\r\n \"UseWork\": \"True\",\r\n \"UsePhysical\": \"True\",\r\n \"UsePostal\": \"False\",\r\n \"CorrespondenceAddress\": \"False\",\r\n \"UnitPostalNumber\": \"Unt 1\",\r\n \"Complex\": \"Cmplx name\",\r\n \"LevelFloor\": \"12\",\r\n \"StreetNumber\": \"Str123\",\r\n \"StreetFarmName\": \"Str Name\",\r\n \"SuburbDistrict\": \"Suburb\",\r\n \"CityTown\": \"City\",\r\n \"Province\": \"Provinceeee\",\r\n \"PostalCode\": \"0011\",\r\n \"PostalAgency\": \"pst agency\",\r\n \"PostOffice\": \"pst office\",\r\n \"PostalAddressNumber\": \"pst adrs\",\r\n \"CareOf\": \"False\",\r\n \"CountryCode\": \"ZAF\"\r\n },\r\n {\r\n //\"AddressID\": \"78\", // No ID Provided will add new record\r\n \"UseWork\": \"False\",\r\n \"UsePhysical\": \"False\",\r\n \"UsePostal\": \"True\",\r\n \"AddressServiceTypeCode\": \"PO\",\r\n \"CorrespondenceAddress\": \"True\",\r\n \"SuburbDistrict\": \"pstal\",\r\n \"CityTown\": \"postal line\",\r\n \"Province\": \"pst prov\",\r\n \"PostalCode\": \"2211\",\r\n \"PostalAgency\": \"postal agency\",\r\n \"PostOffice\": \"post office\",\r\n \"PostalAddressNumber\": \"2nd addr\",\r\n \"OtherServiceType\": \"othr srvc tp111\",\r\n \"DistrictCode\": \"DST9\",\r\n \"CareOf\": \"False\",\r\n \"CountryCode\": \"ZAF\"\r\n }\r\n ],\r\n \"BankAccounts\": [ //Existing Bank Account details can not be updated for Auditing purposes, therefore only new records will be created. However, an existing record can be set to inactive when there are other bank records on the employee\r\n {\r\n //\"BankDetailID\": 23,\r\n \"AccountName\": \"Mrs E FULL\",\r\n \"AccountNo\": \"6249994975\",\r\n \"AccountTypeCode\": \"CA\",\r\n \"BankCode\": \"ABSA\",\r\n \"BankBranchCode\": \"632005\",\r\n \"DefaultInd\": true,\r\n \"Status\": \"A\"\r\n // A - Actvive\r\n // I - Inactive\r\n }\r\n ],\r\n \"DriversLicenses\": [\r\n {\r\n //\"DriversLicensesID\": \"63\", // No ID Provided will add new record\r\n \"DriversLicCountryCode\": \"ZAF\",\r\n \"IssueDate\": \"2016-10-10\",\r\n \"ExpiryDate\": \"2026-02-20\",\r\n \"LicenseNumber\": \"API_EDIT\",\r\n \"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\r\n \"LicenseRestrictionsTypeCode\": \"\"\r\n },\r\n {\r\n //\"DriversLicensesID\": \"27\", // No ID Provided will add new record\r\n \"DriversLicCountryCode\": \"ZAF\",\r\n \"IssueDate\": \"2021-10-10\",\r\n \"ExpiryDate\": \"2022-02-20\",\r\n \"LicenseNumber\": \"API_NEW\",\r\n \"LicenseCategoriesTypeCode\": \"\",\r\n \"LicenseRestrictionsTypeCode\": \"LIC_REST_1\"\r\n }\r\n ],\r\n \"Contacts\": [ //additional contact details\r\n {\r\n //\"ContactID\":\"113\", // No ID Provided, will add new record\r\n \"ContactTypeCode\": \"CELL\",\r\n \"ContactDetail\": \"0821234567\"\r\n },\r\n {\r\n //\"ContactID\":\"114\", // No ID Provided, will add new record\r\n \"ContactTypeCode\": \"HOME\",\r\n \"ContactDetail\": \"0124643789\"\r\n },\r\n {\r\n //\"ContactID\":\"115\", // No ID Provided, will add new record\r\n \"ContactTypeCode\": \"MAIL\",\r\n \"ContactDetail\": \"NewAdditional@mWebTest.com\"\r\n },\r\n {\r\n //\"ContactID\":\"116\", // No ID Provided, will add new record\r\n \"ContactTypeCode\": \"FAX\",\r\n \"ContactDetail\": \"0123654859\"\r\n },\r\n {\r\n //\"ContactID\":\"117\", // No ID Provided, will add new record\r\n \"ContactTypeCode\": \"HOME\",\r\n \"ContactDetail\": \"0124589632\"\r\n }\r\n ],\r\n \"Hierarchies\": [\r\n {\r\n \"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n \"HierarchyCode\": \"IT\"\r\n }\r\n ],\r\n \"GenericFields\": [\r\n {\r\n \"GenericfieldHeading\": \"Social Security Number\",\r\n \"GenericfieldType\": \"GenericStringField1\",\r\n \"GenericfieldValue\": \"ABC123\"\r\n },\r\n {\r\n \"GenericfieldHeading\": \"Secondary Employement\",\r\n \"GenericfieldType\": \"GenericBitField1\",\r\n \"GenericfieldValue\": \"true\"\r\n },\r\n {\r\n \"GenericfieldHeading\": \"User defined annual basic salary\",\r\n \"GenericfieldType\": \"GenericDecimalField1\",\r\n \"GenericfieldValue\": 150000.00\r\n },\r\n {\r\n \"GenericfieldHeading\": \"Staff Category\",\r\n \"GenericfieldType\": \"GenericLookupField1\",\r\n \"GenericfieldValue\": \"CANDOR\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee/put","description":"\n\nAverage 3 - 5 seconds per call. Dependent on system setup, requirements, infrastructure, etc.
\nThe vast amount of rules and business logic applied will make this API slower than the standard.
\n
\n\n\"SecondName\": \"\",
\n\n
\n- field active with no data, will clear/delete the existing data from the Employee or Entity Record.
\n
\n\n//\"OtherNames\": \"Full\",
\n\n
\n- Field not sent or commented out will not replace / override any data.
\n
To be safe, Do Not include any fields that should not be updated in anyway.
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","employee","put"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"ec5b476a-13c9-464c-bcc6-28bf647ea595","name":"Fail - Emp Code and Company not correct","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B1\",\r\n\t\"EntityCode\": \"API_1A\", //null = system generates code\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"Full\",\r\n\t\"LastName\": \"Employee\",\r\n\t\"SecondName\": \"Full\",\r\n\t\"OtherNames\": \"Full\",\r\n\t\"KnownAsName\": \"Full\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"FALSE\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t//\"IDNumber\": \"85092058440081\", //Male ID\r\n\t//\"PassportNo\": \"1234567891012345\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\t\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n\t\"AnnualSalary\": \"25000.0000\",\r\n\t//\"PeriodSalary\": \"\",\r\n\t//\"RatePerDay\": \"300\",\r\n\t//\"RatePerHour\": \"10\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/01\", // Null = Defaults as per standard rules\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"john.doe@WebTest.com\",\r\n\r\n\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t\t\t\"AddressID\": \"1\",\r\n\t\t\t\t\"UseWork\": \"True\",\r\n\t\t\t\t\"UsePhysical\": \"True\",\r\n\t\t\t\t\"UsePostal\": \"False\",\r\n\t\t\t\t\"CorrespondenceAddress\": \"False\",\r\n\t\t\t\t\"UnitPostalNumber\": \"Unt 1\",\r\n\t\t\t\t\"Complex\": \"Cmplx name\",\r\n\t\t\t\t\"LevelFloor\": \"12\",\r\n\t\t\t\t\"StreetNumber\": \"Str123\",\r\n\t\t\t\t\"StreetFarmName\": \"Str Name\",\r\n\t\t\t\t\"SuburbDistrict\": \"Suburb\",\r\n\t\t\t\t\"CityTown\": \"City\",\r\n\t\t\t\t\"Province\": \"Provinceeee\",\r\n\t\t\t\t\"PostalCode\": \"0011\",\r\n\t\t\t\t\"PostalAgency\": \"pst agency\",\r\n\t\t\t\t\"PostOffice\": \"pst office\",\r\n\t\t\t\t\"PostalAddressNumber\": \"pst adrs\",\r\n\t\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"DRV123466\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t}\r\n\t],\r\n\t\"Contacts\": [ //additional contact details?\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0821234567\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"cfg@myemail.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee/put"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"95"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 17 Nov 2021 12:00:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Could not Resolve the EmployeeID from Employee Code and Company Rule Code.\"\n}"},{"id":"6dc69a91-0aeb-4de2-b109-929a6b0b6769","name":"Fail - Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B142\",\r\n\t\"EntityCode\": \"API_1A\",\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"Full\",\r\n\t\"LastName\": \"Employee\",\r\n\t\"SecondName\": \"\",\r\n\t\"OtherNames\": \"Full\",\r\n\t\"KnownAsName\": \"Full\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"FALSE\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"IDNumber\": \"3409294800081\",\r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n// Only one of: \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"25000.0000\",\r\n\t//\"PeriodSalary\": \"\",\r\n\t//\"RatePerDay\": \"300\",\r\n\t//\"RatePerHour\": \"10\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/05\",\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"john.doe@WebTest.com\",\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t\t//\"AddressID\": \"75\", // No ID Provided will add new record\r\n\t\t\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t\t\"UsePostal\": \"False\",\r\n\t\t\t\"CorrespondenceAddress\": \"False\",\r\n\t\t\t\"UnitPostalNumber\": \"Unt 1\",\r\n\t\t\t\"Complex\": \"Cmplx name\",\r\n\t\t\t\"LevelFloor\": \"12\",\r\n\t\t\t\"StreetNumber\": \"Str123\",\r\n\t\t\t\"StreetFarmName\": \"Str Name\",\r\n\t\t\t\"SuburbDistrict\": \"Suburb\",\r\n\t\t\t\"CityTown\": \"City\",\r\n\t\t\t\"Province\": \"Provinceeee\",\r\n\t\t\t\"PostalCode\": \"0011\",\r\n\t\t\t\"PostalAgency\": \"pst agency\",\r\n\t\t\t\"PostOffice\": \"pst office\",\r\n\t\t\t\"PostalAddressNumber\": \"pst adrs\",\r\n\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"AddressID\": \"78\", // No ID Provided will add new record\r\n\t\t\t\"UseWork\": \"False\",\r\n\t\t\t\"UsePhysical\": \"False\",\r\n\t\t\t\"UsePostal\": \"True\",\r\n\t\t\t\"AddressServiceTypeCode\": \"PO\",\r\n\t\t\t\"CorrespondenceAddress\": \"True\",\r\n\t\t\t\"SuburbDistrict\": \"pstal\",\r\n\t\t\t\"CityTown\": \"postal line\",\r\n\t\t\t\"Province\": \"pst prov\",\r\n\t\t\t\"PostalCode\": \"2211\",\r\n\t\t\t\"PostalAgency\": \"postal agency\",\r\n\t\t\t\"PostOffice\": \"post office\",\r\n\t\t\t\"PostalAddressNumber\": \"2nd addr\",\r\n\t\t\t\"OtherServiceType\": \"othr srvc tp111\",\r\n\t\t\t\"DistrictCode\": \"DST9\",\r\n\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t//\"DriversLicensesID\": \"63\", // No ID Provided will add new record\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"API_EDIT\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"DriversLicensesID\": \"27\", // No ID Provided will add new record\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2021-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2022-02-20\",\r\n\t\t\t\"LicenseNumber\": \"API_NEW\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"LIC_REST_1\"\r\n\t\t}\r\n\t],\r\n\t\"Contacts\": [ //additional contact details\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"113\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0821234567\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"114\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"115\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"NewAdditional@mWebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"116\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"117\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee/put"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"68"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 23 Nov 2021 10:54:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"},{"id":"6f29b69f-c807-4daa-b173-10d2e8cbc359","name":"Update Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"EMPAPI_B142\",\r\n\t\"EntityCode\": \"API_1A\",\r\n\t\"GenEntityTypeCode\": \"INDV\",\r\n\t\"GenEntitySubTypeCode\": \"EMPL\",\r\n\t\"TaxNo\": \"1231239846\",\r\n\t\"TaxRegistrationDate\": \"2017/09/15\",\r\n\t\"TitleTypeCode\": \"MS\",\r\n\t\"Initials\": \"F\",\r\n\t\"FirstName\": \"Full\",\r\n\t\"LastName\": \"Employee\",\r\n\t\"SecondName\": \"\",\r\n\t\"OtherNames\": \"Full\",\r\n\t\"KnownAsName\": \"Full\",\r\n\t\"MaritalStatusTypeCode\": \"MRD\",\r\n\t\"BirthDate\": \"1999/01/01\",\r\n\t\"BirthCertificateNumber\": \"\",\r\n\t\"CityOfBirth\": \"Pretoria\",\r\n\t\"CountryOfBirth\": \"ZAF\",\r\n\t\"Disabled\": \"FALSE\",\r\n\t\"EthnicTypeCode\": \"EU\",\r\n\t\"LanguageTypeCode\": \"ENG\",\r\n\t\"NationalityCountryCode\": \"ZAF\",\r\n\t\"RacialGroup\": \"W\",\r\n\t\"IDNumber\": \"3409294800081\",\r\n\t\"PassportNo\": \"123456789101234\",\r\n\t\"PassportCountryCode\": \"ZAF\",\r\n\t\"LeavePolicyCode\": \"SA_START\",\r\n\t\"LeaveStartDate\": \"2019/03/01\",\r\n\t\"RemunerationEarnDefCode\": \"SALARY\",\r\n\t\"PaymentRunDefCode\": \"SA_CASH\",\r\n// Only one of: \"AnnualSalary\", \"PeriodSalary\", \"RatePerDay\" or \"RatePerHour\". The last used value will overwrite the other values when more than one is sent.\r\n\t\"AnnualSalary\": \"25000.0000\",\r\n\t//\"PeriodSalary\": \"\",\r\n\t//\"RatePerDay\": \"300\",\r\n\t//\"RatePerHour\": \"10\",\r\n\t\"JobGradeCode\": \"JOBGRADE_TIER1\",\r\n\t\"JobTitleTypeCode\": \"TEAMLEAD\",\r\n\t\"PrimaryPosition\": \"\",\r\n\t\"TaxStatusCode\": \"ST\",\r\n\t\"TaxCalculation\": \"A\",\r\n\t\"TaxStartDate\": \"2021/03/05\",\r\n\t\"NatureOfContractCode\": \"PERM\",\r\n\t\"ProbationPeriodEndDate\": \"2021/05/01\",\r\n\t\"ReligionCode\": \"\",\r\n\t\"BloodGroup\": \"O+\",\r\n\t\"DateEngaged\": \"2021/03/01\",\r\n\t\"DateJoinedGroup\": \"2021/03/01\",\r\n\t\"TerminationDate\": \"2021/12/31\",\r\n\t\"TerminationReasonCode\": \"EC\",\r\n\t\"FinalCalcNow\": \"2\",\r\n\t\"UIFStatusCode\": \"UIF\",\r\n\t\"UIFStartDate\": \"2021/03/01\",\r\n\t\"MedicalStartDate\": \"2019/03/01\",\r\n\t\"OverrideAnnualBonusCalcRecurrence\": \"FALSE\",\r\n\t\"CalendarMonth\": \"12\",\r\n\t\"LegallyRetiredforTaxPurpose\": \"TRUE\",\r\n\t\"ForeignIncome\": \"TRUE\",\r\n\t\"HomeNumber\": \"0129911739\",\r\n\t\"WorkNumber\": \"0124207000\",\r\n\t\"FaxNumber\": \"0863334444\",\r\n\t\"CellNumber\": \"0811112233\",\r\n\t\"EmailAddress\": \"john.doe@WebTest.com\",\r\n\t\"Addresses\": [\r\n\t\t{\r\n\t\t\t//\"AddressID\": \"75\", // No ID Provided will add new record\r\n\t\t\t\"UseWork\": \"True\",\r\n\t\t\t\"UsePhysical\": \"True\",\r\n\t\t\t\"UsePostal\": \"False\",\r\n\t\t\t\"CorrespondenceAddress\": \"False\",\r\n\t\t\t\"UnitPostalNumber\": \"Unt 1\",\r\n\t\t\t\"Complex\": \"Cmplx name\",\r\n\t\t\t\"LevelFloor\": \"12\",\r\n\t\t\t\"StreetNumber\": \"Str123\",\r\n\t\t\t\"StreetFarmName\": \"Str Name\",\r\n\t\t\t\"SuburbDistrict\": \"Suburb\",\r\n\t\t\t\"CityTown\": \"City\",\r\n\t\t\t\"Province\": \"Provinceeee\",\r\n\t\t\t\"PostalCode\": \"0011\",\r\n\t\t\t\"PostalAgency\": \"pst agency\",\r\n\t\t\t\"PostOffice\": \"pst office\",\r\n\t\t\t\"PostalAddressNumber\": \"pst adrs\",\r\n\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"AddressID\": \"78\", // No ID Provided will add new record\r\n\t\t\t\"UseWork\": \"False\",\r\n\t\t\t\"UsePhysical\": \"False\",\r\n\t\t\t\"UsePostal\": \"True\",\r\n\t\t\t\"AddressServiceTypeCode\": \"PO\",\r\n\t\t\t\"CorrespondenceAddress\": \"True\",\r\n\t\t\t\"SuburbDistrict\": \"pstal\",\r\n\t\t\t\"CityTown\": \"postal line\",\r\n\t\t\t\"Province\": \"pst prov\",\r\n\t\t\t\"PostalCode\": \"2211\",\r\n\t\t\t\"PostalAgency\": \"postal agency\",\r\n\t\t\t\"PostOffice\": \"post office\",\r\n\t\t\t\"PostalAddressNumber\": \"2nd addr\",\r\n\t\t\t\"OtherServiceType\": \"othr srvc tp111\",\r\n\t\t\t\"DistrictCode\": \"DST9\",\r\n\t\t\t\"CareOf\": \"False\",\r\n\t\t\t\"CountryCode\": \"ZAF\"\r\n\t\t}\r\n\t],\r\n\t\"BankAccounts\": [\r\n\t\t{\r\n\t\t\t\"AccountName\": \"Mrs E FULL\",\r\n\t\t\t\"AccountNo\": \"6249994975\",\r\n\t\t\t\"AccountTypeCode\": \"CA\",\r\n\t\t\t\"BankCode\": \"ABSA\",\r\n\t\t\t\"BankBranchCode\": \"632005\",\r\n\t\t\t\"DefaultInd\": true\r\n\t\t}\r\n\t],\r\n\t\"DriversLicenses\": [\r\n\t\t{\r\n\t\t\t//\"DriversLicensesID\": \"63\", // No ID Provided will add new record\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2016-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2026-02-20\",\r\n\t\t\t\"LicenseNumber\": \"API_EDIT\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"LIC_CAT1\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"DriversLicensesID\": \"27\", // No ID Provided will add new record\r\n\t\t\t\"DriversLicCountryCode\": \"ZAF\",\r\n\t\t\t\"IssueDate\": \"2021-10-10\",\r\n\t\t\t\"ExpiryDate\": \"2022-02-20\",\r\n\t\t\t\"LicenseNumber\": \"API_NEW\",\r\n\t\t\t\"LicenseCategoriesTypeCode\": \"\",\r\n\t\t\t\"LicenseRestrictionsTypeCode\": \"LIC_REST_1\"\r\n\t\t}\r\n\t],\r\n\t\"Contacts\": [ //additional contact details\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"113\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"CELL\",\r\n\t\t\t\"ContactDetail\": \"0821234567\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"114\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124643789\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"115\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"MAIL\",\r\n\t\t\t\"ContactDetail\": \"NewAdditional@mWebTest.com\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"116\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"FAX\",\r\n\t\t\t\"ContactDetail\": \"0123654859\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t//\"ContactID\":\"117\", // No ID Provided, will add new record\r\n\t\t\t\"ContactTypeCode\": \"HOME\",\r\n\t\t\t\"ContactDetail\": \"0124589632\"\r\n\t\t}\r\n\t],\r\n\t\"Hierarchies\": [\r\n\t\t{\r\n\t\t\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t\t\t\"HierarchyCode\": \"IT\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/employee/put"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"102"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 23 Nov 2021 10:55:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Employee with Employee Code EMPAPI_B142 updated successfully.\"\n}"}],"_postman_id":"ae1c38bc-d488-4cf6-bf65-5f1fed75d950"}],"id":"ca186c3b-636e-4721-867d-ac3aab348bd9","description":"\n\nAverage 3 - 5 seconds per call. Dependent on system setup, requirements, infrastructure, Payload sent, etc.
\nThe vast amount of rules and business logic applied will make this API slower than the standard.
\n
These API's no longer follow the previously used methods of creating a Header then a Line item and then the final process steps of Validation and Process, this is a true direct API. Only 1 employee record per API call is allowed.
\nThe Employee Takeon consists of 3 API's, each API has it's own rules and logic which is described on each API call.
\nEmployee Batch API:
\nCreate - (POST)
\nUpdate - (PUT)
\nGET - By EmployeeID
GET - Using Company Rule and Employee ID Number
GET - Using Company Rule and Employee Code
There is a multitude of business logic behind the Employee Create and Update process. The API will have different requirements depending on the system configuration. The system setup influences what data is mandatory and which is not. For full details refer to the Sage 300 People system documentation on New Employee.
\n\n\n<h2 >Note:</h2><p >All API calls follow the Method = POST</p>
\n
Additional fields and functionality has been added to allow for the following requirements:
\n\"NewEmployeeCode\" has been added to the Update functionality. This will allow the employee code to be changed through the API. The Original Employee Code or Employee ID is still required as the identification factor to determine the correct record to update.
\n\"BankDetailID\" and \"Status\" has been added to the Update functionality. This will allow the employee bank details to be set to either \"A - Active\" or \"I - Inactive\" for existing records.
\n\"ExistingEntityOverride\" has been added to the Create New Employee fucntionality as to allow a new Employee Record to be linked to an existing entity Record.
\nAn additional fields have been added to cater for the Generic Fields used in Africa country setups.
\npublic class GetFullEmployeeDTO\n{\n// Employee\npublic string EmployeeCode { get; set; }\npublic string CompanyCode { get; set; }\npublic DateTime? DateEngaged { get; set; }\npublic string TaxBranchCode { get; set; }\npublic string UIFStatusCode { get; set; }\npublic DateTime? UIFStartDate { get; set; }\npublic string JobTitleTypeCode { get; set; }\npublic string JobGradeCode { get; set; }\npublic DateTime? TerminationDate { get; set; }\npublic string TerminationReasonCode { get; set; }\npublic int? FinalCalcNow { get; set; }\npublic DateTime? DateJoinedGroup { get; set; }\npublic DateTime? LeaveStartDate { get; set; }\npublic string NatureOfContractCode { get; set; }\npublic DateTime? ProbationPeriodEndDate { get; set; }\n// GenEntity\npublic string EntityCode { get; set; }\npublic string GenEntityTypeCode { get; set; }\npublic string GenEntitySubTypeCode { get; set; }\npublic string CompanyName { get; set; }\npublic string TaxNo { get; set; }\npublic string TaxOffice { get; set; }\npublic DateTime? TaxRegistrationDate { get; set; }\npublic string TitleTypeCode { get; set; }\npublic string Initials { get; set; }\npublic string FirstName { get; set; }\npublic string SecondName { get; set; }\npublic string OtherNames { get; set; }\npublic string KnownAsName { get; set; }\npublic string LastName { get; set; }\npublic string MaidenName { get; set; }\npublic string ArabicFullName { get; set; }\npublic string MaritalStatusTypeCode { get; set; }\npublic string IdentityTypeCode { get; set; }\npublic string IDNumber { get; set; }\npublic DateTime? BirthDate { get; set; }\npublic string BirthCertificateNumber { get; set; }\npublic string CityOfBirth { get; set; }\npublic string Gender { get; set; }\npublic string LanguageTypeCode { get; set; }\npublic string NationalityCountryCode { get; set; }\npublic string CountryOfBirth { get; set; }\npublic string PassportNo { get; set; }\npublic string PassportCountryCode { get; set; }\npublic bool? Disabled { get; set; }\npublic string DisabilityTypeCode { get; set; }\npublic string EthnicTypeCode { get; set; }\npublic string RacialGroup { get; set; }\npublic string RaceGroupCode { get; set; }\npublic string ReligionCode { get; set; }\npublic string BloodGroup { get; set; }\npublic string HomeNumber { get; set; }\npublic string WorkNumber { get; set; }\npublic string FaxNumber { get; set; }\npublic string CellNumber { get; set; }\npublic string EmailAddress { get; set; }\n// Employee Rule\npublic string CompanyRuleCode { get; set; }\npublic decimal? HoursPerPeriod { get; set; }\npublic decimal? HoursPerDay { get; set; }\npublic decimal? AnnualSalary { get; set; }\npublic decimal? PeriodSalary { get; set; }\npublic bool? OverrideAnnualBonusCalcRecurrence { get; set; }\npublic int? CalendarMonth { get; set; }\npublic string PeriodInMonth { get; set; }\npublic int? DefaultShiftsPerPeriod { get; set; }\npublic decimal? RatePerDay { get; set; }\npublic decimal? RatePerHour { get; set; }\npublic DateTime? PensionFundStartDate { get; set; }\npublic DateTime? ProvidentFundStartDate { get; set; }\npublic string ZoneCodes { get; set; }\npublic string IncreaseReasonTypeCode { get; set; }\npublic DateTime? MedicalStartDate { get; set; }\npublic string RemunerationDefinitionHeaderCode { get; set; }\n//singapore\npublic string CPFVoluntaryPolicyCode { get; set; }\npublic string SocialSecurityFundTypeCode { get; set; }\npublic bool? SDLExempt { get; set; }\n// Employee Tax\npublic bool? LegallyRetiredforTaxPurpose { get; set; }\npublic bool? ForeignIncome { get; set; }\npublic string TaxStatusCode { get; set; }\npublic DateTime? TaxStartDate { get; set; }\npublic string TaxCalculation { get; set; }\npublic string DirectiveNumber { get; set; }\npublic decimal? DirectivePercentage { get; set; }\npublic decimal? DirectiveTaxAmount { get; set; }\npublic decimal? DeemedRemuneration { get; set; }\npublic string UseTaxValue1 { get; set; }\npublic string UseTaxValue2 { get; set; }\n// Employee Leave\npublic string LeavePolicyCode { get; set; }\n// Payslip Definition\npublic string PaymentRunDefCode { get; set; }\npublic string RemunerationEarnDefCode { get; set; }\n// Employee FWL\npublic string FWLPolicyCode { get; set; }\npublic DateTime? EffectiveDate { get; set; }\npublic DateTime? FWLExpiryDate { get; set; }\npublic string PermitNumber { get; set; }\npublic DateTime? CancellationDate { get; set; }\npublic DateTime? FWLIssueDate { get; set; }\npublic DateTime? ArrivalDate { get; set; }\npublic DateTime? ApplicationDate { get; set; }\n// Employee Indonesia Report Fields\npublic string RTNumber { get; set; }\npublic string RWNumber { get; set; }\npublic string KartuKeluargaNumber { get; set; }\npublic string HealthFacilityCode { get; set; }\npublic string BPJSPensionNumber { get; set; }\npublic string JPKNumber { get; set; }\npublic string KPJNumber { get; set; }\npublic string EmploymentStatusCode { get; set; }\npublic bool? BPJSKesehatan { get; set; }\npublic bool? GovernmentAssistance { get; set; }\n// Lists\npublic List\n\nThe Employee Header has multiple types that cater for different requirements, therefore treating the sent data in different ways.
\n\n\nWill only create new records, if an existing Entity or Employee code is found then the API will fail for the given record.
\n
\n\nIf an existing Entity or Employee code is not found then the API will create a New Record.\nIf an existing Entity or Employee code is found then the API will Update the existing record with Override All.
\n
\n\nOnly applies to existing records. Will override all existing data with the data sent. \nExisting data can also be overridden with 'null' values.
\n
\n\nOnly applies to existing records. Will override all existing data with the data sent where fields are Not 'null'.
\n
IE: Create only URL\nhttp://{{HostName}}:{{APIPort}}/api/apibase/Header/EMPLOYEE/C\nCookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t\"EmployeeCode\": \"00001\",\r\n\t//\"HierarchyHeaderID\":\"2\",\r\n\t\"HierarchyHeaderCode\": \"DEPARTMENT\",\r\n\t//\"HierarchyID\":\"9\",\r\n\t\"HierarchyCode\": \"IT\"\r\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/H","description":"\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","H"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"920ae762-d527-41d0-af4f-4ac799596b33"},{"name":"Bank Detail - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APILineID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APILineID\", APILineID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"1ede68af-d800-458e-bf9a-277c295024a8"}}],"id":"e60cab94-1107-46da-a2be-e9dace029038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Note
\nHierarchy Line doesn't allow for multiple Hierarchy Items in a single request line. For multiple Hierarchy entries there will need to be multiple request lines.
\n
Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n //\"BankDetailID\": 23,\n \"CompanyRuleCode\": \"RSA\",\n \"EmployeeCode\": \"00003\",\n \"AccountHolderRelationship\": \"O\",\n \"AccountName\": \"Mr Mm Bank\",\n \"BankCode\": \"STDBANK\",\n \"AccountTypeCode\": \"CA\",\n \"AccountNo\": \"123654789\",\n \"BankBranchCode\": \"051001\",\n \"Ccy\": \"ZAR\",\n \"DefaultInd\": true,\n \"Status\": \"A\"\n // A - Actvive\n // I - Inactive\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/B","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","B"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e60cab94-1107-46da-a2be-e9dace029038"},{"name":"Address - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APILineID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APILineID\", APILineID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"3b20b249-fce7-4ceb-88d5-23f47246c311"}}],"id":"452ad52e-4bdd-487b-93fe-e444d5b6da08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"EmployeeCode\": \"00001\",\n \"CompanyRuleCode\": \"RSA\",\n \"UseWork\": true,\n \"UsePhysical\": true,\n \"UsePostal\": true,\n \"AddressServiceTypeCode\": \"STREET\",\n \"CorrespondenceAddress\": false,\n \"UnitPostalNumber\": \"1\",\n \"Complex\": \"Complex\",\n \"LevelFloor\": \"Level1\",\n \"Block\": \"Block - A\",\n \"StreetNumber\": \"2\",\n \"StreetFarmName\": \"Str 1\",\n \"SuburbDistrict\": \"Suburbia\",\n \"DistrictCode\": \"DST9\",\n \"CityTown\": \"CPT\",\n \"Province\": \"GP\",\n \"PostalCode\": \"1010\",\n \"PostalAgency\": null,\n \"PostalOffice\": null,\n \"PostalAddressNumber\": \"121\",\n \"OtherServiceType\": \"null\",\n \"CareOf\": false,\n \"CareOfName\": null,\n \"CountryCode\": \"ZAF\"\n}\n"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/A","description":"Add API Line
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","A"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"452ad52e-4bdd-487b-93fe-e444d5b6da08"},{"name":"Drivers License - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APILineID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APILineID\", APILineID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"0a737e5f-6e46-4ba0-8c20-ac7de01e263e"}}],"id":"8c906ba3-3a8b-43e5-a213-472d275d0fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"EmployeeCode\":\"00001\",\r\n\t\"CompanyRuleCode\":\"RSA\",\r\n\t\"DriversLicCountryCode\":\"ZAF\",\r\n\t\"IssueDate\":\"2010-10-10\",\r\n\t\"ExpiryDate\":\"2020-02-20\",\r\n\t\"LicenseNumber\":\"DRV123456\",\r\n\t\"LicenseCategoriesTypeCode\":\"TRK\",\r\n\t\"LicenseRestrictionsTypeCode\":\"FUEL\"\r\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/D","description":"Add API Line
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","D"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c906ba3-3a8b-43e5-a213-472d275d0fa8"},{"name":"Contacts - Line","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APILineID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APILineID\", APILineID);\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"37e32691-b30b-4b8a-abb0-0ebd99d6fb85"}}],"id":"09d03f85-edac-411d-9f2e-30e23502bf74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"EmployeeCode\":\"00001\",\r\n\t\"CompanyRuleCode\":\"RSA\",\r\n\t\"ContactTypeCode\":\"ADD_CELL\",\r\n\t\"ContactDetail\":\"0821234567\"\r\n}\r\n"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/C","description":"Add API Line
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","C"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09d03f85-edac-411d-9f2e-30e23502bf74"},{"name":"Generic Fields - Line","event":[{"listen":"test","script":{"id":"69d1a4e5-d6f2-40b7-bc39-80ad5af0764d","exec":[""],"type":"text/javascript"}}],"id":"6c01732f-7b2b-4de0-afbe-fe6fc090d578","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Cookie Value
\n","key":"Cookie","type":"text","value":"{{cookie}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyCode\": \"MCS_TEST\",\r\n \"CompanyRuleCode\": \"RSA_M\",\r\n\t\"EmployeeCode\": \"EMP_BDATE\",\r\n \"GenericFields\": \r\n [\r\n { \r\n \"GenericfieldHeading\": \"Social Security Number\", //GenericFieldSetup.FriendlyName Not Required but there for user visibility \r\n \"GenericfieldType\": \"GenericStringField1\", //GenericFieldSetup.GenericFieldNameID \r\n \"GenericfieldValue\": \"12345\" //Actual Data - Required \r\n }, \r\n { \r\n \"GenericfieldHeading\": \"Secondary Employement\", //GenericFieldSetup.FriendlyName Not Required but there for user visibility \r\n \"GenericfieldType\": \"GenericBitField1\", //GenericFieldSetup.GenericFieldNameID \r\n \"GenericfieldValue\": \"true\" //Actual Data - Required \r\n },\r\n { \r\n \"GenericfieldHeading\": \"User defined annual basic salary\", //GenericFieldSetup.FriendlyName Not Required but there for user visibility \r\n \"GenericfieldType\": \"GenericDecimalField1\", //GenericFieldSetup.GenericFieldNameID \r\n \"GenericfieldValue\": 150000.00 //Actual Data - Required \r\n },\r\n { \r\n \"GenericfieldHeading\": \"Staff Category\", //GenericFieldSetup.FriendlyName Not Required but there for user visibility \r\n \"GenericfieldType\": \"GenericLookupField1\", //GenericFieldSetup.GenericFieldNameID \r\n \"GenericfieldValue\": \"AMITY\" //Actual Data - Required \r\n }\r\n ]\r\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/F","description":"Generic Fields as defined in the Sage 300 People system can be created or updated using this Line Item.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}","F"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c01732f-7b2b-4de0-afbe-fe6fc090d578"}],"id":"2825e638-1aed-4c95-9239-ec575acee5c1","description":"The Employee Header type allows for different models to be used. Each model requires an existing Header and will create its own Line. E.g. updating an employee’s Contact information and Bank Details will be two separate Lines and cannot be nested in the same Line request.
\nIt is allowed to have multiple Line Items in a single Header Record, keep in mind that the validation and processing will take longer and each line item will have to be validated against all business rules required.
\nThere is a multitude of business logic behind the Employee Create and Update process. The Header Type as well as Line Types have different requirements. The system setup influences what data is mandatory and which is not. For full details refer to the Sage 300 People system documentation on New Employee.
\nLine Types available for Employee API:
\n\n\nLine Types must be defined in the URL for the required Line data.
\n
IE: Employee only Line URL\nhttp://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}/E\n\nAn additional field for \"NewEmployeeCode\" has been added to the Update functionality. This will allow the employee code to be changed through the API. The Original Employee Code or Employee ID is still required as the identification factor to determine the correct record to update.
\nAn additional field for “ExistingEntityOverride”: true / false has been added to the API functionality. This will check if the Entity details needs to be created as new or update an existing record.
\nIf True the following will happen with validation and processing:
\nThe payload only needs to specify, the Entity Code together will all employee related fields in the body, and the system will check if the entity code exist in the database and link the employee record to the existing entity record.
\nIf the entity code does not exist an error will be returned to indicate Entity Code does not exist.
\nIf the payload specifies to link to an existing entity record, no entity data is required to be specified in the body.
\nIf there is entity related data specified in thepayload the existing entity details will be overwritten with the details specified in the API. This will also be Indicated in the results: Warning; existing entity data will be overwritten with specified details.
\nIf False
\nIf no property is indicated
\nAn additional Line Type has been added to cater for the Generic Fields used in Africa country setups.
\npublic class EmployeeTakeOnModel : APIBaseModel\n{\npublic GenEntityModel GenEntity{get;set;}\npublic EmployeeModel Employee{get;set;}\npublic EmployeeRuleModel EmployeeRule {get;set;}\npublic EmployeeTaxModel EmployeeTax {get;set;}\npublic EmployeeLeavePolicyModel EmployeeLeavePolicy {get;set;}\npublic PayslipDefModel PayslipDef {get;set;}\npublic EmployeeFWLModel EmployeeFWL {get;set;}\npublic EmployeeIndonesiaReportFieldsModel EmployeeIndonesiaReportFieldsModel { get;set;\n}\npublic class GenEntityModel\n{\npublic int? GenEntityID { get; set; }\npublic string EntityCode { get; set; }\npublic int? GenEntityTypeID { get; set; }\npublic string GenEntityTypeCode { get; set; }\npublic int? GenEntitySubTypeID { get; set; }\npublic string GenEntitySubTypeCode { get; set; }\npublic string CompanyName { get; set; }\npublic string TaxNo { get; set; }\npublic DateTime? TaxRegistrationDate { get; set; }\npublic string VATNo { get; set; }\npublic string CompanyRegistrationNo { get; set; }\npublic DateTime? CompanyRegistrationDate { get; set; }\npublic int? TitleTypeID { get; set; }\npublic string TitleTypeCode { get; set; }\npublic string Initials { get; set; }\npublic string FirstName { get; set; }\npublic string SecondName { get; set; }\npublic string OtherNames { get; set; }\npublic string KnownAsName { get; set; }\npublic string LastName { get; set; }\npublic string MaidenName { get; set; }\npublic string ArabicFullName { get; set; }\npublic int? MaritalStatusTypeID { get; set; }\npublic string MaritalStatusTypeCode { get; set; }\npublic int? IdentityTypeID { get; set; }\npublic string IdentityTypeCode { get; set; }\npublic string IDNumber { get; set; }\npublic DateTime? IDNumberExpiryDate { get; set; }\npublic DateTime? BirthDate { get; set; }\npublic string BirthCertificateNumber { get; set; }\npublic string CityOfBirth { get; set; }\npublic string Gender { get; set; }\npublic int? LanguageTypeID { get; set; }\npublic string LanguageTypeCode { get; set; }\npublic string NationalityCountryCode { get; set; }\npublic string CountryOfBirth { get; set; }\npublic string PassportNo { get; set; }\npublic string PassportCountryCode { get; set; }\npublic bool? Disabled { get; set; }\npublic int? DisabilityTypeID { get; set; }\npublic string DisabilityTypeCode { get; set; }\npublic int? EthnicTypeID { get; set; }\npublic string EthnicTypeCode { get; set; }\npublic string RacialGroup { get; set; }\npublic int? RaceGroupID { get; set; }\npublic string RaceGroupCode { get; set; }\npublic int? ReligionID { get; set; }\npublic string ReligionCode { get; set; }\npublic string BloodGroup { get; set; }\npublic string HomeNumber { get; set; }\npublic string WorkNumber { get; set; }\npublic string FaxNumber { get; set; }\npublic string CellNumber { get; set; }\npublic string EmailAddress { get; set; }\n}\npublic class EmployeeModel \n{\npublic int? EmployeeID { get; set; }\npublic string EmployeeCode { get; set; }\npublic int? CompanyID { get; set; }\npublic string CompanyCode { get; set; }\npublic DateTime? DateEngaged { get; set; }\npublic int? TaxBranchID { get; set; }\npublic string TaxBranchCode { get; set; }\npublic int? UIFStatusID { get; set; }\npublic string UIFStatusCode { get; set; }\npublic DateTime? UIFStartDate { get; set; }\npublic int? JobTitleTypeID { get; set; }\npublic string JobTitleTypeCode { get; set; }\npublic int? JobGradeID { get; set; }\npublic string JobGradeCode { get; set; }\npublic DateTime? TerminationDate { get; set; }\npublic int? TerminationReasonID { get; set; }\npublic string TerminationReasonCode { get; set; }\npublic int? FinalCalcNow { get; set; }\npublic DateTime? DateJoinedGroup { get; set; }\npublic DateTime? LeaveStartDate { get; set; }\npublic int? NatureOfContractID { get; set; }\npublic string NatureOfContractCode { get; set; }\npublic DateTime? ProbationPeriodEndDate { get; set; }\n}\npublic class EmployeeRuleModel\n{\npublic int? CompanyRuleID { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic decimal? HoursPerPeriod { get; set; }\npublic decimal? HoursPerDay { get; set; }\npublic decimal? AnnualSalary { get; set; }\npublic decimal? PeriodSalary { get; set; }\npublic bool? OverrideAnnualBonusCalcRecurrence { get; set; }\npublic int? CalendarMonth { get; set; }\npublic string PeriodInMonth { get; set; }\npublic int? DefaultShiftsPerPeriod { get; set; }\npublic decimal? RatePerDay { get; set; }\npublic decimal? RatePerHour { get; set; }\npublic DateTime? PensionFundStartDate { get; set; }\npublic DateTime? ProvidentFundStartDate { get; set; }\npublic string ZoneCodes { get; set; }\npublic int? IncreaseReasonTypeID { get; set; }\npublic string IncreaseReasonTypeCode { get; set; }\npublic DateTime? MedicalStartDate { get; set; }\npublic int? RemunerationDefinitionHeaderID { get; set; }\npublic string RemunerationDefinitionHeaderCode { get; set; }\n//singapore specific fields:\npublic int? CPFVoluntaryPolicyID { get; set; }\npublic string CPFVoluntaryPolicyCode { get; set; }\npublic int? SocialSecurityFundTypeID { get; set; }\npublic string SocialSecurityFundTypeCode { get; set; }\npublic bool? SDLExempt { get; set; }\n}\npublic class EmployeeTaxModel\n{\npublic bool? LegallyRetiredforTaxPurpose { get; set; }\npublic bool? ForeignIncome { get; set; }\npublic int? TaxStatusID { get; set; }\npublic string TaxStatusCode { get; set; }\npublic DateTime? TaxStartDate { get; set; }\npublic string TaxCalculation { get; set; }\npublic string DirectiveNumber { get; set; }\npublic decimal? DirectivePercentage { get; set; }\npublic decimal? DirectiveTaxAmount { get; set; }\npublic decimal? DeemedRemuneration { get; set; }\npublic string UseTaxValue1 { get; set; }\npublic string UseTaxValue2 { get; set; }\n}\npublic class EmployeeLeavePolicyModel\n{\npublic int? LeavePolicyID { get; set; }\npublic string LeavePolicyCode { get; set; }\n}\npublic class PayslipDefModel\n{\npublic int? PaymentRunDefID { get; set; }\npublic string PaymentRunDefCode { get; set; }\npublic int? RemunerationEarnDefID { get; set; }\npublic string RemunerationEarnDefCode { get; set; }\n}\npublic class EmployeeFWLModel\n{\npublic int? FWLPolicyID { get; set; }\npublic string FWLPolicyCode { get; set; }\npublic DateTime? EffectiveDate { get; set; }\npublic DateTime? FWLExpiryDate { get; set; }\npublic string PermitNumber { get; set; }\npublic DateTime? CancellationDate { get; set; }\npublic DateTime? FWLIssueDate { get; set; }\npublic DateTime? ArrivalDate { get; set; }\npublic DateTime? ApplicationDate { get; set; }\n}\npublic class EmployeeIndonesiaReportFieldsModel\n{\npublic string RTNumber { get; set; }\npublic string RWNumber { get; set; }\npublic string KartuKeluargaNumber { get; set; }\npublic int? HealthFacilityID { get; set; }\npublic string HealthFacilityCode { get; set; }\npublic string BPJSPensionNumber { get; set; }\npublic string JPKNumber { get; set; }\npublic string KPJNumber { get; set; }\npublic int? EmploymentStatusID { get; set; }\npublic string EmploymentStatusCode { get; set; }\npublic bool? BPJSKesehatan { get; set; }\npublic bool? GovernmentAssistance { get; set; }\n}\n\npublic class AddressModel\n{\n//Group Key\npublic string EmployeeCode { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic string CompanyCode { get; set; }\n//Values\npublic int? AddressID { get; set; }\npublic bool? UseWork { get; set; }\npublic bool? UsePhysical { get; set; }\npublic bool? UsePostal { get; set; }\npublic int? AddressServiceTypeID { get; set; }\npublic string AddressServiceTypeCode { get; set; }\npublic bool? CorrespondenceAddress { get; set; }\npublic string UnitPostalNumber { get; set; }\npublic string Complex { get; set; }\npublic string LevelFloor { get; set; }\npublic string Block { get; set; }\npublic string StreetNumber { get; set; }\npublic string StreetFarmName { get; set; }\npublic string SuburbDistrict { get; set; }\npublic int? DistrictID { get; set; }\npublic string DistrictCode { get; set; }\npublic string CityTown { get; set; }\npublic string Province { get; set; }\npublic string PostalCode { get; set; }\npublic string PostalAgency { get; set; }\npublic string PostalOffice { get; set; }\npublic string PostalAddressNumber { get; set; }\npublic string OtherServiceType { get; set; }\npublic bool? CareOf { get; set; }\npublic string CareOfName { get; set; }\npublic string CountryCode { get; set; }\n }\n\npublic class ContactModel \n{\n//Group Key\npublic string EmployeeCode { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic string CompanyCode { get; set; }\n//Values\npublic int? ContactID { get; set; } // Contact ID for Updating a Contact Line\npublic int ContactTypeID { get; set; } // Contact Type ([Entity].[Contact] Table)\npublic string ContactTypeCode { get; set; } // Contact Type Code:\npublic const int ContactTypeCode = 1 - HOME \npublic const int ContactTypeCode = 2 - WORK\npublic const int ContactTypeCode = 3 - FAX\npublic const int ContactTypeCode = 4 - CELL\npublic const int ContactTypeCode = 5 - MAIL\npublic string ContactDetail { get; set; } // Contact Detail eg. Actual Email Address, Cellphone Number, Etc. \n }\n\npublic class BankDetailModel\n{\n//Group Key\npublic string EmployeeCode { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic string CompanyCode { get; set; }\n//Values\npublic string AccountHolderRelationship { get; set; }\npublic string AccountName { get; set; }\npublic int BankID { get; set; }\npublic string BankCode { get; set; }\npublic int AccountTypeID { get; set; }\npublic string AccountTypeCode { get; set; }\npublic string AccountNo { get; set; }\npublic int BankBranchID { get; set; }\npublic string BankBranchCode { get; set; }\npublic string Ccy { get; set; }\npublic bool DefaultInd { get; set; }\npublic string CreditLineNumber { get; set; }\n}\n\npublic class DriversLicenseModel\n{\n//Group Key\npublic string EmployeeCode { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic string CompanyCode { get; set; }\n//Values\npublic int? DriversLicensesID { get; set; }\npublic DateTime? IssueDate { get; set; }\npublic DateTime? ExpiryDate { get; set; }\npublic string LicenseNumber { get; set; }\npublic int? LicenseCategoriesTypeID { get; set; }\npublic string LicenseCategoriesTypeCode { get; set; }\npublic int? LicenseRestrictionsTypeID { get; set; }\npublic string LicenseRestrictionsTypeCode { get; set; }\npublic string CountryCode { get; set; }\n}\n\npublic class EmployeeRuleHierarchyRelModel\n{\n//Group Key\npublic string EmployeeCode { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic string CompanyCode { get; set; }\n//Detail\npublic int HierarchyHeaderID { get; set; }\npublic string HierarchyHeaderCode { get; set; }\npublic int? HierarchyID { get; set; }\npublic string HierarchyCode { get; set; }\n }\n\n\n\nNote
\nBusiness rules need to be followed when reinstating an employee.
\n
For instance; Broken Service Periods, Previous Tax Year Termination, Effects of selected dates on Tax Records as well as Leave calculations, etc.
public class PayrollBaseModel : APIBaseModel\n{\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 People (Alternatively use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic int CompanyID { get; set; } // Company ID\npublic string CompanyCode { get; set; } // Company Code in Sage 300 People\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300 People\npublic class EmployeeReinstateModel : PayrollBaseModel\n{\npublic DateTime? DateEngaged { get; set; } // Date Engaged\npublic bool ReinstateWithOriginalDateEngaged { get; set; } // ReInstate with Original Date Engaged\npublic bool ReinstateWithNewDateEngaged { get; set; } // ReInstate with New Date Engaged\npublic bool KeepPreviousPayslipFixedValues { get; set; } // Keep Previous Payslip Fixed Values\npublic char CurrentPeriod { get; set; } // Current Period\npublic string ReferenceNumber { get; set; } // Reference Number\n}\n\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5889d6f2-6dfb-4c40-8aa8-0d6ae2811c42"},{"name":"Employee Permit - Line (Refugee)","event":[{"listen":"test","script":{"id":"d5e5a931-edb9-4b24-acb8-c1c73a29ca6b","exec":[" pm.test(\"Business Rules Validated\", function () {\r"," pm.expect(pm.response.text()).to.include(\"true\");\r","});"],"type":"text/javascript"}}],"id":"186691f7-762e-46f2-ad5b-ce245f24c8c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t//Employee Identifier fields:\n\t//\"EmployeeID\": 34,\n\t\"EmployeeCode\": \"00034\",\n\t//\"CompanyID\": 1,\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\n// Refugee Fields:\n\t\"RefugeePermit\": true,\n\t\"RefugeePermitNumber\": 222,\n\t\"RefugeePermitIssued\": \"2020/08/16\",\n\t\"RefugeePermitExpiry\": \"2021/08/16\",\n\t\"comment\": null\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","description":"Note
\nAn employee can have Asylum Details OR Refugee Details. User is not permitted to add details for both on one record.
\n
\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"186691f7-762e-46f2-ad5b-ce245f24c8c2"}],"id":"7a8825c2-e68f-4fab-ad5b-3650d9519bed","description":"Note
\nAn employee can have Asylum Details OR Refugee Details. User is not permitted to add details for both on one record.
\n
The Employee Permit API allows for a Create, Update as well as Delete for existing records. It is required to use separate Headers for each as the data sent is validated in different ways.
\nCreate
Will only create new records, if an existing record is found with the same code, then the API will fail for the given record.
Update
Will Update the specified record with Override.
Business Rules doesn't allow for \"Asylum Seeker Permit\" and \"Refugee Permit\", therefore the API will not allow for both the sections in the same call. Activating one of these selections will disable the other.
For instance; If Asylum Permit exists on the Employee record and data is sent for Refugee Permit, then the Asylum record will be made inactive and the data disabled.
\n\nNote
\n
public class EmployeePermitModel : APIBaseModel\n{\npublic int GenEntityID { get; set; } \npublic int EmployeeID { get; set; } // Employee ID in Sage 300 People (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300 People\npublic string CompanyCode { get; set; } // Company Code in Sage 300 People\npublic string CountryOfOriginCode { get; set; } // Country Of Origin Code\npublic string IssuingAuthority { get; set; } // Issuing Authority\npublic string PlaceOfIssue { get; set; } // Place Of Issue \npublic DateTime? PassportIssued { get; set; } // Passport Issue Date\npublic DateTime? PassportExpiry { get; set; } // Passport Expiry Date\npublic bool? WorkPermit { get; set; } // Work Permit\npublic string WorkPermitNumber { get; set; } // Work Permit Number\npublic int? WorkPermitTypeID { get; set; } // Work Permit Type ID\npublic DateTime? WorkPermitIssued { get; set; } // Work Permit Date Issued\npublic DateTime? WorkPermitExpiry { get; set; } // Work Permit Expiry Date\npublic bool? ResidencyPermit { get; set; } // Residency Permit\npublic string ResidencyPermitNumber { get; set; } // Residency Permit Number\npublic DateTime? ResidencyPermitIssued { get; set; } // Residency Permit Date Issued\npublic DateTime? ResidencyPermitExpiry { get; set; } // Residency Permit Expiry Date\npublic bool? AsylumSeekerPermit { get; set; } // Asylum Seeker Permit\npublic string AsylumSeekerPermitNumber { get; set; } // Asylum Seeker Permit Number\npublic DateTime? AsylumSeekerPermitIssued { get; set; } // Asylum Seeker Permit Issued Date\npublic DateTime? AsylumSeekerPermitExpiry { get; set; } // Asylum Seeker Permit Expiry Date\n// Asylum Seeker Permit OR Refugee Permit - Not Both\npublic bool? RefugeePermit { get; set; } // Refugee Permit \npublic string RefugeePermitNumber { get; set; } // Refugee Permit Number\npublic DateTime? RefugeePermitIssued { get; set; } // Refugee Permit Issued Date\npublic DateTime? RefugeePermitExpiry { get; set; } // Refugee Permit Expiry Date\npublic string Comment { get; set; } // Comment on given fields\n}\n\nThe training transaction API allows for a Create as well as Update existing records. It is required to use 2 separate Headers for each as the data sent is validated in different ways.
\nTRAINING/C - Create
Will only create new records, if an existing record is found with the same code, then the API will fail for the given record.
TRAINING/U - Update Existing
Will Update the specified record with Override.
\n\nNote
\nAPI allows for multiple entries for the Training Cost as well as Training Subject lists.
\n
Specifying an existing Training Subject Code or ID (subject already setup within Sage 300 People), the data will be populated from that setup and therefore no additional info is needed to be sent.
public class TrainingTransactionModel : APIBaseModel\n{\npublic int EmployeeTrainingID { get; set; } // For Update only - [EmployeeTransaction].[EmployeeTraining].[EmployeeTrainingID]\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string CompanyCode { get; set; } // Company Code in Sage 300\npublic int TrainingDictionaryID { get; set; } // Training Dictionary ID (Alternatively use TrainingDictionaryCode)\npublic string TrainingDictionaryCode { get; set; } // Training Dictionary Code\npublic string Description { get; set; } // Description\npublic int? TrainingScore { get; set; } // Training Score\npublic string Comment { get; set; } // Comment\npublic int? InterventionProviderID { get; set; } // Intervention Provider ID (Alternatively use InterventionProviderCode)\npublic string InterventionProviderCode { get; set; } // Intervention Provider Code\npublic int? InternalFacilitatorEmployeeID { get; set; } // Internal Facilitator Employee ID in Sage 300 (Alternatively Use InternalFacilitatorEmployeeCode + (InternalFacilitatorCompanyRuleCode or InternalFacilitatorCompanyCode))\npublic string InternalFacilitatorEmployeeCode { get; set; } // Internal Facilitator Employee Code\npublic string InternalFacilitatorCompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string InternalFacilitatorCompanyCode { get; set; } // Company Code in Sage 300\npublic int? ExternalFacilitatorID { get; set; } // External Facilitator ID (Alternatively use ExternalFacilitatorCode)\npublic string ExternalFacilitatorCode { get; set; } // External Facilitator Code\npublic int? InterventionResultID { get; set; } // Intervention Result ID (Alternatively use InterventionResultCode)\npublic string InterventionResultCode { get; set; } // Intervention Result Code\npublic DateTime? PlannedDate { get; set; } // Planned Date\npublic DateTime? AttendedDate { get; set; } // AttendedDate\npublic DateTime? AssessedDate { get; set; } // AssessedDate\npublic DateTime? CompletedDate { get; set; } // Completed Date\npublic DateTime? TrainingExpiryDate { get; set; } // Training Expiry Date\npublic int? ReasonNotCompletedID { get; set; } // Reason Not Completed ID (Alternatively use ReasonNotCompletedCode)\npublic string ReasonNotCompletedCode { get; set; } // Reason Not Completed Code\npublic int? AdditionalInformationID { get; set; } // Additional Information ID (Alternatively use AdditionalInformationCode)\npublic string AdditionalInformationCode { get; set; } // Additional Information Code\npublic bool? IsLinkDevelopmentPlan { get; set; } // Is Link Development Plan\npublic bool? RecordTrainingForEquity { get; set; } // Record Training For Equity\npublic bool? AchievedPreviously { get; set; } // Achieved Previously\npublic bool? RecognitionForPriorLearning { get; set; } // Recognition For Prior Learning\npublic decimal? DurationDays { get; set; } // Duration Days\npublic decimal? DurationHours { get; set; } // Duration Hours\npublic decimal? DirectCost { get; set; } // Direct Cost\npublic bool? IsFormalBursary { get; set; } // Is Formal Bursary\npublic bool? IsCompanySponsoredBursary { get; set; } // Is Company Sponsored Bursary\npublic decimal? InvestmentAmount { get; set; } // Investment Amount\npublic decimal? BuyOutAmount { get; set; } // BuyOutAmount\npublic DateTime? BursaryWorkBackDateFrom { get; set; } // Bursary Work Back Date From\npublic DateTime? BursaryWorkBackDateTo { get; set; } // Bursary Work Back Date To\npublic List TrainingCostList { get; set; } // Training Cost List\npublic List TrainingSubjectList { get; set; } // Training Cost List\npublic List Documents { get; set; } // Collection to Add Documents to the Leave Transaction(See DocumentsModel for Detailss)\n}\npublic class TrainingCostModel\n{\npublic int? EmployeeTrainingCostID { get; set; } // For Update only - [EmployeeTransaction].[EmployeeTrainingCostRel].[EmployeeTrainingCostRelID]\npublic int InterventionCostID { get; set; } // Intervention Cost ID (Alternatively use InterventionCostCode)\npublic string InterventionCostCode { get; set; } // Intervention Cost Code\npublic decimal? Cost { get; set; } // Cost\n}\npublic class TrainingSubjectModel\n{\npublic int? EmployeeTrainingSubjectID { get; set; } // For Update only - [EmployeeTransaction].[EmployeeTrainingSubject].[EmployeeTrainingSubjectID]\npublic int? InterventionSubjectDictionaryID { get; set; } // Intervention Subject DictionaryID (Alternatively use InterventionSubjectDictionaryCode)\npublic string InterventionSubjectDictionaryCode { get; set; } // Intervention Subject Dictionary Code\npublic string InterventionSubjectCode { get; set; } // Intervention Subject Code\npublic string InterventionSubjectShortDescription { get; set; } // Intervention Subject Short Description\npublic string InterventionSubjectLongDescription { get; set; } // Intervention Subject Long Description\npublic decimal? DirectCost { get; set; } // Direct Cost\npublic string InterventionDescription { get; set; } // Intervention Description\npublic string UnitStandardCode { get; set; } // Unit Standard Code\npublic string UnitStandardTitle { get; set; } // Unit Standard Title\npublic int? InterventionNQFLevelID { get; set; } // Intervention NQF LevelID (Alternatively use InterventionNQFLevelCode)\npublic string InterventionNQFLevelCode { get; set; } // InterventionNQFLevelCode\npublic int? InterventionLevelID { get; set; } // Intervention Level ID (Alternatively use InterventionLevelCode)\npublic string InterventionLevelCode { get; set; } // Intervention Level Code\npublic string AccreditationNumber { get; set; } // Accreditation Number\npublic int? NQFCredits { get; set; } // NQF Credits\npublic int? InformalCredits { get; set; } // Informal Credits\npublic int? InterventionLearningModeID { get; set; } // Intervention Learning Mode ID (Alternatively use InterventionLearningModeCode)\npublic string InterventionLearningModeCode { get; set; } // Intervention Learning Mode Code\npublic int? InterventionLearningDescriptionID { get; set; } // Intervention Learning Description ID (Alternatively use InterventionLearningDescriptionCode)\npublic string InterventionLearningDescriptionCode { get; set; } // Intervention Learning Description Code\npublic int? InterventionTypeOfLearningID { get; set; } // Intervention Type Of Learning ID (Alternatively use InterventionTypeOfLearningCode)\npublic string InterventionTypeOfLearningCode { get; set; } // Intervention Type Of Learning Code\npublic int? ResultID { get; set; } // ResultID ID (Alternatively use ResultCode)\npublic string ResultCode { get; set; } // Result Code\npublic int? Score { get; set; } // Score\npublic DateTime? DateCompleted { get; set; } // Date Completed\n}\n\nThe qualification transaction API allows for a Create as well as Update existing records. It is required to use 2 separate Headers for each as the data sent is validated in different ways.
\nQUALIFICATION - Create
Will only create new records, if an existing record is found with the same code, then the API will fail for the given record.
QUALIFICATION/U - Update Existing
Will Update the specified record with Override.
QUALIFICATION/D - Delete Existing
Will Delete the specified record.
\n\nNote
\n
public class QualificationTransactionModel : APIBaseModel\n{\npublic int EmployeeQualificationID { get; set; } // For Update / Delete only - [EmployeeTransaction].[EmployeeTraining].[EmployeeTrainingID]\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string CompanyCode { get; set; } // Company Code in Sage 300\npublic int QualificationDictionaryID { get; set; } // Qualification Dictionary ID (Alternatively use TrainingDictionaryCode)\npublic string QualificationDictionaryCode { get; set; } // Qualification Dictionary Code\npublic string Description { get; set; } // Description\npublic int? TrainingScore { get; set; } // Training Score\npublic string Comment { get; set; } // Comment\npublic int? InterventionProviderID { get; set; } // Intervention Provider ID (Alternatively use InterventionProviderCode)\npublic string InterventionProviderCode { get; set; } // Intervention Provider Code\npublic int? InternalFacilitatorEmployeeID { get; set; } // Internal Facilitator Employee ID in Sage 300 (Alternatively Use InternalFacilitatorEmployeeCode + (InternalFacilitatorCompanyRuleCode or InternalFacilitatorCompanyCode))\npublic string InternalFacilitatorEmployeeCode { get; set; } // Internal Facilitator Employee Code\npublic string InternalFacilitatorCompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string InternalFacilitatorCompanyCode { get; set; } // Company Code in Sage 300\npublic int? ExternalFacilitatorID { get; set; } // External Facilitator ID (Alternatively use ExternalFacilitatorCode)\npublic string ExternalFacilitatorCode { get; set; } // External Facilitator Code\npublic int? InterventionResultID { get; set; } // Intervention Result ID (Alternatively use InterventionResultCode)\npublic string InterventionResultCode { get; set; } // Intervention Result Code\npublic DateTime? PlannedDate { get; set; } // Planned Date\npublic DateTime? AttendedDate { get; set; } // AttendedDate\npublic DateTime? AssessedDate { get; set; } // AssessedDate\npublic DateTime? CompletedDate { get; set; } // Completed Date\npublic DateTime? TrainingExpiryDate { get; set; } // Training Expiry Date\npublic int? ReasonNotCompletedID { get; set; } // Reason Not Completed ID (Alternatively use ReasonNotCompletedCode)\npublic string ReasonNotCompletedCode { get; set; } // Reason Not Completed Code\npublic int? AdditionalInformationID { get; set; } // Additional Information ID (Alternatively use AdditionalInformationCode)\npublic string AdditionalInformationCode { get; set; } // Additional Information Code\npublic bool? IsLinkDevelopmentPlan { get; set; } // Is Link Development Plan\npublic bool? RecordQualificationForEquity { get; set; } // Record Qualification For Equity\npublic bool? AchievedPreviously { get; set; } // Achieved Previously\npublic bool? RecognitionForPriorLearning { get; set; } // Recognition For Prior Learning\npublic decimal? DurationDays { get; set; } // Duration Days\npublic decimal? DurationHours { get; set; } // Duration Hours\npublic decimal? DirectCost { get; set; } // Direct Cost\npublic bool? IsFormalBursary { get; set; } // Is Formal Bursary\npublic bool? IsCompanySponsoredBursary { get; set; } // Is Company Sponsored Bursary\npublic decimal? InvestmentAmount { get; set; } // Investment Amount\npublic decimal? BuyOutAmount { get; set; } // BuyOutAmount\npublic DateTime? BursaryWorkBackDateFrom { get; set; } // Bursary Work Back Date From\npublic DateTime? BursaryWorkBackDateTo { get; set; } // Bursary Work Back Date To\npublic List QualificationCostList { get; set; } // Qualification Cost List\npublic List QualificationSubjectList { get; set; } // Qualification Cost List\npublic class QualificationCostModel\n{\npublic int? EmployeeQualificationCostID { get; set; } // For Update only - [EmployeeTransaction].[EmployeeQualificationCostRel].[EmployeeQualificationCostRelID]\npublic int InterventionCostID { get; set; } // Intervention Cost ID (Alternatively use InterventionCostCode)\npublic string InterventionCostCode { get; set; } // Intervention Cost Code\npublic decimal? Cost { get; set; } // Cost\n}\npublic class QualificationSubjectModel\n{\npublic int? EmployeeQualificationSubjectID { get; set; } // For Update only - [EmployeeTransaction].[EmployeeQualificationSubject].[EmployeeQualificationSubjectID]\npublic int? InterventionSubjectDictionaryID { get; set; } // Intervention Subject DictionaryID (Alternatively use InterventionSubjectDictionaryCode)\npublic string InterventionSubjectDictionaryCode { get; set; } // Intervention Subject Dictionary Code\npublic string InterventionSubjectCode { get; set; } // Intervention Subject Code\npublic string InterventionSubjectShortDescription { get; set; } // Intervention Subject Short Description\npublic string InterventionSubjectLongDescription { get; set; } // Intervention Subject Long Description\npublic decimal? DirectCost { get; set; } // Direct Cost\npublic string InterventionDescription { get; set; } // Intervention Description\npublic string UnitStandardCode { get; set; } // Unit Standard Code\npublic string UnitStandardTitle { get; set; } // Unit Standard Title\npublic int? InterventionNQFLevelID { get; set; } // Intervention NQF LevelID (Alternatively use InterventionNQFLevelCode)\npublic string InterventionNQFLevelCode { get; set; } // InterventionNQFLevelCode\npublic int? InterventionLevelID { get; set; } // Intervention Level ID (Alternatively use InterventionLevelCode)\npublic string InterventionLevelCode { get; set; } // Intervention Level Code\npublic string AccreditationNumber { get; set; } // Accreditation Number\npublic int? NQFCredits { get; set; } // NQF Credits\npublic int? InformalCredits { get; set; } // Informal Credits\npublic int? InterventionLearningModeID { get; set; } // Intervention Learning Mode ID (Alternatively use InterventionLearningModeCode)\npublic string InterventionLearningModeCode { get; set; } // Intervention Learning Mode Code\npublic int? InterventionLearningDescriptionID { get; set; } // Intervention Learning Description ID (Alternatively use InterventionLearningDescriptionCode)\npublic string InterventionLearningDescriptionCode { get; set; } // Intervention Learning Description Code\npublic int? InterventionTypeOfLearningID { get; set; } // Intervention Type Of Learning ID (Alternatively use InterventionTypeOfLearningCode)\npublic string InterventionTypeOfLearningCode { get; set; } // Intervention Type Of Learning Code\npublic int? ResultID { get; set; } // ResultID ID (Alternatively use ResultCode)\npublic string ResultCode { get; set; } // Result Code\npublic int? Score { get; set; } // Score\npublic DateTime? DateCompleted { get; set; } // Date Completed\n}\n\npublic class UpdateEmployeeReportsToModel\n{\npublic string FromCompanyCode { get; set; }\npublic string EmployeeCode { get; set; }\npublic string ToCompanyCode { get; set; }\npublic string ReportsToCode { get; set; }\n}\nCreates Reports To Position Input line to specific header
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"687c2548-87dd-4d4d-a618-598bfcf4fc4a"}],"id":"94053911-7731-47b1-8ab4-9a3f33dd0080","description":"public class UpdateReportToPositionModel: APIBaseModel\n{\npublic string FromCompanyCode { get; set; }\npublic string PositionCode { get; set; }\npublic string ToCompanyCodeString { get; set; }\npublic string ReportsToCode { get; set; }\npublic string Priority { get; set; }\n}\nThe Employee Entity Relationship API allows for Create, Update as well as Delete for existing records. It is required to use separate Headers for each as the data sent is validated in different ways.
\n\n\nWill only create new records, if an existing record is found with the same code, then the API will fail for the given record.
\n
\n\nWill Update the specified record with Override.
\n
\n\nWill Delete the specified record.
\n
public class GenEntityRelModel : APIBaseModel\n{\npublic int? GenEntityID { get; set; } // Primary Entity ID\n\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300 People\npublic string CompanyCode { get; set; } // Company Code in Sage 300 People\n\npublic string EntityCode { get; set; } // Secondary Entity \npublic int? RelEntityID { get; set; } // Secondary Entity ID\n\npublic string EntityRelType { get; set; } // Relationship Type\npublic int? GenEntityRelTypeID { get; set; } // Relationship Type ID (read only)\n\npublic bool EmergencyContact { get; set; } // Emergency Contact \npublic int EmergencyContactDetail { get; set; } // Emergency Contact Detail (read only) // Emergency Contact Number = Cell Number of Child gen entity \n\npublic DateTime? RelationshipDate { get; set; } // Relationship Date \npublic bool? Beneficiary { get; set; } // Beneficiary (read only)\n\npublic int? EntityRelationshipID { get; set; } // Entity Relationship ID (read only) \n\n\nNote
\nAPI Body is not standard RAW JSON but in a FORM-DATA Model.
\nThe File Extensions allowed are determined by the setup within Sage 300 People.
\n
public class DocumentsAttachModel\n{\npublic int EmployeeID { get; set; } // Employee ID\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyCode { get; set; } // Company Code \npublic string CompanyRuleCode { get; set; } // Company Code \npublic int EntityID { get; set; } // Entity ID \npublic int Username { get; set; } // Username \npublic string Status { get; set; } // Status \npublic int DocumentID { get; set; } // Document ID\npublic string DocumentCode { get; set; } // Document Code\npublic string ContentCategoryTypeCode { get; set; } // Content Category Type Code\npublic int? ContentCategoryTypeID { get; set; } // Content Category Type ID\npublic DateTime? DateCreated { get; set; } // Date Created \npublic string Subject { get; set; } // Subject \npublic DateTime? ExpiryDate { get; set; } // Expiry Date \npublic int RelatedTable { get; set; } // Related Table \npublic int ContentSensitivity { get; set; } // Content Sensitivity \npublic string ZoneCode { get; set; } // Zone Code\npublic int ZoneCodeID { get; set; } // Zone Code ID \npublic string FileName { get; set; } // File Name \npublic int FileExtension { get; set; } // File Extension \npublic string Comments { get; set; } // Comments \npublic string AdditionalAuthors { get; set; } // Additional Authors \npublic string Version { get; set; } // Version \npublic string SensitivityCode { get; set; } // Sensitivity Code\npublic int SensitivityCodeID { get; set; } // Sensitivity Code ID\n}\n\nThe Employee Items Issued API allows for Create, Update as well as Delete for existing records. It is required to use separate Headers for each as the data sent is validated in different ways.
\n\n\nWill only create new records, if an existing record is found with the same code, then the API will fail for the given record.
\n
\n\nWill Update the specified record with Override.
\n
\n\nWill Delete the specified record.
\n
public class EmployeeItemsIssuedModel : APIBaseModel\n{\npublic int EmployeeItemsIssuedID { get; set; } // For Update only\n\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string CompanyCode { get; set; } // Company Code in Sage 300\n\npublic DateTime DateIssuedToEmployee { get; set; } // Date Issued To Employee \npublic int TypeOfItemID { get; set; } // Type Of Item ID\npublic string TypeOfItem { get; set; } // Type Of Item \npublic int DescriptionOfItemID { get; set; } // Description Of Item ID \npublic string DescriptionOfItem { get; set; } // Description Of Item \npublic int Quantity { get; set; } // Quantity \npublic string StockNumber { get; set; } // Stock Number \npublic string SerialNumber { get; set; } // Serial Number \npublic string AssetNumber { get; set; } // Asset Number \npublic string CommentsOnIssue { get; set; } // Comments On Issue \npublic string CommentsOnReturn { get; set; } // Comments On Return \npublic string ItemIssuedByEmployee { get; set; } // Item Issued By Employee \npublic Decimal EmployeePaidAnAmount { get; set; } // Employee Paid An Amount \npublic Boolean ItemMustBeReturned { get; set; } // Item Must Be Returned \n\n// Validation applicable to next fields: Only available if Item Must be Returned is selected\npublic string ItemReturnSetting { get; set; } // Item Return Setting \npublic DateTime DateToBeReturned { get; set; } // Date To Be Returned \npublic DateTime ActualReturnDate { get; set; } // Actual Return Date \npublic string ReturnedToEmployee { get; set; } // Returned To Employee\npublic int ConditionOfReturnedItemID { get; set; } // Condition Of Returned Item ID\npublic string ConditionOfReturnedItem { get; set; } // Condition Of Returned Item \n\n }\nThere is no Data Model for the GenericGet as this is defined by the selection query setup within the Sage 300 People GenericGet Setup. The Code used in the URL is also defined as a setup parameter in the system.
\nData altering queries will not be allowed in the GenericGet setup. See release notes for full details on the setup requirements.
\n\n\n","_postman_id":"92345291-5a23-4793-87af-046daa356b17"},{"name":"Generic GET - Parameterised","item":[{"name":"GenericGet - Parameterised","id":"fce697bf-3e70-4a17-a8d4-4bab0b2f1e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@INT\",\r\n\t\t\t\"ParameterValue\": \"11\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@PayPeriodID\",\r\n\t\t\t\"ParameterValue\": \"214\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSELECT * FROM Payroll.Payslip\r\nWhere PayslipDefID = @PayslipDefID \r\nAND EmployeePayPeriodID > @PayPeriodId\r\n\r\n-- @PayslipDefID defined as Parameter Type = Integer\r\n-- @PayPeriodId defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}","description":"Note
\nThe API is a 1 to 1 relationship with the applicable APIKey and GenericGet Code. Therefore only 1 Key can be granted access to each GenericGet setup.
\nIt is allowed to have multiple GenericGet setups linked to 1 APIKey.
\nInternal Sage 300 People security will be ignored as the Database tables are exposed to the query being used in the setup. All data is available to this call.
\n
The URL needs to state the Code of the setup in Sage 300 People - Generic Get.
\nhttp://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/\"\"Gen Get Code As Setup In People\"\"
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","GenericGet","{{GenGetCodeAsSetupInPeople}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"ac8a6dae-cad6-4d5e-84eb-6fc5363e7bf8","name":"Fail - Invalid Parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@IDontExist\",\r\n\t\t\t\"ParameterValue\": \"text\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSelect * From Employee.Employee\r\nWhere GenEntityID = @INT\r\n\r\n-- @INT defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"409"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 14 Dec 2021 07:53:19 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"businessRules\": [\n {\n \"propertyName\": \"QueryParameterString\",\n \"propertyFriendlyName\": \"Query Parameter String\",\n \"errorRulesCollection\": [\n {\n \"message\": \"QueryParameterString : @IDontExist does not exist in the query parameterList\"\n }\n ],\n \"warningRulesCollection\": [],\n \"successRulesCollection\": []\n }\n ]\n}"},{"id":"79f41034-2e46-402c-990d-957055ecb911","name":"Fail - Parameter/s not defined","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@INT\",\r\n\t\t\t\"ParameterValue\": \"11\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@PayPeriodID\",\r\n\t\t\t\"ParameterValue\": \"214\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSELECT * FROM Payroll.Payslip\r\nWhere PayslipDefID = @PayslipDefID \r\nAND EmployeePayPeriodID > @PayPeriodId\r\n\r\n-- @PayslipDefID defined as Parameter Type = Integer\r\n-- @PayPeriodId defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"131"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 14 Dec 2021 07:54:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"businessRules\": [],\n \"message\": \"ParameterList are not equal to the expected API query parameters.\"\n}"},{"id":"7b761e2b-6851-46ad-bf34-2e6086f53017","name":"Fail - Parameters sent has invalid values","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EmployeeID\",\r\n\t\t\t\"ParameterValue\": \"1\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@StartDate\",\r\n\t\t\t\"ParameterValue\": \"214\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EndDate\",\r\n\t\t\t\"ParameterValue\": \"214\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\n SELECT \r\n emp.EmployeeID,\r\n er.EmployeeRuleID,\r\n er.CompanyRuleID,\r\n ppg.PayPeriodGenID AS PayPeriodID,\r\n ppg.PeriodStatus,\r\n ppg.StartDate,\r\n ppg.EndDate,\r\n ppg.PayPeriodNumberInMonth,\r\n ppg.PayPeriodsInMonth,\r\n ppg.CalendarMonth,\r\n ppg.CalendarYear,\r\n cr.CompanyRuleCode + ' - ' + cr.ShortDescription AS CompanyRuleDisplay,\r\n cr.CompanyRuleCode,\r\n cr.ShortDescription AS CompanyRuleShortDescription\r\nFROM Employee.EmployeeSimple emp\r\nLEFT JOIN Employee.EmployeeRule er ON er.EmployeeRuleID = emp.EmployeeRuleID\r\nLEFT JOIN Company.PayPeriodGen ppg ON ppg.CompanyRuleID = er.CompanyRuleID\r\nLEFT JOIN Company.CompanyRule cr ON cr.CompanyRuleID = ppg.CompanyRuleID\r\nWHERE emp.EmployeeID = @EmployeeID And ppg.PayPeriodGenID >= (SELECT ppg.PayPeriodGenID\r\n FROM Company.PayPeriodGen ppg\r\n LEFT JOIN Employee.EmployeeRule er on er.CompanyRuleID = ppg.CompanyRuleID\r\n LEFT JOIN Employee.EmployeePayPeriod epp on epp.EmployeePayPeriodID = ppg.PayPeriodGenID And epp.EmployeeRuleID = er.EmployeeRuleID\r\n LEFT JOIN Employee.EmployeeSimple emp on emp.EmployeeRuleID = er.EmployeeRuleID\r\n WHERE ppg.PeriodStatus = 'L' And emp.EmployeeID = @EmployeeID)\r\nAND ppg.StartDate > @StartDate AND ppg.EndDate < @EndDate\r\n\r\n -- @EmployeeID defined as Parameter Type = Integer\r\n -- @StartDate defined as Parameter Type = DateTime\r\n -- @EndDate defined as Parameter Type = DateTime\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"156"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 14 Dec 2021 08:10:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"businessRules\": [],\n \"message\": \"An Error Occured while Processing the request: Please check your query or parameters value\"\n}"},{"id":"951ee12d-5cbd-461e-b6e2-cd4c5838aa84","name":"Successful - Integer","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@INT\",\r\n\t\t\t\"ParameterValue\": \"264\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSelect * From Employee.Employee\r\nWhere GenEntityID = @INT\r\n\r\n-- @INT defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"1293"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Thu, 02 Dec 2021 13:11:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"employeeID\": 160,\n \"genEntityID\": 264,\n \"companyID\": 2,\n \"employeeCode\": \"00161\",\n \"sdlLearner\": false,\n \"dateEngaged\": \"2017-03-01T00:00:00\",\n \"dateJoinedGroup\": \"2017-03-01T00:00:00\",\n \"leaveStartDate\": \"2017-03-01T00:00:00\",\n \"terminationDate\": \"2021-04-30T00:00:00\",\n \"terminationReasonID\": 1,\n \"finalCalcNow\": 1,\n \"bceaPeriods\": 0,\n \"uifStatusID\": 1,\n \"uifReasonStartDate\": \"2017-03-01T00:00:00\",\n \"employeeStatusID\": 2,\n \"isRecruit\": false,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-12-02T15:07:46\",\n \"tmStamp\": \"AAAAAACl7kw=\"\n },\n {\n \"employeeID\": 1129,\n \"genEntityID\": 264,\n \"companyID\": 2,\n \"employeeCode\": \"L168\",\n \"sdlLearner\": false,\n \"dateEngaged\": \"2021-03-01T00:00:00\",\n \"dateJoinedGroup\": \"2021-03-01T00:00:00\",\n \"leaveStartDate\": \"2021-03-01T00:00:00\",\n \"bceaPeriods\": 0,\n \"uifStatusID\": 1,\n \"uifReasonStartDate\": \"2021-03-01T00:00:00\",\n \"employeeStatusID\": 1,\n \"isRecruit\": false,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-12-02T15:08:10.697\",\n \"tmStamp\": \"AAAAAACl7qE=\"\n }\n ]\n}"},{"id":"d26b713b-1a38-46d3-83b6-51d9428ca689","name":"Successful - DateTime","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@Date\",\r\n\t\t\t\"ParameterValue\": \"2021-09-29\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSELECT PAL.*\r\nFROM [Payroll].[PayslipAdditionalLine] pal\r\nINNER JOIN Payroll.Payslip p ON pal.PayslipID = p.PayslipID\r\nINNER JOIN Employee.EmployeePayPeriod epp ON epp.EmployeePayPeriodID = p.EmployeePayPeriodID\r\nINNER JOIN Employee.Employee e ON epp.EmployeeID = e.EmployeeID\r\nWhere PAL.LastChanged > @Date\r\n\r\n-- @Date defined as Parameter Type = DateTime\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"6653"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Thu, 02 Dec 2021 13:00:51 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"payslipAdditionalLineID\": 53,\n \"empAdditionalDefID\": 3,\n \"defID\": 2,\n \"payslipID\": 27546,\n \"calcEntryID\": 87,\n \"calcVersionID\": 88,\n \"units\": 0,\n \"fixed\": 23456,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 1,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 23456,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-17T14:39:18.477\",\n \"tmStamp\": \"AAAAAAChalg=\"\n },\n {\n \"payslipAdditionalLineID\": 54,\n \"empAdditionalDefID\": 4,\n \"defID\": 1,\n \"payslipID\": 27546,\n \"units\": 0,\n \"fixed\": 3,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 1,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 3,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"17-Approver\",\n \"lastChanged\": \"2021-09-29T21:45:30.323\",\n \"tmStamp\": \"AAAAAACUrjI=\"\n },\n {\n \"payslipAdditionalLineID\": 55,\n \"empAdditionalDefID\": 1,\n \"defID\": 2,\n \"payslipID\": 28655,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 27,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-19T08:17:15.73\",\n \"tmStamp\": \"AAAAAACiJlk=\"\n },\n {\n \"payslipAdditionalLineID\": 56,\n \"empAdditionalDefID\": 2,\n \"defID\": 1,\n \"payslipID\": 28655,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 27,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-19T08:17:15.763\",\n \"tmStamp\": \"AAAAAACiJlo=\"\n },\n {\n \"payslipAdditionalLineID\": 57,\n \"empAdditionalDefID\": 3,\n \"defID\": 2,\n \"payslipID\": 28656,\n \"calcEntryID\": 87,\n \"calcVersionID\": 88,\n \"units\": 0,\n \"fixed\": 23456,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 2,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 23456,\n \"previousTotal\": 23456,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 23456,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-19T08:17:15.727\",\n \"tmStamp\": \"AAAAAACiJo0=\"\n },\n {\n \"payslipAdditionalLineID\": 58,\n \"empAdditionalDefID\": 4,\n \"defID\": 1,\n \"payslipID\": 28656,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 2,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 3,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 3,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-19T08:17:15.763\",\n \"tmStamp\": \"AAAAAACiJo4=\"\n },\n {\n \"payslipAdditionalLineID\": 59,\n \"empAdditionalDefID\": 5,\n \"defID\": 3,\n \"payslipID\": 29736,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 1,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-30T12:39:24.643\",\n \"tmStamp\": \"AAAAAAClHGQ=\"\n },\n {\n \"payslipAdditionalLineID\": 60,\n \"empAdditionalDefID\": 6,\n \"defID\": 1,\n \"payslipID\": 29736,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 1,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-30T12:39:36.1\",\n \"tmStamp\": \"AAAAAAClHHo=\"\n },\n {\n \"payslipAdditionalLineID\": 61,\n \"empAdditionalDefID\": 7,\n \"defID\": 2,\n \"payslipID\": 29736,\n \"units\": 0,\n \"fixed\": 0,\n \"recurrenceAmount\": 0,\n \"recurrenceCount\": 1,\n \"amount\": 0,\n \"leavePayAmount\": 0,\n \"total\": 0,\n \"previousTotal\": 0,\n \"taxableAmount\": 0,\n \"balance\": 0,\n \"mtdTotal\": 0,\n \"ytdTotal\": 0,\n \"mtdUnits\": 0,\n \"ytdUnits\": 0,\n \"specialAccumulatedTotal\": 0,\n \"specialAccumulatedUnits\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-30T12:39:39.383\",\n \"tmStamp\": \"AAAAAAClHHs=\"\n }\n ]\n}"},{"id":"f6d0afa2-aaad-4254-a4e6-f11c07a948a1","name":"Successful - Multi-Parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@PayslipDefID\",\r\n\t\t\t\"ParameterValue\": \"11\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@PayPeriodId\",\r\n\t\t\t\"ParameterValue\": \"214\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSELECT * FROM Payroll.Payslip\r\nWhere PayslipDefID = @PayslipDefID \r\nAND EmployeePayPeriodID > @PayPeriodId\r\n\r\n-- @PayslipDefID defined as Parameter Type = Integer\r\n-- @PayPeriodId defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/{{GenGetCodeAsSetupInPeople}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"35085"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Mon, 06 Dec 2021 12:48:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"payslipID\": 215,\n \"employeePayPeriodID\": 215,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5552.69,\n \"netPay\": 23613.98,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 9,\n \"employeeTaxID\": 11,\n \"annualisationFactor\": 273.7494,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 52,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 48635.78,\n \"rfiAdjustment\": 0,\n \"payRunID\": 33,\n \"payPeriodGenID\": 33,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:15:58.373\",\n \"tmStamp\": \"AAAAAAAaZOk=\"\n },\n {\n \"payslipID\": 246,\n \"employeePayPeriodID\": 246,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5552.7,\n \"netPay\": 23613.97,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 10,\n \"employeeTaxID\": 11,\n \"annualisationFactor\": 304.166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 52,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 54039.76,\n \"rfiAdjustment\": 0,\n \"payRunID\": 34,\n \"payPeriodGenID\": 34,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:16:55.513\",\n \"tmStamp\": \"AAAAAAAaacA=\"\n },\n {\n \"payslipID\": 272,\n \"employeePayPeriodID\": 272,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5552.69,\n \"netPay\": 23613.98,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 11,\n \"employeeTaxID\": 11,\n \"annualisationFactor\": 334.5826,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 52,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 59443.73,\n \"rfiAdjustment\": 0,\n \"payRunID\": 35,\n \"payPeriodGenID\": 35,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:17:57.523\",\n \"tmStamp\": \"AAAAAAAabWs=\"\n },\n {\n \"payslipID\": 302,\n \"employeePayPeriodID\": 302,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5552.6,\n \"netPay\": 23614.07,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 12,\n \"employeeTaxID\": 11,\n \"annualisationFactor\": 365,\n \"taxCalculation\": \"F\",\n \"taxTableID\": 52,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 64847.61,\n \"rfiAdjustment\": 0,\n \"payRunID\": 36,\n \"payPeriodGenID\": 36,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:18:36.627\",\n \"tmStamp\": \"AAAAAAAacYo=\"\n },\n {\n \"payslipID\": 333,\n \"employeePayPeriodID\": 333,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 13,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 30.4166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 5289.38,\n \"rfiAdjustment\": 0,\n \"payRunID\": 37,\n \"payPeriodGenID\": 37,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:19:21.14\",\n \"tmStamp\": \"AAAAAAAadjM=\"\n },\n {\n \"payslipID\": 360,\n \"employeePayPeriodID\": 360,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.11,\n \"netPay\": 23728.56,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 14,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 60.8332,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 10578.77,\n \"rfiAdjustment\": 0,\n \"payRunID\": 38,\n \"payPeriodGenID\": 38,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:20:05.663\",\n \"tmStamp\": \"AAAAAAAaeko=\"\n },\n {\n \"payslipID\": 391,\n \"employeePayPeriodID\": 391,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 15,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 91.2498,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 15868.15,\n \"rfiAdjustment\": 0,\n \"payRunID\": 39,\n \"payPeriodGenID\": 39,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:20:51.893\",\n \"tmStamp\": \"AAAAAAAafoU=\"\n },\n {\n \"payslipID\": 419,\n \"employeePayPeriodID\": 419,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.11,\n \"netPay\": 23728.56,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 16,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 121.6664,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 21157.54,\n \"rfiAdjustment\": 0,\n \"payRunID\": 40,\n \"payPeriodGenID\": 40,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:21:32.25\",\n \"tmStamp\": \"AAAAAAAagnA=\"\n },\n {\n \"payslipID\": 447,\n \"employeePayPeriodID\": 447,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 17,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 152.083,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 26446.92,\n \"rfiAdjustment\": 0,\n \"payRunID\": 41,\n \"payPeriodGenID\": 41,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:22:13.467\",\n \"tmStamp\": \"AAAAAAAahls=\"\n },\n {\n \"payslipID\": 478,\n \"employeePayPeriodID\": 478,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.11,\n \"netPay\": 23728.56,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 18,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 182.4996,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 31736.31,\n \"rfiAdjustment\": 0,\n \"payRunID\": 42,\n \"payPeriodGenID\": 42,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:22:49.927\",\n \"tmStamp\": \"AAAAAAAaiqQ=\"\n },\n {\n \"payslipID\": 507,\n \"employeePayPeriodID\": 507,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 19,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 212.9162,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 37025.69,\n \"rfiAdjustment\": 0,\n \"payRunID\": 43,\n \"payPeriodGenID\": 43,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:23:34.3\",\n \"tmStamp\": \"AAAAAAAajro=\"\n },\n {\n \"payslipID\": 535,\n \"employeePayPeriodID\": 535,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 20,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 243.3328,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 42315.07,\n \"rfiAdjustment\": 0,\n \"payRunID\": 44,\n \"payPeriodGenID\": 44,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:24:11.84\",\n \"tmStamp\": \"AAAAAAAakrQ=\"\n },\n {\n \"payslipID\": 564,\n \"employeePayPeriodID\": 564,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.11,\n \"netPay\": 23728.56,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 21,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 273.7494,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 47604.46,\n \"rfiAdjustment\": 0,\n \"payRunID\": 45,\n \"payPeriodGenID\": 45,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:26:54.223\",\n \"tmStamp\": \"AAAAAAAalyE=\"\n },\n {\n \"payslipID\": 593,\n \"employeePayPeriodID\": 593,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.1,\n \"netPay\": 23728.57,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 22,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 304.166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 52893.84,\n \"rfiAdjustment\": 0,\n \"payRunID\": 46,\n \"payPeriodGenID\": 46,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:27:43.627\",\n \"tmStamp\": \"AAAAAAAam0U=\"\n },\n {\n \"payslipID\": 621,\n \"employeePayPeriodID\": 621,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438.11,\n \"netPay\": 23728.56,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 23,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 334.5826,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 58183.23,\n \"rfiAdjustment\": 0,\n \"payRunID\": 47,\n \"payPeriodGenID\": 47,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2019-02-06T14:28:37.767\",\n \"tmStamp\": \"AAAAAAAan08=\"\n },\n {\n \"payslipID\": 650,\n \"employeePayPeriodID\": 650,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5438,\n \"netPay\": 23728.67,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 24,\n \"employeeTaxID\": 45,\n \"annualisationFactor\": 365,\n \"taxCalculation\": \"F\",\n \"taxTableID\": 59,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 63472.51,\n \"rfiAdjustment\": 0,\n \"payRunID\": 48,\n \"payPeriodGenID\": 48,\n \"payslipType\": 0,\n \"userID\": \"17-Approver\",\n \"lastChanged\": \"2020-11-23T09:31:11.967\",\n \"tmStamp\": \"AAAAAABBtd4=\"\n },\n {\n \"payslipID\": 1730,\n \"employeePayPeriodID\": 1730,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 25,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 30.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 5276.63,\n \"rfiAdjustment\": 0,\n \"payRunID\": 97,\n \"payPeriodGenID\": 97,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2020-12-03T13:04:40.147\",\n \"tmStamp\": \"AAAAAABGa3s=\"\n },\n {\n \"payslipID\": 2802,\n \"employeePayPeriodID\": 2803,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.34,\n \"netPay\": 23741.33,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 26,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 61,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 10553.25,\n \"rfiAdjustment\": 0,\n \"payRunID\": 98,\n \"payPeriodGenID\": 98,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T21:55:02.053\",\n \"tmStamp\": \"AAAAAABsA8U=\"\n },\n {\n \"payslipID\": 3872,\n \"employeePayPeriodID\": 3880,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 27,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 91.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 15829.88,\n \"rfiAdjustment\": 0,\n \"payRunID\": 99,\n \"payPeriodGenID\": 99,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T21:57:11.893\",\n \"tmStamp\": \"AAAAAABsd3A=\"\n },\n {\n \"payslipID\": 4946,\n \"employeePayPeriodID\": 4961,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.34,\n \"netPay\": 23741.33,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 28,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 122,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 21106.5,\n \"rfiAdjustment\": 0,\n \"payRunID\": 100,\n \"payPeriodGenID\": 100,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T21:59:23.727\",\n \"tmStamp\": \"AAAAAABs63c=\"\n },\n {\n \"payslipID\": 6018,\n \"employeePayPeriodID\": 6040,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 29,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 152.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 26383.13,\n \"rfiAdjustment\": 0,\n \"payRunID\": 101,\n \"payPeriodGenID\": 101,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:01:46.357\",\n \"tmStamp\": \"AAAAAABtX0k=\"\n },\n {\n \"payslipID\": 7090,\n \"employeePayPeriodID\": 7119,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 30,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 183,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 31659.76,\n \"rfiAdjustment\": 0,\n \"payRunID\": 102,\n \"payPeriodGenID\": 102,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:04:01.34\",\n \"tmStamp\": \"AAAAAABt0yA=\"\n },\n {\n \"payslipID\": 8159,\n \"employeePayPeriodID\": 8195,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.34,\n \"netPay\": 23741.33,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 31,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 213.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 36936.38,\n \"rfiAdjustment\": 0,\n \"payRunID\": 121,\n \"payPeriodGenID\": 121,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:06:18.97\",\n \"tmStamp\": \"AAAAAABuRq0=\"\n },\n {\n \"payslipID\": 9231,\n \"employeePayPeriodID\": 9274,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 32,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 244,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 42213.01,\n \"rfiAdjustment\": 0,\n \"payRunID\": 129,\n \"payPeriodGenID\": 129,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:08:39.707\",\n \"tmStamp\": \"AAAAAABuuo0=\"\n },\n {\n \"payslipID\": 10305,\n \"employeePayPeriodID\": 10355,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.34,\n \"netPay\": 23741.33,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 33,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 274.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 47489.63,\n \"rfiAdjustment\": 0,\n \"payRunID\": 130,\n \"payPeriodGenID\": 130,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:10:53.777\",\n \"tmStamp\": \"AAAAAABvLs8=\"\n },\n {\n \"payslipID\": 11376,\n \"employeePayPeriodID\": 11433,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 34,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 305,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 52766.26,\n \"rfiAdjustment\": 0,\n \"payRunID\": 131,\n \"payPeriodGenID\": 131,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-15T22:13:12.02\",\n \"tmStamp\": \"AAAAAABvop0=\"\n },\n {\n \"payslipID\": 12450,\n \"employeePayPeriodID\": 12514,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.34,\n \"netPay\": 23741.33,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 35,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 335.5,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 58042.88,\n \"rfiAdjustment\": 0,\n \"payRunID\": 132,\n \"payPeriodGenID\": 132,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-16T22:06:06.943\",\n \"tmStamp\": \"AAAAAABxB2s=\"\n },\n {\n \"payslipID\": 13522,\n \"employeePayPeriodID\": 13593,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5425.35,\n \"netPay\": 23741.32,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 36,\n \"employeeTaxID\": 1123,\n \"annualisationFactor\": 366,\n \"taxCalculation\": \"F\",\n \"taxTableID\": 66,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 63319.51,\n \"rfiAdjustment\": 0,\n \"payRunID\": 133,\n \"payPeriodGenID\": 133,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T10:47:03.323\",\n \"tmStamp\": \"AAAAAABxmhc=\"\n },\n {\n \"payslipID\": 14592,\n \"employeePayPeriodID\": 14670,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 37,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 30.4166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 5082.51,\n \"rfiAdjustment\": 0,\n \"payRunID\": 134,\n \"payPeriodGenID\": 134,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:23:17.733\",\n \"tmStamp\": \"AAAAAAByEWA=\"\n },\n {\n \"payslipID\": 15672,\n \"employeePayPeriodID\": 15750,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 38,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 60.8332,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 10165.02,\n \"rfiAdjustment\": 0,\n \"payRunID\": 135,\n \"payPeriodGenID\": 135,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:26:53.3\",\n \"tmStamp\": \"AAAAAAByp24=\"\n },\n {\n \"payslipID\": 16751,\n \"employeePayPeriodID\": 16829,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 39,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 91.2498,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 15247.53,\n \"rfiAdjustment\": 0,\n \"payRunID\": 136,\n \"payPeriodGenID\": 136,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:28:55.217\",\n \"tmStamp\": \"AAAAAABzG+U=\"\n },\n {\n \"payslipID\": 17831,\n \"employeePayPeriodID\": 17909,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 40,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 121.6664,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 20330.04,\n \"rfiAdjustment\": 0,\n \"payRunID\": 137,\n \"payPeriodGenID\": 137,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:31:04.657\",\n \"tmStamp\": \"AAAAAABzkIg=\"\n },\n {\n \"payslipID\": 18910,\n \"employeePayPeriodID\": 18988,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 41,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 152.083,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 25412.55,\n \"rfiAdjustment\": 0,\n \"payRunID\": 138,\n \"payPeriodGenID\": 138,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:33:05.107\",\n \"tmStamp\": \"AAAAAAB0BQY=\"\n },\n {\n \"payslipID\": 19988,\n \"employeePayPeriodID\": 20066,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 42,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 182.4996,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 30495.06,\n \"rfiAdjustment\": 0,\n \"payRunID\": 139,\n \"payPeriodGenID\": 139,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:35:08.07\",\n \"tmStamp\": \"AAAAAAB0eXQ=\"\n },\n {\n \"payslipID\": 21068,\n \"employeePayPeriodID\": 21146,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 43,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 212.9162,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 35577.57,\n \"rfiAdjustment\": 0,\n \"payRunID\": 140,\n \"payPeriodGenID\": 140,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:37:13.35\",\n \"tmStamp\": \"AAAAAAB07h8=\"\n },\n {\n \"payslipID\": 22147,\n \"employeePayPeriodID\": 22225,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 44,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 243.3328,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 40660.08,\n \"rfiAdjustment\": 0,\n \"payRunID\": 141,\n \"payPeriodGenID\": 141,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:39:22.98\",\n \"tmStamp\": \"AAAAAAB1YrA=\"\n },\n {\n \"payslipID\": 23226,\n \"employeePayPeriodID\": 23304,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 45,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 273.7494,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 45742.59,\n \"rfiAdjustment\": 0,\n \"payRunID\": 142,\n \"payPeriodGenID\": 142,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:41:32.907\",\n \"tmStamp\": \"AAAAAAB112s=\"\n },\n {\n \"payslipID\": 24305,\n \"employeePayPeriodID\": 24383,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 46,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 304.166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 50825.1,\n \"rfiAdjustment\": 0,\n \"payRunID\": 143,\n \"payPeriodGenID\": 143,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:43:44.873\",\n \"tmStamp\": \"AAAAAAB2TAk=\"\n },\n {\n \"payslipID\": 25381,\n \"employeePayPeriodID\": 25459,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.23,\n \"netPay\": 23935.44,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 47,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 334.5826,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 55907.61,\n \"rfiAdjustment\": 0,\n \"payRunID\": 144,\n \"payPeriodGenID\": 144,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:45:58.463\",\n \"tmStamp\": \"AAAAAAB2xHE=\"\n },\n {\n \"payslipID\": 26463,\n \"employeePayPeriodID\": 26541,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5231.12,\n \"netPay\": 23935.55,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 48,\n \"employeeTaxID\": 2195,\n \"annualisationFactor\": 365,\n \"taxCalculation\": \"F\",\n \"taxTableID\": 73,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 60990.01,\n \"rfiAdjustment\": 0,\n \"payRunID\": 161,\n \"payPeriodGenID\": 161,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-02-17T11:48:08.707\",\n \"tmStamp\": \"AAAAAAB3OWc=\"\n },\n {\n \"payslipID\": 27539,\n \"employeePayPeriodID\": 27617,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5032.06,\n \"netPay\": 24134.61,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 49,\n \"employeeTaxID\": 3273,\n \"annualisationFactor\": 30.4166,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 80,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 4883.34,\n \"rfiAdjustment\": 0,\n \"payRunID\": 162,\n \"payPeriodGenID\": 162,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-17T14:39:18.463\",\n \"tmStamp\": \"AAAAAAChalQ=\"\n },\n {\n \"payslipID\": 28655,\n \"employeePayPeriodID\": 28733,\n \"payslipDefID\": 11,\n \"grossEarnings\": 29166.67,\n \"deductions\": 5032.07,\n \"netPay\": 24134.6,\n \"leavePeriodsRemain\": 0,\n \"payslipNumber\": 50,\n \"employeeTaxID\": 3273,\n \"annualisationFactor\": 60.8332,\n \"taxCalculation\": \"A\",\n \"taxTableID\": 80,\n \"earlyPay\": false,\n \"forcedPay\": false,\n \"bceaIncPeriods\": 0,\n \"forceAverageYTDCalc\": false,\n \"bceaTakeonTotal\": 0,\n \"siteTotalYTDP\": 0,\n \"payeTotalYTDP\": 9766.69,\n \"rfiAdjustment\": 0,\n \"payRunID\": 163,\n \"payPeriodGenID\": 163,\n \"payslipType\": 0,\n \"userID\": \"1-Admin\",\n \"lastChanged\": \"2021-11-19T08:17:15.693\",\n \"tmStamp\": \"AAAAAACiJkc=\"\n }\n ]\n}"},{"id":"e4b1eeb1-b885-4caa-9b54-f2ff00349145","name":"Successful - Advanced Query - Multiple entry Parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EmployeeID\",\r\n\t\t\t\"ParameterValue\": \"11, 18, 20\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\nSELECT h.ContentHeaderID, h.DateCreated, h.VIPUserID, h.Subject, h.ZoneCodeID\r\n ,h.ContentCategoryTypeID, h.SensitivityID, h.Status\r\n ,h.EmployeeID, h.GenEntityID, h.EntryTable, h.EntryKey, h.RelatedTable, h.RelatedKey\r\n ,o.FriendlyName as RelatedFriendlyName\r\n ,u.VIPUserName\r\n ,COUNT(n.NoteID) NoteCount\r\n ,COUNT(d.DocumentID) DocumentCount\r\n ,d.FileName\r\nFROM Content.ContentHeader h\r\n left outer join Content.Note n on n.ContentHeaderID = h.ContentHeaderID\r\n left outer join Content.Document d on d.ContentHeaderID = h.ContentHeaderID\r\n left outer join Security.SystemObject o on o.ObjectName = h.RelatedTable\r\n left outer join Security.VIPUser u on u.VIPUserID = h.VIPUserID\r\n\r\nWHERE EmployeeID IN (@EmployeeID)\r\nGROUP BY h.ContentHeaderID, h.DateCreated, h.VIPUserID, h.Subject, h.ZoneCodeID\r\n ,h.ContentCategoryTypeID, h.SensitivityID, h.Status\r\n ,h.EmployeeID, h.GenEntityID, h.EntryTable, h.EntryKey, h.RelatedTable, h.RelatedKey\r\n ,o.FriendlyName\r\n ,u.VIPUserName\r\n ,d.FileName\r\n\r\n-- @EmployeeID defined as Parameter Type = Decimal\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/T_ADV1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"5417"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 14 Dec 2021 07:35:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"contentHeaderID\": 2,\n \"dateCreated\": \"2020-09-16T11:24:54.03\",\n \"vipUserID\": 17,\n \"subject\": \"Annual Leave for Mr A Approver - From: 2020/09/16 To: 2020/09/16\",\n \"contentCategoryTypeID\": 18,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"LeaveTransaction\",\n \"relatedKey\": 4,\n \"relatedFriendlyName\": \"Leave Transaction\",\n \"vipUserName\": \"Approver\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"5000 CHARACTERS.docx\"\n },\n {\n \"contentHeaderID\": 3,\n \"dateCreated\": \"2020-09-16T11:28:32\",\n \"vipUserID\": 10,\n \"contentCategoryTypeID\": 291,\n \"status\": \"A\",\n \"employeeID\": 11,\n \"genEntityID\": 13,\n \"entryTable\": \"Claim\",\n \"entryKey\": 3,\n \"relatedTable\": \"GroupedClaim\",\n \"relatedKey\": 1,\n \"relatedFriendlyName\": \"Grouped Claim\",\n \"vipUserName\": \"SubmitMultiClaim\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"Mr A Approver - Payslip - password.pdf\"\n },\n {\n \"contentHeaderID\": 4,\n \"dateCreated\": \"2020-09-16T11:28:32.22\",\n \"vipUserID\": 10,\n \"contentCategoryTypeID\": 291,\n \"status\": \"A\",\n \"employeeID\": 11,\n \"genEntityID\": 13,\n \"entryTable\": \"Claim\",\n \"entryKey\": 1,\n \"relatedTable\": \"GroupedClaim\",\n \"relatedKey\": 1,\n \"relatedFriendlyName\": \"Grouped Claim\",\n \"vipUserName\": \"SubmitMultiClaim\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"test - Very Long name of document to check import is successful and display is correct for the document.pdf\"\n },\n {\n \"contentHeaderID\": 5,\n \"dateCreated\": \"2020-11-23T09:06:02.517\",\n \"vipUserID\": 20,\n \"subject\": \"Annual Leave for Mr E Employee - From: 2020-11-24 To: 2020-11-24\",\n \"contentCategoryTypeID\": 18,\n \"status\": \"A\",\n \"employeeID\": 20,\n \"genEntityID\": 23,\n \"relatedTable\": \"LeaveTransaction\",\n \"relatedKey\": 6,\n \"relatedFriendlyName\": \"Leave Transaction\",\n \"vipUserName\": \"Employee\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"Payslip_MAIN_31-Jan-2019.pdf\"\n },\n {\n \"contentHeaderID\": 7,\n \"dateCreated\": \"2020-12-03T15:04:31.537\",\n \"vipUserID\": 17,\n \"contentCategoryTypeID\": 291,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"entryTable\": \"Claim\",\n \"entryKey\": 8,\n \"relatedTable\": \"GroupedClaim\",\n \"relatedKey\": 4,\n \"relatedFriendlyName\": \"Grouped Claim\",\n \"vipUserName\": \"Approver\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"test - PDF.pdf\"\n },\n {\n \"contentHeaderID\": 8,\n \"dateCreated\": \"2020-12-03T15:04:33.917\",\n \"vipUserID\": 17,\n \"contentCategoryTypeID\": 291,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"GroupedClaim\",\n \"relatedKey\": 4,\n \"relatedFriendlyName\": \"Grouped Claim\",\n \"vipUserName\": \"Approver\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"Test - Doc.doc\"\n },\n {\n \"contentHeaderID\": 9,\n \"dateCreated\": \"2020-12-21T15:16:33.583\",\n \"vipUserID\": 17,\n \"contentCategoryTypeID\": 251,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"Process\",\n \"relatedKey\": 22,\n \"relatedFriendlyName\": \"Process\",\n \"vipUserName\": \"Approver\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"test - Long name of document to check import is successful.pdf\"\n },\n {\n \"contentHeaderID\": 36,\n \"dateCreated\": \"2021-09-29T21:22:09.16\",\n \"vipUserID\": 17,\n \"subject\": \"Sick Leave for Mr A Approver - From: 2021/09/01 To: 2021/09/02\",\n \"contentCategoryTypeID\": 18,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"LeaveTransaction\",\n \"relatedKey\": 22,\n \"relatedFriendlyName\": \"Leave Transaction\",\n \"vipUserName\": \"Approver\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"Mr A Approver - Payslip - password.pdf\"\n },\n {\n \"contentHeaderID\": 45,\n \"dateCreated\": \"2021-10-14T00:00:00\",\n \"vipUserID\": 1,\n \"subject\": \"test - Save : All other docs dissapear\",\n \"contentCategoryTypeID\": 502,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"EmployeeUber\",\n \"relatedKey\": 18,\n \"relatedFriendlyName\": \"Employee Uber\",\n \"vipUserName\": \"Admin\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"Sage 300 People API Documentation.docx\"\n },\n {\n \"contentHeaderID\": 47,\n \"dateCreated\": \"2021-10-22T00:00:00\",\n \"vipUserID\": 1,\n \"subject\": \"Daniel Test\",\n \"contentCategoryTypeID\": 503,\n \"sensitivityID\": 5,\n \"status\": \"A\",\n \"employeeID\": 18,\n \"genEntityID\": 21,\n \"relatedTable\": \"EmployeeUber\",\n \"relatedKey\": 18,\n \"relatedFriendlyName\": \"Employee Uber\",\n \"vipUserName\": \"Admin\",\n \"noteCount\": 0,\n \"documentCount\": 1,\n \"fileName\": \"VPN access guide.docx\"\n }\n ]\n}"},{"id":"336fedd4-d905-4635-bc9a-f43fb5ac391e","name":"Successful - Advanced Query - Multiple Parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EmployeeID\",\r\n\t\t\t\"ParameterValue\": \"00008\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@CompanyID\",\r\n\t\t\t\"ParameterValue\": \"2\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\n SELECT E.EmployeeID\r\n , E.EmployeeCode\r\n , GE.EntityCode\r\n , GE.LastName\r\n , GE.DisplayName\r\n , ER.CompanyRuleID\r\n , GE.Gender\r\n , ER.EmployeeRuleID\r\n , E.EmployeeStatusID\r\n , E.TerminationDate\r\n , GE.GenEntityID\r\n , E.CompanyID \r\n , dbo.LookUpDisplayValue(JT.Code, JT.LongDescription, JT.ShortDescription) as JobTitleType\r\n , CONVERT(bit,ISNULL(ESI.TrainingFacilitator,0)) as TrainingFacilitator\r\n , GE.EmailAddress\r\n FROM Employee.Employee E\r\n Join [Entity].[GenEntity] GE on E.GenEntityID = GE.GenEntityID\r\n Join [Employee].[EmployeeRule] ER on E.EmployeeID = ER.EmployeeID AND ER.MainRel = 1\r\n LEFT OUTER Join [Employee].[EmployeeSkillsInformation] ESI on E.EmployeeID = ESI.EmployeeID\r\n LEFT OUTER JOIN [Employee].[JobTitleType] JT on E.JobTitleTypeID = JT.JobTitleTypeID\r\n WHERE E.EmployeeID = @EmployeeID AND CompanyID = @CompanyID\r\n\r\n-- @EmployeeID defined as Parameter Type = Integer\r\n-- @CompanyID defined as Parameter Type = Integer\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/T_ADV2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"499"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 14 Dec 2021 07:49:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"employeeID\": 8,\n \"employeeCode\": \"00008\",\n \"entityCode\": \"10\",\n \"lastName\": \"CancelInProgress\",\n \"displayName\": \"Mr L CancelInProgress\",\n \"companyRuleID\": 2,\n \"gender\": \"M\",\n \"employeeRuleID\": 8,\n \"employeeStatusID\": 2,\n \"genEntityID\": 10,\n \"companyID\": 2,\n \"trainingFacilitator\": false,\n \"emailAddress\": \"CancelInProgress@Test_WebSS.com\"\n }\n ]\n}"}],"_postman_id":"fce697bf-3e70-4a17-a8d4-4bab0b2f1e68"},{"name":"GenericGet - Parameterised Advanced Query","id":"aba9f91b-ee20-4c6a-bdea-f35291c63e92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EmployeeID\",\r\n\t\t\t\"ParameterValue\": \"1\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@StartDate\",\r\n\t\t\t\"ParameterValue\": \"2022-01-01\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EndDate\",\r\n\t\t\t\"ParameterValue\": \"2022-11-30\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\n SELECT \r\n emp.EmployeeID,\r\n er.EmployeeRuleID,\r\n er.CompanyRuleID,\r\n ppg.PayPeriodGenID AS PayPeriodID,\r\n ppg.PeriodStatus,\r\n ppg.StartDate,\r\n ppg.EndDate,\r\n ppg.PayPeriodNumberInMonth,\r\n ppg.PayPeriodsInMonth,\r\n ppg.CalendarMonth,\r\n ppg.CalendarYear,\r\n cr.CompanyRuleCode + ' - ' + cr.ShortDescription AS CompanyRuleDisplay,\r\n cr.CompanyRuleCode,\r\n cr.ShortDescription AS CompanyRuleShortDescription\r\nFROM Employee.EmployeeSimple emp\r\nLEFT JOIN Employee.EmployeeRule er ON er.EmployeeRuleID = emp.EmployeeRuleID\r\nLEFT JOIN Company.PayPeriodGen ppg ON ppg.CompanyRuleID = er.CompanyRuleID\r\nLEFT JOIN Company.CompanyRule cr ON cr.CompanyRuleID = ppg.CompanyRuleID\r\nWHERE emp.EmployeeID = @EmployeeID And ppg.PayPeriodGenID >= (SELECT ppg.PayPeriodGenID\r\n FROM Company.PayPeriodGen ppg\r\n LEFT JOIN Employee.EmployeeRule er on er.CompanyRuleID = ppg.CompanyRuleID\r\n LEFT JOIN Employee.EmployeePayPeriod epp on epp.EmployeePayPeriodID = ppg.PayPeriodGenID And epp.EmployeeRuleID = er.EmployeeRuleID\r\n LEFT JOIN Employee.EmployeeSimple emp on emp.EmployeeRuleID = er.EmployeeRuleID\r\n WHERE ppg.PeriodStatus = 'L' And emp.EmployeeID = @EmployeeID)\r\nAND ppg.StartDate > @StartDate AND ppg.EndDate < @EndDate\r\n\r\n -- @EmployeeID defined as Parameter Type = Integer\r\n -- @StartDate defined as Parameter Type = DateTime\r\n -- @EndDate defined as Parameter Type = DateTime\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/T_ADV3","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","GenericGet","T_ADV3"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"e771a8b0-1888-4baf-9b89-546a0b77d47f","name":"Successful - Advanced Multi Parameter Query","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"QueryParameterList\": [\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EmployeeID\",\r\n\t\t\t\"ParameterValue\": \"1\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@StartDate\",\r\n\t\t\t\"ParameterValue\": \"2022-01-01\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"QueryParameterString\": \"@EndDate\",\r\n\t\t\t\"ParameterValue\": \"2022-11-30\"\r\n\t\t}\r\n\t]\r\n}\r\n/* SQL Query in People - Generic Get setup:\r\n SELECT \r\n emp.EmployeeID,\r\n er.EmployeeRuleID,\r\n er.CompanyRuleID,\r\n ppg.PayPeriodGenID AS PayPeriodID,\r\n ppg.PeriodStatus,\r\n ppg.StartDate,\r\n ppg.EndDate,\r\n ppg.PayPeriodNumberInMonth,\r\n ppg.PayPeriodsInMonth,\r\n ppg.CalendarMonth,\r\n ppg.CalendarYear,\r\n cr.CompanyRuleCode + ' - ' + cr.ShortDescription AS CompanyRuleDisplay,\r\n cr.CompanyRuleCode,\r\n cr.ShortDescription AS CompanyRuleShortDescription\r\nFROM Employee.EmployeeSimple emp\r\nLEFT JOIN Employee.EmployeeRule er ON er.EmployeeRuleID = emp.EmployeeRuleID\r\nLEFT JOIN Company.PayPeriodGen ppg ON ppg.CompanyRuleID = er.CompanyRuleID\r\nLEFT JOIN Company.CompanyRule cr ON cr.CompanyRuleID = ppg.CompanyRuleID\r\nWHERE emp.EmployeeID = @EmployeeID And ppg.PayPeriodGenID >= (SELECT ppg.PayPeriodGenID\r\n FROM Company.PayPeriodGen ppg\r\n LEFT JOIN Employee.EmployeeRule er on er.CompanyRuleID = ppg.CompanyRuleID\r\n LEFT JOIN Employee.EmployeePayPeriod epp on epp.EmployeePayPeriodID = ppg.PayPeriodGenID And epp.EmployeeRuleID = er.EmployeeRuleID\r\n LEFT JOIN Employee.EmployeeSimple emp on emp.EmployeeRuleID = er.EmployeeRuleID\r\n WHERE ppg.PeriodStatus = 'L' And emp.EmployeeID = @EmployeeID)\r\nAND ppg.StartDate > @StartDate AND ppg.EndDate < @EndDate\r\n\r\n -- @EmployeeID defined as Parameter Type = Integer\r\n -- @StartDate defined as Parameter Type = DateTime\r\n -- @EndDate defined as Parameter Type = DateTime\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/GenericGet/T_ADV3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"4503"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 15 Dec 2021 18:17:34 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"businessRules\": [],\n \"data\": [\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 186,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-02-01T00:00:00\",\n \"endDate\": \"2022-02-28T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 2,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 187,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-03-01T00:00:00\",\n \"endDate\": \"2022-03-31T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 3,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 188,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-04-01T00:00:00\",\n \"endDate\": \"2022-04-30T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 4,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 189,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-05-01T00:00:00\",\n \"endDate\": \"2022-05-31T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 5,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 190,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-06-01T00:00:00\",\n \"endDate\": \"2022-06-30T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 6,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 191,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-07-01T00:00:00\",\n \"endDate\": \"2022-07-31T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 7,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 192,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-08-01T00:00:00\",\n \"endDate\": \"2022-08-31T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 8,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 193,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-09-01T00:00:00\",\n \"endDate\": \"2022-09-30T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 9,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n },\n {\n \"employeeID\": 1,\n \"employeeRuleID\": 1,\n \"companyRuleID\": 2,\n \"payPeriodID\": 194,\n \"periodStatus\": \"F\",\n \"startDate\": \"2022-10-01T00:00:00\",\n \"endDate\": \"2022-10-31T00:00:00\",\n \"payPeriodNumberInMonth\": 1,\n \"payPeriodsInMonth\": 1,\n \"calendarMonth\": 10,\n \"calendarYear\": 2022,\n \"companyRuleDisplay\": \"RSA - South Africa\",\n \"companyRuleCode\": \"RSA\",\n \"companyRuleShortDescription\": \"South Africa\"\n }\n ]\n}"}],"_postman_id":"aba9f91b-ee20-4c6a-bdea-f35291c63e92"}],"id":"c3d4eb95-36c5-42b4-8e70-950b781f19c1","description":"The following types of data fields can be setup to be Parameters used in the queries for this API. These data types define the expected input from the API call to be used in the saved query.
\nINT - Integer
\nDECIMAL - Decimal
\nVARCHAR - Varchar
\nBOOLEAN - Boolean
\nDATETIME - Date Time
\nUNIQUE - Unique Identifier
\n\n\nNotes:
\n
From Release 25.4.3.0
Due to the nature of how the API builds the query data, a comma is essential in use where multiple parameters are required and therefore having the comma part of the \"text\" in a specific parameter would break all parameterized queries. If the comma is needed in the parameter value text then you can |, to successfully retrieve the data.
IE: \"ParameterValue\": \"Tester|,\"
\n","_postman_id":"c3d4eb95-36c5-42b4-8e70-950b781f19c1"},{"name":"Employee Increase","item":[{"name":"Employee Increase Create - Header","event":[{"listen":"test","script":{"id":"3749569c-8025-4842-b727-266a1b34b8c3","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","console.log(APIHeaderID)\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","\tpm.expect(pm.response.text()).to.contain(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"f1a32b42-a46f-4231-9f09-af66d94815cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/Header/INCREASE","urlObject":{"protocol":"http","port":"{{APIPort2}}","path":["api","apibase","Header","INCREASE"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1a32b42-a46f-4231-9f09-af66d94815cf"},{"name":"Employee Increase Create - Line","event":[{"listen":"test","script":{"id":"99de4c86-887c-4b69-9387-b19e4e3a8267","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Test For Company Rule Code Validation\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});"],"type":"text/javascript"}}],"id":"6be14228-e41d-4b4e-8185-44924a3aef6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\t\"EmployeeCode\": \"00003\",\n\t\"TransactionValues\": [\n\t\t{\n\t\t\t//\"IncreaseHistoryId\": 5, // Use for Update / Delete\n\t\t\t\"EffectiveDate\": \"2021/01/01\", // Which Date must the Increase become active (Null = Default to Current Period Start Date)\n\t\t\t\"IncreasePercentage\": 2.00, // Amount or Percentage, not both\n\t\t\t//\"IncreaseAmount\": 45000.00, // Amount or Percentage, not both\n\t\t\t\"IncreaseAppliedOn\": \"A\", \n\t\t\t/* \n\t\t\tA - Annual Salary\n\t\t\tP - Period Salary\n\t\t\tR - Rate per Hour\n\t\t\tD - Rate per Day\n\t\t\t*/\n\t\t\t//\"IncreaseReasonTypeID\": 1, //ID or Code (ID supersedes Code)\n\t\t\t\"IncreaseReasonTypeCode\": \"API_1\",\n\t\t\t\"ChargeOutRate\": 555,\n\t\t\t\"AuthorisedBy\": 141 //Authorising Entity Code\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/line/{{APIHeaderID}}","description":"Create Job Costing Input line to specific header
\n","urlObject":{"protocol":"http","port":"{{APIPort2}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6be14228-e41d-4b4e-8185-44924a3aef6e"},{"name":"Employee Increase Update - Header","event":[{"listen":"test","script":{"id":"d5c2f613-1d55-41a3-89be-50ff23a86b97","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","console.log(APIHeaderID)\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","\tpm.expect(pm.response.text()).to.contain(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"294ad92b-1bdc-4cb1-b994-e4202b89cdf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/INCREASE/U","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","INCREASE","U"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"294ad92b-1bdc-4cb1-b994-e4202b89cdf7"},{"name":"Employee Increase Update - Line","event":[{"listen":"test","script":{"id":"e5be55b8-740a-443b-932b-6e8d26518e96","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Test For Company Rule Code Validation\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});"],"type":"text/javascript"}}],"id":"9c541a09-c43d-4e58-b2c8-a9e79c653bec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"CompanyCode\": \"SOUTHAFRICA\",\n\t\"CompanyRuleCode\": \"RSA\",\n\t\"EmployeeCode\": \"00001\",\n\t\"TransactionValues\": [\n\t\t{\n\t\t\"IncreaseHistoryId\": 5, // Use for Update / Delete\n\t\t\t\"EffectiveDate\": \"2021/06/01\", // Which Date must the Increase become active (Null = Default to Period Start Date)\n\t\t\t//\"IncreasePercentage\": 1.00, // Amount or Percentage, not both\n\t\t\t\"IncreaseAmount\": 10000.00, // Amount or Percentage, not both\n\t\t\t\"IncreaseAppliedOn\": \"A\", \n\t\t\t/* \n\t\t\tA - Annual Salary\n\t\t\tP - Period Salary\n\t\t\tR - Rate per Hour\n\t\t\tD - Rate per Day\n\t\t\t*/\n\t\t\t//\"IncreaseReasonTypeID\": 1002, //ID or Code (ID supersedes Code)\n\t\t\t\"IncreaseReasonTypeCode\": \"API_1\", //Customer setup\n\t\t\t\"ChargeOutRate\": 777,\n\t\t\t\"AuthorisedBy\": 142 //Entity Code\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","description":"Create Job Costing Input line to specific header
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c541a09-c43d-4e58-b2c8-a9e79c653bec"},{"name":"Employee Increase Delete - Header","event":[{"listen":"test","script":{"id":"ed66fff6-c790-45c8-93fe-27364801f005","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","console.log(APIHeaderID)\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","\tpm.expect(pm.response.text()).to.contain(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript"}}],"id":"aea296ca-13e1-440c-b46d-2fac73fd6e41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/Header/INCREASE/D","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","Header","INCREASE","D"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aea296ca-13e1-440c-b46d-2fac73fd6e41"},{"name":"Employee Increase Delete - Line","event":[{"listen":"test","script":{"id":"73a9ac69-8d37-4760-bfb1-480567598f55","exec":["let jsonResponse = pm.response.json();","let APILineID = jsonResponse.data.apiObjectID;","pm.environment.set(\"APILineID\", APILineID);","","pm.test(\"Test for Response Case Formatting\", function () {"," pm.expect(pm.response.text()).to.include(\"success\");"," pm.expect(pm.response.text()).to.include(\"data\");"," pm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Successful POST Response Status\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});","","pm.test(\"Response time is less than 500ms\", function () {"," pm.expect(pm.response.responseTime).to.be.below(500);","});","","pm.test(\"Succesful Post\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});","","pm.test(\"apiObjectID returned\", function () {","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");","});","","pm.test(\"Test For Company Rule Code Validation\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.eql(true);","});"],"type":"text/javascript"}}],"id":"f8a44cae-f9e7-47ea-be6e-e659ada97d1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"CompanyCode\": \"SOUTHAFRICA\",\n \"CompanyRuleCode\": \"RSA\",\n \"EmployeeCode\": \"00001\",\n \"TransactionValues\": [\n {\n \"IncreaseHistoryId\": 5 // Use for Update / Delete\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/line/{{APIHeaderID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","line","{{APIHeaderID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8a44cae-f9e7-47ea-be6e-e659ada97d1b"},{"name":"Employee Increase - GET","event":[{"listen":"test","script":{"id":"0b862fde-75ca-42f7-a08d-25be647f5a2d","exec":["pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 800ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(800);\r","});\r","\r","pm.test(\"Test for Response Details - EmployeeID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"employeeID\");\r","});\r","pm.test(\"Test for Response Details - employeeCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"employeeCode\");\r","});\r","pm.test(\"Test for Response Details - companyID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"companyID\");\r","});\r","pm.test(\"Test for Response Details - companyCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"companyCode\");\r","});\r","pm.test(\"Test for Response Details - companyRuleID\", function () {\r"," pm.expect(pm.response.text()).to.include(\"companyRuleID\");\r","});\r","pm.test(\"Test for Response Details - companyRuleCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"companyRuleCode\");\r","});\r","pm.test(\"Test for Response Details - comapanyRuleShortDescription\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"comapanyRuleShortDescription\");\r","});\r","pm.test(\"Test for Response Details - increaseHistoryID\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increaseHistoryID\");\r","});\r","pm.test(\"Test for Response Details - changedPayPeriod\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"changedPayPeriod\");\r","});\r","pm.test(\"Test for Response Details - changedPayPeriodEndDate\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"changedPayPeriodEndDate\");\r","});\r","pm.test(\"Test for Response Details - effectiveDate\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"effectiveDate\");\r","});\r","pm.test(\"Test for Response Details - increaseReasonTypeID\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increaseReasonTypeID\");\r","});\r","pm.test(\"Test for Response Details - increaseReasonTypeCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increaseReasonTypeCode\");\r","});\r","pm.test(\"Test for Response Details - increaseAppliedOn\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increaseAppliedOn\");\r","});\r","pm.test(\"Test for Response Details - increaseAmount\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increaseAmount\");\r","});\r","pm.test(\"Test for Response Details - increasePercentage\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"increasePercentage\");\r","});\r","pm.test(\"Test for Response Details - authorisedBy\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"authorisedBy\");\r","});\r","pm.test(\"Test for Response Details - periodSalary\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"periodSalary\");\r","});\r","pm.test(\"Test for Response Details - previousPeriodSalary\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"previousPeriodSalary\");\r","});\r","pm.test(\"Test for Response Details - periodSalary\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"periodSalary\");\r","});\r","pm.test(\"Test for Response Details - previousAnnualSalary\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"previousAnnualSalary\");\r","});\r","pm.test(\"Test for Response Details - ratePerDay\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"ratePerDay\");\r","});\r","pm.test(\"Test for Response Details - previousRatePerDay\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"previousRatePerDay\");\r","});\r","pm.test(\"Test for Response Details - ratePerHour\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"ratePerHour\");\r","});\r","pm.test(\"Test for Response Details - previousRatePerHour\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"previousRatePerHour\");\r","});\r","pm.test(\"Test for Response Details - chargeOutRate\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"chargeOutRate\");\r","});\r","pm.test(\"Test for Response Details - previousChargeOutRate\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"previousChargeOutRate\");\r","});\r","pm.test(\"Test for Response Details - jobGradeCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"jobGradeCode\");\r","});\r","pm.test(\"Test for Response Details - jobTitleTypeCode\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"jobTitleTypeCode\");\r","});\r","pm.test(\"Test for Response Details - takeOn\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"takeOn\");\r","});\r","pm.test(\"Test for Response Details - lastChanged\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"lastChanged\");\r","});\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});"],"type":"text/javascript"}}],"id":"c8716b3a-b05e-4276-857a-faba0ea90884","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/employee/EmployeesIncreaseHistory/{{EmployeeID}}","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","employee","EmployeesIncreaseHistory","{{EmployeeID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8716b3a-b05e-4276-857a-faba0ea90884"}],"id":"a32e88a0-2cf8-4eab-9c6f-ec1f1e6324e5","description":"The Employee Increase API allows for a Create, Update as well as Delete for existing records. It is required to use separate Headers for each as the data sent is validated in different ways. The GET call is also allowed to extract current information.
\n\n\nNote
\nHistory Takeon Increases can only be done through the Sage 300 People system batch. All History increases applied through the API will be effective in the current processing period of the system.
\n
INCREASE - Create
Will only create new records, if an existing record is found with the same code, then the API will fail for the given record.
INCREASE/U - Update Existing
Will Update the specified record with Override.
INCREASE/D - Delete Existing
Will Delete the specified record.
public class EmployeeIncreaseModel : PayrollBaseModel\n{\npublic List TransactionValues { get; set; }\npublic EmployeeIncreaseModel()\n{\nTransactionValues = new List();\n}\n}\npublic class IncreaseModel : APIBaseModel\n{\npublic int? IncreaseHistoryId { get; set; } // PK of Increase history\npublic string IncreaseAppliedOn { get; set; } // enum (A, P, R, D),\npublic DateTime? EffectiveDate { get; set; } // Effective Date\npublic DateTime? IncreaseProcessedDate { get; set; } // Company Code in Sage 300\npublic int? IncreaseReasonTypeID { get; set; } // FK To increase Type\npublic string IncreaseReasonTypeCode { get; set; } // Code \npublic decimal IncreaseAmount { get; set; } // Increase Amount\npublic decimal IncreasePercentage { get; set; } // Increase Percentage\npublic decimal PreviousChargeOutRate { get; set; } // Previous Charge out Rate\npublic decimal? ChargeOutRate { get; set; } // Charge Out Rate\npublic int AuthorisedBy { get; set; } // Authorise by Entity Code\n}\n\nThe Position Transfer can only be used to transfer Primary Positions. Secondary positions are not allowed. If a position has secondary positions linked, then those positions will also be transferred to the new linking. See Position transfer system documentation for further details.
\n\n\nNote
\nThis API will only transfer existing positions and can't be used to link new positions.
\n
public class EmployeePositionTransferModel : PayrollBaseModel\n{\npublic string EmployeeCode { get; set; }\npublic int EmployeeId { get; set; }\npublic string CompanyCode { get; set; }\npublic int CompanyId { get; set; }\npublic string CompanyRuleCode { get; set; }\n\npublic int CompanyRuleID { get; set; }\npublic string CurrentPositionCode { get; set; }\npublic int CurrentPositionID { get; set; }\npublic int TransferReasonID { get; set; }\npublic string TransferReason { get; set; }\npublic DateTime CurrentPositionEndDate { get; set; }\npublic int CurrentPositionReasonID { get; set; }\npublic string CurrentPositionReason { get; set; }\n \npublic EmployeePositionsListModel NewPosition { get; set; }\n}\n\npublic class EmployeePositionsListModel\n{\npublic DateTime StartDate { get; set; }\npublic int NewPositionID { get; set; }\npublic string NewPositionCode { get; set; }\npublic int PositionReasonID { get; set; }\npublic string PositionReason { get; set; }\n}\nGet's the PayPeriod ID for the required/Defined GL Setup ID.\nGL Setup ID required in the command to be able to return the available Pay Period.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","generalledger","GetGLSetupPayPeriods","{{GLSetupID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc63e18c-706e-4efa-997b-e8c6af21c5d3"},{"name":"GL Export - Export GL Data","id":"77575a8a-1042-4929-a04a-98a2b3e8e2d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"GLSetupID\": \"{{GLSetupID}}\",\n \"PayPeriodGenID\": 73\n}"},"url":"http://{{HostName}}:{{APIPort}}/api/generalledger/GetGLExport","description":"Get's the PayPeriod ID for the required/Defined GL Setup ID.\nGL Setup ID required in the command to be able to return the available Pay Period.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","generalledger","GetGLExport"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"77575a8a-1042-4929-a04a-98a2b3e8e2d6"}],"id":"04597cd6-3a35-4ff2-a8eb-c1af72fb0ba4","description":"To utilize the GL API requests, the APIKey Description must contain the following value: \nGL_API_AUTH
\nThe GL export is per generated GL export and period.
\n\n\nNote
\nThe required GL will need to be Generated in Sage 300 People before the data can be extracted.
\n
This API is a 2 step process:
\npublic partial class GeneralLedgerTransactionModel : BaseModel\n{\n public int GLSetupID { get; set; }\n public int PayPeriodGenID { get; set; }\n}\n\nReturns the Details for the Employee of the provided \"EmployeeID\" in the Header URL. \nReturns all linked information on the Employee Record, not only the Active Record of medical aid on the Contracts and Benefits Screen, but all records.
\nResponse values are laid out in the required format in JSON to be used in the Create / Update API Calls. Can also be used for the Delete Call.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","employeemedical","GetMedicalAidRules","{{employeeID}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5982cd8-1b82-4fac-93e5-fe0cc055e26c"}],"id":"819110a1-fdae-4c92-9e4f-17a504d58bb8","description":"The Employee Medical Aid Plan API allows for a Create, Update as well as Delete for existing records. It is required to use separate Headers for each as the data sent is validated in different ways. The GET call is also allowed to extract current information.
\nCreate Medical Aid Plan - Header & Line
Update Medical Aid Plan - Header & Line
Retrieve - Per Employee ID: no Body data sent (GET)
Delete Medical Aid Plan - Header & Line
A validation in the system has been added where you can only link to a Medical Aid Plan which has the status = Active. Therefore the API will fail on Validation when an Inactive plan is selected.
\npublic class EmployeeMedicalAidModel : PayrollBaseModel\n{\npublic int EmployeeID { get; set; } // Employee ID in Sage 300 (Alternatively Use EmployeeCode + (CompanyRuleCode or CompanyCode))\npublic string EmployeeCode { get; set; } // Employee Code\npublic string CompanyRuleCode { get; set; } // Company Rule Code in Sage 300\npublic string CompanyCode { get; set; } // Company Code in Sage 300\npublic int? MedicalAidProvider { get; set; } // Medical Aid Provider - only used for GET\npublic string OptionType { get; set; } // Option Type - only used for GET\npublic string Code { get; set; } // Code - only used for GET\npublic string ShortDescription { get; set; } // Short Description only used for GET\npublic int? EmployeeMedicalAidRuleID { get; set; } // Employee Medical Aid Rule ID\npublic string MedicalAidRule { get; set; } // Medical Aid Rule\npublic int MedicalAidRuleID { get; set; } // Looked up id of Medical Aid Rule\npublic string MembershipNumber { get; set; } // Membership Number\npublic string Status { get; set; } // Status\npublic DateTime StartDate { get; set; } // Start Date\npublic DateTime? EndDate { get; set; } // End Date\npublic string AdditionalCostDescription { get; set; } // Additional Cost Description\npublic decimal? AdditionalCostAmount { get; set; } // Additional Cost Amount\npublic DateTime? AdditionalCostEndDate { get; set; } // Additional Cost End Date\npublic List MedicalAidDependants { get; set; } // Collection to Add Dependants to the medical aid rule\n}\npublic class MedicalAidDependantModel\n{\npublic int? MedicalAidRuleDependantTypeRelationshipID { get; set; } // Medical Aid Rule Dependant Type Relationship ID\npublic string MedicalAidRuleDependantTypeRelationship { get; set; } // Medical Aid Rule Dependant Type Relationship\npublic int? Quantity { get; set; } // Quantity\n}\n\nThe Retrieve Job Title information can be used in 2 ways.
\nExamples of each are included.
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","jobtitle","getJobTitles"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"af3c145e-0522-4eab-83c5-d69d0e94443b","name":"Retrieve Job Titles - All","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//No body / Payload, will return all Job Titles in the system.\r\n","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/getJobTitles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"1789"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:28:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"code\": \"ANANLYST\",\n \"shortDescription\": \"Analyst\",\n \"longDescription\": \"Analyst\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 3\n },\n {\n \"code\": \"DIRECTOR\",\n \"shortDescription\": \"Director\",\n \"longDescription\": \"Director\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 4\n },\n {\n \"code\": \"MANAGER001\",\n \"shortDescription\": \"Manager: Senior\",\n \"longDescription\": \"Manager: Senior\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 5\n },\n {\n \"code\": \"MANAGER002\",\n \"shortDescription\": \"Manager: Junior\",\n \"longDescription\": \"Manager: Junior\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 6\n },\n {\n \"code\": \"TEAMLEAD\",\n \"shortDescription\": \"Team Leader\",\n \"longDescription\": \"Team Leader\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 7\n },\n {\n \"code\": \"DEVELOPER\",\n \"shortDescription\": \"Developer\",\n \"longDescription\": \"Developer\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 8\n },\n {\n \"code\": \"TESTER\",\n \"shortDescription\": \"Tester\",\n \"longDescription\": \"Tester\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 9\n },\n {\n \"code\": \"TEST\",\n \"shortDescription\": \"TEST\",\n \"longDescription\": \"TEST\",\n \"comment\": \"TEST\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 15\n },\n {\n \"code\": \"TEST_NEW\",\n \"shortDescription\": \"t\",\n \"longDescription\": \"t\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 16\n },\n {\n \"code\": \"Q\",\n \"shortDescription\": \"q\",\n \"longDescription\": \"q\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 19\n }\n ],\n \"message\": \"Could not read the Object Supplied.\"\n}"},{"id":"9897ce73-9491-4f82-912c-5a9f93926d70","name":"Retrieve Job Title - ID Specified","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//No body / Payload, will return all Job Titles in the system.\r\n//Get a specific Job Title by suplying the JobTitleTypeID or Job Tytle Code.\r\n{\r\n\t\"jobTitleTypeID\": 3\r\n\t//\"code\": \"MANAGER001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/getJobTitles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:28:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"code\": \"ANANLYST\",\n \"shortDescription\": \"Analyst\",\n \"longDescription\": \"Analyst\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 3\n }\n}"},{"id":"cdffb93e-e501-42b1-9d57-f039d996c55a","name":"Retrieve Job Title - Code Specified","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//No body / Payload, will return all Job Titles in the system.\r\n//Get a specific Job Title by suplying the JobTitleTypeID or Job Tytle Code.\r\n{\r\n\t//\"jobTitleTypeID\": 3\r\n\t\"code\": \"MANAGER001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/getJobTitles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"201"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:29:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"code\": \"MANAGER001\",\n \"shortDescription\": \"Manager: Senior\",\n \"longDescription\": \"Manager: Senior\",\n \"status\": \"A\",\n \"jobTitleTypeID\": 5\n }\n}"}],"_postman_id":"f9cf2906-171a-4c5c-918a-631d1a4dc662"},{"name":"Create - JobTitle (POST)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"05c038c4-52fb-4a99-bdb8-f4e7b011d588"}}],"id":"59eb23e6-e698-4674-8ac4-1672a54c223d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"// Single or multiple Job Titles can be created\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_ALL1\",\r\n\t\t\t\"ShortDescription\": \"JT Short\",\r\n\t\t\t\"LongDescription\": \"JT Long\",\r\n\t\t\t\"Comment\": \"JT Comment\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_MIN1\",\r\n\t\t\t\"ShortDescription\": \"JT Min Short\",\r\n\t\t\t\"LongDescription\": \"JT Min Long\"\r\n\t\t\t//\"Comment\": \"JT Min Comment\",\r\n\t\t\t//\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle","description":"Note:
\nWhere there is an \"Enter / New Line\" in the Comments field the data protocol returns the value \"\\r\\n\" in the data instead of a \"blank / new line\" .
\n
The Create Job Title will create a new record in the Job Title Type setup in Sage 300 People.
\nThe system requirements for Job Title is a system wide application, therefore no Company or Company Rule is required.
\nMultiple entries can be sent at once and will be validated and processed individually. If one fails the rest will still be processed.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","jobtitle"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"9b3e4af5-8bc5-4042-9c56-00990d1bac16","name":"Create - Job Title - Multiple Item","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"// Single or multiple Job Titles can be created\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_ALL1\",\r\n\t\t\t\"ShortDescription\": \"JT Short\",\r\n\t\t\t\"LongDescription\": \"JT Long\",\r\n\t\t\t\"Comment\": \"JT Comment\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_MIN1\",\r\n\t\t\t\"ShortDescription\": \"JT Min Short\",\r\n\t\t\t\"LongDescription\": \"JT Min Long\"\r\n\t\t\t//\"Comment\": \"JT Min Comment\",\r\n\t\t\t//\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"191"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:30:36 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"message\": \"Job Title Code 'JT_ALL1' saved sucessfully\"\n },\n {\n \"success\": true,\n \"message\": \"Job Title Code 'JT_MIN1' saved sucessfully\"\n }\n]"},{"id":"4f49f3a8-aa4c-48fc-861f-5506e271db35","name":"FAIL Create - Job Title - Items Exist","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"// Single or multiple Job Titles can be created\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_ALL1\",\r\n\t\t\t\"ShortDescription\": \"JT Short\",\r\n\t\t\t\"LongDescription\": \"JT Long\",\r\n\t\t\t\"Comment\": \"JT Comment\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"JT_MIN1\",\r\n\t\t\t\"ShortDescription\": \"JT Min Short\",\r\n\t\t\t\"LongDescription\": \"JT Min Long\"\r\n\t\t\t//\"Comment\": \"JT Min Comment\",\r\n\t\t\t//\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"185"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:31:13 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"Job Title Code 'JT_ALL1' already exist\"\n },\n {\n \"success\": false,\n \"message\": \"Job Title Code 'JT_MIN1' already exist\"\n }\n]"},{"id":"a82204d1-d496-4810-b33a-e2043b6b73b4","name":"FAIL Create - Job Title - Validation Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"// Single or multiple Job Titles can be created\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"INVALID CODE\",\r\n\t\t\t\"ShortDescription\": \"JT Short\",\r\n\t\t\t\"LongDescription\": \"JT Long\",\r\n\t\t\t\"Comment\": \"JT Comment\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:32:08 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"Job Title Code 'INVALID CODE' cannot be saved\"\n }\n]"}],"_postman_id":"59eb23e6-e698-4674-8ac4-1672a54c223d"},{"name":"Update - JobTitle (PUT)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"95b6ef7f-1fb8-4568-942f-88d4ae008947"}}],"id":"fc2420ea-26a6-4659-87b2-a2cbb55b210d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//Single or multiple job titles can be updated\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t//Identifier - Mandatory for Update\r\n\t\t\t\"jobTitleTypeID\": 15,\r\n\t\t\t// Fields to be updated\r\n\t\t\t\"Code\": \"UP_MAX\",\r\n\t\t\t\"ShortDescription\": \"Update for All fields available\",\r\n\t\t\t\"LongDescription\": \"Update for All fields available\",\r\n\t\t\t\"Comment\": \"Update for All fields available\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"jobTitleTypeID\": 16,\r\n\t\t\t\"Code\": \"UP_MIN\",\r\n\t\t\t\"ShortDescription\": \"Minimum fields required\",\r\n\t\t\t\"LongDescription\": \"Minimum fields required\"\r\n\t\t//\t\"Comment\": \"Comment for update on Job Title 3\",\r\n\t\t//\t\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/update","description":"The Update Job Title will alter the specified record in the Job Title Type setup in Sage 300 People.
\nThe system requirements for Job Title is a system wide application, therefore no Company or Company Rule is required.
\nAs the \"Code\" field is an editable field, the Identifier field is the \"JobTitleTypeID\" and is mandatory for this call.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","jobtitle","update"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"5fe6f448-f719-429e-a65b-c136a42d4f6c","name":"Update - Job Title - Multiple Items","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//Single of multiple job titles can be updated\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t//Identifier\r\n\t\t\t\"jobTitleTypeID\": 15,\r\n\t\t\t// Fields to be updated\r\n\t\t\t\"Code\": \"TEST_NEW2\",\r\n\t\t\t\"ShortDescription\": \"Update for Job Title 2\",\r\n\t\t\t\"LongDescription\": \"Update for Job Title 2\",\r\n\t\t\t\"Comment\": \"Comment for update on Job Title 2\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"jobTitleTypeID\": 16,\r\n\t\t\t\"Code\": \"API_UP3\",\r\n\t\t\t\"ShortDescription\": \"Update for Job Title 3\",\r\n\t\t\t\"LongDescription\": \"Update for Job Title 3\",\r\n\t\t\t\"Comment\": \"Comment for update on Job Title 3\",\r\n\t\t\t\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"197"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:34:58 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": true,\n \"message\": \"Job Title Code 'TEST_NEW2' updated sucessfully\"\n },\n {\n \"success\": true,\n \"message\": \"Job Title Code 'API_UP3' updated sucessfully\"\n }\n]"},{"id":"296f3666-4b8d-4aa6-9369-22b9a947d493","name":"Update - Job Title All fields and Minumum Required fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"//Single of multiple job titles can be updated\r\n{\r\n\t\"JobTitleList\": [\r\n\t\t{\r\n\t\t\t//Identifier - Mandatory for Update\r\n\t\t\t\"jobTitleTypeID\": 15,\r\n\t\t\t// Fields to be updated\r\n\t\t\t\"Code\": \"UP_MAX\",\r\n\t\t\t\"ShortDescription\": \"Update for Job Title 2\",\r\n\t\t\t\"LongDescription\": \"Update for Job Title 2\",\r\n\t\t\t\"Comment\": \"Comment for update on Job Title 2\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"jobTitleTypeID\": 16,\r\n\t\t\t\"Code\": \"UP_MIN\",\r\n\t\t\t\"ShortDescription\": \"Update for Job Title 3\",\r\n\t\t\t\"LongDescription\": \"Update for Job Title 3\"\r\n\t\t//\t\"Comment\": \"Comment for update on Job Title 3\",\r\n\t\t//\t\"Status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/jobtitle/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"190"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:37:08 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"success\": false,\n \"message\": \"Job Title Code 'UP_MAX' cannot be saved\"\n },\n {\n \"success\": true,\n \"message\": \"Job Title Code 'UP_MIN' updated sucessfully\"\n }\n]"}],"_postman_id":"fc2420ea-26a6-4659-87b2-a2cbb55b210d"}],"id":"97114aa7-588f-4382-8887-cb1594275cdf","description":"These API calls are designed to Create and Maintain the Job Title setup within the Sage 300 People system. The Job Title Items are system wide fields and therefore don't have the requirements of specifying a Company and Company Rule.
\nThe Job Title API's consists of 3 API's, each API has it's own rules and logic which is described on each API call.
\nJob Title API's:
\n\n\nNote:
\nAll API calls follow the Method = POST
\n
\n\nThe Job Title sections for Skills Information, Equity Information as well as OFO information has been specifically excluded for all API calls (Retrieve, Create and Update).
\n
public class JobTitleListModel\n{\npublic List JobTitleList { get; set; }\n}\npublic class JobTitleAPIModel\n{\npublic string Code { get; set; } // Job Title Code\npublic string ShortDescription { get; set; } // Short Description for Job Title\npublic string LongDescription { get; set; } // Long Description for Job Title\npublic string Comment { get; set; } // Comment Field for Job Title\npublic string Status { get; set; } // Status of Job Title\npublic int JobTitleTypeID { get; set; } // System generated ID for Job Title\n\n}\n\nThe Retrieve Job Grade information can be used in 2 ways.
\nExamples of each are included.
\n\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","getJobGrade"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"31a9f2c8-e03f-4caf-8f6b-e5dbd1b4f64b","name":"Retrieve - Job Grade (GET) ALL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getJobGrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"893"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Fri, 22 Apr 2022 11:13:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"jobGradeID\": 1,\n \"code\": \"JOBGRADE_TIER4\",\n \"shortDescription\": \"Senior\",\n \"longDescription\": \"Senior\",\n \"status\": \"A\"\n },\n {\n \"jobGradeID\": 2,\n \"code\": \"JOBGRADE_TIER1\",\n \"shortDescription\": \"Director\",\n \"longDescription\": \"Director\",\n \"status\": \"A\"\n },\n {\n \"jobGradeID\": 3,\n \"code\": \"JOBGRADE_TIER2\",\n \"shortDescription\": \"Management\",\n \"longDescription\": \"Management\",\n \"status\": \"A\"\n },\n {\n \"jobGradeID\": 4,\n \"code\": \"JOBGRADE_TIER3\",\n \"shortDescription\": \"Team Leader\",\n \"longDescription\": \"Team Leader\",\n \"status\": \"A\"\n },\n {\n \"jobGradeID\": 5,\n \"code\": \"JOBGRADE_TIER5\",\n \"shortDescription\": \"Junior\",\n \"longDescription\": \"Junior\",\n \"status\": \"A\"\n }\n ]\n}"},{"id":"1dec7e30-c9fc-4670-9247-471faf83441e","name":"Retrieve - Job Grade (GET) by ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"jobGradeID\": 1\r\n\t//\"code\": \"JOBGRADE_TIER1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getJobGrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"183"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Fri, 22 Apr 2022 11:14:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"code\": \"JOBGRADE_TIER4\",\n \"shortDescription\": \"Senior\",\n \"longDescription\": \"Senior\",\n \"status\": \"A\",\n \"jobGradeId\": 1\n }\n}"},{"id":"b86dd086-2d89-4da8-bfc8-30e8996931fa","name":"Retrieve - Job Grade (GET) by Code","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//\"jobGradeID\": 1\r\n\t\"code\": \"JOBGRADE_TIER1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getJobGrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"250"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Fri, 22 Apr 2022 11:16:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"jobGradeID\": 2,\n \"code\": \"JOBGRADE_TIER1\",\n \"shortDescription\": \"Director\",\n \"longDescription\": \"Director\",\n \"comment\": \"Comment field\\r\\n\",\n \"status\": \"A\"\n }\n ]\n}"},{"id":"26141e96-da93-4e58-99d9-9d9c5142bb16","name":"FAIL Retrieve - Job Grade (GET)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"jobGradeID\": 12345\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getJobGrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"60"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 04 May 2022 06:18:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Invalid JobGradeId\"\n}"}],"_postman_id":"ef21c6fc-4a88-4036-92f4-189d101e62c2"},{"name":"Create - JobGrade (POST)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"79d0a20d-5d86-4ea8-b5d8-eae35def0750"}}],"id":"f06ba3d4-c9bc-4801-beab-88b4dafd36c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"JobGrades\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"AllFields\",\r\n\t\t\t\"ShortDescription\": \"Short Description\",\r\n\t\t\t\"LongDescription\": \"Long Description\",\r\n\t\t\t\"Comment\": \"Comment Testing\",\r\n\t\t\t\"status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"MinFields\",\r\n\t\t\t\"ShortDescription\": \"Short Min\",\r\n\t\t\t\"LongDescription\": \"Long Min\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"Test3\",\r\n\t\t\t\"ShortDescription\": \"T3\",\r\n\t\t\t\"LongDescription\": \"T3\",\r\n\t\t\t\"Comment\": \"Test3\",\r\n\t\t\t\"status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createJobGrades","description":"Note:
\nWhere there is an \"Enter / New Line\" in the Comments field the data protocol returns the value \"\\r\\n\" in the data instead of a \"blank / new line\" .
\n
The Create Job Grade will create a new record in the Job Grade setup in Sage 300 People.
\nThe system requirements for Job Grade is a system wide application, therefore no Company or Company Rule is required.
\nMultiple entries can be sent at once and will be validated and processed individually. If one fails the rest will still be processed.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","createJobGrades"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"9a946371-bf6c-4fd5-82f1-3134b25ec942","name":"Create - JobGrade (POST) - Multiple item PASS and FAIL","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"JobGrades\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"AllFields\",\r\n\t\t\t\"ShortDescription\": \"Short Description\",\r\n\t\t\t\"LongDescription\": \"Long Description\",\r\n\t\t\t\"Comment\": \"Comment Testing\",\r\n\t\t\t\"status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"MinFields\",\r\n\t\t\t\"ShortDescription\": \"Short Min\",\r\n\t\t\t\"LongDescription\": \"Long Min\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"Test3\",\r\n\t\t\t\"ShortDescription\": \"T3\",\r\n\t\t\t\"LongDescription\": \"T3\",\r\n\t\t\t\"Comment\": \"Test3\",\r\n\t\t\t\"status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createJobGrades"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 04 May 2022 06:31:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n \"AllFields already exist\",\n \"Test3 already exist\"\n ]\n}"},{"id":"5fa4e3e1-8254-4e85-b0ad-9a6dd33bcab8","name":"Create - JobGrade (POST) Multiple Item - All Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"JobGrades\": [\r\n\t\t{\r\n\t\t\t\"Code\": \"AllFields\",\r\n\t\t\t\"ShortDescription\": \"Short Description\",\r\n\t\t\t\"LongDescription\": \"Long Description\",\r\n\t\t\t\"Comment\": \"Comment Testing\",\r\n\t\t\t\"status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"MinFields\",\r\n\t\t\t\"ShortDescription\": \"Short Min\",\r\n\t\t\t\"LongDescription\": \"Long Min\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Code\": \"Test3\",\r\n\t\t\t\"ShortDescription\": \"T3\",\r\n\t\t\t\"LongDescription\": \"T3\",\r\n\t\t\t\"Comment\": \"Test3\",\r\n\t\t\t\"status\": \"A\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createJobGrades"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"58"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 04 May 2022 06:32:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"JobGrade inserted\"\n}"}],"_postman_id":"f06ba3d4-c9bc-4801-beab-88b4dafd36c9"},{"name":"Update - JobGrade (PUT)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"e126fd0f-84ef-4202-8e62-bb0f2b283efb"}}],"id":"19db7452-3bc2-419b-aa07-f196da1c1d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier - Mandatory for Update\r\n\t\"jobGradeID\": 19,\r\n\r\n\t//Fields to be updated\r\n\t\"Code\": \"lowercase\",\r\n\t\"ShortDescription\": \"2aaShort Description\",\r\n\t\"LongDescription\": \"3aaaLong Description\",\r\n\t\"Comment\": \"4aaaaComment Testing\",\r\n\t\"status\": \"I\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateJobgrade","description":"The Update Job Grade will alter the specified record in the Job Grade setup in Sage 300 People.
\nThe system requirements for Job Grade is a system wide application, therefore no Company or Company Rule is required.
\nAs the \"Code\" field is an editable field, the Identifier field is the \"JobGradeID\" and is mandatory for this call.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","updateJobgrade"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"87fff3bb-52b3-4950-b4bc-8bb4746abad7","name":"FAIL Update - JobGrade (PUT)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier - Mandatory for Update\r\n\t\"jobGradeID\": 19,\r\n\r\n\t//Fields to be updated\r\n\t\"Code\": \"JOBGRADE_TIER4\",\r\n\t\"ShortDescription\": \"2aaShort Description\",\r\n\t\"LongDescription\": \"3aaaLong Description\",\r\n\t\"Comment\": \"4aaaaComment Testing\",\r\n\t\"status\": \"I\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateJobgrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"77"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 04 May 2022 06:21:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Job grade code exist JOBGRADE_TIER4\"\n}"},{"id":"673cbafc-5dd3-4a63-890b-757af65ee469","name":"SUCCESS Update - JobGrade (PUT)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier - Mandatory for Update\r\n\t\"jobGradeID\": 19,\r\n\r\n\t//Fields to be updated\r\n\t\"Code\": \"lowercase\",\r\n\t\"ShortDescription\": \"2aaShort Description\",\r\n\t\"LongDescription\": \"3aaaLong Description\",\r\n\t\"Comment\": \"4aaaaComment Testing\",\r\n\t\"status\": \"I\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateJobgrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"23"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 04 May 2022 06:22:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"19db7452-3bc2-419b-aa07-f196da1c1d4f"}],"id":"6af71dc1-748b-458b-a56e-b419648bfb7a","description":"These API calls are designed to Create and Maintain the Job Grade setup within the Sage 300 People system. The Job Grade Items are system wide fields and therefore don't have the requirements of specifying a Company and Company Rule.
\nThe Job Grade API's consists of 3 API's, each API has it's own rules and logic which is described on each API call.
\nJob Title API's:
\n\n\nNote:
\nAll API calls follow the Method = POST
\n
\n\nThe Job Grade sections for Skills Information, Equity Information as well as OFO information has been specifically excluded for all API calls (Retrieve, Create and Update).
\n
public class JobGradeAPIModel\n{\npublic string Code { get; set; } // Job Grade Code\npublic string ShortDescription { get; set; } // Short Description for Job Grade\npublic string LongDescription { get; set; } // Long Description for Job Grade\npublic string Status { get; set; } // Status of Job Grade\npublic string Comment { get; set; } // Comment Field for Job Grade\npublic int JobGradeId { get; set; } // System generated ID for Job Grade\n}\npublic class JobGradeAPIListModel\n{\npublic List JobGrades { get; set; }\n}\n\nThe Retrieve Hierarchy information can be used in 2 ways.
\nExamples of each are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","getHierarchy"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"a3279baa-98ac-4ff2-b0ec-6250b94c65e3","name":"Retrieve - By Hierarchy Code","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//\"HierarchyHeaderId\": \"1\"\r\n\t\"HierarchyHeaderCode\": \"Department\"\r\n}\r\n// No Body defined will return all Headers and Details Items of each Hierarchy in the system.","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getHierarchy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"1313"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 12 Apr 2022 08:57:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"code\": \"DEPARTMENT\",\n \"shortDescription\": \"Department\",\n \"longDescription\": \"Department\",\n \"hierarchyHeaderId\": 2,\n \"hierarchyItems\": [\n {\n \"hierarchyCode\": \"FINANCE\",\n \"hierarchyName\": \"Finance\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 2\n },\n {\n \"hierarchyCode\": \"IT\",\n \"hierarchyName\": \"Information Technology\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 2\n },\n {\n \"hierarchyCode\": \"DEVELOPMENT\",\n \"hierarchyName\": \"Development\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 2\n },\n {\n \"hierarchyCode\": \"HR\",\n \"hierarchyName\": \"Human Resources\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 2\n }\n ],\n \"apiLineID\": \"00000000-0000-0000-0000-000000000000\"\n }\n ]\n}"},{"id":"dcb85552-3d3d-476e-9a11-fb38628234a1","name":"Retrieve - By Hierarchy ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"HierarchyHeaderId\": \"1\"\r\n\t//\"HierarchyHeaderCode\": \"Department\"\r\n}\r\n// No Body defined will return all Headers and Details Items of each Hierarchy in the system.","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getHierarchy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"1068"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 12 Apr 2022 08:58:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"code\": \"MYS_HRD_PERC\",\n \"shortDescription\": \"Malaysia - HRD Levy Percentage\",\n \"longDescription\": \"Malaysia - HRD Levy Percentage\",\n \"hierarchyHeaderId\": 1,\n \"hierarchyItems\": [\n {\n \"hierarchyCode\": \"1\",\n \"hierarchyName\": \"Exempt Employer\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 1\n },\n {\n \"hierarchyCode\": \"2\",\n \"hierarchyName\": \"1.0%\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 1\n },\n {\n \"hierarchyCode\": \"3\",\n \"hierarchyName\": \"0.5%\",\n \"costCentre\": false,\n \"canLink\": true,\n \"status\": \"A\",\n \"hierarchyHeaderId\": 0,\n \"hierarchyId\": 1\n }\n ],\n \"apiLineID\": \"00000000-0000-0000-0000-000000000000\"\n }\n ]\n}"},{"id":"cac5925c-bbce-4056-9b8b-1185816b16b5","name":"FAIL - Method = GET not allowed","originalRequest":{"method":"GET","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/getHierarchy"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Allow","value":"POST"},{"key":"Content-Length","value":"79"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Wed, 13 Apr 2022 13:18:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requested resource does not support http method 'GET'.\"\n}"}],"_postman_id":"dc7485b3-c38f-4549-9774-f77202740fe6"},{"name":"Create Hierarchy - Header (POST)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"9aa806dd-5fbe-40a6-852f-49be35b8f38c"}}],"id":"0c15e642-9d3b-4904-a97b-c19e417d393f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Header Record Details:\r\n\t\"HierarchyHeaderCode\": \"API_NEW1\",\r\n\t\"ShortDescription\": \"API CREATE 1\",\r\n\t\"LongDescription\": \"api create 1\",\r\n\t\"GeographicLocation\": true,\r\n\t\"Comment\": \"HEADER Comment field\",\r\n\r\n//Initial Item required to create Hierarchy Header Record:\r\n\t\"HierarchyCode\": \"API_NEW122\",\r\n\t\"HierarchyName\": \"API Create Item 1\",\r\n\t\"CostCentre\": true,\r\n\t\"CanLink\": true,\r\n\t\"Entity\": null,\r\n\t\"itemComment\": \"ITEM Comment\",\r\n\t\"ItemStatus\": \"A\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/createHierarchyHeader","description":"The Create Hierarchy Header will create a new record in the Hierarchy setup in Sage 300 People.
\nThe system requirements force a Detail Item to be created as well during this process, therefore the requirements in this API is for the Header Record as well as a single Detail item.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort2}}","path":["api","apibase","createHierarchyHeader"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"061db848-ebf4-4889-a69e-a9cfd28b9b8a","name":"Create Hierarchy - Header Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Header Record Details:\r\n\t\"HierarchyHeaderCode\": \"API_NEW\",\r\n\t\"ShortDescription\": \"API CREATE 1\",\r\n\t\"LongDescription\": \"api create 1\",\r\n\t\"GeographicLocation\": true,\r\n\t\"Comment\": \"HEADER Comment field\",\r\n\r\n//Initial Item required to create Hierarchy Header Record:\r\n\t\"HierarchyCode\": \"API_NEW122\",\r\n\t\"HierarchyName\": \"API Create Item 1\",\r\n\t\"CostCentre\": true,\r\n\t\"CanLink\": true,\r\n\t\"Entity\": \"null\",\r\n\t\"itemComment\": \"ITEM Comment\",\r\n\t\"ItemStatus\": \"A\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createHierarchyHeader"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"66"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:41:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Hierarchy Header inserted\"\n}"},{"id":"5ce8f512-1f25-4c95-ae3d-78f7d2b2a4b3","name":"FAIL Create Hierarchy - Header - Existing Header","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Header Record Details:\r\n\t\"HierarchyHeaderCode\": \"API_NEW\",\r\n\t\"ShortDescription\": \"API CREATE 1\",\r\n\t\"LongDescription\": \"api create 1\",\r\n\t\"GeographicLocation\": true,\r\n\t\"Comment\": \"HEADER Comment field\",\r\n\r\n//Initial Item required to create Hierarchy Header Record:\r\n\t\"HierarchyCode\": \"API_NEW122\",\r\n\t\"HierarchyName\": \"API Create Item 1\",\r\n\t\"CostCentre\": true,\r\n\t\"CanLink\": true,\r\n\t\"Entity\": \"null\",\r\n\t\"itemComment\": \"ITEM Comment\",\r\n\t\"ItemStatus\": \"A\"\r\n\t//A - Active\r\n\t//I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createHierarchyHeader"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"69"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Set-Cookie","value":"PeopleEssUser=AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAwFUHEnjfxUCUVc2YjwriQAAAAAACAAAAAAAQZgAAAAEAACAAAABu8KqDUaeLwPxdLA0IrJlQJffSzqkkW8ySbO-UF5lCbAAAAAAOgAAAAAIAACAAAACK1xZYDy89tVck0mJQOKpN4jYwI34z5AKTNyevKCglTsABAABVyeETfiD9oSYUmgn4Xa2ZdGfmVi7VEVrmaUFd0gW0q0IkW071fDyfO-qW6MCOekKzXuXMdCNflumCYJyr7opa6ZKUucRES6-LEyZ6KgYnlmf47F7GY6b7KiBH0aFnDi6VEQ-zYUU2EtfPNyaILZLQ80oJLiT8Eg5KkMbKkw7sVGWKw4_K3LNlS_PRDoxyESkHp-UmYk4tTU-jJTF4X1SJdXX3b3K3Q9uXON0ZfM1oqleuMeozScG1aUcYAhm-N5vScIu-ViSrYHKOgStRpWn4CuT0wx4xeHN8FJlJ65ekBvpOEQywyESgdqaFkCMMQhezjDFr_3eL-FTJt8H1Zvu914fUGCT2ADmPYDtsDZ01uQzzu85bOCdk-84kUq4oFR9cpjRDC8KCcvVQkGDp6E0Bl3ul24-cmCaAIBx2fGewMKHGJSRRXLTHbN_XLmNxFYlRhtbA4wY5ykGMvV9x9MN4NwTc8eCuEA6I09kGCbKlAGMAENRS50kzZ0-Xf0yRTvt8OmncjpodO2V_GVkSXv-2NlvzWPNq-7fZLgGo6lL2JAJb2mO1McOQLH1KLqP56Iqo1o28vwAWurJDHX4R_dDRQAAAAJB2y4v0KUcVMg7AqA8Xtq-tc-BfRpgsjNi0koPiQ7lcWhshdUpsF-4kfOqs5pPrg0wO7Ss0_BZX0tf1NYt5myo; path=/; HttpOnly; SameSite=Lax"},{"key":"Date","value":"Tue, 19 Apr 2022 06:47:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Hierarchy Header Item exist\"\n}"}],"_postman_id":"0c15e642-9d3b-4904-a97b-c19e417d393f"},{"name":"Create Hierarchy - Item/s (POST)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"2c139ace-35bb-4456-bab0-0afbb086acdb"}}],"id":"22abf34c-6c89-480b-92b2-4907ae455074","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Specified Hierarchy Header where the Detail Items are to be created in.\t\r\n\t\"HierarchyHeaderCode\": \"API_NEW1\",\r\n\t//\"HierarchyHeaderId\": 13,\r\n\t\"HierarchyHeaderItems\": [\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ALL\",\r\n\t\t\t\"HierarchyName\": \"API all selections\",\r\n\t\t\t\"CostCentre\": true,\r\n\t\t\t\"CanLink\": true,\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Comment API Item ALL\",\r\n\t\t\t\"ItemStatus\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_MIN\",\r\n\t\t\t\"HierarchyName\": \"API Minimum fields\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT1\",\r\n\t\t\t\"HierarchyName\": \"API Entity 1\",\r\n\t\t\t\"Entity\": \"21\",\r\n\t\t\t\"itemComment\": \"Entity 21 = INDV\",\r\n\t\t\t\"ItemStatus\": null //defaults to A - Active\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT2\",\r\n\t\t\t\"HierarchyName\": \"API Entity 2\",\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Entity 16 = CMPY\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/createHierarchyHeaderItem","description":"The Create Hierarchy Item will create a new record in the specified Hierarchy header setup in Sage 300 People.
\nThe API allows for multiple items to be loaded at a time but limits to only saving to one Header record at a time.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort2}}","path":["api","apibase","createHierarchyHeaderItem"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"d668fc57-fd0b-4ab7-a9e1-32f7909a4235","name":"Create Hierarchy - Item/s (POST) - Multiple Items","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//\"HierarchyHeaderCode\": \"TEST\",\r\n\t\"HierarchyHeaderId\": 4,\r\n\t\"HierarchyHeaderItems\": [\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ALL\",\r\n\t\t\t\"HierarchyName\": \"API all selections\",\r\n\t\t\t\"CostCentre\": true,\r\n\t\t\t\"CanLink\": true,\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Comment API Item ALL\",\r\n\t\t\t\"Status\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_MIN\",\r\n\t\t\t\"HierarchyName\": \"API Minimum fields\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT1\",\r\n\t\t\t\"HierarchyName\": \"API Entity 1\",\r\n\t\t\t\"Entity\": \"21\",\r\n\t\t\t\"itemComment\": \"Entity 21 = INDV\",\r\n\t\t\t\"Status\": null\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT2\",\r\n\t\t\t\"HierarchyName\": \"API Entity 2\",\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Entity 16 = CMPY\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createHierarchyHeaderItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"64"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 18:33:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Hierarchy items Created\"\n}"},{"id":"be42aaa8-0d26-4f4e-8353-8800e70de971","name":"FAIL - Create Hierarchy - Item/s (POST) Multiple Errors","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"HierarchyHeaderCode\": \"TEST\",\r\n\t\"HierarchyHeaderId\": 4,\r\n\t\"HierarchyHeaderItems\": [\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ ALL\",\r\n\t\t\t\"HierarchyName\": \"API all selections\",\r\n\t\t\t\"CostCentre\": true,\r\n\t\t\t\"CanLink\": true,\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Comment API Item ALL\",\r\n\t\t\t\"ItemStatus\": \"I\"\r\n\t\t\t//A - Active\r\n\t\t\t//I - Inactive\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_MIN\",\r\n\t\t\t//\"HierarchyName\": \"API Minimum fields\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT1\",\r\n\t\t\t\"HierarchyName\": \"API Entity 1\",\r\n\t\t\t\"Entity\": \"21\",\r\n\t\t\t\"itemComment\": \"Entity 21 = INDV\",\r\n\t\t\t\"ItemStatus\": null //defaults to A - Active\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"HierarchyCode\": \"API_ENT2\",\r\n\t\t\t\"HierarchyName\": \"API Entity 2\",\r\n\t\t\t\"Entity\": \"16\",\r\n\t\t\t\"itemComment\": \"Entity 16 = CMPY\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/createHierarchyHeaderItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"225"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Wed, 20 Apr 2022 04:53:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": [\n \"API_ ALL Invalid Code\",\n \"API_MIN Invalid Hierarchy Name\",\n \"API_ENT1 already exist\",\n \"API_ENT2 already exist\"\n ],\n \"message\": \"Some are Invalid or already Exist\"\n}"}],"_postman_id":"22abf34c-6c89-480b-92b2-4907ae455074"},{"name":"Update Hierarchy - Header (PUT)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"3e7d0b72-a7a8-476d-aaa9-c3a3ed1d2581"}}],"id":"58d79c6b-ca71-4c3a-86e6-7fc208d23d4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyHeaderID\": 3, //Mandatory for Update\r\n\r\n\t// Fields to be updated\r\n\t\"HierarchyHeaderCode\": \"TEST\",\r\n\t\"ShortDescription\": \"Update\",\r\n\t\"LongDescription\": \"Update\",\r\n\t\"GeographicLocation\": false,\r\n\t\"Comment\": \"Update from API 2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeader","description":"The Update Hierarchy Header will Update an existing record in the Hierarchy setup in Sage 300 People.
\nThe system requires the HierarchyHeaderID as the only identifying data as this allows for the Hierarchy Header Code to be available as a field that can be updated.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","updateHierarchyHeader"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"07ecd981-5b01-405b-8f6b-1af81fe39703","name":"Update Hierarchy - Header Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyHeaderID\": 4, //Mandatory for Update\r\n\t// Fields to be updated\r\n\t\"HierarchyHeaderCode\": \"TEST\",\r\n\t\"ShortDescription\": \"Update\",\r\n\t\"LongDescription\": \"Update\",\r\n\t\"GeographicLocation\": false,\r\n\t\"Comment\": \"Update from API 2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeader"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"58"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:56:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Hierarchy updated\"\n}"},{"id":"e6b5c7f5-4bd9-4dca-868b-5c1d10720560","name":"FAIL - Update Hierarchy - Header - Invalid ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyHeaderID\": 8, //Mandatory for Update\r\n\t// Fields to be updated\r\n\t\"HierarchyHeaderCode\": \"TEST\",\r\n\t\"ShortDescription\": \"Update\",\r\n\t\"LongDescription\": \"Update\",\r\n\t\"GeographicLocation\": false,\r\n\t\"Comment\": \"Update from API 2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeader"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"84"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 06:57:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Invalid HierarchyHeaderID: (data supplied)\"\n}"}],"_postman_id":"58d79c6b-ca71-4c3a-86e6-7fc208d23d4b"},{"name":"Update Hierarchy - Item (PUT)","event":[{"listen":"test","script":{"exec":["pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"message\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});"],"type":"text/javascript","id":"8cf45c27-2962-4e4d-b8b6-723ef2f6d655"}}],"id":"94432788-c6f0-4ca3-92dd-9fe7a24934b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyId\": 81, //Mandatroy for Update\r\n\t\r\n\t// Fields to be updated\r\n\t\"HierarchyCode\": \"API_NEW122\",\r\n\t\"HierarchyName\": \"Updated 321\",\r\n\t\"CostCentre\": true,\r\n\t\"CanLink\": false,\r\n\t\"Entity\": \"16\",\r\n\t\"itemComment\": \"NEW Comment API Item\",\r\n\t\"ItemStatus\": \"I\"\r\n\t// A - Active\r\n\t// I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeaderItem","description":"The Update Hierarchy Item will Update an existing record in the Hierarchy setup in Sage 300 People.
\nThe system requires the HierarchyID as the only identifying data as this allows for the Hierarchy Item Code to be available as a field that can be updated.
\nExamples are included.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","updateHierarchyHeaderItem"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"b9935144-d59d-4512-bad3-c782d5c1aa46","name":"FAIL - Update Hierarchy - Item (PUT) Code already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyId\": 61, //Mandatroy for Update\r\n\t// Fields to be updated\r\n\t\"HierarchyCode\": \"UPD_123\",\r\n\t\"HierarchyName\": \"Updated 123\"\r\n\t//\"CostCentre\": true,\r\n\t//\"CanLink\": false,\r\n\t//\"Entity\": \"16\",\r\n\t//\"itemComment\": \"NEW Comment API Item\",\r\n\t//\"Status\": \"I\"\r\n\t// A - Active\r\n\t// I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeaderItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"61"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 18:50:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"hierarchyCode exist\"\n}"},{"id":"76ae4445-b51a-4236-85fe-a8110806a06c","name":"Update Hierarchy - Item (PUT) - Minumum required fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyId\": 61, //Mandatroy for Update\r\n\t// Fields to be updated\r\n\t\"HierarchyCode\": \"UPD_123\",\r\n\t\"HierarchyName\": \"Updated 123\"\r\n\t//\"CostCentre\": true,\r\n\t//\"CanLink\": false,\r\n\t//\"Entity\": \"16\",\r\n\t//\"itemComment\": \"NEW Comment API Item\",\r\n\t//\"Status\": \"I\"\r\n\t// A - Active\r\n\t// I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeaderItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"70"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 18:51:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"hierarchy Header item Updated\"\n}"},{"id":"473ce315-2a72-4469-936c-6a081e8c8292","name":"Update Hierarchy - Item (PUT)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//Identifier\r\n\t\"HierarchyId\": 61, //Mandatroy for Update\r\n\t// Fields to be updated\r\n\t\"HierarchyCode\": \"UPD_321\",\r\n\t\"HierarchyName\": \"Updated 321\",\r\n\t\"CostCentre\": true,\r\n\t\"CanLink\": false,\r\n\t\"Entity\": \"16\",\r\n\t\"itemComment\": \"NEW Comment API Item\",\r\n\t\"Status\": \"I\"\r\n\t// A - Active\r\n\t// I - Inactive\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/updateHierarchyHeaderItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"70"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Tue, 19 Apr 2022 18:52:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"hierarchy Header item Updated\"\n}"}],"_postman_id":"94432788-c6f0-4ca3-92dd-9fe7a24934b5"}],"id":"826d33c2-6b78-479c-9dc1-b75e21533a35","description":"These API calls are designed to Create and Maintain the Hierarchy setup within the Sage 300 People system. The Hierarchy Headers and Hierarchy Items are system wide fields and therefore don't have the requirements of specifying a Company and Company Rule.
\nThe Hierarchy API's consists of 5 API's, each API has it's own rules and logic which is described on each API call.
\nHierarchy API's:
\n\n\nNote:
\nWhen creating a new Hierarchy Header the system has a requirement that you also need to create a hierarchy Item at the same time, therefore the Hierarchy Item requirements in the Create Header is mandatory.
\n
\n\nAll API calls follow the Method = POST
\n
\n\nThe Hierarchy Detail Items field for Addresses' has specifically been excluded for all the API calls (Retrieve, Create and Update).
\n
\n\nThe Hierarchy sections for Skills Information, Equity Information as well as OFO information has also been specifically excluded for all API calls (Retrieve, Create and Update).
\n
public class HierarchyHeaderAPI: APIBaseModel\n{\npublic string hierarchyHeaderCode { get; set; } // Hierarchy Header Code\npublic string ShortDescription { get; set; } // Hierarchy Header Short Description\npublic string LongDescription { get; set; } // Hierarchy Header Long Description\npublic string Comment { get; set; } // Hierarchy Header Comment field\npublic int HierarchyHeaderId { get; set; } // Hierarchy Header system generated ID\npublic Boolean GeographicLocation { get; set; } // Hierarchy Header Geographical Location link\npublic string status { get; set; } // Hierarchy Header Status\n#region lists\npublic List HierarchyItems { get; set; }\n#endregion\n}\npublic class HierarchyHeaderAndItemModel : APIBaseModel\n{\npublic string HierarchyCode { get; set; } // Hierarchy Item Code\npublic string HierarchyName { get; set; } // Hierarchy Item Name\npublic Boolean CostCentre { get; set; } // // Hierarchy Item Cost Centre link \npublic Boolean CanLink { get; set; } // Hierarchy Item Can Link\npublic int? Entity { get; set; } // Hierarchy Item Entity Code Link \npublic string itemComment { get; set; } // Hierarchy Item Comment field\npublic int HierarchyHeaderId { get; set; } // Hierarchy Header ID\npublic int HierarchyId { get; set; }// Hierarchy Item ID\npublic string itemstatus { get; set; }// Hierarchy Item Status\n}\npublic class HierarchyHeaderItems\n{\npublic string HierarchyCode { get; set; } // Hierarchy Item Code\npublic string HierarchyName { get; set; } // Hierarchy Item Name\npublic Boolean CostCentre { get; set; } // // Hierarchy Item Cost Centre link \npublic Boolean CanLink { get; set; } // Hierarchy Item Can Link\npublic int? Entity { get; set; } // Hierarchy Item Entity Code Link \npublic string itemComment { get; set; } // Hierarchy Item Comment field\npublic int HierarchyHeaderId { get; set; } // Hierarchy Header ID\npublic int HierarchyId { get; set; }// Hierarchy Item ID\npublic string itemstatus { get; set; }// Hierarchy Item Status\n}\npublic class HierarchyHeaderItemsList\n{\npublic string HierarchyHeaderCode { get; set; } // Hierarchy Header Code\npublic int HierarchyHeaderId { get; set; } // Hierarchy Header ID\npublic List HierarchyHeaderItems { get; set; } // Hierarchy Item List\n}\n\nThe Fringe Benefit Motor Vehicle API is to allow the functionality to add and maintain the requirements for the Vehicle Details saved.
\nThe API will create/update the Sub screens for the additional requirements for the Motor Vehicle Fringe Benefit (3802 Use of Motor Vehicle (PAYE)).
\n\n\nNote:
\nAll API calls follow the Method = POST
\n
\n\n","_postman_id":"d15d22bc-f954-458b-909c-a4ac0af25a10"},{"name":"Retrieve Tax Certificate PDF/s","item":[{"name":"Get Tax Cert IDs","event":[{"listen":"test","script":{"exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","console.log(APIHeaderID)\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r","\tpm.expect(jsonData.data.apiObjectID).to.contain(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","id":"b35ebd6c-e5ac-4c01-b502-68cfe6460c36"}}],"id":"cb0b118e-3cc0-49d0-ba93-9618951f52db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Identifier fields:\r\n\t\"CompanyCode\": \"ALLDEFS\",\r\n\t//\"CompanyID\": 1,\r\n\t\"CompanyRuleCode\": \"MONTHLY\",\r\n\t//\"CompanyRuleID\": 2,\r\n\r\n//Optional: - Use if Tax Certificate identification is required for a single employee.\r\n\t//\"EmployeeCode\": \"DIR_TEMP_DG_M\",\r\n\t//\"EmployeeID\": 160,\r\n\r\n//Selection/Filter Fields for Tax Certificate ID's to be returned\r\n\t//\"DateFrom\": \"2000/03/01\",\r\n\t//\"DateTo\": \"2023/01/30\",\r\n\t//\"Count\": 1\r\n}\r\n\r\n\r\n/* \r\nOnly Tax Certificates flagged as \"release to ESS\" allowed / returned.\r\n\r\nEmployee Code/ID Only - Latest Tax Certificate only\r\n\r\nCount: \r\n- the latest number of Tax Certificate ID's to return\r\n- Latest available Tax Year counting back\r\n\r\nDate Range:\r\n- Valid Range Only (Start and End must be correct for Period/s required, any Tax year outside of the range will be excluded). \r\n- Dates are specific to Period Start Date and Period End - the fields will not return values if the Period Start/End date is not correctly specified.\r\n\r\nCompany & Company Rule only\r\n= All employees in Rule \r\n-> No Date or Count = Latest Tax Certificates only for All Employees\r\n-> Count Only = Latest XX amount of Tax Certificates only\r\n-> Date AND Count = Latest XX amount of Tax Certificates within the specified Date Range only \r\n*/","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/TXCERT/get","description":"Only on RSA tax country
\n
Only Tax Certificates flagged as \"release to ESS\" allowed / returned.
\nEmployee Code/ID Only - Latest Tax Certificate only
\nCount:
\n- the latest number of Tax Certificate ID's to return- Latest available Tax Year counting back
\nDate Range:
\n- Valid Range Only (Start and End must be correct for Period/s required, any Tax year outside of the range will be excluded).
- Dates are specific to Period Start Date and Period End - the fields will not return values if the Period Start/End date is not correctly specified.
Company & Company Rule only:
\n= All employees in Rule - No Date or Count = Latest Tax Certificates only for All Employees
- Count Only = Latest XX amount of Tax Certificates only
- Date AND Count = Latest XX amount of Tax Certificates within the specified Date Range only
Create Job Costing API Header
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","TXCERT"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ce57d93-6cc1-45e6-8c3f-f8fa7d7a2e67"}],"id":"c98c0f71-d8d8-47f3-a969-bdade8188bdb","description":"These API calls are designed to Retrieve and Generate a PDF Tax Certificate for an employee from the Sage 300 People system.
\nThe API is designed to Generate a PDF Tax Certificate per employee according to the Payroll setup for that individual. Tax Year, Directives and all associated data for the employee will be included as it would be printed / generated from within the Sage 300 People system.
\nThe PDF generated will automatically be Password protected according to a specified order. The used format for the password will be given in the Header Results of each PDF Generated.
\nPassword allocation: (in order or precedence)
1. RSA ID Number
2. Passport Number
3. DOB - Date of Birth (Format = YYYYMMDD)
Tax Certificate PDF API's:
\n\n\nNote:
\n
\n\nAll API calls follow the Method = POST
\n
\n\nThe PDF Generation is per employee, per tax certificate ID only.
\n
(1 call = 1 Tax Certificate generated)
\n\nThe password is currently non optional and the system will always generate a password protected PDF. It will assign the password according to the available data on the employee, working through the above order of precedence.
\nIE: If an employee doesn't have a RSA ID number then the system will look for the Passport number, if that is also not available then the Date Of Birth will be used in the specified format.
\nThe Password is an exact match to the data on the system (Case and Character, including special characters and spaces).
\n
\n\nThe Generate PDF Call does not have a Response body as the PDF is generated in the Header Record. The response needs to be \"Saved\" for the PDF to be available.
\n
\n\nWarning - The Generated PDF happens with an Authentication API Key. How and where the data is saved, stored, shared and or released after the fact remains the responsibility of the Client / Consumer of the API. Sage can not be held liable for the exposure of personal information.
\n
As this API requires the system to generate a Report Layout for the Tax Certificate and then convert the results to PDF format, the call can be experienced as being rather slow.
\n//Get Tax Certificate IDs\n public class GetEmployeePayslipsModel\n{\npublic int? EmployeeID { get; set; }\npublic string EmployeeCode { get; set; }\npublic string CompanyCode { get; set; }\npublic int? CompanyID { get; set; }\npublic string CompanyRuleCode { get; set; }\npublic int? CompanyRuleID { get; set; }\npublic DateTime? DateFrom { get; set; }\npublic DateTime? DateTo { get; set; }\npublic int Count { get; set; }\n}\n//Get Tax Certificate PDF File\n public class GetTaxCertificatePDFModel\n{\npublic int? EmployeeID { get; set; }\npublic string EmployeeCode { get; set; }\npublic int EmployeeTaxID { get; set; }\n}\n\nUsage variations of the JSON body and the requirements of those are covered in each specific call. All retrieval options has it's own requirements for input. For full details, see the specific call descriptions.
\n","_postman_id":"c98c0f71-d8d8-47f3-a969-bdade8188bdb"},{"name":"Retrieve Payslip PDF/s","item":[{"name":"Retrieve Payslip IDs","event":[{"listen":"test","script":{"id":"5995ac90-0e2c-47aa-8e1a-5e4332386833","exec":["let jsonResponse = pm.response.json();\r","let APIHeaderID = jsonResponse.data.apiObjectID;\r","pm.environment.set(\"APIHeaderID\", APIHeaderID);\r","console.log(APIHeaderID)\r","\r","pm.test(\"Test for Response Case Formatting\", function () {\r"," pm.expect(pm.response.text()).to.include(\"success\");\r"," pm.expect(pm.response.text()).to.include(\"data\");\r","\tpm.expect(jsonData.data.apiObjectID).to.contain(\"-\");\r","});\r","\r","pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Successful POST Response Status\", function () {\r"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);\r","});\r","\r","pm.test(\"Response time is less than 500ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(500);\r","});\r","\r","pm.test(\"Succesful Post\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.success).to.eql(true);\r","});\r","\r","pm.test(\"apiObjectID returned\", function () {\r","\tpm.expect(pm.response.text()).to.include(\"apiObjectID\");\r","});"],"type":"text/javascript","packages":{}}}],"id":"4ae3b04d-506b-4e19-b7d6-264682f7dbae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n//Identifier fields:\r\n\t\"CompanyCode\": \"SOUTHAFRICA\",\r\n\t//\"CompanyID\": 1,\r\n\t\"CompanyRuleCode\": \"RSA\",\r\n\t//\"CompanyRuleID\": 2,\r\n\r\n//Optional: - Use if Payslip identification is required for a single employee.\r\n\t\"EmployeeCode\": \"PSAPI_CSTM_PS\",\r\n\t//\"EmployeeID\": 160,\r\n\r\n\t//Selection/Filter Fields for Payslip ID's to be returned\r\n\t\"DateFrom\": \"2021/03/01\",\r\n\t\"DateTo\": \"2022/03/31\",\r\n\t\"Count\": 6\r\n}\r\n/* \r\n\r\nEmployee code Only - Latest processed Period Payslip/s\r\n\r\nCount: \r\n- the number of Payrun Periods to return\r\n- Latest processed Period counting back\r\nCount value applies per Payrun-Run Period where the Payrun-Status is 1, 2, 3, 4, or 5. Payrun-Status 0 is excluded, as it indicates a payrun that has not yet been processed.\r\n\r\nDate Range:\r\n- Valid Range Only (Start and End must be correct for Period/s required). \r\n- Dates are specific to Period Start Date and Period End - the fields will not return values if the Period Start/End date is not correctly specified.\r\n\r\nCompany & Company Rule only\r\n= All employees in Rule \r\n-> Date selectors become mandatory\r\n*/","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/PSPDF/get","description":"The Retrieve Payslip ID call can be used in a multitude of ways, each of which returning different results. A few examples will be covered here. (Each scenario will also be saved as an example).
\nThe response will be arranged per employee by employee code, from the \"latest\" to \"oldest\" pay period. Unfortunately no sorting or grouping can be applied in the results returned.
\nOnly ONE Payslip PDF can be generated per call. Therefore only ONE Payslip item is allowed in this API.
\nValidation for allowing the Payslip to be generated for Consolidated Pay Runs is dependent on the \"Workflow - Company Rule Setup Profile\" Payslip Print Option.
\n\"Consolidated\":
\nTo generate a Consolidated Payslip, only 1 of the Payslip ID's is required in the call. The system will automatically combine all available Pay Runs for the Period into a Consolidated Payslip.
\nThe Payslip Layout used to generate the PDF will be defaulted from the Payslip Report setup on \"Company Rule - Default Rules\" and print according to the \"Employee - Payslip Definition - Remuneration\" Setup.
\nIf no Company Rule Payslip Report layout's are defined then the Default Payslip Report will be used.
\nIE: \"Payslip_00001 - Mr L Local_MAIN_28-Feb-2022.pdf\"
\n\n\nNote:
\nA positive example can't be saved for the purpose of the documentation as the PDF lies within the Header Record and Postman does not allow this to be saved as an example.
\n
\n\nHeader Record - PasswordType will define the password set for the PDF.
\n
\n\nConsolidated Payslip will always print the Payslip Layout defined for the Main Pay Run. If any additional Pay Run has separate requirements for the Payslip layout it is recommended to not generate a consolidated Payslip.
\n
\n\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","PSPDF"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"ac8a78ef-37ab-4a5b-ab5e-6298ef149060","name":"FAIL - Multiple Item - Not Allowed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"EmployeeCode\": \"PSAPI_CSTM_PS\",\r\n\t\t//\"EmployeeID\": 1,\r\n\t\t\"PayslipID\": 40626,\r\n\t\t\"Consolidated\": true\r\n\t},\r\n\t{\r\n\t\t\"EmployeeCode\": \"PSAPI_CSTM_PS\",\r\n\t\t//\"EmployeeID\": 1,\r\n\t\t\"PayslipID\": 39534,\r\n\t\t\"Consolidated\": true\r\n\t}\r\n]\r\n","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/PSPDF"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 12 May 2022 14:29:04 GMT"}],"cookie":[],"responseTime":null,"body":""},{"id":"90754c0e-9070-406a-9950-bcab5055b6db","name":"FAIL - Retrieve/Generate Payslip PDF - Consolidated not allowed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t//\"EmployeeCode\": \"PSAPI_CSTM_PS\",\r\n\t\"EmployeeID\": 1,\r\n\t\"PayslipID\": 40585,\r\n\t\"Consolidated\": true\r\n}\r\n/* \r\nPDF Attached to the Header as attachment -> \"Save Response\" to generate PDF\r\n\r\nPassword defined in Response Header to Identify PDF password (system generated). \r\n\r\nID Number - RSA ID\r\nPassport No - Passport No\r\nDOB - Date of Birth: YYYYMMDD\r\n\r\nConsolidated = true - any ID in required period specified will consolidate all Payslips in the period.\r\n\r\n*/ ","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort2}}/api/apibase/PSPDF"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"49"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Thu, 19 May 2022 10:03:49 GMT"}],"cookie":[],"responseTime":null,"body":"Payslip Print Option does not allow Consolidated."}],"_postman_id":"0cea3dda-1ab2-4a06-b433-a923a496e0bc"}],"id":"21ba4ac3-5536-46ee-979d-63646ef183c5","description":"As this API requires the system to generate a Report Layout for the Payslip and then convert the results to PDF format, the call can be experienced as being rather slow.
\n
These API calls are designed to Retrieve and Generate a PDF Payslip for an employee from the Sage 300 People system.
\nThe API is designed to Generate a PDF Payslip per employee according to the Payroll setup for that individual. Payslip print type (Standard, Custom Payslip, Cost to Company, Net Up, etc.)
\nThe PDF generated will automatically be Password protected according to a specified order. The used format for the password will be given in the Response Header of each PDF Generated.
\nPassword allocation: (in order or precedence)
1. RSA ID Number
2. Passport Number
3. DOB - Date of Birth (Format = YYYYMMDD)
Payslip PDF API's:
\nAll systems are now supported to allow the Retrieve Payslip PDF functionality.
The Consolidation requirement is updated to work in 2 ways as non ESS systems doesn't have the workflow configuration previously used.
\n\nNote:
\n
\n\nAll API calls follow the Method = POST
\n
\n\nOnly Payslips for Pay Run's flagged as Processed on Company Rule will be available to this API.
\n
\n\nThe PDF Generation is per employee, per Payslip ID only.
\n
(1 call = 1 Payslip PDF generated)
\n\nAny changes made to the All Reports - Payslip Layout will require a Services Restart for the changes to take effect. (IE adding the option to print Leave, Units, etc.)
\n
\n\nThe password is currently non optional and the system will always generate a password protected PDF. It will assign the password according to the available data on the employee, working through the above order of precedence.
\nIE: If an employee doesn't have a RSA ID number then the system will look for the Passport number, if that is also not available then the Date Of Birth will be used in the specified format.
\nThe Password is an exact match to the data on the system (Case and Character, including special characters and spaces).
\n
\n\nThe Generate PDF Call does not have a Response body as the PDF is generated in the Header Record. The response needs to be \"Saved\" for the PDF to be available.
\n
\n\nWarning - The Generated PDF happens with an Authentication API Key. How and where the data is saved, stored, shared and or released after the fact remains the responsibility of the Client / Consumer of the API. Sage can not be held liable for the exposure of personal information.
\n
As this API requires the system to generate a Report Layout for the Payslip and then convert the results to PDF format, the call can be experienced as being rather slow.
\n//Get Payslip IDs\n public class GetEmployeePayslipsModel\n {\n public int? EmployeeID { get; set; }\n public string EmployeeCode { get; set; }\n public string CompanyCode { get; set; }\n public int? CompanyID { get; set; }\n public string CompanyRuleCode { get; set; }\n public int? CompanyRuleID { get; set; }\n public DateTime? DateFrom { get; set; }\n public DateTime? DateTo { get; set; }\n public int Count { get; set; }\n }\n//Get Payslip PDF File\n public class GetPayslipPDFModel\n {\n public int EmployeeID { get; set; }\n public string EmployeeCode { get; set; }\n public int PayslipID { get; set; }\n public bool Consolidated { get; set; }\n }\n\nUsage variations of the JSON body and the requirements of those are covered in each specific call. All retrieval options has it's own requirements for input. For full details, see the specific call descriptions.
\n","_postman_id":"21ba4ac3-5536-46ee-979d-63646ef183c5"},{"name":"Unit Line Batches","item":[{"name":"GET - Retrieve Unit Line Batch Template Details","event":[{"listen":"test","script":{"id":"4151652b-b172-4c4b-b687-8eca43c334a4","exec":[""],"type":"text/javascript"}}],"id":"7a62f11e-b1a7-43d3-9559-168dac8b9e2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchTemplateDetails","description":"This will return a list of all Unit Batch Line templates and their detail.
\n\"unitLineBatchHeaderTemplateID\" or \"unitLineBatchHeaderTemplateCode\" in response is needed for POST / create API
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","UnitLineBatchTemplateDetails"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"ba43620d-c68e-4931-9407-46ad3b6546fa","name":"Unit Line Batch Template Details","originalRequest":{"method":"GET","header":[],"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchTemplateDetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"7278"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src https://www.google.com 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Mon, 17 Jul 2023 09:02:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"unitLineBatchHeaderTemplateID\": 2,\n \"code\": \"01U-NRMUNITS\",\n \"shortDescription\": \"01-U-Normal Unit SD\",\n \"longDescription\": \"01-U-Normal Unit LD\",\n \"batchLineType\": \"U - Normal Unit Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|2|1|\",\n \"payRunDefFilters\": \"1|2|3|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": true,\n \"skipTerminated\": true,\n \"override\": true,\n \"createLine\": true,\n \"uniqueBatchReference\": \"B_Ref123\",\n \"reference1\": \"Ref 1 123\",\n \"reference2\": \"Ref 2 123\"\n },\n {\n \"unitLineBatchHeaderTemplateID\": 3,\n \"code\": \"02-T-TRANSCUNIT\",\n \"shortDescription\": \"02-T-Transaction Code Unit Batch SD\",\n \"longDescription\": \"02-T-Transaction Code Unit Batch Long Description (#Extra Text to Test Response of API of Long Desc)\",\n \"batchLineType\": \"T - Transaction Code Unit Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|2|\",\n \"payRunDefFilters\": \"1|2|\",\n \"batchInstanceType\": \"I - Import\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 4,\n \"code\": \"03-J-JOBCOST_M\",\n \"shortDescription\": \"03-J-JobCost - Monthly SD\",\n \"longDescription\": \"03-J-JobCost - Monthly LD\",\n \"batchLineType\": \"J - Job Costing Unit Batch\",\n \"jobCostProfileID\": 1,\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|\",\n \"payRunDefFilters\": \"1|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": true\n },\n {\n \"unitLineBatchHeaderTemplateID\": 5,\n \"code\": \"04-L-NRMLINE\",\n \"shortDescription\": \"04-L-Normal Line SD\",\n \"longDescription\": \"04-L-Normal Line LD\",\n \"batchLineType\": \"L - Normal Line Amount Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|\",\n \"payRunDefFilters\": \"1|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 6,\n \"code\": \"05-A-TRANSAMNT\",\n \"shortDescription\": \"05-A-TransCode Amount SD\",\n \"longDescription\": \"05-A-TransCode Amount LD\",\n \"batchLineType\": \"A - Transaction Code Amount Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|\",\n \"payRunDefFilters\": \"1|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 7,\n \"code\": \"06-J-JOBCOST_W\",\n \"shortDescription\": \"06-J-JobCost - Weekly SD\",\n \"longDescription\": \"06-J-JobCost - Weekly LD\",\n \"batchLineType\": \"J - Job Costing Unit Batch\",\n \"jobCostProfileID\": 2,\n \"comment\": \"Comment for Weekly Job Costing profile linked\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"2|\",\n \"payRunDefFilters\": \"2|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false,\n \"uniqueBatchReference\": \"WJC01\"\n },\n {\n \"unitLineBatchHeaderTemplateID\": 8,\n \"code\": \"07-L-NRMLINE_AL\",\n \"shortDescription\": \"07 Normal Line - All options\",\n \"longDescription\": \"07 Normal Line - Create, override, Monthly and weekly\",\n \"batchLineType\": \"L - Normal Line Amount Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|1|2|2|\",\n \"payRunDefFilters\": \"1|3|2|9|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": true,\n \"skipTerminated\": true,\n \"override\": true,\n \"createLine\": true\n },\n {\n \"unitLineBatchHeaderTemplateID\": 9,\n \"code\": \"08_L_TAXPS\",\n \"shortDescription\": \"08 Norm Line - Tax Payslip \",\n \"longDescription\": \"08 Norm Line - Tax Payslip \",\n \"batchLineType\": \"L - Normal Line Amount Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|2|\",\n \"payRunDefFilters\": \"1|2|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 10,\n \"code\": \"09-T-TRANSCUNIT\",\n \"shortDescription\": \"09-T-Transaction Code Unit Batch SD\",\n \"longDescription\": \"09-T-Transaction Code Unit Batch SD\",\n \"batchLineType\": \"T - Transaction Code Unit Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|\",\n \"payRunDefFilters\": \"1|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 11,\n \"code\": \"10-T-TRCMULPAYR\",\n \"shortDescription\": \"10-T-TransCode Unit Multiple PayRun\",\n \"longDescription\": \"10-T-TransCode Unit Multiple PayRun\",\n \"batchLineType\": \"T - Transaction Code Unit Batch\",\n \"comment\": \"Multiple PayRun Comment\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|1|2|2|\",\n \"payRunDefFilters\": \"1|3|2|8|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false,\n \"uniqueBatchReference\": \"Multiple PayRun Unique Batch Reference\",\n \"reference1\": \"Multiple PayRun Reference 1\",\n \"reference2\": \"Multiple PayRun Reference 2\"\n },\n {\n \"unitLineBatchHeaderTemplateID\": 12,\n \"code\": \"11-T-TRANSCCROV\",\n \"shortDescription\": \"11-T-TransCode Unit Create/Override\",\n \"longDescription\": \"11-T-TransCode Unit Batch Create + Override\",\n \"batchLineType\": \"T - Transaction Code Unit Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|\",\n \"payRunDefFilters\": \"1|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": true,\n \"createLine\": true\n },\n {\n \"unitLineBatchHeaderTemplateID\": 13,\n \"code\": \"12-U-NU-FALSE\",\n \"shortDescription\": \"12-U-Nrm Unit - Selections False\",\n \"longDescription\": \"12-U-Nrm Unit - Selections False\",\n \"batchLineType\": \"U - Normal Unit Batch\",\n \"companyID\": 1,\n \"companyRuleFilters\": \"1|2|1|2|\",\n \"payRunDefFilters\": \"1|8|3|2|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": false,\n \"createLine\": false\n },\n {\n \"unitLineBatchHeaderTemplateID\": 14,\n \"code\": \"13-J-JCOVERRIDE\",\n \"shortDescription\": \"13-J-JC Override\",\n \"longDescription\": \"13-J-JC Override\",\n \"batchLineType\": \"J - Job Costing Unit Batch\",\n \"jobCostProfileID\": 2,\n \"companyID\": 1,\n \"companyRuleFilters\": \"2|\",\n \"payRunDefFilters\": \"2|\",\n \"batchInstanceType\": \"C - Capture\",\n \"verify\": false,\n \"skipTerminated\": false,\n \"override\": true,\n \"createLine\": false\n }\n ]\n}"}],"_postman_id":"7a62f11e-b1a7-43d3-9559-168dac8b9e2d"},{"name":"GET - Retrieve Unit Line Batch Template Layout","event":[{"listen":"test","script":{"id":"9780c775-aaf9-4cdd-b779-e039117f8f00","exec":[""],"type":"text/javascript"}}],"id":"f2f4891f-6232-4f3a-962b-8bad26e607e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n //ID or Code - ID will supersede Code\r\n \"unitLineBatchHeaderTemplateID\": 4\r\n //\"code\": \"NRMUNITS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchTemplateLayout","description":"This will return any fields that can be used in the POST to create detailed records.
\nInclude the following in your request:
\n\"code\": \"NRMUNITS\",
\n\"unitLineBatchHeaderTemplateID\": 1
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","UnitLineBatchTemplateLayout"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"2bdd84be-7b8c-4789-aa04-2218bdb49962","name":"Unit Line Batch - Transaction Code Unit Batch","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"code\": \"NRMUNITS\",\r\n\t\"unitLineBatchHeaderTemplateID\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchTemplateLayout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"1818"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src https://www.google.com 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Mon, 17 Jul 2023 09:03:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"unitLineBatchHeaderTemplateFieldID\": 2,\n \"code\": \"COMPANYRULE\",\n \"longDescription\": \"Company Rule\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 3,\n \"code\": \"PAYRUNDEFINITION\",\n \"longDescription\": \"Pay Run Definition\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 32,\n \"code\": \"EMPLOYEECODES\",\n \"longDescription\": \"Employee Code\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 32,\n \"code\": \"EMPLOYEECODES\",\n \"longDescription\": \"Employee Display Name\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 33,\n \"code\": \"DATEWORKED\",\n \"longDescription\": \"Date Worked\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 35,\n \"code\": \"TRANSACTIONCODE\",\n \"longDescription\": \"Transaction Code\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 36,\n \"code\": \"UNITINPUT\",\n \"longDescription\": \"Units\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 38,\n \"code\": \"INPUTAMOUNT\",\n \"longDescription\": \"Input Amount\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 39,\n \"code\": \"EMPRATE\",\n \"longDescription\": \"Employee Rate\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 40,\n \"code\": \"CHARGEOUTRATE\",\n \"longDescription\": \"Charge Out Rate\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 41,\n \"code\": \"NOTE\",\n \"longDescription\": \"Note\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 43,\n \"code\": \"PAYROLLDEFCODE\",\n \"longDescription\": \"Payroll Definition Code\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 44,\n \"code\": \"JOBCOSTCODE\",\n \"longDescription\": \"Job Cost Code\"\n }\n ]\n}"},{"id":"47588b82-ada3-4f83-9840-18469868e81c","name":"Unit Line Batch - Job Costing Unit Batch","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"unitLineBatchHeaderTemplateID\": 4,\r\n //\"code\": \"NRMUNITS\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchTemplateLayout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache, max-age=0"},{"key":"Content-Length","value":"2476"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Referrer-Policy","value":"geolocation 'none'; payment 'none'; camera 'none'; microphone 'none'"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src ; frame-src https://www.google.com 'self' blob:; object-src 'self' blob:; style-src 'self' http:// 'unsafe-inline'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'; img-src 'self' http://* data:"},{"key":"Date","value":"Mon, 17 Jul 2023 09:04:14 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"unitLineBatchHeaderTemplateFieldID\": 2,\n \"code\": \"COMPANYRULE\",\n \"longDescription\": \"Company Rule\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 3,\n \"code\": \"PAYRUNDEFINITION\",\n \"longDescription\": \"Pay Run Definition\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 46,\n \"code\": \"LEVELSETUPIDS\",\n \"longDescription\": \"Hord\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 46,\n \"code\": \"LEVELSETUPIDS\",\n \"longDescription\": \"Division\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 46,\n \"code\": \"LEVELSETUPIDS\",\n \"longDescription\": \"Rank\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 46,\n \"code\": \"LEVELSETUPIDS\",\n \"longDescription\": \"Function\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 47,\n \"code\": \"EMPLOYEECODES\",\n \"longDescription\": \"Employee Code\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 47,\n \"code\": \"EMPLOYEECODES\",\n \"longDescription\": \"Employee Display Name\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 48,\n \"code\": \"DATEWORKED\",\n \"longDescription\": \"Date Worked\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 49,\n \"code\": \"ENDDATE\",\n \"longDescription\": \"End Date\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 50,\n \"code\": \"TRANSACTIONCODE\",\n \"longDescription\": \"Transaction Code\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 51,\n \"code\": \"UNITINPUT\",\n \"longDescription\": \"Units\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 52,\n \"code\": \"ADDITIONAL\",\n \"longDescription\": \"Additional Unit Input\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 53,\n \"code\": \"INPUTAMOUNT\",\n \"longDescription\": \"Input Amount\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 54,\n \"code\": \"EMPRATE\",\n \"longDescription\": \"Employee Rate\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 55,\n \"code\": \"CHARGEOUTRATE\",\n \"longDescription\": \"Charge Out Rate\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 56,\n \"code\": \"NOTE\",\n \"longDescription\": \"Note\"\n },\n {\n \"unitLineBatchHeaderTemplateFieldID\": 58,\n \"code\": \"PAYROLLDEFCODE\",\n \"longDescription\": \"Payroll Definition Code\"\n }\n ]\n}"}],"_postman_id":"f2f4891f-6232-4f3a-962b-8bad26e607e6"},{"name":"GET - Retrieve Unit Line Batch Instance Details","event":[{"listen":"test","script":{"id":"7e84a1ab-d226-4ab7-a2a4-3be8dcba1cc4","exec":[""],"type":"text/javascript"}}],"id":"4fdf9cd5-7cd9-43c9-9526-cfea982dfcd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"batchInstanceID\": 1,\r\n \"code\": \"ULBT\",\r\n \"dateCaptured\": \"2023/06/01\",\r\n \"processingStatus\": \"U\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/UnitLineBatchHeaderDetails","description":"Retrieves the details of the Batch Instance defined in payload.
\nThe following fields may be used in the request body:
\n\"code\": \"ULBT\", \"batchInstanceID\": 1, \"dateCaptured\": \"2023/06/01\", \"processingStatus\": \"U\"
\nOr
\nIf no Body is sent, all Unit Line Batch Instances and their details will be returned.
\nThis can be used during any step of the Batch to check the status and details.
\nNote:
\nWhen the \"transactionCodeID\" or \"transactionCode\" is specified, the \"payrollDefCode\" will default.
\n\"Date Worked\" is a mandatory field.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","create"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ed0c428-8025-4c1e-925f-4646cea6a3c9"},{"name":"Batch Line Type: Transaction Code Unit","event":[{"listen":"test","script":{"id":"602091c5-158b-4f8a-9c54-b98d25f6a20f","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"c1f09482-a8a9-4f2c-a54f-eae99e1bc40b","exec":["let testRandom = Math.random().toString(36).substring(2, 8) + Math.random().toString(36).substring(2, 8);\r","testRandom = testRandom.toUpperCase();\r","pm.environment.set(\"testRandom\", testRandom);\r","console.log(testRandom)"],"type":"text/javascript"}}],"id":"0eef18a3-b59b-46db-a10c-55f7d35a2fef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"unitLineBatchHeaderTemplateID\": 10,\r\n //\"unitLineBatchHeaderTemplateCode\": \"TRANSUNIT\",\r\n \"code\": \"TU31\",\r\n \"shortDescription\": \"Transaction Code Unit Batch\",\r\n \"longDescription\": \"Transaction Code Unit Batch\",\r\n \"employeeList\": [\r\n {\r\n \"employeeCode\": \"05_NJC_M\",\r\n \"fieldList\": [\r\n {\r\n //\"companyRuleID\": 1,\r\n \"companyruleCode\": \"RSA_M\",\r\n //\"payRunDefID\": 1,\r\n \"payRunDefCode\": \"MAIN\",\r\n //\"TransactionCodeID\": 1,\r\n \"TransactionCode\": \"OT15\",\r\n \"LineType\": \"EA\",\r\n \"payrollDefCode\": \"OT15\",\r\n \"Units\": 123,\r\n \"inputAmount\": 321.00, // Input Amount is only valid for Payroll Definitions with Calculation Type = 10.\r\n \"DateWorked\": \"2023-03-01\", // Required Field\r\n \"employeerate\": 20.00,\r\n \"chargeoutrate\": 15.00,\r\n \"jobcostcode\": \"TEST_JC_Code\",\r\n \"Note\": \"Note\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/create","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","create"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0eef18a3-b59b-46db-a10c-55f7d35a2fef"},{"name":"Batch Line Type: Job Costing","event":[{"listen":"test","script":{"id":"612da50c-c66b-4406-8069-ba7443676b85","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"7d5901bd-1c3d-473c-9dee-e7e901cad450","exec":["let testRandom = Math.random().toString(36).substring(2, 8) + Math.random().toString(36).substring(2, 8);\r","testRandom = testRandom.toUpperCase();\r","pm.environment.set(\"testRandom\", testRandom);\r","console.log(testRandom)"],"type":"text/javascript"}}],"id":"5f03bab9-f673-45ed-a0ee-849aa0986732","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"unitLineBatchHeaderTemplateID\": 4,\r\n\t//\"unitLineBatchHeaderTemplateCode\": \"JCTEMP\",\r\n\t\"code\": \"JOBCOST6854\", // must be unique\r\n\t\"shortDescription\": \"Job Costing ULB\",\r\n\t\"longDescription\": \"Job Costing Unit Line Batch\",\r\n\t\"employeeList\": [\r\n\t\t{\r\n\t\t\t\"employeeCode\": \"EMP6981\",\r\n\t\t\t\"fieldList\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t//\"companyRuleID\": 1,\r\n\t\t\t\t\t\"companyruleCode\": \"RSA_M\",\r\n\t\t\t\t\t//\"payRunDefID\": 1,\r\n\t\t\t\t\t\"payRunDefCode\": \"MAIN\",\r\n\t\t\t\t\t\"transactionCode\": \"WAGES\",\r\n\t\t\t\t\t\"payrollDefCode\": \"WAGE\",\r\n\t\t\t\t\t\"dateWorked\": \"2023-06-01\",\r\n\t\t\t\t\t\"endDate\": \"2023-06-02\",\r\n\t\t\t\t\t\"units\": 2,\r\n\t\t\t\t\t\"inputAmount\": 0, // Input Amount is only valid for Payroll Definitions with Calculation Type = 10.\r\n\t\t\t\t\t\"additionalUnitInput\": 2,\r\n\t\t\t\t\t\"employeeRate\": 500.00,\r\n\t\t\t\t\t\"chargeOutRate\": 600.00,\r\n\t\t\t\t\t\"Note\": \"Note on Record\",\r\n\t\t\t\t\t\"jobCostCode\": \"JC Code 5413\",\r\n\t\t\t\t\t\"fieldLevelList\": [\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"hierarchyID\": 2, //ID will take \"priority\" if code is also are added\r\n\t\t\t\t\t\t\t\"hierarchyCode\": \"PTA\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t//\"hierarchyID\": 8,\r\n\t\t\t\t\t\t\t\"hierarchyCode\": \"IT\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t//\"jobGradeID\": 2,\r\n\t\t\t\t\t\t\t\"jobGradeCode\": \"JG5\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t//\"jobTitleTypeID\": 3,\r\n\t\t\t\t\t\t\t\"jobTitleTypeCode\": \"CLR\"\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t]\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/create","description":"Important note
\nThe Field level list items are according to the actual linked items and not the descriptions setup on the Level Definition Screen.
\nTake note that business rules will be checked.
\nExample:
\nThe number of levels will be checked.
\nIf there are incorrect linked levels used, then the batch will fail.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","create"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f03bab9-f673-45ed-a0ee-849aa0986732"},{"name":"Verify Unti Line Batch","event":[{"listen":"prerequest","script":{"id":"14ee28ac-11be-4179-99ee-1132e3ec049a","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"e3e00a2e-10b0-4bab-8925-f20afb720c48","exec":[""],"type":"text/javascript"}}],"id":"88b02dd0-7829-4a6a-afe5-21bee91ba166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"unitLineBatchHeaderID\": 1,\r\n \"Code\": \"UNITBATCHCODE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/verify","description":"This API can verify a batch whether the template requires it to be verified or not.
\nThis API's will only respond with succesful true/false and no other details. Use the \"GET Batch Instance Detail\" API to view full results.
\nThe following line can be included in the request:
\n{ \"unitLineBatchHeaderID\": 1, or \"Code\": \"UNITBATCHCODE\"}
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","verify"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"88b02dd0-7829-4a6a-afe5-21bee91ba166"},{"name":"Process Unit LIne Batch","event":[{"listen":"prerequest","script":{"id":"dbedcac6-8caa-405b-8efa-32c163e48c80","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"187742ba-2fc1-467b-81cb-e638e7d6c1cb","exec":[""],"type":"text/javascript"}}],"id":"e4c146d8-62c2-4da8-a863-bc23c0442535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"unitLineBatchHeaderID\": 1,\r\n \"Code\": \"UNITBATCHCODE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/process","description":"Important note
\nThis will only return a response when the processing has been completed by the system. The API will remain in sending status while the batch runs.
\nPlease verify the batch before processing if the template setup requires verification.
\nThis API will only respond with succesful true/false and no other details. Use the \"GET Batch Instance Detail\" API to view full results.
\nThe following line can be included in the request:
\n{ \"unitLineBatchHeaderID\": 1, or \"Code\": \"UNITBATCHCODE\"}
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","process"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4c146d8-62c2-4da8-a863-bc23c0442535"},{"name":"DELETE Batch Instance","event":[{"listen":"test","script":{"id":"4b82f972-1942-4295-81f7-cf8bb940e857","exec":[""],"type":"text/javascript"}}],"id":"c32e42e0-ff00-43cd-acde-bca35bb50a59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"unitLineBatchHeaderID\": 1,\r\n \"Code\": \"UNITBATCHCODE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/{{DELBatchIns01}}","description":"The Delete Batch Instance rules work the same as the Sage 300 People application. A user can delete a batch during any processing status of the batch.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","{{DELBatchIns01}}"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c32e42e0-ff00-43cd-acde-bca35bb50a59"},{"name":"Reverse Batch Instance","event":[{"listen":"prerequest","script":{"id":"1ac4d94f-be08-4e9d-89a5-7a599b76170b","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"60b5c8b5-2b45-4585-bd7f-932a8af91d9b","exec":[""],"type":"text/javascript"}}],"id":"f3838fca-5ef6-400a-bad9-5cbc4dc37300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"unitLineBatchHeaderID\": 1,\r\n \"Code\": \"UNITBATCHCODE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/ULBATCH/reverse","description":"Note
\nIt is advised to use the Reverse Batch cautiously.
\nIf \"Override\" option is selected on the template used, it can cause extra negative amounts if an employee has duplicate lines.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","ULBATCH","reverse"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3838fca-5ef6-400a-bad9-5cbc4dc37300"}],"id":"a32036ea-5ac6-4300-a61b-d9a46d75dde9","description":"The following API's are designed to allow the user to mange and process input data through the Sage 300 People system's batch engine and no longer the API single input based processing. The system configuration for Multi-threading and Multi-processing will therefore be used.
\n(For configurations on Multi-Processing consult the implementation guides)
\nAll input will be added to the standard system location for Unit Line Batches and can therefore also be accessed in system.
\nIt is important to be aware of the following:
\nA user can use an API to import employees for different Companies (Front End only allows 1). It is highly recommended to only process data for 1 at a time to assist with any possible speed issues, this will also improve error handling.
\n","_postman_id":"a32036ea-5ac6-4300-a61b-d9a46d75dde9"},{"name":"Position Maintenance","item":[{"name":"GET - Retrieve Position Details per Entity/Position Code","event":[{"listen":"test","script":{"id":"c24119d1-5d46-412f-9924-1f6c28cf4ab7","exec":[""],"type":"text/javascript"}}],"id":"afe28948-858f-4259-b50c-571503de1152","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"PositionCode\": \"POS_GET_01\"\r\n //\"HREntityID\": 14\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/GetPositionMaintenance","description":"Either Position Code or HREntityID to be used. If both are submitted and conflict the API will error.
\n","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","pmaintenance","GetPositionMaintenance"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"3a048c63-45c0-4354-8611-ebfb17a311a1","name":"Successful","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"PositionCode\": \"POS_GET_01\"\r\n //\"HREntityID\": 14\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/GetPositionMaintenance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"10387"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 14:19:41 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"headerDetails\": {\n \"hrEntityId\": 14,\n \"positionStatus\": \"VT\",\n \"vacancyDate\": \"2021-01-01T00:00:00\",\n \"code\": \"POS_GET_01\",\n \"shortDescription\": \"Job GET Template 01\",\n \"longDescription\": \"Job GET Template 01\",\n \"jobTemplateID\": 13,\n \"jobTemplate\": \"GT01-Job GET Template 01\",\n \"natureOfPositionID\": 501,\n \"natureOfPosition\": \"ALMGTH\",\n \"reportsToPositionID\": 15,\n \"reportsToPosition\": \"POS_GET_02\",\n \"status\": \"A\"\n },\n \"otherInformation\": {\n \"companyID\": 1,\n \"company\": \"MCS_TEST\",\n \"companyRuleID\": 5,\n \"companyRule\": \"POSITIONS\",\n \"zoneCodeID\": 1,\n \"zoneCode\": \"ZONE1\",\n \"jobTitleID\": 11,\n \"jobTitle\": \"KOTN\",\n \"functionID\": 1,\n \"function\": \"FUNC_1\",\n \"jobGradeID\": 1,\n \"jobGrade\": \"LOW\",\n \"jobGeneralID\": 1,\n \"jobGeneral\": \"JOB_GEN1\",\n \"competencyRatingTypeID\": 1,\n \"competencyRatingType\": \"1-3_VALUE\",\n \"competencySetupTypeID\": 1,\n \"competencySetupType\": \"AREA\",\n \"keyPerformanceRatingTypeID\": 1,\n \"keyPerformanceRatingType\": \"1-3_VALUE\",\n \"performanceSetupTypeID\": 3,\n \"performanceSetupType\": \"SUBINDICATOR\",\n \"levelOfWorkID\": 1,\n \"levelOfWork\": \"EASY\",\n \"criticalPositionID\": 1,\n \"criticalPosition\": \"CRIT_A\",\n \"payScaleID\": 2,\n \"payScale\": \"PAY_SCALE01\",\n \"affectedEarningLineID\": 1,\n \"affectedEarningLine\": \"SALARY\"\n },\n \"hierarchyInformation\": [\n {\n \"hrEntityHierarchyRelationshipID\": 23,\n \"hierarchyHeader\": \"Faction\",\n \"hierarchyID\": 2,\n \"hierarchy\": \"AMITY\"\n },\n {\n \"hrEntityHierarchyRelationshipID\": 24,\n \"hierarchyHeader\": \"Department\",\n \"hierarchyID\": 8,\n \"hierarchy\": \"DEV\"\n }\n ],\n \"competency\": [\n {\n \"competencyAreaID\": 1,\n \"competencyArea\": \"WORK\",\n \"competencyWeightPerc\": 10,\n \"competencyRatingID\": 1,\n \"competencyRating\": \"UNSATISFACTORY\",\n \"levelOfComplexityID\": 1,\n \"levelOfComplexity\": \"EASY\",\n \"strategicObjectiveID\": 1,\n \"strategicObjectiveCode\": \"STRG_1\",\n \"behaviouralIndicator\": \"At least had one course completed.\",\n \"measurementID\": 2,\n \"measurementCode\": \"MEAS_DETAIL01\",\n \"evidenceID\": 1,\n \"evidenceCode\": \"EVD1_DETAIL01\",\n \"targetID\": 1,\n \"targetCode\": \"TRG_DETAIL01\",\n \"additionalComment\": \"Additional Com Work\",\n \"occupationCriticalCompetency\": false\n },\n {\n \"competencyAreaID\": 2,\n \"competencyArea\": \"SOCIAL\",\n \"competencyWeightPerc\": 20,\n \"competencyRatingID\": 2,\n \"competencyRating\": \"SATISFIED\",\n \"levelOfComplexityID\": 2,\n \"levelOfComplexity\": \"MODERATE\",\n \"strategicObjectiveID\": 2,\n \"strategicObjectiveCode\": \"STRG_2\",\n \"behaviouralIndicator\": \"No defects were reported after the release.\",\n \"measurementID\": 2,\n \"measurementCode\": \"MEAS_DETAIL01\",\n \"evidenceID\": 1,\n \"evidenceCode\": \"EVD1_DETAIL01\",\n \"targetID\": 1,\n \"targetCode\": \"TRG_DETAIL01\",\n \"additionalComment\": \"Additional Com Social\",\n \"occupationCriticalCompetency\": false\n },\n {\n \"competencyAreaID\": 5,\n \"competencyArea\": \"WIZARDRY\",\n \"competencyWeightPerc\": 70,\n \"competencyRatingID\": 3,\n \"competencyRating\": \"EXCEEDED\",\n \"levelOfComplexityID\": 3,\n \"levelOfComplexity\": \"DIFFICULT\",\n \"strategicObjectiveID\": 3,\n \"strategicObjectiveCode\": \"STRG_3\",\n \"behaviouralIndicator\": \"All spells and potions mastered\",\n \"measurementID\": 2,\n \"measurementCode\": \"MEAS_DETAIL01\",\n \"evidenceID\": 1,\n \"evidenceCode\": \"EVD1_DETAIL01\",\n \"targetID\": 1,\n \"targetCode\": \"TRG_DETAIL01\",\n \"additionalComment\": \"Additional Com Wizard\",\n \"occupationCriticalCompetency\": false\n }\n ],\n \"keyPerformance\": [\n {\n \"keyPerformanceAreaID\": 2,\n \"keyPerformanceArea\": \"TRAINING\",\n \"keyPerformanceIndicatorID\": 1,\n \"keyPerformanceIndicator\": \"RATING\",\n \"keyPerformanceSubIndicatorID\": 1,\n \"keyPerformanceSubIndicator\": \"RTN_SUB_KEY_A\",\n \"keyPerformanceWeightPerc\": 15,\n \"keyPerformanceRatingID\": 1,\n \"keyPerformanceRating\": \"UNSATISFACTORY\",\n \"strategicObjective\": \"Strategic Obj Training\",\n \"behaviouralIndicator\": \"Training Behaviour\",\n \"measurementID\": 1,\n \"measurementCode\": \"MEAS_DETAIL03\",\n \"evidenceID\": 2,\n \"evidenceCode\": \"EVD1_DETAIL03\",\n \"target\": \"Target Training\",\n \"additionalComment\": \"Additional Comments01\"\n },\n {\n \"keyPerformanceAreaID\": 2,\n \"keyPerformanceArea\": \"TRAINING\",\n \"keyPerformanceIndicatorID\": 1,\n \"keyPerformanceIndicator\": \"RATING\",\n \"keyPerformanceWeightPerc\": 0\n },\n {\n \"keyPerformanceAreaID\": 2,\n \"keyPerformanceArea\": \"TRAINING\",\n \"keyPerformanceWeightPerc\": 0\n },\n {\n \"keyPerformanceAreaID\": 4,\n \"keyPerformanceArea\": \"COMPLIANCE\",\n \"keyPerformanceIndicatorID\": 2,\n \"keyPerformanceIndicator\": \"STANDARDS\",\n \"keyPerformanceSubIndicatorID\": 3,\n \"keyPerformanceSubIndicator\": \"STD_SUB_KEY_A\",\n \"keyPerformanceWeightPerc\": 30,\n \"keyPerformanceRatingID\": 2,\n \"keyPerformanceRating\": \"SATISFIED\",\n \"strategicObjective\": \"Strategic Obj Compliance\",\n \"behaviouralIndicator\": \"Compliance Behaviour\",\n \"measurementID\": 1,\n \"measurementCode\": \"MEAS_DETAIL03\",\n \"evidenceID\": 2,\n \"evidenceCode\": \"EVD1_DETAIL03\",\n \"target\": \"Target Compliance\",\n \"additionalComment\": \"Additional Comments02\"\n },\n {\n \"keyPerformanceAreaID\": 4,\n \"keyPerformanceArea\": \"COMPLIANCE\",\n \"keyPerformanceIndicatorID\": 2,\n \"keyPerformanceIndicator\": \"STANDARDS\",\n \"keyPerformanceWeightPerc\": 0\n },\n {\n \"keyPerformanceAreaID\": 4,\n \"keyPerformanceArea\": \"COMPLIANCE\",\n \"keyPerformanceWeightPerc\": 0\n },\n {\n \"keyPerformanceAreaID\": 4,\n \"keyPerformanceArea\": \"COMPLIANCE\",\n \"keyPerformanceIndicatorID\": 2,\n \"keyPerformanceIndicator\": \"STANDARDS\",\n \"keyPerformanceWeightPerc\": 100,\n \"keyPerformanceRatingID\": 2,\n \"keyPerformanceRating\": \"SATISFIED\"\n },\n {\n \"keyPerformanceAreaID\": 5,\n \"keyPerformanceArea\": \"QUALITY\",\n \"keyPerformanceIndicatorID\": 3,\n \"keyPerformanceIndicator\": \"UX\",\n \"keyPerformanceSubIndicatorID\": 4,\n \"keyPerformanceSubIndicator\": \"UX_SUB_KEY_A\",\n \"keyPerformanceWeightPerc\": 55,\n \"keyPerformanceRatingID\": 3,\n \"keyPerformanceRating\": \"EXCEEDED\",\n \"strategicObjective\": \"Strategic Obj Quality\",\n \"behaviouralIndicator\": \"Quality Behaviour\",\n \"measurementID\": 1,\n \"measurementCode\": \"MEAS_DETAIL03\",\n \"evidenceID\": 2,\n \"evidenceCode\": \"EVD1_DETAIL03\",\n \"target\": \"Target Quality\",\n \"additionalComment\": \"Additional Comments03\"\n },\n {\n \"keyPerformanceAreaID\": 5,\n \"keyPerformanceArea\": \"QUALITY\",\n \"keyPerformanceIndicatorID\": 3,\n \"keyPerformanceIndicator\": \"UX\",\n \"keyPerformanceWeightPerc\": 0\n },\n {\n \"keyPerformanceAreaID\": 5,\n \"keyPerformanceArea\": \"QUALITY\",\n \"keyPerformanceWeightPerc\": 0\n }\n ],\n \"qualifications\": [\n {\n \"hrEntityQualificationRelationshipID\": 1002,\n \"qualificationTypeID\": 3,\n \"qualificationType\": \"ABET1\",\n \"qualificationID\": 1,\n \"qualification\": \"GENTLEMAN\",\n \"points\": 5,\n \"essential\": true\n },\n {\n \"hrEntityQualificationRelationshipID\": 1003,\n \"qualificationTypeID\": 4,\n \"qualificationType\": \"ABET2\",\n \"qualificationID\": 2,\n \"qualification\": \"ASSASSIN\",\n \"points\": 5,\n \"essential\": true\n }\n ],\n \"affiliationsAndMemberships\": [],\n \"experience\": [],\n \"training\": [],\n \"priorLearning\": [],\n \"skills\": [],\n \"task\": [],\n \"itemsIssued\": [],\n \"equityInformation\": {\n \"occupationalCategoryID\": 1,\n \"occupationalCategory\": \"1\",\n \"occupationalCategoryDisplayMember\": \"Off & Mgrs\",\n \"occupationallevelID\": 1,\n \"occupationallevel\": \"1\",\n \"occupationallevelDisplayMember\": \"Top Mgmt\",\n \"workplaceID\": 2,\n \"workplace\": \"PTA\",\n \"provinceID\": 2,\n \"province\": \"2\",\n \"provinceDisplayMember\": \"Eastern Cape\",\n \"equityJobFunctionID\": 2,\n \"equityJobFunction\": \"2\",\n \"equityJobFunctionDisplayMember\": \"Support\",\n \"typeOfEmploymentID\": 2,\n \"typeOfEmployment\": \"2\",\n \"typeOfEmploymentDisplayMember\": \"Temporary\",\n \"gender\": \"F\",\n \"racialGroup\": \"C\",\n \"designatedEmployee\": false,\n \"disabled\": false,\n \"disabilityID\": 1,\n \"disability\": \"HEAR\"\n },\n \"skillsInformation\": [\n {\n \"occupationalCategoryID\": 2,\n \"occupationalCategory\": \"2\",\n \"occupationalCategoryDisplayMember\": \"Professionals\",\n \"occupationalLevelID\": 1,\n \"occupationalLevel\": \"1\",\n \"occupationalLevelDisplayMember\": \"Top Mgmt\",\n \"workplaceID\": 1,\n \"workplace\": \"JHB\",\n \"provinceID\": 1,\n \"province\": \"1\",\n \"provinceDisplayMember\": \"Gauteng North\",\n \"ofoCategoryID\": 1,\n \"ofoCategory\": \"1\",\n \"ofoCategoryDisplayMember\": \"MANAGERS\",\n \"scarceSkillsTypeID\": 1,\n \"scarceSkillsType\": \"1\",\n \"scarceSkillsTypeDisplayMember\": \"Absolute\",\n \"ofoCodeID\": 1,\n \"ofoCode\": \"OFO_01\",\n \"typeOfEmploymentID\": 1,\n \"typeOfEmployment\": \"1\",\n \"typeOfEmploymentDisplayMember\": \"Permanent\"\n }\n ],\n \"remunerationComponent\": [],\n \"reportsTo\": [],\n \"succession\": []\n }\n}"},{"id":"5b978f71-6171-4398-8ee6-0da3b2f3f071","name":"Error - Mandatory Fields","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n\r\n//\"PositionCode\": \"POS_GET_01\",\r\n//\"HREntityID\": 14\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/GetPositionMaintenance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"84"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 13:00:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"PositionCode and/or HREntityID is required\"\n}"},{"id":"986778a5-36eb-402e-87e2-dc01bc59a625","name":"Error - Non-Existing PositionCode/HREntityID","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n\r\n\"PositionCode\": \"POS_GET_99\",\r\n\"HREntityID\": 1324\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/GetPositionMaintenance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"101"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 12:59:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Could not resolve PositionCode/HREntityID Code (Data sent)\"\n}"},{"id":"2ceca407-65eb-4cd1-9f1e-6255753420b1","name":"Error - Positions/Entity Mismatch","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n\r\n\"PositionCode\": \"POS_GET_01\",\r\n\"HREntityID\": 15\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/GetPositionMaintenance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"84"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 13:01:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"PositionCode and HREntityID is in conflict\"\n}"}],"_postman_id":"afe28948-858f-4259-b50c-571503de1152"},{"name":"PUT - Update Position Details (All items)","event":[{"listen":"test","script":{"id":"c1739e4e-49a3-4cf0-a26c-431ed55f5a40","exec":[""],"type":"text/javascript"}}],"id":"dd541f5e-a657-49c2-b3d2-a9747f45924b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"positionCode\": \"POS_GET_01\",\r\n //\"hrEntityID\": 15,\r\n \"headerDetails\": {\r\n \"positionStatus\": \"VT\",\r\n \"code\": \"POS_GET_04\",\r\n \"vacancyDate\": \"2023/05/09\",\r\n \"shortDescription\": \"Line Edit\",\r\n \"longDescription\": \"Line Edit\",\r\n \"jobTemplateID\": 1,\r\n \"jobTemplate\": \"JT01\",\r\n \"natureOfPositionID\": 5,\r\n \"natureOfPosition\": \"CASUAL\",\r\n \"reportsToPositionID\": 1017,\r\n \"reportsToPosition\": \"TEST001\",\r\n \"status\": \"A\"\r\n },\r\n \"otherInformation\": {\r\n \"companyID\": 1,\r\n \"company\": \"MCS_TEST\",\r\n \"companyRuleID\": 5,\r\n \"companyRule\": \"RSA_M\",\r\n \"linkedToEmployee\": \"00004 - Mr L StartPeriod\",\r\n \"zoneCodeID\": 1,\r\n \"zoneCode\": \"ZONE2\",\r\n \"jobTitleID\": 1,\r\n \"jobTitle\": \"NN\",\r\n \"functionID\": 3,\r\n \"function\": \"FUNC_1\",\r\n \"jobGradeID\": 1,\r\n \"jobGrade\": \"HIGH\",\r\n \"jobGeneralID\": 1,\r\n \"jobGeneral\": \"JOB_GEN3\",\r\n \"competencyRatingTypeID\": 1,\r\n \"competencyRatingType\": \"1-3_IMAGE\",\r\n \"competencySetupTypeID\": 3,\r\n \"competencySetupType\": \"SUBCOMPETENCY\",\r\n \"keyPerformanceRatingTypeID\": 1,\r\n \"keyPerformanceRatingType\": \"1-3_IMAGE\",\r\n \"performanceSetupTypeID\": 1,\r\n \"performanceSetupType\": \"INDICATOR\",\r\n \"levelOfWorkID\": 1,\r\n \"levelOfWork\": \"LEVEL_WRK_2\",\r\n \"criticalPositionID\": 1,\r\n \"criticalPosition\": \"CRIT_B\",\r\n \"payScaleID\": 2,\r\n \"payScale\": \"PAY_SCALE01\",\r\n \"affectedEarningLineID\": 1,\r\n \"affectedEarningLine\": \"SALARY\"\r\n },\r\n \"hierarchyInformation\": [\r\n {\r\n \"hrEntityHierarchyRelationshipID\": 1025,\r\n \"hierarchyHeader\": \"Faction\",\r\n \"hierarchyID\": 3,\r\n \"hierarchy\": \"DAUNTLESS\"\r\n },\r\n {\r\n \"hrEntityHierarchyRelationshipID\": 1026,\r\n \"hierarchyHeader\": \"Department\",\r\n \"hierarchyID\": 8,\r\n \"hierarchy\": \"DEV\"\r\n }\r\n ],\r\n \"qualifications\": [\r\n {\r\n //\"hrEntityQualificationRelationshipID\": 1002,\r\n //\"QualificationTypeID\": 1, \r\n //\"qualificationType\": \"ABET3\",\r\n // \"qualificationID\": 1,\r\n \"qualification\": \"ASSASSIN\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"competency\": [\r\n {\r\n //\"competencyAreaID\": 1,\r\n \"competencyArea\": \"WORK\",\r\n \"competencyWeightPerc\": 50,\r\n \"competencyRatingID\": 3,\r\n //\"competencyRating\": \"SATISFIED\", \r\n \"levelOfComplexityID\": 3,\r\n //\"levelOfComplexity\": \"MODERATE\",\r\n \"behaviouralIndicator\": \"As a manager this is your most important task and will apply the highest weight.\",\r\n \"occupationCriticalCompetency\": true\r\n },\r\n {\r\n //\"competencyAreaID\": 1,\r\n \"competencyArea\": \"SOCIAL\",\r\n \"competencyWeightPerc\": 50,\r\n //\"competencyRatingID\": 3, \r\n \"competencyRating\": \"SATISFIED\",\r\n //\"levelOfComplexityID\": 3,\r\n \"levelOfComplexity\": \"MODERATE\",\r\n \"behaviouralIndicator\": \"As a manager this is your most important task and will apply the highest weight.\",\r\n \"occupationCriticalCompetency\": true\r\n }\r\n ],\r\n \"keyPerformance\": [\r\n {\r\n \"keyPerformanceAreaID\": 1,\r\n \"keyPerformanceArea\": \"TRAINING\",\r\n \"keyPerformanceWeightPerc\": 100,\r\n \"keyPerformanceRatingID\": 2,\r\n \"keyPerformanceRating\": \"EXCEEDED\"\r\n }\r\n ],\r\n \"affiliationsAndMemberships\": [\r\n {\r\n //\"hrEntityAffiliationsMemRelationshipID\": 1,\r\n \"affiliationsMembershipType\": \"UNION\",\r\n \"affiliationsMembershipBodyID\": 1,\r\n \"affiliationsMembershipBody\": \"UNION_MEMB_BOD2\",\r\n \"essential\": true,\r\n \"points\": 5\r\n }\r\n ],\r\n \"experience\": [\r\n {\r\n //\"hrEntityExperienceRelationshipID\": 1,\r\n \"experienceID\": 1,\r\n \"experience\": \"GENERAL\",\r\n \"experienceGainedID\": 1,\r\n //\"experienceGained\": \"GEN_XP_3\",\r\n \"durationYears\": 5.0,\r\n \"essential\": true\r\n }\r\n ],\r\n \"training\": [\r\n {\r\n //\"hrEntityTrainingDictionaryRelationshipID\": 1,\r\n \"trainingType\": \"INDUCTION - Employee Induction\",\r\n \"trainingDictionaryID\": 1,\r\n //\"trainingDictionary\": \"CHAOSTHEORY\", \r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"priorLearning\": [\r\n {\r\n //\"hrEntityPriorLearningRelationshipID\": 1,\r\n \"priorLearningTypeDisplayMember\": \"EASY - Easy\",\r\n \"priorLearningDictionaryID\": 1,\r\n //\"priorLearningDictionary\": \"P_LEARNING02\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"skills\": [\r\n {\r\n //\"hrEntitySkillsRelationshipID\": 1,\r\n \"skillsType\": \"SKILL_TP_1\",\r\n //\"skillID\": 2, \r\n \"skill\": \"SKL_TP1_DTL_A\",\r\n \"occupationCriticalSkillFlag\": true\r\n }\r\n ],\r\n \"task\": [\r\n {\r\n //\"hrEntityTaskRelationshipID\": 1,\r\n \"taskID\": 1,\r\n \"task\": \"TASK2\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"itemsIssued\": [\r\n {\r\n //\"hrEntityItemsIssuedRelationshipID\": 1,\r\n \"itemsIssuedType\": \"COMPUTER\",\r\n \"itemIssuedID\": 1,\r\n \"descriptionOfItem\": \"ACCESS\",\r\n \"quantity\": 6,\r\n \"toBeIssued\": \"DE\",\r\n \"itemMustBeReturned\": true,\r\n \"itemReturnString\": \"TM\"\r\n }\r\n ],\r\n \"equityInformation\": {\r\n // \"occupationalCategoryID\": 2,\r\n \"occupationalCategory\": \"1\",\r\n // \"occupationallevelID\": 2,\r\n \"occupationallevel\": \"1\",\r\n //\"workplaceID\": 2,\r\n \"workplace\": \"PTA\",\r\n //\"provinceID\": 2,\r\n \"province\": \"1\",\r\n //\"equityJobFunctionID\": 2,\r\n \"equityJobFunction\": \"1\",\r\n //\"typeOfEmploymentID\": 2,\r\n \"typeOfEmployment\": \"1\",\r\n \"gender\": \"F\",\r\n \"racialGroup\": \"C\",\r\n \"designatedEmployee\": false,\r\n \"disabled\": false,\r\n \"disability\": \"\"\r\n },\r\n \"skillsInformation\": [\r\n {\r\n \"occupationalCategoryID\": 2,\r\n \"occupationalCategory\": \"2\",\r\n \"occupationalLevelID\": 1,\r\n \"occupationalLevel\": \"2\",\r\n \"workplaceID\": 1,\r\n \"workplace\": \"PTA\",\r\n \"provinceID\": 1,\r\n \"province\": \"2\",\r\n \"ofoCategoryID\": 1,\r\n \"ofoCategory\": \"2\",\r\n \"scarceSkillsTypeID\": 1,\r\n \"scarceSkillsType\": \"2\",\r\n \"ofoCodeID\": 1,\r\n \"ofoCode\": \"OFO_02\",\r\n \"typeOfEmploymentID\": 1,\r\n \"typeOfEmployment\": \"2\"\r\n }\r\n ],\r\n \"remunerationComponent\": [\r\n {\r\n //\"hrEntityComponentRelationshipID\": 1,\r\n \"componentType\": \"COMP_TP1\",\r\n \"component\": 1,\r\n \"componentID\": 1,\r\n \"componentCode\": \"CMP_TP1_B\",\r\n \"componentMinimum\": 200.0000,\r\n \"componentMiddle\": 200.0000,\r\n \"componentMaximum\": 200.0000,\r\n \"marketMinimum\": 200.0000,\r\n \"marketMiddle\": 200.0000,\r\n \"marketMaximum\": 200.0000\r\n }\r\n ],\r\n \"reportsTo\": [\r\n {\r\n //\"hrEntityReportsToRelationshipID\": 2,\r\n \"reportsToPositionID\": 3,\r\n \"reportsToPosition\": \"POS_EMP_02\",\r\n \"priority\": 1,\r\n \"relationship\": \"A\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/update","urlObject":{"protocol":"http","port":"{{APIPort}}","path":["api","apibase","pmaintenance","update"],"host":["{{HostName}}"],"query":[],"variable":[]}},"response":[{"id":"c3e203f6-3c61-4b9a-be4d-1f9036938a7c","name":"Update - only Qualifications","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"positionCode\": \"POS_GET_01\",\r\n //\"HrEntityId\": 14,\r\n \"qualifications\": [\r\n {\r\n //\"hrEntityQualificationRelationshipID\": 1002,\r\n //\"QualificationTypeID\": 1, \r\n //\"qualificationType\": \"ABET3\",\r\n // \"qualificationID\": 1,\r\n \"qualification\": \"ASSASSIN\", \r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"803"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 14:05:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"headerDetails\": {\n \"hrEntityId\": 0\n },\n \"otherInformation\": {},\n \"hierarchyInformation\": [],\n \"competency\": [],\n \"keyPerformance\": [],\n \"qualifications\": [\n {\n \"hrEntityQualificationRelationshipID\": 0,\n \"qualificationID\": 2,\n \"qualification\": \"ASSASSIN\",\n \"points\": 5,\n \"essential\": true\n }\n ],\n \"affiliationsAndMemberships\": [],\n \"experience\": [],\n \"training\": [],\n \"priorLearning\": [],\n \"skills\": [],\n \"task\": [],\n \"itemsIssued\": [],\n \"equityInformation\": {\n \"designatedEmployee\": false,\n \"disabled\": false\n },\n \"skillsInformation\": [],\n \"remunerationComponent\": [],\n \"reportsTo\": [],\n \"succession\": []\n }\n}"},{"id":"368ce320-4fe8-41a7-97d5-223096de0f4e","name":"Update - only Other Information","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"positionCode\": \"POS_GET_04\",\r\n //\"HrEntityId\": 14,\r\n \"otherInformation\": {\r\n \"companyID\": 1,\r\n \"company\": \"MCS_TEST\",\r\n \"companyRuleID\": 5,\r\n \"companyRule\": \"RSA_M\",\r\n \"linkedToEmployee\": \"00004 - Mr L StartPeriod\",\r\n \"zoneCodeID\": 1,\r\n \"zoneCode\": \"ZONE2\",\r\n \"jobTitleID\": 1,\r\n \"jobTitle\": \"NN\",\r\n \"functionID\": 3,\r\n \"function\": \"FUNC_1\",\r\n \"jobGradeID\": 1,\r\n \"jobGrade\": \"HIGH\",\r\n \"jobGeneralID\": 1,\r\n \"jobGeneral\": \"JOB_GEN3\",\r\n \"competencyRatingTypeID\": 1,\r\n \"competencyRatingType\": \"1-3_IMAGE\",\r\n \"competencySetupTypeID\": 3,\r\n \"competencySetupType\": \"SUBCOMPETENCY\",\r\n \"keyPerformanceRatingTypeID\": 1,\r\n \"keyPerformanceRatingType\": \"1-3_IMAGE\",\r\n \"performanceSetupTypeID\": 1,\r\n \"performanceSetupType\": \"INDICATOR\",\r\n \"levelOfWorkID\": 1,\r\n \"levelOfWork\": \"LEVEL_WRK_2\",\r\n \"criticalPositionID\": 1,\r\n \"criticalPosition\": \"CRIT_B\",\r\n \"payScaleID\": 2,\r\n \"payScale\": \"PAY_SCALE01\",\r\n \"affectedEarningLineID\": 1,\r\n \"affectedEarningLine\": \"SALARY\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1539"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 13:50:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"headerDetails\": {\n \"hrEntityId\": 0\n },\n \"otherInformation\": {\n \"companyID\": 1,\n \"company\": \"MCS_TEST\",\n \"companyRuleID\": 5,\n \"companyRule\": \"POSITIONS\",\n \"linkedToEmployee\": \"00004 - Mr L StartPeriod\",\n \"zoneCodeID\": 1,\n \"zoneCode\": \"ZONE1\",\n \"jobTitle\": \"HSMM\",\n \"functionID\": 3,\n \"function\": \"FUNC_3\",\n \"jobGradeID\": 1,\n \"jobGrade\": \"LOW\",\n \"jobGeneralID\": 1,\n \"jobGeneral\": \"JOB_GEN1\",\n \"competencyRatingTypeID\": 1,\n \"competencyRatingType\": \"1-3_VALUE\",\n \"competencySetupTypeID\": 3,\n \"competencySetupType\": \"SUBCOMPETENCY\",\n \"keyPerformanceRatingTypeID\": 1,\n \"keyPerformanceRatingType\": \"1-3_VALUE\",\n \"performanceSetupType\": \"AREA\",\n \"levelOfWorkID\": 1,\n \"levelOfWork\": \"EASY\",\n \"criticalPositionID\": 1,\n \"criticalPosition\": \"CRIT_A\",\n \"payScaleID\": 2,\n \"payScale\": \"PAY_SCALE01\",\n \"affectedEarningLine\": \"SALARY\"\n },\n \"hierarchyInformation\": [],\n \"competency\": [],\n \"keyPerformance\": [],\n \"qualifications\": [],\n \"affiliationsAndMemberships\": [],\n \"experience\": [],\n \"training\": [],\n \"priorLearning\": [],\n \"skills\": [],\n \"task\": [],\n \"itemsIssued\": [],\n \"equityInformation\": {\n \"designatedEmployee\": false,\n \"disabled\": false\n },\n \"skillsInformation\": [],\n \"remunerationComponent\": [],\n \"reportsTo\": [],\n \"succession\": []\n }\n}"},{"id":"353defdb-2092-4051-ae77-34b710440997","name":"Update - only Hierarchy Information","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"PositionCode\": \"POS_GET_01\",\r\n //\"HrEntityId\": 14,\r\n \"hierarchyInformation\": [\r\n {\r\n \"hrEntityHierarchyRelationshipID\": 23,\r\n \"hierarchyHeader\": \"FACTION\",\r\n //\"hierarchyID\": 1,\r\n \"hierarchy\": \"AMITY\"\r\n },\r\n {\r\n \"hrEntityHierarchyRelationshipID\": 24,\r\n \"hierarchyHeader\": \"DEPARTMENT\",\r\n //\"hierarchyID\": 7,\r\n \"hierarchy\": \"DEV\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"942"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 13:58:58 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"headerDetails\": {\n \"hrEntityId\": 0\n },\n \"otherInformation\": {},\n \"hierarchyInformation\": [\n {\n \"hrEntityHierarchyRelationshipID\": 23,\n \"hierarchyHeader\": \"FACTION\",\n \"hierarchyID\": 2,\n \"hierarchy\": \"AMITY\"\n },\n {\n \"hrEntityHierarchyRelationshipID\": 24,\n \"hierarchyHeader\": \"DEPARTMENT\",\n \"hierarchyID\": 8,\n \"hierarchy\": \"DEV\"\n }\n ],\n \"competency\": [],\n \"keyPerformance\": [],\n \"qualifications\": [],\n \"affiliationsAndMemberships\": [],\n \"experience\": [],\n \"training\": [],\n \"priorLearning\": [],\n \"skills\": [],\n \"task\": [],\n \"itemsIssued\": [],\n \"equityInformation\": {\n \"designatedEmployee\": false,\n \"disabled\": false\n },\n \"skillsInformation\": [],\n \"remunerationComponent\": [],\n \"reportsTo\": [],\n \"succession\": []\n }\n}"},{"id":"1df51cf0-62c5-4407-8345-a1caa5775435","name":"Error - Competency and Key Performance setup conflict","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"positionCode\": \"POS_GET_01\",\r\n //\"hrEntityID\": 15,\r\n \"headerDetails\": {\r\n \"positionStatus\": \"VT\",\r\n \"code\": \"POS_GET_04\",\r\n \"vacancyDate\": \"2023/05/09\",\r\n \"shortDescription\": \"Line Edit\",\r\n \"longDescription\": \"Line Edit\",\r\n \"jobTemplateID\": 1,\r\n \"jobTemplate\": \"JT01\",\r\n \"natureOfPositionID\": 5,\r\n \"natureOfPosition\": \"CASUAL\",\r\n \"reportsToPositionID\": 1017,\r\n \"reportsToPosition\": \"TEST001\",\r\n \"status\": \"A\"\r\n },\r\n \"otherInformation\": {\r\n \"companyID\": 1,\r\n \"company\": \"MCS_TEST\",\r\n \"companyRuleID\": 5,\r\n \"companyRule\": \"RSA_M\",\r\n \"linkedToEmployee\": \"00004 - Mr L StartPeriod\",\r\n \"zoneCodeID\": 1,\r\n \"zoneCode\": \"ZONE2\",\r\n \"jobTitleID\": 1,\r\n \"jobTitle\": \"NN\",\r\n \"functionID\": 3,\r\n \"function\": \"FUNC_1\",\r\n \"jobGradeID\": 1,\r\n \"jobGrade\": \"HIGH\",\r\n \"jobGeneralID\": 1,\r\n \"jobGeneral\": \"JOB_GEN3\",\r\n \"competencyRatingTypeID\": 1,\r\n \"competencyRatingType\": \"1-3_IMAGE\",\r\n \"competencySetupTypeID\": 3,\r\n \"competencySetupType\": \"SUBCOMPETENCY\",\r\n \"keyPerformanceRatingTypeID\": 1,\r\n \"keyPerformanceRatingType\": \"1-3_IMAGE\",\r\n \"performanceSetupTypeID\": 1,\r\n \"performanceSetupType\": \"INDICATOR\",\r\n \"levelOfWorkID\": 1,\r\n \"levelOfWork\": \"LEVEL_WRK_2\",\r\n \"criticalPositionID\": 1,\r\n \"criticalPosition\": \"CRIT_B\",\r\n \"payScaleID\": 2,\r\n \"payScale\": \"PAY_SCALE01\",\r\n \"affectedEarningLineID\": 1,\r\n \"affectedEarningLine\": \"SALARY\"\r\n },\r\n // \"hierarchyInformation\": [\r\n // {\r\n // \"hrEntityHierarchyRelationshipID\": 1025,\r\n // \"hierarchyHeader\": \"Faction\",\r\n // \"hierarchyID\": 3,\r\n // \"hierarchy\": \"DAUNTLESS\"\r\n // },\r\n // {\r\n // \"hrEntityHierarchyRelationshipID\": 1026,\r\n // \"hierarchyHeader\": \"Department\",\r\n // \"hierarchyID\": 8,\r\n // \"hierarchy\": \"DEV\"\r\n // }\r\n // ],\r\n \"qualifications\": [\r\n {\r\n //\"hrEntityQualificationRelationshipID\": 1002,\r\n //\"QualificationTypeID\": 1, \r\n //\"qualificationType\": \"ABET3\",\r\n // \"qualificationID\": 1,\r\n \"qualification\": \"ASSASSIN\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"competency\": [\r\n {\r\n //\"competencyAreaID\": 1,\r\n \"competencyArea\": \"WORK\",\r\n \"competencyWeightPerc\": 50,\r\n \"competencyRatingID\": 3,\r\n //\"competencyRating\": \"SATISFIED\", \r\n \"levelOfComplexityID\": 3,\r\n //\"levelOfComplexity\": \"MODERATE\",\r\n \"behaviouralIndicator\": \"As a manager this is your most important task and will apply the highest weight.\",\r\n \"occupationCriticalCompetency\": true\r\n },\r\n {\r\n //\"competencyAreaID\": 1,\r\n \"competencyArea\": \"SOCIAL\",\r\n \"competencyWeightPerc\": 50,\r\n //\"competencyRatingID\": 3, \r\n \"competencyRating\": \"SATISFIED\",\r\n //\"levelOfComplexityID\": 3,\r\n \"levelOfComplexity\": \"MODERATE\",\r\n \"behaviouralIndicator\": \"As a manager this is your most important task and will apply the highest weight.\",\r\n \"occupationCriticalCompetency\": true\r\n }\r\n ],\r\n \"keyPerformance\": [\r\n {\r\n \"keyPerformanceAreaID\": 1,\r\n \"keyPerformanceArea\": \"TRAINING\",\r\n \"keyPerformanceWeightPerc\": 100,\r\n \"keyPerformanceRatingID\": 2,\r\n \"keyPerformanceRating\": \"EXCEEDED\"\r\n }\r\n ],\r\n \"affiliationsAndMemberships\": [\r\n {\r\n //\"hrEntityAffiliationsMemRelationshipID\": 1,\r\n \"affiliationsMembershipType\": \"UNION\",\r\n \"affiliationsMembershipBodyID\": 1,\r\n \"affiliationsMembershipBody\": \"UNION_MEMB_BOD2\",\r\n \"essential\": true,\r\n \"points\": 5\r\n }\r\n ],\r\n \"experience\": [\r\n {\r\n //\"hrEntityExperienceRelationshipID\": 1,\r\n \"experienceID\": 1,\r\n \"experience\": \"GENERAL\",\r\n \"experienceGainedID\": 1,\r\n //\"experienceGained\": \"GEN_XP_3\",\r\n \"durationYears\": 5.0,\r\n \"essential\": true\r\n }\r\n ],\r\n \"training\": [\r\n {\r\n //\"hrEntityTrainingDictionaryRelationshipID\": 1,\r\n \"trainingType\": \"INDUCTION - Employee Induction\",\r\n \"trainingDictionaryID\": 1,\r\n //\"trainingDictionary\": \"CHAOSTHEORY\", \r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"priorLearning\": [\r\n {\r\n //\"hrEntityPriorLearningRelationshipID\": 1,\r\n \"priorLearningTypeDisplayMember\": \"EASY - Easy\",\r\n \"priorLearningDictionaryID\": 1,\r\n //\"priorLearningDictionary\": \"P_LEARNING02\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"skills\": [\r\n {\r\n //\"hrEntitySkillsRelationshipID\": 1,\r\n \"skillsType\": \"SKILL_TP_1\",\r\n //\"skillID\": 2, \r\n \"skill\": \"SKL_TP1_DTL_A\",\r\n \"occupationCriticalSkillFlag\": true\r\n }\r\n ],\r\n \"task\": [\r\n {\r\n //\"hrEntityTaskRelationshipID\": 1,\r\n \"taskID\": 1,\r\n \"task\": \"TASK2\",\r\n \"points\": 5,\r\n \"essential\": true\r\n }\r\n ],\r\n \"itemsIssued\": [\r\n {\r\n //\"hrEntityItemsIssuedRelationshipID\": 1,\r\n \"itemsIssuedType\": \"COMPUTER\",\r\n \"itemIssuedID\": 1,\r\n \"descriptionOfItem\": \"ACCESS\",\r\n \"quantity\": 6,\r\n \"toBeIssued\": \"DE\",\r\n \"itemMustBeReturned\": true,\r\n \"itemReturnString\": \"TM\"\r\n }\r\n ],\r\n \"equityInformation\": {\r\n // \"occupationalCategoryID\": 2,\r\n \"occupationalCategory\": \"1\",\r\n // \"occupationallevelID\": 2,\r\n \"occupationallevel\": \"1\",\r\n //\"workplaceID\": 2,\r\n \"workplace\": \"PTA\",\r\n //\"provinceID\": 2,\r\n \"province\": \"1\",\r\n //\"equityJobFunctionID\": 2,\r\n \"equityJobFunction\": \"1\",\r\n //\"typeOfEmploymentID\": 2,\r\n \"typeOfEmployment\": \"1\",\r\n \"gender\": \"F\",\r\n \"racialGroup\": \"C\",\r\n \"designatedEmployee\": false,\r\n \"disabled\": false,\r\n \"disability\": \"\"\r\n },\r\n \"skillsInformation\": [\r\n {\r\n \"occupationalCategoryID\": 2,\r\n \"occupationalCategory\": \"2\",\r\n \"occupationalLevelID\": 1,\r\n \"occupationalLevel\": \"2\",\r\n \"workplaceID\": 1,\r\n \"workplace\": \"PTA\",\r\n \"provinceID\": 1,\r\n \"province\": \"2\",\r\n \"ofoCategoryID\": 1,\r\n \"ofoCategory\": \"2\",\r\n \"scarceSkillsTypeID\": 1,\r\n \"scarceSkillsType\": \"2\",\r\n \"ofoCodeID\": 1,\r\n \"ofoCode\": \"OFO_02\",\r\n \"typeOfEmploymentID\": 1,\r\n \"typeOfEmployment\": \"2\"\r\n }\r\n ],\r\n \"remunerationComponent\": [\r\n {\r\n //\"hrEntityComponentRelationshipID\": 1,\r\n \"componentType\": \"COMP_TP1\",\r\n \"component\": 1,\r\n \"componentID\": 1,\r\n \"componentCode\": \"CMP_TP1_B\",\r\n \"componentMinimum\": 200.0000,\r\n \"componentMiddle\": 200.0000,\r\n \"componentMaximum\": 200.0000,\r\n \"marketMinimum\": 200.0000,\r\n \"marketMiddle\": 200.0000,\r\n \"marketMaximum\": 200.0000\r\n }\r\n ],\r\n \"reportsTo\": [\r\n {\r\n //\"hrEntityReportsToRelationshipID\": 2,\r\n \"reportsToPositionID\": 3,\r\n \"reportsToPosition\": \"POS_EMP_02\",\r\n \"priority\": 1,\r\n \"relationship\": \"A\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{HostName}}:{{APIPort}}/api/apibase/pmaintenance/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"709"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-HTTPAPI/2.0"},{"key":"Date","value":"Tue, 18 Jul 2023 14:17:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"businessRules\": [\n {\n \"PropertyName\": \"CompetencySetupTypeID\",\n \"PropertyFriendlyName\": \"Competency Setup Type\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Once you have linked this setup to a position you will have limited edit functionality on the Competency Setup Type.\"\n }\n ]\n },\n {\n \"PropertyName\": \"KeyPerformanceSetupTypeID\",\n \"PropertyFriendlyName\": \"Performance Setup Type\",\n \"WarningRulesCollection\": [\n {\n \"Message\": \"Once you have linked this setup to a position you will have limited edit functionality on the Performance Setup Type.\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"dd541f5e-a657-49c2-b3d2-a9747f45924b"}],"id":"2e56f47f-bdd8-474d-b77e-fa4682a3e744","description":"The following API's are designed to allow the user to Retrieve and Update the existing Positions within the Sage 300 People system. The API will not create a new Position, however any detail items that are not set to update an existing ID in the respective list will be treated as a new record in the section.
\nExamples are given with each API.
\nNote:
\nDue to the advanced complexity of a setup available on Competency and Key Performance, be aware of the required structure as it will change with each setup. It is recommended to first execute a GET (Retrieve) on an existing position that has the required setup on the fields and base the payload requirements for the PUT (Update) on that.
\nWith position's being able to be setup/used as a driving factor for many payroll calculations it is advised to always recalculate the employees in the system after any updates are made.
\n","_postman_id":"2e56f47f-bdd8-474d-b77e-fa4682a3e744"}]}