Murano - Payrolls
Request URL
Request parameters
string
Person 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",
"first_name": "string",
"surname_one": "string",
"surname_two": "string",
"tax_reference_type": "NIF",
"tax_country": "string",
"tax_reference": "string",
"social_security_region": "string",
"social_security_number": "string",
"extended_social_security_number": "string",
"addresses": [
{
"id": "string",
"address_type": "PAR",
"street_type": "AD",
"street_name": "string",
"number_one": "string",
"number_two": "string",
"stairs": "string",
"floor": "string",
"door": "string",
"letter": "string",
"complete_address": "string",
"postcode": "string",
"locality_id": "string"
}
],
"gender": "M",
"civil_state": "SL",
"nationality": "string",
"birth_date": "string",
"educational_level": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"representative_tax_number": "string",
"representative_name": "string",
"representative_description": "string",
"accreditations": [
{
"id": "string",
"application_id": "string",
"description": "string",
"start_date": "string",
"end_date": "string"
}
]
}
{
"type": "object",
"description": "General data for an employee.. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "General",
"x-sage-relatedopeations": [
"companies"
],
"required": [
"company_id",
"first_name",
"surname_one",
"surname_two",
"tax_reference",
"extended_social_security_number",
"addresses",
"gender",
"civil_state",
"birth_date"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Persons",
"readOnly": false
},
"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
},
"first_name": {
"type": "string",
"maxLength": 10,
"description": "First name of the person",
"readOnly": false
},
"surname_one": {
"type": "string",
"maxLength": 15,
"description": "First surname (family name)",
"readOnly": false
},
"surname_two": {
"type": "string",
"maxLength": 15,
"description": "Second surname",
"readOnly": false
},
"tax_reference_type": {
"type": "string",
"description": "NIF/NIE/Passport…\r\nIts value refers to the “Code” column of Master Table “Tax Reference Types”.. See <a href=\"/docs#/spain/murano/payrolls/v1/taxreference\">taxreference</a>",
"readOnly": false,
"x-sage-enumlink": "taxreference",
"enum": [
"NIF",
"NFV",
"PAS",
"DOF",
"RES",
"OTR"
]
},
"tax_country": {
"type": "string",
"maxLength": 2,
"description": "Country acronym for the taxReference. See ISO 3166-2 Country Codes",
"readOnly": false
},
"tax_reference": {
"type": "string",
"maxLength": 14,
"description": "NIF/NIE/Passport… Number",
"readOnly": false
},
"social_security_region": {
"type": "string",
"maxLength": 2,
"description": "Code of the employee's social security card",
"readOnly": false
},
"social_security_number": {
"type": "string",
"maxLength": 9,
"description": "Social security card number",
"readOnly": false
},
"extended_social_security_number": {
"type": "string",
"maxLength": 12,
"description": "socialSecurityRegion+socialSecurityNumber",
"readOnly": false
},
"addresses": {
"type": "array",
"description": "Person addresses",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Address",
"readOnly": false
},
"address_type": {
"type": "string",
"description": "Address classification. Its value refers to the “Code” column of Master Table “Address Types”. See <a href=\"/docs#/spain/murano/payrolls/v1/addresstypecode\">addresstypecode</a>",
"readOnly": false,
"x-sage-enumlink": "addresstypecode",
"enum": [
"PAR",
"SOC",
"FIS",
"ENV"
]
},
"street_type": {
"type": "string",
"description": "Street classification. Its value refers to the “Code” column of Master Table 'Street types'. See <a href=\"/docs#/spain/murano/payrolls/v1/streettypecode\">streettypecode</a>",
"readOnly": false,
"x-sage-enumlink": "streettypecode",
"enum": [
"AD",
"AL",
"AP",
"AV",
"BL",
"BO",
"CH",
"CL",
"CM",
"CO",
"CR",
"CS",
"CT",
"ED",
"GL",
"GR",
"LG",
"MC",
"MN",
"MZ",
"PB",
"PG",
"PJ",
"PQ",
"PR",
"PS",
"PZ",
"RB",
"RD",
"TR",
"UR"
]
},
"street_name": {
"type": "string",
"maxLength": 40,
"description": "Street main name",
"readOnly": false
},
"number_one": {
"type": "string",
"maxLength": 4,
"description": "First number of the address",
"readOnly": false
},
"number_two": {
"type": "string",
"maxLength": 4,
"description": "Second number of the address",
"readOnly": false
},
"stairs": {
"type": "string",
"maxLength": 2,
"description": "Stairs of the address",
"readOnly": false
},
"floor": {
"type": "string",
"maxLength": 2,
"description": "Floor of the address",
"readOnly": false
},
"door": {
"type": "string",
"maxLength": 2,
"description": "Door of the address",
"readOnly": false
},
"letter": {
"type": "string",
"maxLength": 2,
"description": "Letter of the address",
"readOnly": false
},
"complete_address": {
"type": "string",
"description": "Complete address description. If not informed it will be calculated joining the previous fields.",
"readOnly": false
},
"postcode": {
"type": "string",
"maxLength": 8,
"description": "Postcode",
"readOnly": false
},
"locality_id": {
"type": "string",
"maxLength": 128,
"description": "LocalityId",
"x-sage-entitylink": "localities",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"gender": {
"type": "string",
"description": "The employee`s gender. Its value refers to the “Code” column of Master Table “Gender Codes”. See <a href=\"/docs#/spain/murano/payrolls/v1/gender\">gender</a>",
"readOnly": false,
"x-sage-enumlink": "gender",
"enum": [
"M",
"F"
]
},
"civil_state": {
"type": "string",
"description": "Marital status of the employee: single, married, widow, widower…\r\nIts value refers to the “Code” column of Master Table “Civil State Codes”. See <a href=\"/docs#/spain/murano/payrolls/v1/civilstate\">civilstate</a>",
"readOnly": false,
"x-sage-enumlink": "civilstate",
"enum": [
"SL",
"CS",
"VD",
"DV",
"SP",
"RG",
"PH"
]
},
"nationality": {
"type": "string",
"maxLength": 2,
"description": "Country of origin",
"readOnly": false
},
"birth_date": {
"type": "string",
"format": "date-time",
"description": "Birthday date",
"readOnly": false
},
"educational_level": {
"type": "string",
"maxLength": 50,
"description": "Educational level description",
"readOnly": false
},
"email": {
"type": "string",
"maxLength": 250,
"description": "Email address",
"readOnly": false
},
"telephone": {
"type": "string",
"maxLength": 15,
"description": "Phone number",
"readOnly": false
},
"mobile": {
"type": "string",
"maxLength": 15,
"description": "Mobile number",
"readOnly": false
},
"representative_tax_number": {
"type": "string",
"maxLength": 9,
"description": "Tax number of the legal representative if exists",
"readOnly": false
},
"representative_name": {
"type": "string",
"maxLength": 50,
"description": "Name of the legal representative if exists",
"readOnly": false
},
"representative_description": {
"type": "string",
"maxLength": 250,
"description": "Description of the legal representative type",
"readOnly": false
},
"accreditations": {
"type": "array",
"description": "List of the accreditations of the employee (residence permission, drive licenses, …).",
"readOnly": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for accreditations",
"readOnly": false
},
"application_id": {
"type": "string",
"maxLength": 128,
"description": "Application Code for accreditations",
"readOnly": false
},
"description": {
"type": "string",
"maxLength": 50,
"description": "Description of the accreditation",
"readOnly": false
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Initial date for accreditation",
"readOnly": false
},
"end_date": {
"type": "string",
"format": "date-time",
"description": "Date from which accreditation is not valid",
"readOnly": false
}
}
}
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/es/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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/murano/payrolls/v1/persons/{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