Murano - Payrolls
Request URL
Request parameters
string
PaymentIncident 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.
string
Media type of the body sent to the API.
(optional)
string
Media type of the body sent to the API.
Request body
This resource contains the daily incidents (km, extra hours,…). According to the status of the incident it can also be updated or deleted. Payment incidents.
{
"id": "string",
"company_id": "string",
"employee_id": "string",
"payment_incident_type_id": "string",
"payroll_code": "string",
"transfer_date": "string",
"cost": 0.0,
"quantity": 0.0,
"total_amount": 0.0,
"note": "string"
}
{
"type": "object",
"description": "This resource contains the daily incidents (km, extra hours,…). According to the status of the incident it can also be updated or deleted. Payment incidents.",
"x-sage-menusection": "Payments",
"x-sage-relatedopeations": [
"companies",
"employees",
"work_quotation_centers",
"persons",
"payment_incident_types"
],
"required": [
"company_id",
"employee_id",
"payment_incident_type_id",
"transfer_date",
"total_amount"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Payment Incidents",
"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
},
"employee_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Employee",
"x-sage-entitylink": "employees",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"payment_incident_type_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for the Incident type. See payment_incident_types resource.",
"x-sage-entitylink": "payment_incident_types",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"payroll_code": {
"type": "string",
"maxLength": 15,
"description": "Concept code in paysheet",
"readOnly": false
},
"transfer_date": {
"type": "string",
"format": "date-time",
"description": "Date of the incident",
"readOnly": false
},
"cost": {
"type": "number",
"format": "integer 10",
"description": "Incident cost",
"readOnly": false
},
"quantity": {
"type": "number",
"format": "integer 10",
"description": "Quantity",
"readOnly": false
},
"total_amount": {
"type": "number",
"format": "integer 10",
"description": "Amount of the incident",
"readOnly": false
},
"note": {
"type": "string",
"description": "Extra information about the incident",
"readOnly": false
}
}
}
Response 200
OK.
{
"id": "string",
"company_id": "string",
"employee_id": "string",
"payment_incident_type_id": "string",
"payroll_code": "string",
"transfer_date": "string",
"cost": 0.0,
"quantity": 0.0,
"total_amount": 0.0,
"note": "string"
}
{
"type": "object",
"description": "This resource contains the daily incidents (km, extra hours,…). According to the status of the incident it can also be updated or deleted. Payment incidents.",
"x-sage-menusection": "Payments",
"x-sage-relatedopeations": [
"companies",
"employees",
"work_quotation_centers",
"persons",
"payment_incident_types"
],
"required": [
"company_id",
"employee_id",
"payment_incident_type_id",
"transfer_date",
"total_amount"
],
"properties": {
"id": {
"type": "string",
"maxLength": 128,
"description": "Unique Identifier for Payment Incidents",
"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
},
"employee_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for Employee",
"x-sage-entitylink": "employees",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"payment_incident_type_id": {
"type": "string",
"maxLength": 128,
"description": "Unique identifier for the Incident type. See payment_incident_types resource.",
"x-sage-entitylink": "payment_incident_types",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"payroll_code": {
"type": "string",
"maxLength": 15,
"description": "Concept code in paysheet",
"readOnly": false
},
"transfer_date": {
"type": "string",
"format": "date-time",
"description": "Date of the incident",
"readOnly": false
},
"cost": {
"type": "number",
"format": "integer 10",
"description": "Incident cost",
"readOnly": false
},
"quantity": {
"type": "number",
"format": "integer 10",
"description": "Quantity",
"readOnly": false
},
"total_amount": {
"type": "number",
"format": "integer 10",
"description": "Amount of the incident",
"readOnly": false
},
"note": {
"type": "string",
"description": "Extra information about the incident",
"readOnly": false
}
}
}
Code samples
@ECHO OFF
curl -v -X PUT "https://api.columbus.sage.com/es/murano/payrolls/v1/payment_incidents/{id}"
-H "X-Site: "
-H "X-Company: "
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: "
-H "Content-Type: "
-H "Content-Type: application/json"
-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/payment_incidents/{id}?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
}
// // 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/payment_incidents/{id}");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("X-Site", "");
request.setHeader("X-Company", "");
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "");
request.setHeader("Content-Type", "");
request.setHeader("Content-Type", "application/json");
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/payment_incidents/{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("Content-Type","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// 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/payment_incidents/{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:@"PUT"];
// 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:@"" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/payment_incidents/{id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Site' => '',
'X-Company' => '',
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '',
'Content-Type' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// 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': '',
'Content-Type': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("PUT", "/es/murano/payrolls/v1/payment_incidents/{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': '',
'Content-Type': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("PUT", "/es/murano/payrolls/v1/payment_incidents/{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/payment_incidents/{id}')
request = Net::HTTP::Put.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['Content-Type'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# 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