{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fcd63fb1-7524-494f-8f22-609d896dd144","name":"HyperPayroll REST API for Sage 50 Payroll","description":"The API uses REST. All data sent to it or received from it will be in a JSON format.\n\n# Optional fields\n\nIf you want to clear the value you must pass an empty string as the value. missing properties or null values will be ignored to prevent data loss by customers that accidentally miss a field, maybe from having an older version of the API.\n\nOther optional types can either be omitted completely or set to null.\n\n# Authentication\n\nThe API requires all requests to have an `AuthToken` Header with the customers unique token in each request or a 403 forbidden error will be thrown.\n\nPlease contact Hyperext support via [support@hyperext.com](https://mailto:support@hyperext.com) to obtain your unique token if you do not already have it.\n\n# Change Log\n\n## Release 1.5.7.2\n\n- Update to support V32 of Payroll\n    \n\n## Release 1.5.7.1\n\n- Changes to endpoint - api/employee to return error 404 on invalid employees\n    \n- Changes to endpoint - api/employee/{employeeReference}/payments to return error 404 on invalid employees\n    \n- Changes to endpoint - api/employee/{employeeReference}/deductions to return error 404 on invalid employees\n    \n- Changes to endpoint - api/employee/{employeeReference}/absences to return error 404 on invalid employees\n    \n- Fix on endpoint - api/employee/{{id}}/payments to return correct reference of pay element after update\n    \n- Changes to API user to disconnect after 15 seconds\n    \n\n## Release 1.5.7.0\n\n- Performance & Reliability improvements across all endpoints\n    \n- Bug fixed on endpoint - api/employee\n    \n- Bug fixed on endpoint - api/allPayslips?TaxYearStart={{yyyy}}&TaxMonth={M}&TaxWeek={{WW}}\n    \n\n## Release 1.5.6.0\n\n- Bug fixed on all endpoints to stop application errors\n    \n\n## Release 1.5.5.0\n\n- Bug fixed on endpoint - api/employee\n    \n- Bug fixed on endpoint - api/department\n    \n- Bug fixed on endpoint - api/payment\n    \n- Bug fixed on endpoint - api/deduction/\n    \n\n## Release 1.5.4.0\n\n- Bug fixed on endpoint - api/employee for week1BasisFlag\n    \n\n## Release 1.5.3.0\n\n- Bug fixed on endpoint - api/employee/{{id}}/deductions/\n    \n- Added field \"totalGrossTD\" to endpoint- api/payslips\n    \n- Added field \"taxGrossTD\" to endpoint- api/payslips\n    \n\n## Release 1.5.2.0\n\n- Update to support V30 of Payroll\n    \n\n## Release 1.5.1.0\n\n- Added new new fields to endpoint - endpoint - api/allPayslips?TaxYearStart={{yyyy}}&TaxMonth={M}&TaxWeek={{WW}}\n    \n\n## Release 1.5.0.1\n\n- Added new endpoint - api/allPayslips?TaxYearStart={{yyyy}}&TaxMonth={M}&TaxWeek={{WW}}\n    \n\n## Release 1.4.0.2\n\n- Update to support V29 of Payroll\n    \n\n## Release 1.4.0.1\n\n- Bug fixed on api/p45 endpoint\n    \n\n## Release 1.4.0\n\n- Added endpoint - api/p45/{{WorksNumber}}\n    \n- Bug fixed on allPayslips endpoint\n    \n\n## Release 1.3.10\n\n- Added endpoint - api/allPayslips/{{year}}\n    \n\n## Release 1.3.9.1\n\n- Added field \"ssp\" to endpoint - api/payslips\n    \n- Added field \"smp\" to endpoint - api/payslips\n    \n- Added field \"employeePension\" to endpoint - api/payslips\n    \n- Added field \"studentLoan\" to endpoint - api/payslips\n    \n- Update response for endpoint - api/payslips\n    \n\n## Release 1.3.8\n\n- Added new endpoint - api/esubmissionLog\n    \n- Added field \"employeePensionTD\" to endpoint - api/payslips\n    \n- Added field \"employerPensionTD\" to endpoint - api/payslips\n    \n\n## Release 1.3.7.4\n\n- Updates to endpoints - api/paymentSummary1 and api/paymentSummary2\n    \n\n## Release 1.3.7\n\n- Updated P11 endpoint - api/reportP11Summary\n    \n\n## Release 1.3.6\n\n- Update to support V28 of Payroll\n    \n- Added \"departmentRef\" field to endpoint - api/payslips\n    \n- Added “grossForNIC” field to endpoint - api/payslips\n    \n- Added “employerNIC” field to endpoint - api/payslips\n    \n\n## Release 1.3.5\n\n- Fixed issue on endpoint - api/employee\n    \n- Added \"department\" new field to api/employee\n    \n- Added new endpoint - api/department\n    \n- Added new endpoint - api/paymentSummary1\n    \n- Added new endpoint - api/paymentSummary2\n    \n\n## Release 1.3.4\n\n- Fix taxCode issue on api/employee and add taxPaid and employeeNIC to api/payslips\n    \n\n## Release 1.3.3\n\n- GET api/payslips endpoint to return last pay run payslips\n    \n\n## Release 1.3.2\n\n- Added searchPensionReports endpoint, added search online payslip historical, added searchP32, added search P11 and version endpoint\n    \n\n## Release 1.3.1\n\n- Implemented multi-company across all controllers and also ODBC\n    \n- Added P11 endpoint\n    \n\n## Release 1.3.0\n\n- Added multi-company\n    \n\n## Release 1.2.0\n\n- implementing ODBC structure\n    \n\n## Release 1.0.0\n\n- Initial build","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6298410","team":1584067,"collectionId":"fcd63fb1-7524-494f-8f22-609d896dd144","publishedId":"U16dQTmV","public":true,"publicUrl":"https://sage-50-payroll-api-v1-docs.hyperext.com","privateUrl":"https://go.postman.co/documentation/6298410-fcd63fb1-7524-494f-8f22-609d896dd144","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"}}]}},"version":"8.10.0","publishDate":"2024-07-05T08:28:47.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/257a04c3253e71e47dec6a00c2345e130933cd91a30275907c8f96323edaba7f","favicon":"https://hyperext.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://sage-50-payroll-api-v1-docs.hyperext.com/view/metadata/U16dQTmV"}