Sage One - Accounts - v3 CA
Documentation of the Sage Business Cloud Accounting API.
Returns a Migration Tax Return
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 Statutory Reporting
: Full Access
Request URL
Request parameters
string
The Migration Tax Return Key.
(optional)
boolean
Display the legacy_id for the Migration Tax Return.
(optional)
string
Specify the attributes that you want to expose for the Migration Tax Return (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
Request headers
Request body
Response 200
Returns a Migration Tax Return
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"from_date": "string",
"to_date": "string",
"tax_return_frequency": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"total_amount": 0.0,
"gb": {
"box_1": 0.0,
"box_2": 0.0,
"box_3": 0.0,
"box_4": 0.0,
"box_5": 0.0,
"box_6": 0.0,
"box_7": 0.0,
"box_8": 0.0,
"box_9": 0.0
},
"ie": {
"box_T1": 0.0,
"box_T2": 0.0,
"box_T3": 0.0,
"box_T4": 0.0,
"box_E1": 0.0,
"box_E2": 0.0,
"box_ES1": 0.0,
"box_ES2": 0.0
}
}
{
"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"
},
"from_date": {
"type": "string",
"format": "date",
"description": "The start date of the tax return"
},
"to_date": {
"type": "string",
"format": "date",
"description": "The end date of the tax return"
},
"tax_return_frequency": {
"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 tax return submission frequency",
"x-sage-menusection": "Settings"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total of the tax return"
},
"gb": {
"type": "object",
"properties": {
"box_1": {
"type": "number",
"format": "double",
"description": "The value of box 1"
},
"box_2": {
"type": "number",
"format": "double",
"description": "The value of box 2"
},
"box_3": {
"type": "number",
"format": "double",
"description": "The value of box 3"
},
"box_4": {
"type": "number",
"format": "double",
"description": "The value of box 4"
},
"box_5": {
"type": "number",
"format": "double",
"description": "The value of box 5"
},
"box_6": {
"type": "number",
"format": "double",
"description": "The value of box 6"
},
"box_7": {
"type": "number",
"format": "double",
"description": "The value of box 7"
},
"box_8": {
"type": "number",
"format": "double",
"description": "The value of box 8"
},
"box_9": {
"type": "number",
"format": "double",
"description": "The value of box 9"
}
},
"description": "The tax return data"
},
"ie": {
"type": "object",
"properties": {
"box_T1": {
"type": "number",
"format": "double",
"description": "The value of box T1"
},
"box_T2": {
"type": "number",
"format": "double",
"description": "The value of box T2"
},
"box_T3": {
"type": "number",
"format": "double",
"description": "The value of box T3"
},
"box_T4": {
"type": "number",
"format": "double",
"description": "The value of box T4"
},
"box_E1": {
"type": "number",
"format": "double",
"description": "The value of box E1"
},
"box_E2": {
"type": "number",
"format": "double",
"description": "The value of box E2"
},
"box_ES1": {
"type": "number",
"format": "double",
"description": "The value of box ES1"
},
"box_ES2": {
"type": "number",
"format": "double",
"description": "The value of box ES2"
}
},
"description": "The tax return data"
}
},
"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 `Statutory Reporting`: Full Access",
"x-sage-menusection": "Financial Accounts & Entries"
}
Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/ca/sageone/accounts/v3/migration_tax_returns/{key}?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["show_legacy_id"] = "{boolean}";
queryString["attributes"] = "{string}";
var uri = "https://api.columbus.sage.com/ca/sageone/accounts/v3/migration_tax_returns/{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/ca/sageone/accounts/v3/migration_tax_returns/{key}");
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
"show_legacy_id": "{boolean}",
"attributes": "{string}",
};
$.ajax({
url: "https://api.columbus.sage.com/ca/sageone/accounts/v3/migration_tax_returns/{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/ca/sageone/accounts/v3/migration_tax_returns/{key}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"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/ca/sageone/accounts/v3/migration_tax_returns/{key}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'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
'show_legacy_id': '{boolean}',
'attributes': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/ca/sageone/accounts/v3/migration_tax_returns/{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
'show_legacy_id': '{boolean}',
'attributes': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/ca/sageone/accounts/v3/migration_tax_returns/{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/ca/sageone/accounts/v3/migration_tax_returns/{key}')
query = URI.encode_www_form({
# Request parameters
'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