Sage One - Accounts - v3 UKI

Documentation of the Sage Business Cloud Accounting API.

Creates a Service

Endpoint Availability

  • Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
  • Accounting Standard: 🇬🇧, 🇮🇪

Access Control Restrictions

Requires the authenticated user to have any mentioned role in one of the listed areas:

  • Area: Products & Services: Restricted Access, Full Access

Try it

Request URL

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "service": {
    "description": "string",
    "sales_ledger_account_id": "string",
    "item_code": "string",
    "notes": "string",
    "purchase_ledger_account_id": "string",
    "sales_tax_rate_id": "string",
    "purchase_tax_rate_id": "string",
    "source_guid": "string",
    "purchase_description": "string",
    "usual_supplier_id": "string",
    "active": true,
    "cost_price": 0.0,
    "oss_service": true,
    "sales_rates": [
      {
        "rate_name": "string",
        "rate": 0.0,
        "rate_includes_tax": true,
        "service_rate_type_id": "string"
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "service": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "The service description"
        },
        "sales_ledger_account_id": {
          "type": "string",
          "description": "The sales ledger account for the service"
        },
        "item_code": {
          "type": "string",
          "description": "The item code for the service"
        },
        "notes": {
          "type": "string",
          "description": "The notes for the service"
        },
        "purchase_ledger_account_id": {
          "type": "string",
          "description": "The ID of the Purchase Ledger Account."
        },
        "sales_tax_rate_id": {
          "type": "string",
          "description": "The ID of the Sales Tax Rate."
        },
        "purchase_tax_rate_id": {
          "type": "string",
          "description": "The ID of the Purchase Tax Rate."
        },
        "source_guid": {
          "type": "string",
          "description": "Used when importing services from external sources"
        },
        "purchase_description": {
          "type": "string",
          "description": "The service purchase description"
        },
        "usual_supplier_id": {
          "type": "string",
          "description": "The ID of the Usual Supplier."
        },
        "active": {
          "type": "boolean",
          "description": "Indicates whether the service is active"
        },
        "cost_price": {
          "type": "number",
          "format": "double",
          "description": "The cost price of the service"
        },
        "oss_service": {
          "type": "boolean",
          "description": "Indicates whether the service is One Stop Shop"
        },
        "sales_rates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "rate_name": {
                "type": "string",
                "description": "The name of the service rate"
              },
              "rate": {
                "type": "number",
                "format": "double",
                "description": "The rate amount"
              },
              "rate_includes_tax": {
                "type": "boolean",
                "description": "Indicates whether the rate already includes tax"
              },
              "service_rate_type_id": {
                "type": "string",
                "description": "The ID of the Service Rate Type."
              }
            }
          }
        }
      },
      "required": [
        "description",
        "sales_ledger_account_id"
      ]
    }
  },
  "required": [
    "service"
  ],
  "description": "Creates a Service"
}

Response 201

Creates a Service

Code samples

@ECHO OFF

curl -v -X POST "https://api.columbus.sage.com/uki/sageone/accounts/v3/services"
-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/services?" + 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.PostAsync(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/services");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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/services?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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/services";
    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:@"POST"];
    // 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/services');
$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_POST);

// 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("POST", "/uki/sageone/accounts/v3/services?%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("POST", "/uki/sageone/accounts/v3/services?%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/services')

request = Net::HTTP::Post.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