Sage One - Accounts - v3 CA

Documentation of the Sage Business Cloud Accounting API.

Returns all Financial Settings

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: Settings: Full Access, Read Only

Try it

Request URL

Request parameters

(optional)
boolean

Display the legacy_id for the Financial Settings.

Request headers

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

Request body

Response 200

Returns all Financial Settings

{
  "$path": "string",
  "year_end_date": "string",
  "year_end_lockdown_date": "string",
  "accounting_type": "string",
  "accounts_start_date": "string",
  "base_currency": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "multi_currency_enabled": true,
  "use_live_exchange_rates": true,
  "mtd_activation_status": "string",
  "mtd_connected": true,
  "mtd_authenticated_date": "string",
  "tax_scheme": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "tax_return_frequency": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "tax_number": "string",
  "general_tax_number": "string",
  "tax_office": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "default_irpf_rate": 0.0,
  "flat_rate_tax_percentage": 0.0,
  "recoverable_percentage": 0.0,
  "sales_tax_calculation": "string",
  "purchase_tax_calculation": "string",
  "updated_at": "string",
  "postponed_accounting": true,
  "destination_vat": true
}
{
  "type": "object",
  "properties": {
    "$path": {
      "type": "string",
      "description": "The api path for this item"
    },
    "year_end_date": {
      "type": "string",
      "format": "date",
      "description": "The financial year end date of the business"
    },
    "year_end_lockdown_date": {
      "type": "string",
      "format": "date",
      "description": "The year end lockdown date of the business"
    },
    "accounting_type": {
      "type": "string",
      "maxLength": 255,
      "description": "Indicates the accounting type of a business, it can be accrual or cash based"
    },
    "accounts_start_date": {
      "type": "string",
      "format": "date",
      "description": "The accounts start date of the business"
    },
    "base_currency": {
      "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 base currency of the business",
      "x-sage-menusection": "Settings"
    },
    "multi_currency_enabled": {
      "type": "boolean",
      "description": "Indicates whether multi-currency is enabled for the business"
    },
    "use_live_exchange_rates": {
      "type": "boolean",
      "description": "Indicates whether to use live or business defined exchange rates"
    },
    "mtd_activation_status": {
      "type": "string",
      "description": "Indicates the UK Making Tax Digital for VAT activation status"
    },
    "mtd_connected": {
      "type": "boolean",
      "description": "Indicates whether UK Making Tax Digital for VAT is currently connected"
    },
    "mtd_authenticated_date": {
      "type": "string",
      "format": "date",
      "description": "Indicates when a UK business enabled UK Making Tax Digital for VAT, nil if not enabled or non-uk"
    },
    "tax_scheme": {
      "type": "object",
      "properties": {
        "legacy_id": {
          "type": "integer",
          "format": "int32",
          "description": "The legacy ID for the item"
        },
        "id": {
          "type": "string",
          "maxLength": 20,
          "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 scheme of the business",
      "x-sage-menusection": "Settings"
    },
    "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 frequency",
      "x-sage-menusection": "Settings"
    },
    "tax_number": {
      "type": "string",
      "maxLength": 255,
      "description": "The tax number"
    },
    "general_tax_number": {
      "type": "string",
      "description": "The number for various tax report submissions"
    },
    "tax_office": {
      "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 office details",
      "x-sage-menusection": "Settings"
    },
    "default_irpf_rate": {
      "type": "number",
      "format": "double",
      "description": "The default IRPF rate"
    },
    "flat_rate_tax_percentage": {
      "type": "number",
      "format": "double",
      "description": "The tax percentage that applies to flat rate tax schemes."
    },
    "recoverable_percentage": {
      "type": "number",
      "format": "double",
      "description": "The partial recoverable tax rate (Canada only)"
    },
    "sales_tax_calculation": {
      "type": "string",
      "description": "The method of collection for tax on sales. Allowed values - \"invoice\", \"cash\"."
    },
    "purchase_tax_calculation": {
      "type": "string",
      "description": "The method of collection for tax on purchases. Allowed values - \"invoice\", \"cash\"."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the item was last updated"
    },
    "postponed_accounting": {
      "type": "boolean",
      "description": "Indicates whether to use postponed accounting or not"
    },
    "destination_vat": {
      "type": "boolean",
      "description": "Indicates whether to use destination vat or not"
    }
  },
  "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 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/ca/sageone/accounts/v3/financial_settings?show_legacy_id={boolean}"
-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}";
            var uri = "https://api.columbus.sage.com/ca/sageone/accounts/v3/financial_settings?" + 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/financial_settings");

            builder.setParameter("show_legacy_id", "{boolean}");

            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}",
        };
      
        $.ajax({
            url: "https://api.columbus.sage.com/ca/sageone/accounts/v3/financial_settings?" + $.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/financial_settings";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"show_legacy_id={boolean}",
                      ];
    
    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/financial_settings');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'show_legacy_id' => '{boolean}',
);

$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}',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    'show_legacy_id' => '{boolean}'
})

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