Sage 200 - Accounts
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. Accounts API exposes resources of Sage 200 related to accounting process such as customers, suppliers, ledger accounts, payment methods, journals, journal entries, analytics. Typical integrations use cases are financial reporting, expenses management, or invoice accounting.
Request URL
Request parameters
string
Receipt 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",
"invoice_id": "string",
"serial": "string",
"number": "string",
"order": 0.0,
"date": "string",
"due_date": "string",
"operation_date": "string",
"customer_id": "string",
"supplier_id": "string",
"status": "string",
"type_receipts": "1",
"commercial_paper": true,
"bank_ledger_account_id": "string",
"iban": "string",
"total": 0.0,
"description": "string",
"extended_properties": [
{
"name": "string",
"value": "string"
}
]
}{
"type": "object",
"description": "List of Receipt of the company",
"x-sage-menusection": "Payments",
"x-sage-relatedopeations": [
"companies",
"customers",
"ledger_accounts",
"suppliers",
"payment_methods",
"cost_centers",
"zones"
],
"required": [
"company_id"
],
"properties": {
"id": {
"type": "string",
"description": "Receipt ID",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"invoice_id": {
"type": "string",
"description": "Invoice ID",
"x-sage-entitylink": "journal_documents",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"serial": {
"type": "string",
"description": "Serial of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of accounts document",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"order": {
"type": "number",
"description": "Counter of receipts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"date": {
"type": "string",
"format": "date-time",
"description": "Date of receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Due date of the receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"operation_date": {
"type": "string",
"format": "date-time",
"description": "Operation date of the receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"customer_id": {
"type": "string",
"description": "Customer ID of the receipt",
"x-sage-entitylink": "customers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"supplier_id": {
"type": "string",
"description": "Supplier ID of the receipt",
"x-sage-entitylink": "suppliers",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"status": {
"type": "string",
"description": "Status of the receipt",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type_receipts": {
"type": "string",
"description": "Type of the receipt. See <a href=\"/docs#/spain/s200/accounts/v1/typereceipts\">typereceipts</a>",
"readOnly": false,
"x-sage-enumlink": "typereceipts",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"commercial_paper": {
"type": "boolean",
"description": "Generate commercial paper",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_ledger_account_id": {
"type": "string",
"description": "Ledger account of the bank",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"description": "IBAN of the receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"total": {
"type": "number",
"description": "Total of the receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"description": {
"type": "string",
"description": "Comments of the receipt",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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/accounts/v1/receipts/{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