Info

Created 02-02-2021 by Lavinia Gheghea

Revision



Description

The API allows you to create  payroll setup. You can retrieve a list of all payroll setups.

Endpoints


GET:  /payrollsetups


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/payrollsetups" -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
[ 
{
"UseEmployeeCode2": true,
    "DatalonAPIKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "ProloenCompanyID": xxxxx,
    "GratisalUserName": "xx@smarttid.dk",
    "GratisalPassword": "xxxxxxx",
    "DanlonAPIKey": "xxxxxxxxxxxxxxxxxxx"
}
]
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



POST: /payrollsetups


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
{
 "bUseEmployeeCode2": true,
  "sDatalonAPIKey": "string",
  "nProloenCompanyID": 0,
  "sGratisalUserName": "string",
  "sGratisalPassword": "string",
  "sDanlonAPIKey": "string"
}

Curl example
curl -X POST "https://smartapi.smarttid.dk/payrollsetups" -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 {\"bUseEmployeeCode2\": true,  \"sDatalonAPIKey\": \"string\",  \"nProloenCompanyID\": 0,  \"sGratisalUserName\": \"string\",  \"sGratisalPassword\": \"string\",  \"sDanlonAPIKey\": \"string\"}"

Response

200 (OK) : success

400 (ERROR) : Error message

Response Body
Error message

Object

 Name
 Description
 Type
bUseEmployeeCode2 Use Employee Code 2
 Bool
sDatalonAPIKey
 Datalon API Key
 String
 nProloenCompanyID
 Proloen Company ID
Number(integer)
 sGratisalUserName
Gratisal User NameString
 sGratisalPassword
 Gratisal Password
String
 sDanlonAPIKey Danlon API Key String