Sage One - Accounts - v3 DE

Documentation of the Sage Business Cloud Accounting API.

Returns a Ledger Account

Endpoint Availability

  • Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
  • Accounting Standard: 🇬🇧, 🇮🇪
  • Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Access Control Restrictions

Requires the authenticated user to have any mentioned role in one of the listed areas:

  • Area: Sales: Full Access, Restricted Access, Read Only
  • Area: Purchases: Full Access, Restricted Access, Read Only
  • Area: Products & Services: Full Access, Restricted Access, Read Only
  • Area: Contacts: Full Access, Restricted Access, Read Only
  • Area: Bank: Full Access, Restricted Access, Read Only
  • Area: Journals: Full Access, Restricted Access, Read Only
  • Area: Settings: Full Access, Read Only

Try it

Request URL

Request parameters

string

The Ledger Account Key.

(optional)
string

Specify the attributes that you want to expose for nested entities of the Ledger Account (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)

(optional)
boolean

Use this to display the balance details for ledger accounts between a date range (requires from_date and to_date).

(optional)
boolean

Exclude deleted ledger entries.

(optional)
string

Format - date-time (as date-time in RFC3339). Calculate balances from this date.

(optional)
string

Format - date-time (as date-time in RFC3339). Calculate balances to this date.

(optional)
boolean

Display the legacy_id for the Ledger Account.

(optional)
string

Specify the attributes that you want to expose for the Ledger Account (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

Request headers

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

Returns a Ledger Account

Code samples

@ECHO OFF

curl -v -X GET "https://api.columbus.sage.com/de/sageone/accounts/v3/ledger_accounts/{key}?nested_attributes={string}&show_balance_details={boolean}&exclude_deleted_entries={boolean}&from_date={string}&to_date={string}&show_legacy_id={boolean}&attributes={string}"
-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["nested_attributes"] = "{string}";
            queryString["show_balance_details"] = "{boolean}";
            queryString["exclude_deleted_entries"] = "{boolean}";
            queryString["from_date"] = "{string}";
            queryString["to_date"] = "{string}";
            queryString["show_legacy_id"] = "{boolean}";
            queryString["attributes"] = "{string}";
            var uri = "https://api.columbus.sage.com/de/sageone/accounts/v3/ledger_accounts/{key}?" + 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/de/sageone/accounts/v3/ledger_accounts/{key}");

            builder.setParameter("nested_attributes", "{string}");
            builder.setParameter("show_balance_details", "{boolean}");
            builder.setParameter("exclude_deleted_entries", "{boolean}");
            builder.setParameter("from_date", "{string}");
            builder.setParameter("to_date", "{string}");
            builder.setParameter("show_legacy_id", "{boolean}");
            builder.setParameter("attributes", "{string}");

            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
            "nested_attributes": "{string}",
            "show_balance_details": "{boolean}",
            "exclude_deleted_entries": "{boolean}",
            "from_date": "{string}",
            "to_date": "{string}",
            "show_legacy_id": "{boolean}",
            "attributes": "{string}",
        };
      
        $.ajax({
            url: "https://api.columbus.sage.com/de/sageone/accounts/v3/ledger_accounts/{key}?" + $.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/de/sageone/accounts/v3/ledger_accounts/{key}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"nested_attributes={string}",
                         @"show_balance_details={boolean}",
                         @"exclude_deleted_entries={boolean}",
                         @"from_date={string}",
                         @"to_date={string}",
                         @"show_legacy_id={boolean}",
                         @"attributes={string}",
                      ];
    
    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/de/sageone/accounts/v3/ledger_accounts/{key}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'nested_attributes' => '{string}',
    'show_balance_details' => '{boolean}',
    'exclude_deleted_entries' => '{boolean}',
    'from_date' => '{string}',
    'to_date' => '{string}',
    'show_legacy_id' => '{boolean}',
    'attributes' => '{string}',
);

$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
    'nested_attributes': '{string}',
    'show_balance_details': '{boolean}',
    'exclude_deleted_entries': '{boolean}',
    'from_date': '{string}',
    'to_date': '{string}',
    'show_legacy_id': '{boolean}',
    'attributes': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/de/sageone/accounts/v3/ledger_accounts/{key}?%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
    'nested_attributes': '{string}',
    'show_balance_details': '{boolean}',
    'exclude_deleted_entries': '{boolean}',
    'from_date': '{string}',
    'to_date': '{string}',
    'show_legacy_id': '{boolean}',
    'attributes': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/de/sageone/accounts/v3/ledger_accounts/{key}?%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/de/sageone/accounts/v3/ledger_accounts/{key}')

query = URI.encode_www_form({
    # Request parameters
    'nested_attributes' => '{string}',
    'show_balance_details' => '{boolean}',
    'exclude_deleted_entries' => '{boolean}',
    'from_date' => '{string}',
    'to_date' => '{string}',
    'show_legacy_id' => '{boolean}',
    'attributes' => '{string}'
})

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