Sage One - Accounts - v3 US
Documentation of the Sage Business Cloud Accounting API.
Returns all Business Settings
Endpoint Availability
- Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
- Accounting Standard: 🇬🇧, 🇮🇪
- Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
Access Control Restrictions
Requires the authenticated user to have any of the following roles in the area Settings: Full Access, Read Only
Request URL
Request parameters
(optional)
boolean
Display the legacy_id for the Business Settings.
Request headers
Request body
Response 200
Returns all Business Settings
{
"$path": "string",
"siret": "string",
"management_centre_member": true,
"rcs_number": "string",
"share_capital": 0.0,
"business_activity_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"legal_form_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"auxiliary_accounts_visible": true,
"default_ledger_accounts": {
"bank_charges_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_interest_received_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_interest_charges_paid_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"exchange_rate_gains_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"exchange_rate_losses_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"sales_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"sales_discount_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"purchase_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"purchase_discount_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"product_sales_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"product_purchase_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"service_sales_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"service_purchase_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"stock_purchase_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"other_receipt_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"other_payment_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"customer_receipt_discount_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"vendor_payment_discount_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"carriage_ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
}
},
"business_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"name": "string",
"description": "string"
},
"country_of_registration": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"business_created_at": "string",
"updated_at": "string"
}{
"type": "object",
"properties": {
"$path": {
"type": "string",
"description": "The path for the resource"
},
"siret": {
"type": "string",
"description": "SIRET Number (France only)"
},
"management_centre_member": {
"type": "boolean",
"description": "Member of Approved Management Centres (France only)"
},
"rcs_number": {
"type": "string",
"description": "RCS Number (France only)"
},
"share_capital": {
"type": "number",
"format": "double",
"description": "Share Capital (France only)"
},
"business_activity_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"maxLength": 15,
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Business Activity Type (France only)"
},
"legal_form_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"maxLength": 15,
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Legal Form Business Type (France only)",
"x-sage-menusection": "Settings"
},
"auxiliary_accounts_visible": {
"type": "boolean",
"description": "Auxiliary Accounts Visible (France & Spain only)"
},
"default_ledger_accounts": {
"type": "object",
"properties": {
"bank_charges_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for bank charges",
"x-sage-menusection": "Settings"
},
"bank_interest_received_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for bank interest received",
"x-sage-menusection": "Settings"
},
"bank_interest_charges_paid_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for bank interest charges paid",
"x-sage-menusection": "Settings"
},
"exchange_rate_gains_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for exchange rate gains",
"x-sage-menusection": "Settings"
},
"exchange_rate_losses_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for exchange rate losses",
"x-sage-menusection": "Settings"
},
"sales_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for sales",
"x-sage-menusection": "Settings"
},
"sales_discount_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for sales discounts",
"x-sage-menusection": "Settings"
},
"purchase_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for purchases",
"x-sage-menusection": "Settings"
},
"purchase_discount_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for purchase discounts",
"x-sage-menusection": "Settings"
},
"product_sales_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default sales ledger account for products",
"x-sage-menusection": "Settings"
},
"product_purchase_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default purchase ledger account for products",
"x-sage-menusection": "Settings"
},
"service_sales_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default sales ledger account for services",
"x-sage-menusection": "Settings"
},
"service_purchase_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default purchase ledger account for services",
"x-sage-menusection": "Settings"
},
"stock_purchase_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default purchase ledger account for stock",
"x-sage-menusection": "Settings"
},
"other_receipt_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for other receipts",
"x-sage-menusection": "Settings"
},
"other_payment_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for other payments",
"x-sage-menusection": "Settings"
},
"customer_receipt_discount_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for customer receipt discounts",
"x-sage-menusection": "Settings"
},
"vendor_payment_discount_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for vendor payment discounts",
"x-sage-menusection": "Settings"
},
"carriage_ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default ledger account for carriage",
"x-sage-menusection": "Settings"
}
},
"description": "The default ledger accounts for the business"
},
"business_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"name": {
"type": "string",
"description": "The name of the business type"
},
"description": {
"type": "string",
"description": "The description of the business type"
}
},
"description": "The type of the business"
},
"country_of_registration": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "One of the political entities identified by [\"ENGLAND_AND_WALES\", \"WALES\", \"SCOTLAND\", \"NORTHERN_IRELAND\", \"REPUBLIC_OF_IRELAND\"]. Only for businesses registered on the British Isles",
"x-sage-menusection": "Settings"
},
"business_created_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp on which the business was created. This can be the timestamp of the initial creation or the latest business reset."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
}
},
"description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Settings`: Full Access",
"x-sage-menusection": "Settings"
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/us/sageone/accounts/v3/business_settings?show_legacy_id={boolean}"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["show_legacy_id"] = "{boolean}";
var uri = "https://api.columbus.sage.com/us/sageone/accounts/v3/business_settings?" + 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/us/sageone/accounts/v3/business_settings");
builder.setParameter("show_legacy_id", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
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
"show_legacy_id": "{boolean}",
};
$.ajax({
url: "https://api.columbus.sage.com/us/sageone/accounts/v3/business_settings?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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/us/sageone/accounts/v3/business_settings";
NSArray* array = @[
// Request parameters
@"entities=true",
@"show_legacy_id={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_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/us/sageone/accounts/v3/business_settings');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'show_legacy_id' => '{boolean}',
);
$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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'show_legacy_id': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/us/sageone/accounts/v3/business_settings?%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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'show_legacy_id': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/us/sageone/accounts/v3/business_settings?%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/us/sageone/accounts/v3/business_settings')
query = URI.encode_www_form({
# Request parameters
'show_legacy_id' => '{boolean}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# 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