Sage One - Accounts - v3 DE
Documentation of the Sage Business Cloud Accounting API.
Returns all Contacts
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:
Contacts
: Read Only, Restricted Access, Full Access - Area:
Sales
: Read Only, Restricted Access, Full Access - Area:
Purchases
: Read Only, Restricted Access, Full Access
Request URL
Request parameters
Format - date-time (as date-time in RFC3339). Use this to limit the response to Contacts 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.
Format - date-time (as date-time in RFC3339). Use this to limit the response to Contacts deleted since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Not inclusive of the passed timestamp.
Use this to filter by contact type id
Use this to filter out system entities, not applicable for transaction creation
Specify the attributes that you want to expose for nested entities of the Contacts (expose all nested attributes with 'all'). These are in addition to the base attributes (name, path)
Use this to display the balance for a contact.
Format - date (as full-date in RFC3339). Use this to determine the correct tax treatment for a contact on a given date.
Use this to filter by the contact name, company name or reference.
Use this to filter by the contact person email address.
Display the legacy_id for the Contacts.
Format - int32. Returns the given number of Contacts per request.
Format - int32. Go to specific page of Contacts
Specify the attributes that you want to expose for the Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
Request headers
Request body
Response 200
Returns all Contacts
Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/de/sageone/accounts/v3/contacts?updated_or_created_since={string}&deleted_since={string}&contact_type_id={string}&exclude_system={boolean}&nested_attributes={string}&show_balance={boolean}&context_date={string}&search={string}&email={string}&show_unfinished_recurring_invoices_status={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["updated_or_created_since"] = "{string}";
queryString["deleted_since"] = "{string}";
queryString["contact_type_id"] = "{string}";
queryString["exclude_system"] = "{boolean}";
queryString["nested_attributes"] = "{string}";
queryString["show_balance"] = "{boolean}";
queryString["context_date"] = "{string}";
queryString["search"] = "{string}";
queryString["email"] = "{string}";
queryString["show_unfinished_recurring_invoices_status"] = "{boolean}";
queryString["show_legacy_id"] = "{boolean}";
queryString["items_per_page"] = "20";
queryString["page"] = "1";
queryString["attributes"] = "{string}";
var uri = "https://api.columbus.sage.com/de/sageone/accounts/v3/contacts?" + 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/de/sageone/accounts/v3/contacts");
builder.setParameter("updated_or_created_since", "{string}");
builder.setParameter("deleted_since", "{string}");
builder.setParameter("contact_type_id", "{string}");
builder.setParameter("exclude_system", "{boolean}");
builder.setParameter("nested_attributes", "{string}");
builder.setParameter("show_balance", "{boolean}");
builder.setParameter("context_date", "{string}");
builder.setParameter("search", "{string}");
builder.setParameter("email", "{string}");
builder.setParameter("show_unfinished_recurring_invoices_status", "{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
"updated_or_created_since": "{string}",
"deleted_since": "{string}",
"contact_type_id": "{string}",
"exclude_system": "{boolean}",
"nested_attributes": "{string}",
"show_balance": "{boolean}",
"context_date": "{string}",
"search": "{string}",
"email": "{string}",
"show_unfinished_recurring_invoices_status": "{boolean}",
"show_legacy_id": "{boolean}",
"items_per_page": "20",
"page": "1",
"attributes": "{string}",
};
$.ajax({
url: "https://api.columbus.sage.com/de/sageone/accounts/v3/contacts?" + $.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/de/sageone/accounts/v3/contacts";
NSArray* array = @[
// Request parameters
@"entities=true",
@"updated_or_created_since={string}",
@"deleted_since={string}",
@"contact_type_id={string}",
@"exclude_system={boolean}",
@"nested_attributes={string}",
@"show_balance={boolean}",
@"context_date={string}",
@"search={string}",
@"email={string}",
@"show_unfinished_recurring_invoices_status={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/de/sageone/accounts/v3/contacts');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'contact_type_id' => '{string}',
'exclude_system' => '{boolean}',
'nested_attributes' => '{string}',
'show_balance' => '{boolean}',
'context_date' => '{string}',
'search' => '{string}',
'email' => '{string}',
'show_unfinished_recurring_invoices_status' => '{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
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'contact_type_id': '{string}',
'exclude_system': '{boolean}',
'nested_attributes': '{string}',
'show_balance': '{boolean}',
'context_date': '{string}',
'search': '{string}',
'email': '{string}',
'show_unfinished_recurring_invoices_status': '{boolean}',
'show_legacy_id': '{boolean}',
'items_per_page': '20',
'page': '1',
'attributes': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/de/sageone/accounts/v3/contacts?%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
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'contact_type_id': '{string}',
'exclude_system': '{boolean}',
'nested_attributes': '{string}',
'show_balance': '{boolean}',
'context_date': '{string}',
'search': '{string}',
'email': '{string}',
'show_unfinished_recurring_invoices_status': '{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", "/de/sageone/accounts/v3/contacts?%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/contacts')
query = URI.encode_www_form({
# Request parameters
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'contact_type_id' => '{string}',
'exclude_system' => '{boolean}',
'nested_attributes' => '{string}',
'show_balance' => '{boolean}',
'context_date' => '{string}',
'search' => '{string}',
'email' => '{string}',
'show_unfinished_recurring_invoices_status' => '{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