Sage One - Accounts - v3 CA

Documentation of the Sage Business Cloud Accounting API.

Returns all Coa Accounts

Endpoint Availability

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

Try it

Request URL

Request parameters

(optional)
string

Use this to filter by COA Template

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to limit the response to Coa Accounts changed since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Inclusive of the passed timestamp.

(optional)
boolean

Display the legacy_id for the Coa Accounts.

(optional)
integer

Format - int32. Returns the given number of Coa Accounts per request.

(optional)
integer

Format - int32. Go to specific page of Coa Accounts

(optional)
string

Specify the attributes that you want to expose for the Coa Accounts (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 all Coa Accounts

[
  {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string",
    "created_at": "string",
    "updated_at": "string",
    "ledger_account_group": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string"
    },
    "name": "string",
    "control_name": "string",
    "nominal_code": 0,
    "ledger_account_type": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    },
    "ledger_account_classification": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    },
    "tax_rate": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    },
    "fixed_tax_rate": true,
    "cis_materials": true,
    "cis_labour": true
  }
]
{
  "type": "array",
  "items": {
    "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"
      },
      "created_at": {
        "type": "string",
        "format": "date-time",
        "description": "The datetime when the item was created"
      },
      "updated_at": {
        "type": "string",
        "format": "date-time",
        "description": "The datetime when the item was last updated"
      },
      "ledger_account_group": {
        "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"
          }
        },
        "description": "The ledger account group for the account"
      },
      "name": {
        "type": "string",
        "maxLength": 200,
        "description": "The name for the COA account"
      },
      "control_name": {
        "type": "string",
        "maxLength": 50,
        "description": "The system control name for the COA account.\n\nSystem control names are used in Accounting to identify the correct ledger account for booking taxes\netc.\n"
      },
      "nominal_code": {
        "type": "integer",
        "format": "int32",
        "description": "The nominal code of the COA account"
      },
      "ledger_account_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"
          }
        },
        "description": "The ledger account type for the COA account",
        "x-sage-menusection": "Settings"
      },
      "ledger_account_classification": {
        "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 ledger account classification for the COA account",
        "x-sage-menusection": "Settings"
      },
      "tax_rate": {
        "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 tax rate for the COA account",
        "x-sage-menusection": "Settings"
      },
      "fixed_tax_rate": {
        "type": "boolean",
        "description": "Indicates whether the default tax rate is fixed or may be changed per transaction"
      },
      "cis_materials": {
        "type": "boolean",
        "description": "Indicates whether the COA account is flagged for CIS Materials"
      },
      "cis_labour": {
        "type": "boolean",
        "description": "Indicates whether the COA account is flagged for CIS Labour"
      }
    },
    "description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸",
    "x-sage-menusection": "Financial Accounts & Entries"
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.columbus.sage.com/ca/sageone/accounts/v3/coa_accounts?coa_template_id={string}&updated_or_created_since={string}&show_legacy_id={boolean}&items_per_page=20&page=1&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["coa_template_id"] = "{string}";
            queryString["updated_or_created_since"] = "{string}";
            queryString["show_legacy_id"] = "{boolean}";
            queryString["items_per_page"] = "20";
            queryString["page"] = "1";
            queryString["attributes"] = "{string}";
            var uri = "https://api.columbus.sage.com/ca/sageone/accounts/v3/coa_accounts?" + 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/ca/sageone/accounts/v3/coa_accounts");

            builder.setParameter("coa_template_id", "{string}");
            builder.setParameter("updated_or_created_since", "{string}");
            builder.setParameter("show_legacy_id", "{boolean}");
            builder.setParameter("items_per_page", "20");
            builder.setParameter("page", "1");
            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
            "coa_template_id": "{string}",
            "updated_or_created_since": "{string}",
            "show_legacy_id": "{boolean}",
            "items_per_page": "20",
            "page": "1",
            "attributes": "{string}",
        };
      
        $.ajax({
            url: "https://api.columbus.sage.com/ca/sageone/accounts/v3/coa_accounts?" + $.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/ca/sageone/accounts/v3/coa_accounts";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"coa_template_id={string}",
                         @"updated_or_created_since={string}",
                         @"show_legacy_id={boolean}",
                         @"items_per_page=20",
                         @"page=1",
                         @"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/ca/sageone/accounts/v3/coa_accounts');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'coa_template_id' => '{string}',
    'updated_or_created_since' => '{string}',
    'show_legacy_id' => '{boolean}',
    'items_per_page' => '20',
    'page' => '1',
    '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
    'coa_template_id': '{string}',
    'updated_or_created_since': '{string}',
    'show_legacy_id': '{boolean}',
    'items_per_page': '20',
    'page': '1',
    'attributes': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/ca/sageone/accounts/v3/coa_accounts?%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
    'coa_template_id': '{string}',
    'updated_or_created_since': '{string}',
    'show_legacy_id': '{boolean}',
    'items_per_page': '20',
    'page': '1',
    'attributes': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'coa_template_id' => '{string}',
    'updated_or_created_since' => '{string}',
    'show_legacy_id' => '{boolean}',
    'items_per_page' => '20',
    'page' => '1',
    '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