Info

Created 01-02-2021 by Lavinia Gheghea

Revision



Description

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

Endpoints


GET:  /payrollperiodlines


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
 sPayrolPeriodCode - required
 Payroll Period Code
 String

Curl example

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

Response

200 (OK) :  array of  payroll period lines

Response body
[
{
    "ID": 1467,
    "PayrollPeriodCode": "14D_LIGE",
    "PeriodName": "2020-26-27",
    "StartDate": "2020-06-22T00:00:00",
    "EndDate": "2020-07-05T00:00:00",
    "Locked": false,
    "Transfered": false
  },
  {
    "ID": 1465,
    "PayrollPeriodCode": "14D_LIGE",
    "PeriodName": "2020-20-21",
    "StartDate": "2020-05-11T00:00:00",
    "EndDate": "2020-05-24T00:00:00",
    "Locked": false,
    "Transfered": false
  },
  {
    "ID": 1462,
    "PayrollPeriodCode": "14D_LIGE",
    "PeriodName": "2020-11-12",
    "StartDate": "2020-03-09T00:00:00",
    "EndDate": "2020-03-22T00:00:00",
    "Locked": false,
    "Transfered": false
  },
]

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} : /payrollperiodlines/{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 line
 Integer
Curl example

curl -X GET "https://smartapi.smarttid.dk/payrollperiodlines/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 line

Response Body
[
    {
    "ID": 1462,
    "PayrollPeriodCode": "14D_LIGE",
    "PeriodName": "2020-11-12",
    "StartDate": "2020-03-09T00:00:00",
    "EndDate": "2020-03-22T00:00:00",
    "Locked": false,
    "Transfered": false
  }
]


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: /payrollperiodlines?sPayrollPeriodCode=XXXX


Parameters
 Name
 Description
 Type
 API-key - required
  Authorization Token  
 String(64)
 UID - required
 UID -how can be obtained
 String
 DEVICEID - required
  DEVICEID
 String
 sPayrollPeriodCode -required
 Payroll Period Code
 String

Request body
{
"sPeriodName": "string",
  "dtStartDate": "string",
  "dtEndDate": "string",
  "bLocked": true,
  "bTransfered": true
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/payrollperiodlines?sPayrollPeriodCode=XXXX" -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 { \"sPeriodName\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\",  \"bLocked\": true,  \"bTransfered\": true}"

Response

200 (OK) : The ID of the newpayroll period line

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}: /payrollperiodlines/{id}?sPayrollPeriodCode=XXXX


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 line
 Integer
 sPayrollPeriodCode - required
 Payroll Period Code
 String

Request body

{ 
"sPeriodName": "string",
 "dtStartDate": "string",
 "dtEndDate": "string",
 "bLocked": true,
 "bTransfered": true
}


Curl example

curl -X PUT "https://smartapi.smarttid.dk/payrollperiodlines/id?sPayrollPeriodCode=XXXX" -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 {\"sPeriodName\": \"string\",  \"dtStartDate\": \"string\",  \"dtEndDate\": \"string\",  \"bLocked\": true,  \"bTransfered\": true}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message


DELETE{id}: /payrollperiodlines/{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 line
 Integer

Curl example

curl -X DELETE "https://smartapi.smarttid.dk/payrollperiodlines/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
sPeriodName
Period Name 
String
 dtStartDate
Start Date 
 String
dtEndDate
End Date
String
bLocked
Locked
Bool
 bTransfered
 Transfered
 Bool