Sage 200 - Payrolls
A powerful API providing easy, secure, scalable integration into the core Sage 200 product which enables third-party developers to rapidly create apps and rich extensions. Payroll API exposes resources of Sage 200 related to payroll process such as persons, employees, contracts, absences, payments, payslips, collective agreements and categories. Typical integrations use cases are employee portals, expenses management, human resources apps.
Request URL
Request parameters
string
Employee unique identifier
Request headers
string
Tenant unique identifier.
string
Company unique identifier.
string
Sage ID Access Token prefixed with the word 'Bearer'.
string
Subscription key which provides access to this API.
Request body
Response 200
OK.
{
"id": "string",
"company_id": "string",
"work_quotation_center_id": "string",
"person_id": "string",
"application_id": "string",
"start_date": "string",
"end_date": "string",
"payroll_payments": [
{
"id": "string",
"application_id": "string",
"percentage": 0.0,
"amount": 0.0,
"company_bank_account": {
"id": "string",
"application_id": "string",
"bank_id": "string",
"iban": "string"
},
"employee_bank_account": {
"id": "string",
"application_id": "string",
"bank_id": "string",
"iban": "string"
},
"payment_type": "TRA"
}
],
"seniority": "string",
"withholding": 0.0
}{
"type": "object",
"description": "List the employees of a company. . <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Employees",
"x-sage-relatedopeations": [
"companies",
"work_quotation_centers",
"persons"
],
"required": [
"company_id",
"work_quotation_center_id",
"person_id",
"application_id",
"start_date"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Payroll Employee",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Company",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"work_quotation_center_id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Work quotation centers.",
"x-sage-entitylink": "work_quotation_centers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"person_id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Payroll Person.",
"x-sage-entitylink": "persons",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"application_id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Sage application",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Date employee started working in the Company",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Date employee finished working in the Company",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payroll_payments": {
"type": "array",
"description": "Information about the employee payments linked to his/her activity",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Payroll payment",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"maxLength": 128,
"description": "Payroll payment code in desktop application",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"percentage": {
"type": "number",
"format": "integer 28 decimal 10 dp",
"description": "Percentage to be paid in this account. Default 100",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"amount": {
"type": "number",
"format": "integer 28 decimal 10 dp",
"description": "Amount to be paid in this account, only if any percentage is informed",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"company_bank_account": {
"type": "object",
"description": "Payment Bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Bank Account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"maxLength": 128,
"description": "Bank account code in desktop application",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for the Bank associated to the account",
"x-sage-entitylink": "banks",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "IBAN of the account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"employee_bank_account": {
"type": "object",
"description": "Bank account where employee will receive his/her payments",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Bank Account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"maxLength": 128,
"description": "Bank account code in desktop application",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for the Bank associated to the account",
"x-sage-entitylink": "banks",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "IBAN of the account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
},
"payment_type": {
"type": "string",
"description": "Type of payment for the incident. Its value refers to the “Code” column of Master Table “Payment Types”.. See <a href=\"/docs#/spain/s200/payrolls/v1/paymenttype\">paymenttype</a>",
"readOnly": false,
"x-sage-enumlink": "paymenttype",
"enum": [
"TRA",
"CHQ",
"EFE"
],
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"seniority": {
"type": "string",
"format": "date-time",
"description": "That value can be different from the startDate.",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"withholding": {
"type": "number",
"format": "integer 28 decimal 10 dp",
"description": "Withholding percentage applied to the employee",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}"
-H "X-Site: "
-H "X-Company: "
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("X-Site", "");
client.DefaultRequestHeaders.Add("X-Company", "");
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("X-Site", "");
request.setHeader("X-Company", "");
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Site","");
xhrObj.setRequestHeader("X-Company","");
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Site"];
[_request setValue:@"" forHTTPHeaderField:@"X-Company"];
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Site' => '',
'X-Company' => '',
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/s200/payrolls/v1/employees/{id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/s200/payrolls/v1/employees/{id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.columbus.sage.com/es/s200/payrolls/v1/employees/{id}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-Site'] = ''
# Request headers
request['X-Company'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body