Sage One - Accounts - v3 DE
Documentation of the Sage Business Cloud Accounting API.
Updates a Tax Rate (US only)
Access Control Restrictions
Requires the authenticated user to have any mentioned role in one of the listed areas:
- Area:
Settings: Full Access
Request URL
Request parameters
string
The Tax Rate key.
Request headers
(optional)
string
Media type of the body sent to the API.
Request body
{
"tax_rate": {
"name": "string",
"from_date": "string",
"agency": "string",
"percentage": 0.0,
"is_visible": true
}
}{
"type": "object",
"properties": {
"tax_rate": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the tax rate"
},
"from_date": {
"type": "string",
"format": "date-time",
"description": "The date from which the tax rate applies"
},
"agency": {
"type": "string",
"description": "The agency name (US Only)"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The tax rate percentage"
},
"is_visible": {
"type": "boolean",
"description": "Indicates whether the tax rate is visible in the application"
}
}
}
},
"required": [
"tax_rate"
],
"description": "Updates a Tax Rate (US only)"
}Response 200
Updates a Tax Rate (US only)
{
"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": "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 PUT "https://api.columbus.sage.com/de/sageone/accounts/v3/tax_rates/{key}"
-H "Content-Type: application/json"
-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}");
var uri = "https://api.columbus.sage.com/de/sageone/accounts/v3/tax_rates/{key}?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
} // // 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/tax_rates/{key}");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Content-Type", "application/json");
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
};
$.ajax({
url: "https://api.columbus.sage.com/de/sageone/accounts/v3/tax_rates/{key}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// 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/tax_rates/{key}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PUT"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/tax_rates/{key}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// 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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("PUT", "/de/sageone/accounts/v3/tax_rates/{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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("PUT", "/de/sageone/accounts/v3/tax_rates/{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/tax_rates/{key}')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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