Info

Created 01-02-2021 by Lavinia Gheghea

Revision



Description

The API allows you to create, delete, and update  payroll period. You can retrieve individual payroll period as well as a list of all payroll periods.

Endpoints


GET:  /payrollperiods


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
Curl example

curl -X GET "https://smartapi.smarttid.dk/payrollperiods" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) :  array of payroll periods

Response body
[ 
{
    "ID": 17,
    "PayrollPeriodCode": "14D_LIGE",
    "Description": "14 dage. Udbetaling lige uger",
    "IdentityNumber": "",
    "PayrollFormatCode": "DATALØN",
    "TransferDate": "FirstStartDate"
  },
  {
    "ID": 18,
    "PayrollPeriodCode": "14D_ULIGE",
    "Description": "14 dage. Udbetaling ulige uger",
    "IdentityNumber": null,
    "PayrollFormatCode": null,
    "TransferDate": "FirstStartDate"
  },
  {
    "ID": 19,
    "PayrollPeriodCode": "MDR",
    "Description": "Måned",
    "IdentityNumber": "3344",
    "PayrollFormatCode": "GRATISAL",
    "TransferDate": "FirstStartDate"
  },
]


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} : /payrollperiods/{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 payroll period
 Integer
Curl example

curl -X GET "https://smartapi.smarttid.dk/payrollperiods/id" -H "accept: */*" -H "UID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -H "DEVICEID:demo@smarttid.dk" -H "API-Key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 (OK) : the payroll period

Response Body
[ 
 {
    "ID": 19,
 "PayrollPeriodCode": "MDR",
 "Description": "Måned",
 "IdentityNumber": "3344",
 "PayrollFormatCode": "GRATISAL",
 "TransferDate": "FirstStartDate"
  }
]

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: /payrollperiods


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
{
"sPayrollPeriodCode": "string",
  "sDescription": "string",
  "sIdentityNumber": "string",
  "sPayrollFormatCode": "string",
  "sTransferDate": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/payrollperiods" -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 {\"sPayrollPeriodCode\": \"string\",  \"sDescription\": \"string\",  \"sIdentityNumber\": \"string\",  \"sPayrollFormatCode\": \"string\",  \"sTransferDate\": \"string\"}"

Response

200 (OK) : The ID of the new payroll period

Response Body
[
 {
  "ID": 3
 }
]
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}: /payrollperiods/{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 payroll period
 Integer

Request body

{ 
"sPayrollPeriodCode": "string",
 "sDescription": "string",
 "sIdentityNumber": "string",
 "sPayrollFormatCode": "string",
 "sTransferDate": "string"
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/payrollperiods/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 {\"sPayrollPeriodCode\": \"string\",  \"sDescription\": \"string\",  \"sIdentityNumber\": \"string\",  \"sPayrollFormatCode\": \"string\",  \"sTransferDate\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /payrollperiods/{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 payroll period
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/payrollperiods/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


Object

 Name
 Description
 Type
sPayrollPeriodCode
 Code of payroll period
 String
sDescription
 Description
 String
 sIdentityNumber
 Identity Number
 String
 sPayrollFormatCode
Payroll Format Code
String
 sTransferDate
 Transfer Date
 String