Info
Created 05-11-2024 by Lavinia
Gheghea
Revision
Updated
09-09-2025
by
Lavinia
Gheghea
-
added
LaborDirective11HoursRule
and
LaborDirective48HoursRule
fields
Description
The API
allows you to create, delete,
and update work type.
You can retrieve individual
work type as well as a list
of all
worktypes.
Endpoints
GET: /worktypes
Parameters
Headers and Query
| Name | Description | Type |
| API-key - required | Authorization
Token | String(64) |
| UID - required | UID
-how can
be obtained | String |
| DEVICEID - required | DEVICEID | String |
| offset | starting record | Integer |
| limit | how many records displayed
on a page | Integer |
| OrderFieldName | field name to order the
recordset | String |
| OrderDirection | ASC or DESC | String |
| Filter | filter the recordset | String |
| sPageName | Page Name | String |
| nRefID | Ref ID | Integer |
| sType | Type | String |
Curl example
curl -X GET "https://smartapi.smarttid.dk/worktypes" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) : array of
worktypes
Response body
[
{
"ID": 105,
"WorkTypeCode": "AFSPADSERING",
"Description": "Afholdt afspadsering",
"Type": "Absence",
"PayrollReference": "",
"CountAsNormTime": true,
"AutoFill": true,
"FillBreak": true,
"FillExtra": true,
"FillPersonalExtra": true,
"CalculateBreak": true,
"CalculateExtra": false,
"Factor": 1,
"RoundingMethodCode": "",
"RoundingMethodDescription": null,
"ShowOnStartTooSoon": false,
"ShowOnStartTooLate": true,
"ShowOnStopTooSoon": true,
"ShowOnStopTooLate": false,
"ShowOnMetStandardTime": false,
"ShowOnNotMetStandardTime": false,
"ShowOnNotWorking": false,
"ShowOnLoginPeriodTotal": true,
"EmployeeSelect": false,
"SpWhenCome": "",
"SpWhenLeave": "",
"SpWhenPost": "",
"SpOnJournalLineStart": "",
"SpOnJournalLineEnd": "",
"MinTimeBeforeCalculateExtra": "1900-01-01T00:00:00",
"SortOrder": 0,
"ExportType": "Hours",
"NoOfUnits": 1,
"OvertimeCode": "",
"ColorCode": "",
"IgnorePaidBreak": false,
"Vacation": false,
"ShowOnAddAbsence": true,
"OnlyCalculateManuelBreak": false,
"IncludeInJobExtra": true,
"ERPReference": null,
"HtmlCardTitle": "AFSPADSERING",
"HtmlCardContent": "Afholdt afspadsering",
"MaxNoOfExtras": null,
"ReleaseExtraDuringBreak": false,
"LaborDirective11HoursRule": false,
"LaborDirective48HoursRule": false,
"HighlightWorktype": false,
"PayrollExportType": "Absence",
"SpWhenUpdateTimeSheet": "",
"VisibleInTimeSheet": true,
"CrossMidnight": false,
"ForceRemark": false,
"AskForQuantity": true
},
{
"ID": 106,
"WorkTypeCode": "AFSPADSERINGOP",
"Description": "Optjent afspadsering",
"Type": "Absence",
"PayrollReference": "",
"CountAsNormTime": true,
"AutoFill": true,
"FillBreak": true,
"FillExtra": true,
"FillPersonalExtra": true,
"CalculateBreak": true,
"CalculateExtra": false,
"Factor": 1,
"RoundingMethodCode": null,
"RoundingMethodDescription": null,
"ShowOnStartTooSoon": false,
"ShowOnStartTooLate": false,
"ShowOnStopTooSoon": false,
"ShowOnStopTooLate": false,
"ShowOnMetStandardTime": false,
"ShowOnNotMetStandardTime": false,
"ShowOnNotWorking": false,
"ShowOnLoginPeriodTotal": true,
"EmployeeSelect": false,
"SpWhenCome": "",
"SpWhenLeave": "",
"SpWhenPost": "",
"SpOnJournalLineStart": "",
"SpOnJournalLineEnd": "",
"MinTimeBeforeCalculateExtra": "1900-01-01T00:00:00",
"SortOrder": 0,
"ExportType": "Hours",
"NoOfUnits": 1,
"OvertimeCode": null,
"ColorCode": null,
"IgnorePaidBreak": false,
"Vacation": false,
"ShowOnAddAbsence": true,
"OnlyCalculateManuelBreak": false,
"IncludeInJobExtra": true,
"ERPReference": null,
"HtmlCardTitle": "AFSPADSERINGOP",
"HtmlCardContent": "Optjent afspadsering",
"MaxNoOfExtras": null,
"ReleaseExtraDuringBreak": false,
"LaborDirective11HoursRule": false,
"LaborDirective48HoursRule": false,
"HighlightWorktype": false,
"PayrollExportType": "Absence",
"SpWhenUpdateTimeSheet": null,
"VisibleInTimeSheet": true,
"CrossMidnight": false,
"ForceRemark": false,
"AskForQuantity": true
]
Response headers:
content-encoding: gzip content-length: 238 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 08:01:23 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-pagination: {"totalCount":4,"totalFiltered":4,"Offset":0,"Limit":4,"Returned":4} x-powered-by: ASP.NET
400 (ERROR) : Error
message
Response Body
Error message
GET{id} : /worktypes/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization
Token | String(64) |
| UID - required | UID
-how can
be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID ofworktype | Integer |
Curl example
curl -X GET "https://smartapi.smarttid.dk/worktypes/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) : the worktype
Response Body
[ { "ID": 105, "WorkTypeCode": "AFSPADSERING", "Description": "Afholdt afspadsering", "Type": "Absence", "PayrollReference": "", "CountAsNormTime": true, "AutoFill": true, "FillBreak": true, "FillExtra": true, "FillPersonalExtra": true, "CalculateBreak": true, "CalculateExtra": false, "Factor": 1, "RoundingMethodCode": "", "RoundingMethodDescription": null, "ShowOnStartTooSoon": false, "ShowOnStartTooLate": true, "ShowOnStopTooSoon": true, "ShowOnStopTooLate": false, "ShowOnMetStandardTime": false, "ShowOnNotMetStandardTime": false, "ShowOnNotWorking": false, "ShowOnLoginPeriodTotal": true, "EmployeeSelect": false, "SpWhenCome": "", "SpWhenLeave": "", "SpWhenPost": "", "SpOnJournalLineStart": "", "SpOnJournalLineEnd": "", "MinTimeBeforeCalculateExtra": "1900-01-01T00:00:00", "SortOrder": 0, "ExportType": "Hours", "NoOfUnits": 1, "OvertimeCode": "", "ColorCode": "", "IgnorePaidBreak": false, "Vacation": false, "ShowOnAddAbsence": true, "OnlyCalculateManuelBreak": false, "IncludeInJobExtra": true, "ERPReference": null, "HtmlCardTitle": "AFSPADSERING", "HtmlCardContent": "Afholdt afspadsering", "MaxNoOfExtras": null, "ReleaseExtraDuringBreak": false, "LaborDirective11HoursRule": false, "LaborDirective48HoursRule": false, "HighlightWorktype": false, "PayrollExportType": "Absence", "SpWhenUpdateTimeSheet": "", "VisibleInTimeSheet": true, "CrossMidnight": false, "ForceRemark": false, "AskForQuantity": true } ]
Response Headers
content-encoding: gzip content-length: 175 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 08:39:57 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-powered-by: ASP.NET
400 (ERROR) : Error message
Response Body
Error message
POST: /worktypes
Parameters
| Name | Description | Type |
| API-key - required | Authorization
Token | String(64) |
| UID - required | UID
-how can
be obtained | String |
| DEVICEID - required | DEVICEID | String |
Request body
{ "sWorkTypeCode": "string","sDescription": "string", "sType": "string", "sPayrollReference":"string","bCountAsNormTime": true,"bAutoFill": true, "bFillBreak": true,"bFillExtra": true,"bFillPersonalExtra": true,"bCalculateBreak": true,"bCalculateExtra": true,"nFactor": 0,"sRoundingMethodCode":"string","bShowOnStartTooSoon": true,"bShowOnStartTooLate": true,"bShowOnStopTooSoon": true,"bShowOnStopTooLate": true,"bShowOnMetStandardTime":true,"bShowOnNotMetStandardTime":true,"bShowOnNotWorking": true,"bShowOnLoginPeriodTotal":true,"bEmployeeSelect": true,"sSpWhenCome": "string", "sSpWhenLeave": "string","sSpWhenPost": "string","sSpOnJournalLineStart":"string","sSpOnJournalLineEnd":"string","dtMinTimeBeforeCalculateExtra":"string","nSortOrder": 0,"sExportType": "string","nNoOfUnits": 0, "sOvertimeCode": "string","sColorCode": "string","bIgnorePaidBreak": true,"sDimensionCode1": "string", "sDimensionCode2": "string","sDimensionCode3": "string","sDimensionCode4": "string","sDimensionCode5": "string","sDimensionCode6": "string","sDimensionCode7": "string","sDimensionCode8": "string","sDimensionCode9": "string","sDimensionCode10":"string", "sPayrollExportType":"string","bForceRemark": true,"bShowOnAddAbsence": true,"bReleaseExtraDuringBreak":true,"sSpWhenUpdateKM": "string","bIncludeInJobExtra": true,"bAskForQuantity": true,"bVacation": true, "bOnlyCalculateManuelBreak":true, "sERPReference": "string","nMaxNoOfExtras": 0, "bLaborDirective11HoursRule" : false, "bLaborDirective48HoursRule" : false, "bHighlightWorktype": true,"sCopyFromWorkTypeCode":"string","sSpWhenUpdateTimeSheet":"string","bVisibleInTimeSheet": true,"bCrossMidnight": true }
Curl example
curl -X POST "https://smartapi.smarttid.dk/worktypes" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{ \"sWorkTypeCode\": \"string\", \"sDescription\": \"string\", \"sType\": \"string\", \"sPayrollReference\": \"string\", \"bCountAsNormTime\": true, \"bAutoFill\": true, \"bFillBreak\": true, \"bFillExtra\": true, \"bFillPersonalExtra\": true, \"bCalculateBreak\": true, \"bCalculateExtra\": true, \"nFactor\": 0, \"sRoundingMethodCode\": \"string\", \"bShowOnStartTooSoon\": true, \"bShowOnStartTooLate\": true, \"bShowOnStopTooSoon\": true, \"bShowOnStopTooLate\": true, \"bShowOnMetStandardTime\": true, \"bShowOnNotMetStandardTime\": true, \"bShowOnNotWorking\": true, \"bShowOnLoginPeriodTotal\": true, \"bEmployeeSelect\": true, \"sSpWhenCome\": \"string\", \"sSpWhenLeave\": \"string\", \"sSpWhenPost\": \"string\", \"sSpOnJournalLineStart\": \"string\", \"sSpOnJournalLineEnd\": \"string\", \"dtMinTimeBeforeCalculateExtra\": \"string\", \"nSortOrder\": 0, \"sExportType\": \"string\", \"nNoOfUnits\": 0, \"sOvertimeCode\": \"string\", \"sColorCode\": \"string\", \"bIgnorePaidBreak\": true, \"sDimensionCode1\": \"string\", \"sDimensionCode2\": \"string\", \"sDimensionCode3\": \"string\", \"sDimensionCode4\": \"string\", \"sDimensionCode5\": \"string\", \"sDimensionCode6\": \"string\", \"sDimensionCode7\": \"string\", \"sDimensionCode8\": \"string\", \"sDimensionCode9\": \"string\", \"sDimensionCode10\": \"string\", \"sPayrollExportType\": \"string\", \"bForceRemark\": true, \"bShowOnAddAbsence\": true, \"bReleaseExtraDuringBreak\": true, \"sSpWhenUpdateKM\": \"string\", \"bIncludeInJobExtra\": true, \"bAskForQuantity\": true, \"bVacation\": true, \"bOnlyCalculateManuelBreak\": true, \"sERPReference\": \"string\", \"nMaxNoOfExtras\": 0, \"bLaborDirective11HoursRule\": false,\"bLaborDirective48HoursRule\": false, \"bHighlightWorktype\": true, \"sCopyFromWorkTypeCode\": \"string\", \"sSpWhenUpdateTimeSheet\": \"string\", \"bVisibleInTimeSheet\": true, \"bCrossMidnight\": true}"
Response
200 (OK) : The ID of the new
worktype
Response Body
[ { "ID": 30 } ]
Response Headers
content-encoding: gzip content-length: 138 content-type: application/json; charset=utf-8 date: Mon, 24 Aug 2020 09:24:44 GMT server: Microsoft-IIS/10.0 vary: Accept-Encoding x-powered-by: ASP.NET
400 (ERROR) : Error message
Response Body
Error message
PUT{id}: /worktypes/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization
Token | String(64) |
| UID - required | UID
-how can
be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID of worktype | Integer |
Request
body
{ "sWorkTypeCode": "string","sDescription": "string", "sType": "string", "sPayrollReference":"string","bCountAsNormTime": true,"bAutoFill": true, "bFillBreak": true,"bFillExtra": true,"bFillPersonalExtra": true,"bCalculateBreak": true,"bCalculateExtra": true,"nFactor": 0,"sRoundingMethodCode":"string","bShowOnStartTooSoon": true,"bShowOnStartTooLate": true,"bShowOnStopTooSoon": true,"bShowOnStopTooLate": true,"bShowOnMetStandardTime":true,"bShowOnNotMetStandardTime":true,"bShowOnNotWorking": true,"bShowOnLoginPeriodTotal":true,"bEmployeeSelect": true,"sSpWhenCome": "string", "sSpWhenLeave": "string","sSpWhenPost": "string","sSpOnJournalLineStart":"string","sSpOnJournalLineEnd":"string","dtMinTimeBeforeCalculateExtra":"string","nSortOrder": 0,"sExportType": "string","nNoOfUnits": 0, "sOvertimeCode": "string","sColorCode": "string","bIgnorePaidBreak": true,"sDimensionCode1": "string", "sDimensionCode2": "string","sDimensionCode3": "string","sDimensionCode4": "string","sDimensionCode5": "string","sDimensionCode6": "string","sDimensionCode7": "string","sDimensionCode8": "string","sDimensionCode9": "string","sDimensionCode10":"string", "sPayrollExportType":"string","bForceRemark": true,"bShowOnAddAbsence": true,"bReleaseExtraDuringBreak":true,"sSpWhenUpdateKM": "string","bIncludeInJobExtra": true,"bAskForQuantity": true,"bVacation": true, "bOnlyCalculateManuelBreak":true, "sERPReference": "string","nMaxNoOfExtras": 0,"bLaborDirective11HoursRule" : false, "bLaborDirective48HoursRule" : false, "bHighlightWorktype": true,"sCopyFromWorkTypeCode":"string","sSpWhenUpdateTimeSheet":"string","bVisibleInTimeSheet": true,"bCrossMidnight": true }
Curl example
curl -X PUT "https://smartapi.smarttid.dk/worktypes/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "Content-Type: application/json-patch+json" -d "{ \"sWorkTypeCode\": \"string\", \"sDescription\": \"string\", \"sType\": \"string\", \"sPayrollReference\": \"string\", \"bCountAsNormTime\": true, \"bAutoFill\": true, \"bFillBreak\": true, \"bFillExtra\": true, \"bFillPersonalExtra\": true, \"bCalculateBreak\": true, \"bCalculateExtra\": true, \"nFactor\": 0, \"sRoundingMethodCode\": \"string\", \"bShowOnStartTooSoon\": true, \"bShowOnStartTooLate\": true, \"bShowOnStopTooSoon\": true, \"bShowOnStopTooLate\": true, \"bShowOnMetStandardTime\": true, \"bShowOnNotMetStandardTime\": true, \"bShowOnNotWorking\": true, \"bShowOnLoginPeriodTotal\": true, \"bEmployeeSelect\": true, \"sSpWhenCome\": \"string\", \"sSpWhenLeave\": \"string\", \"sSpWhenPost\": \"string\", \"sSpOnJournalLineStart\": \"string\", \"sSpOnJournalLineEnd\": \"string\", \"dtMinTimeBeforeCalculateExtra\": \"string\", \"nSortOrder\": 0, \"sExportType\": \"string\", \"nNoOfUnits\": 0, \"sOvertimeCode\": \"string\", \"sColorCode\": \"string\", \"bIgnorePaidBreak\": true, \"sDimensionCode1\": \"string\", \"sDimensionCode2\": \"string\", \"sDimensionCode3\": \"string\", \"sDimensionCode4\": \"string\", \"sDimensionCode5\": \"string\", \"sDimensionCode6\": \"string\", \"sDimensionCode7\": \"string\", \"sDimensionCode8\": \"string\", \"sDimensionCode9\": \"string\", \"sDimensionCode10\": \"string\", \"sPayrollExportType\": \"string\", \"bForceRemark\": true, \"bShowOnAddAbsence\": true, \"bReleaseExtraDuringBreak\": true, \"sSpWhenUpdateKM\": \"string\", \"bIncludeInJobExtra\": true, \"bAskForQuantity\": true, \"bVacation\": true, \"bOnlyCalculateManuelBreak\": true, \"sERPReference\": \"string\", \"nMaxNoOfExtras\": 0, \\"bLaborDirective11HoursRule\": false,\"bLaborDirective48HoursRule\": false, \"bHighlightWorktype\": true, \"sCopyFromWorkTypeCode\": \"string\", \"sSpWhenUpdateTimeSheet\": \"string\", \"bVisibleInTimeSheet\": true, \"bCrossMidnight\": true}"
Response
200 (OK) : success
400 (ERROR) : Error message
Response Body
Error message
DELETE{id}: /worktypes/{id}
Parameters
| Name | Description | Type |
| API-key - required | Authorization
Token | String(64) |
| UID - required | UID
-how can
be obtained | String |
| DEVICEID - required | DEVICEID | String |
| id- required | ID of worktype | Integer |
Curl example
curl -X DELETE "https://smartapi.smarttid.dk/worktypes/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
200 (OK) :Success
400 (ERROR) : Bad request
Response Body
Error message
Response headers
content-length: 84 content-type: text/plain; charset=utf-8 date: Tue, 25 Aug 2020 08:35:21 GMT server: Microsoft-IIS/10.0 x-powered-by: ASP.NET
SQL Procedure
sp_WorkType
Object
WorkType
| Name | Description | Type |
| sWorkTypeCode | Code of work type | String |
| sDescription | Description | String |
| sType | Type | string |
| sPayrollReference | Payroll Reference | string |
| bCountAsNormTime | Count As NormTime
Code | bool |
| bAutoFill | Auto Fill | bool |
| bFillBreak | Fill Break | bool |
| bFillExtra | Fill Extra | bool |
| bFillPersonalExtra | Fill Personal
Extra | bool |
| bCalculateBreak | Calculate
Break | bool |
| bCalculateExtra | Calculate
Extra | bool |
| nFactor | Factor | Number(Double) |
| sRoundingMethodCode | Rounding Method
Code | string |
| bShowOnStartTooSoon | Show On Start Too
Soon | bool |
| bShowOnStartTooLate | Show On Start Too
Late | bool |
| bShowOnStopTooSoon | Show On Stop Too
Soon | bool |
| bShowOnStopTooLate | Show On Stop Too
Late | bool |
| bShowOnMetStandardTime | Show On Met
StandardTime | bool |
| bShowOnNotMetStandardTime | Show On Not Met Standard
Time | bool |
| bShowOnNotWorking | Show On Not Working | bool |
| bShowOnLoginPeriodTotal | Show On Login Period
Total | bool |
| bEmployeeSelect | Employee Select | bool |
| sSpWhenCome | SpWhenCome | string |
| sSpWhenLeave | SpWhenLeave | string |
| sSpWhenStop | SpWhenStop | string |
| sSpOnJournalLineStart | SpOnJournalLineStart | string |
| sSpOnJournalLineEnd | SpOnJournalLineEnd | string |
| dtMinTimeBeforeCalculateExtra | MinTimeBeforeCalculateExtra | string |
| nSortOrder | SortOrder | number(integer) |
| sExportType | Export Type | string |
| nNoOfUnits | NoOfUnits | number()integer) |
| dtThuEndTime | Thu End Time | string |
| sThuWorkTypeCode | Thu Work Type Code | string |
| sOvertimeCode | OvertimeCode | string |
| sColorCode | Color Code | string |
| bIgnorePaidBreak | IgnorePaidBreak | bool |
| sDimensionCode1 | DimensionCode1 | string |
| sDimensionCode2 | DimensionCode2 | string |
| sDimensionCode3 | DimensionCode3 | string |
| sDimensionCode4 | DimensionCode4 | string |
| sDimensionCode5 | DimensionCode5 | string |
| sDimensionCode6 | DimensionCode6 | string |
| sDimensionCode7 | DimensionCode7 | string |
| sDimensionCode8 | DimensionCode8 | string |
| sDimensionCode9 | DimensionCode9 | string |
| sDimensionCode10 | DimensionCode10 | string |
| sPayrollExportType | PayrollExportType | string |
| bForceRemark | ForceRemark | bool |
| bShowOnAddAbsence | ShowOnAddAbsence | bool |
| bReleaseExtraDuringBreak | ReleaseExtraDuringBreak | bool |
| sSpWhenUpdateKM | SpWhenUpdateKM | string |
| bIncludeInJobExtra | IncludeInJobExtra | bool |
| bAskForQuantity | AskForQuantity | bool |
| bVacation | Vacation | bool |
| bOnlyCalculateManuelBreak | OnlyCalculateManuelBreak | bool |
| sERPReference | ERPReference | string |
| nMaxNoOfExtras | MaxNoOfExtras | number(integer) |
| bLaborDirective11HoursRule | LaborDirective11HoursRule | bool |
| bLaborDirective48HoursRule | LaborDirective48HoursRule | bool |
| bHighlightWorktype | HighlightWorktype | bool |
| sCopyFromWorkTypeCode | CopyFromWorkTypeCode | string |
| sSpWhenUpdateTimeSheet | SpWhenUpdateTimeSheet | string |
| bVisibleInTimeSheet | VisibleInTimeSheet | bool |
| bCrossMidnight | CrossMidnight | bool |