Sage One - Accounts - v3 US
Documentation of the Sage Business Cloud Accounting API.
Returns all Tax Determinations
Endpoint Availability
- Accounting Plus: 🇩🇪, 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪
- Accounting Standard: 🇩🇪, 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪
- Accounting Start: 🇩🇪, 🇫🇷, 🇪🇸, 🇬🇧, 🇮🇪
Access Control Restrictions
Requires the authenticated user to have any of the following roles in the areas:
- Area:
Sales: Full Access, Restricted Access, Read Only - Area:
Purchases: Full Access, Restricted Access, Read Only - Area:
Bank: Full Access, Restricted Access, Read Only - Area:
Settings: Full Access, Read Only
Request URL
Request parameters
string
Tax rates with the intended usage
(optional)
string
The artefact id
(optional)
number
Format - double. The artefact line amount
(optional)
string
The artefact line description
(optional)
string
The artefact line goods and service type
(optional)
string
The artefact line id
(optional)
string
The artefact line includes tax
(optional)
string
Use this to filter by contact id
(optional)
string
Format - date (as full-date in RFC3339). Use this to return results on a specified date.
(optional)
boolean
Include destination vat
(optional)
boolean
Include line determination
(optional)
boolean
Display the legacy_id for the Tax Rates.
(optional)
integer
Format - int32. Returns the given number of Tax Rates per request.
(optional)
integer
Format - int32. Go to specific page of Tax Rates
(optional)
string
Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
Request headers
Request body
Response 200
Returns all Tax Determinations
[
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"agency": "string",
"percentage": 0.0,
"percentages": [
{
"percentage": 0.0,
"from_date": "string",
"to_date": "string"
}
],
"is_visible": true,
"retailer": true,
"editable": true,
"deletable": true,
"is_combined_rate": true,
"component_tax_rates": [
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"agency": "string",
"percentage": 0.0,
"percentages": [
{
"percentage": 0.0,
"from_date": "string",
"to_date": "string"
}
],
"is_visible": true,
"retailer": true,
"editable": true,
"deletable": true,
"is_combined_rate": 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"
},
"name": {
"type": "string",
"description": "The name of the tax rate"
},
"agency": {
"type": "string",
"description": "The agency name (US Only)"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The current tax rate percentage"
},
"percentages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"description": "The percentage of the rate"
},
"from_date": {
"type": "string",
"format": "date",
"description": "The start date for the rate"
},
"to_date": {
"type": "string",
"format": "date",
"description": "The end date for the rate"
}
}
},
"description": "The tax rate percentage and date ranges they apply to"
},
"is_visible": {
"type": "boolean",
"description": "Indicates whether the tax rate is displayed in the application"
},
"retailer": {
"type": "boolean",
"description": "Indicates if tax rate is a retailer rate or not"
},
"editable": {
"type": "boolean",
"description": "Indicates whether a tax rate can be edited"
},
"deletable": {
"type": "boolean",
"description": "Indicates whether a tax rate can be deleted"
},
"is_combined_rate": {
"type": "boolean",
"description": "Indicates whether the tax rate is made up of component tax rates"
},
"component_tax_rates": {
"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"
},
"name": {
"type": "string",
"description": "The name of the tax rate"
},
"agency": {
"type": "string",
"description": "The agency name (US Only)"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The current tax rate percentage"
},
"percentages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"percentage": {
"type": "number",
"format": "double",
"description": "The percentage of the rate"
},
"from_date": {
"type": "string",
"format": "date",
"description": "The start date for the rate"
},
"to_date": {
"type": "string",
"format": "date",
"description": "The end date for the rate"
}
}
},
"description": "The tax rate percentage and date ranges they apply to"
},
"is_visible": {
"type": "boolean",
"description": "Indicates whether the tax rate is displayed in the application"
},
"retailer": {
"type": "boolean",
"description": "Indicates if tax rate is a retailer rate or not"
},
"editable": {
"type": "boolean",
"description": "Indicates whether a tax rate can be edited"
},
"deletable": {
"type": "boolean",
"description": "Indicates whether a tax rate can be deleted"
},
"is_combined_rate": {
"type": "boolean",
"description": "Indicates whether the tax rate is made up of component tax rates"
}
}
},
"description": "The component tax rates which make up a combined rate"
}
},
"description": "\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any mentioned role in one of the listed areas:\n* 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/tax_determinations?usage={usage}?artefact_id={string}&artefact_line_amount={number}&artefact_line_description={string}&artefact_line_goods_services_type={string}&artefact_line_id={string}&artefact_line_tax_included={string}&contact_id={string}&date={string}&include_destination_vat={boolean}&include_line_determination={boolean}&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["artefact_id"] = "{string}";
queryString["artefact_line_amount"] = "{number}";
queryString["artefact_line_description"] = "{string}";
queryString["artefact_line_goods_services_type"] = "{string}";
queryString["artefact_line_id"] = "{string}";
queryString["artefact_line_tax_included"] = "{string}";
queryString["contact_id"] = "{string}";
queryString["date"] = "{string}";
queryString["include_destination_vat"] = "{boolean}";
queryString["include_line_determination"] = "{boolean}";
queryString["show_legacy_id"] = "{boolean}";
queryString["items_per_page"] = "20";
queryString["page"] = "1";
queryString["attributes"] = "{string}";
var uri = "https://api.columbus.sage.com/us/sageone/accounts/v3/tax_determinations?usage={usage}&" + 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/tax_determinations?usage={usage}");
builder.setParameter("artefact_id", "{string}");
builder.setParameter("artefact_line_amount", "{number}");
builder.setParameter("artefact_line_description", "{string}");
builder.setParameter("artefact_line_goods_services_type", "{string}");
builder.setParameter("artefact_line_id", "{string}");
builder.setParameter("artefact_line_tax_included", "{string}");
builder.setParameter("contact_id", "{string}");
builder.setParameter("date", "{string}");
builder.setParameter("include_destination_vat", "{boolean}");
builder.setParameter("include_line_determination", "{boolean}");
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
"artefact_id": "{string}",
"artefact_line_amount": "{number}",
"artefact_line_description": "{string}",
"artefact_line_goods_services_type": "{string}",
"artefact_line_id": "{string}",
"artefact_line_tax_included": "{string}",
"contact_id": "{string}",
"date": "{string}",
"include_destination_vat": "{boolean}",
"include_line_determination": "{boolean}",
"show_legacy_id": "{boolean}",
"items_per_page": "20",
"page": "1",
"attributes": "{string}",
};
$.ajax({
url: "https://api.columbus.sage.com/us/sageone/accounts/v3/tax_determinations?usage={usage}&" + $.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/tax_determinations?usage={usage}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"artefact_id={string}",
@"artefact_line_amount={number}",
@"artefact_line_description={string}",
@"artefact_line_goods_services_type={string}",
@"artefact_line_id={string}",
@"artefact_line_tax_included={string}",
@"contact_id={string}",
@"date={string}",
@"include_destination_vat={boolean}",
@"include_line_determination={boolean}",
@"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/us/sageone/accounts/v3/tax_determinations?usage={usage}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'artefact_id' => '{string}',
'artefact_line_amount' => '{number}',
'artefact_line_description' => '{string}',
'artefact_line_goods_services_type' => '{string}',
'artefact_line_id' => '{string}',
'artefact_line_tax_included' => '{string}',
'contact_id' => '{string}',
'date' => '{string}',
'include_destination_vat' => '{boolean}',
'include_line_determination' => '{boolean}',
'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
'artefact_id': '{string}',
'artefact_line_amount': '{number}',
'artefact_line_description': '{string}',
'artefact_line_goods_services_type': '{string}',
'artefact_line_id': '{string}',
'artefact_line_tax_included': '{string}',
'contact_id': '{string}',
'date': '{string}',
'include_destination_vat': '{boolean}',
'include_line_determination': '{boolean}',
'show_legacy_id': '{boolean}',
'items_per_page': '20',
'page': '1',
'attributes': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/us/sageone/accounts/v3/tax_determinations?usage={usage}&%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
'artefact_id': '{string}',
'artefact_line_amount': '{number}',
'artefact_line_description': '{string}',
'artefact_line_goods_services_type': '{string}',
'artefact_line_id': '{string}',
'artefact_line_tax_included': '{string}',
'contact_id': '{string}',
'date': '{string}',
'include_destination_vat': '{boolean}',
'include_line_determination': '{boolean}',
'show_legacy_id': '{boolean}',
'items_per_page': '20',
'page': '1',
'attributes': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/us/sageone/accounts/v3/tax_determinations?usage={usage}&%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/tax_determinations?usage={usage}')
query = URI.encode_www_form({
# Request parameters
'artefact_id' => '{string}',
'artefact_line_amount' => '{number}',
'artefact_line_description' => '{string}',
'artefact_line_goods_services_type' => '{string}',
'artefact_line_id' => '{string}',
'artefact_line_tax_included' => '{string}',
'contact_id' => '{string}',
'date' => '{string}',
'include_destination_vat' => '{boolean}',
'include_line_determination' => '{boolean}',
'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