Sage One - Accounts - v3 UKI
Documentation of the Sage Business Cloud Accounting API.
Updates a Contact
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
: Restricted Access, Full Access
Request URL
Request parameters
string
The Contact Key.
Request headers
(optional)
string
Media type of the body sent to the API.
Request body
{
"contact": {
"name": "string",
"contact_type_ids": [
"string"
],
"reference": "string",
"default_sales_ledger_account_id": "string",
"default_sales_tax_rate_id": "string",
"default_purchase_ledger_account_id": "string",
"tax_number": "string",
"notes": "string",
"locale": "string",
"credit_limit": 0.0,
"credit_days": 0,
"credit_terms_and_conditions": "string",
"product_sales_price_type_id": "string",
"source_guid": "string",
"currency_id": "string",
"aux_reference": "string",
"registered_number": "string",
"tax_calculation": "string",
"auxiliary_account": "string",
"destination_vat_blocking": true,
"main_address": {
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country_id": "string",
"bank_account_id": "string",
"contact_id": "string",
"address_type_id": "string",
"name": "string",
"region": "string",
"country_group_id": "string",
"is_main_address": true
},
"delivery_address": {
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country_id": "string",
"bank_account_id": "string",
"contact_id": "string",
"address_type_id": "string",
"name": "string",
"region": "string",
"country_group_id": "string",
"is_main_address": true
},
"main_contact_person": {
"contact_person_type_ids": [
"string"
],
"name": "string",
"job_title": "string",
"telephone": "string",
"mobile": "string",
"email": "string",
"fax": "string",
"is_main_contact": true,
"address_id": "string",
"is_preferred_contact": true
},
"bank_account_details": {
"account_name": "string",
"account_number": "string",
"sort_code": "string",
"bic": "string",
"iban": "string"
},
"tax_treatment": {
"home_tax": true,
"eu_tax_registered": true,
"eu_not_tax_registered": true,
"rest_of_world_tax": true,
"is_importer": true
}
}
}
{
"type": "object",
"properties": {
"contact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The contact's full name or business name"
},
"contact_type_ids": {
"type": "array",
"description": "The IDs of the Contact Types.",
"items": {
"type": "string"
}
},
"reference": {
"type": "string",
"description": "Unique reference for the contact"
},
"default_sales_ledger_account_id": {
"type": "string",
"description": "The ID of the Default Sales Ledger Account."
},
"default_sales_tax_rate_id": {
"type": "string",
"description": "The ID of the Default Sales Tax Rate."
},
"default_purchase_ledger_account_id": {
"type": "string",
"description": "The ID of the Default Purchase Ledger Account."
},
"tax_number": {
"type": "string",
"description": "The VAT registration number of the contact. The format will be validated."
},
"notes": {
"type": "string",
"description": "The notes for the contact"
},
"locale": {
"type": "string",
"description": "The locale for the contact"
},
"credit_limit": {
"type": "number",
"format": "double",
"description": "Custom credit limit amount for the contact <br><i>not applicable to Start</i>"
},
"credit_days": {
"type": "integer",
"format": "int32",
"description": "Custom credit days for the contact.<br>\nIf returned as null in a GET response, you may want to GET /invoice_settings\nand use 'customer_credit_days'/'vendor_credit_days' as default/fallback according\nto your use case.\n",
"minimum": 0,
"maximum": 365
},
"credit_terms_and_conditions": {
"type": "string",
"description": "Custom terms and conditions for the contact. If set will override global /invoice_settings\ndefault terms and conditions.\n<br><i>Customers only</i>\n"
},
"product_sales_price_type_id": {
"type": "string",
"description": "The ID of the Product Sales Price Type."
},
"source_guid": {
"type": "string",
"description": "Used when importing contacts from external sources"
},
"currency_id": {
"type": "string",
"description": "The ID of the Currency."
},
"aux_reference": {
"type": "string",
"description": "Auxiliary reference. Used for German \"Kreditorennummer\" and \"Debitorennummer\".\n<br>\n<a href=\"https://developer.sage.com/accounting/reference/settings/#tag/Datev-Settings\">\n See Datev Settings endpoint reference\n</a>\n"
},
"registered_number": {
"type": "string",
"description": "The registered number of the contact's business. Only used for German businesses and represents the \"Steuernummer\" there (not the \"USt-ID\")."
},
"tax_calculation": {
"type": "string",
"description": "<b>France:</b> The tax calculation method used to define tax\ntreatment <i>Vendors only</i>\n<br>\n<b>Spain:</b> Defines if contact is a retailer and tax is subject\nto Recargo de Equivalencia <i>Customers only</i>\n<b>United Kingdom:</b> Defines if contact tax treatment is domestic reverse\ncharge <i>Customers & Suppliers</i>\n"
},
"auxiliary_account": {
"type": "string",
"description": "Auxiliary account - used when auxiliary accounting is enabled in business settings.\n<br><i>Available only in Spain and France</i>\n"
},
"destination_vat_blocking": {
"type": "boolean",
"description": "Identifies a contact should be blocked due to destination vat"
},
"main_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"city": {
"type": "string",
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"description": "The address postal code/zipcode"
},
"country_id": {
"type": "string",
"description": "The ID of the Country."
},
"bank_account_id": {
"type": "string",
"description": "The ID of the Bank Account."
},
"contact_id": {
"type": "string",
"description": "The ID of the Contact."
},
"address_type_id": {
"type": "string",
"description": "The ID of the Address Type."
},
"name": {
"type": "string",
"description": "The custom name of the address"
},
"region": {
"type": "string",
"description": "The address state/province/region"
},
"country_group_id": {
"type": "string",
"description": "The ID of the Country Group."
},
"is_main_address": {
"type": "boolean",
"description": "Specifies the address as the contact's main address. Only a single address can exist for a contact in Start so this is always true when returned by the API but cannot be seen in the UI"
}
}
},
"delivery_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"city": {
"type": "string",
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"description": "The address postal code/zipcode"
},
"country_id": {
"type": "string",
"description": "The ID of the Country."
},
"bank_account_id": {
"type": "string",
"description": "The ID of the Bank Account."
},
"contact_id": {
"type": "string",
"description": "The ID of the Contact."
},
"address_type_id": {
"type": "string",
"description": "The ID of the Address Type."
},
"name": {
"type": "string",
"description": "The custom name of the address"
},
"region": {
"type": "string",
"description": "The address state/province/region"
},
"country_group_id": {
"type": "string",
"description": "The ID of the Country Group."
},
"is_main_address": {
"type": "boolean",
"description": "Specifies the address as the contact's main address. Only a single address can exist for a contact in Start so this is always true when returned by the API but cannot be seen in the UI"
}
}
},
"main_contact_person": {
"type": "object",
"properties": {
"contact_person_type_ids": {
"type": "array",
"description": "The IDs of the Contact Person Types.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "The name of the contact person"
},
"job_title": {
"type": "string",
"description": "The job title of the contact person"
},
"telephone": {
"type": "string",
"description": "The telephone number of the contact person"
},
"mobile": {
"type": "string",
"description": "The mobile number of the contact person"
},
"email": {
"type": "string",
"description": "The email address of the contact person"
},
"fax": {
"type": "string",
"description": "The fax number of the contact person"
},
"is_main_contact": {
"type": "boolean",
"description": "Indicates whether this is the main contact person. Per contact, only one main contact can be selected."
},
"address_id": {
"type": "string",
"description": "The ID of the Address."
},
"is_preferred_contact": {
"type": "boolean",
"description": "Indicates whether this contact person is a preferred contact"
}
}
},
"bank_account_details": {
"type": "object",
"properties": {
"account_name": {
"type": "string",
"description": "The account name"
},
"account_number": {
"type": "string",
"description": "The account number"
},
"sort_code": {
"type": "string",
"description": "The sort code"
},
"bic": {
"type": "string",
"description": "The bic"
},
"iban": {
"type": "string",
"description": "The iban"
}
}
},
"tax_treatment": {
"type": "object",
"properties": {
"home_tax": {
"type": "boolean",
"description": "Indicates a contact where home country tax rules should be applied"
},
"eu_tax_registered": {
"type": "boolean",
"description": "Indicates a contact where EC tax rules should be applied"
},
"eu_not_tax_registered": {
"type": "boolean",
"description": "Indicates an EU contact without a tax number - home tax rules should be applied"
},
"rest_of_world_tax": {
"type": "boolean",
"description": "Indicates a contact where rest of world tax rules should be applied"
},
"is_importer": {
"type": "boolean",
"description": "Indicates a contact where import rules should be appliedOnly used for suppliers and FR, ES, IE and UK businesses"
}
}
}
}
}
},
"required": [
"contact"
],
"description": "Updates a Contact"
}
Response 200
Updates a Contact
Code samples
@ECHO OFF
curl -v -X PUT "https://api.columbus.sage.com/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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", "/uki/sageone/accounts/v3/contacts/{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", "/uki/sageone/accounts/v3/contacts/{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/uki/sageone/accounts/v3/contacts/{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