Sage One - Accounts - v3 UKI

Documentation of the Sage Business Cloud Accounting API.

Creates a Contact Person

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

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

{
  "contact_person": {
    "address_id": "string",
    "name": "string",
    "contact_person_type_ids": [
      "string"
    ],
    "job_title": "string",
    "telephone": "string",
    "mobile": "string",
    "email": "string",
    "fax": "string",
    "is_main_contact": true,
    "is_preferred_contact": true
  }
}
{
  "type": "object",
  "properties": {
    "contact_person": {
      "type": "object",
      "properties": {
        "address_id": {
          "type": "string",
          "description": "The address of the contact person"
        },
        "name": {
          "type": "string",
          "description": "The name of the contact person"
        },
        "contact_person_type_ids": {
          "type": "array",
          "description": "The IDs of the Contact Person Types.",
          "items": {
            "type": "string"
          }
        },
        "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."
        },
        "is_preferred_contact": {
          "type": "boolean",
          "description": "Indicates whether this contact person is a preferred contact"
        }
      },
      "required": [
        "address_id",
        "name",
        "contact_person_type_ids"
      ]
    }
  },
  "required": [
    "contact_person"
  ],
  "description": "Creates a Contact Person"
}

Response 201

Creates a Contact Person

{
  "legacy_id": 0,
  "id": "string",
  "displayed_as": "string",
  "$path": "string",
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string",
  "contact_person_types": [
    {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    }
  ],
  "name": "string",
  "job_title": "string",
  "telephone": "string",
  "mobile": "string",
  "email": "string",
  "fax": "string",
  "is_main_contact": true,
  "address": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "is_preferred_contact": 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"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the item was deleted"
    },
    "contact_person_types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "legacy_id": {
            "type": "integer",
            "format": "int32",
            "description": "The legacy ID for the item"
          },
          "id": {
            "type": "string",
            "maxLength": 15,
            "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": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸",
        "x-sage-menusection": "Contacts, Addresses & Countries"
      },
      "description": "The contact person types for the contact person. Get possible types by retrieving\n<a href=\"https://developer.sage.com/accounting/reference/contacts/#operation/getContactPersonTypes\">\n  all available contact person types\n</a>.\n"
    },
    "name": {
      "type": "string",
      "maxLength": 50,
      "description": "The name of the contact person"
    },
    "job_title": {
      "type": "string",
      "maxLength": 50,
      "description": "The job title of the contact person"
    },
    "telephone": {
      "type": "string",
      "maxLength": 50,
      "description": "The telephone number of the contact person"
    },
    "mobile": {
      "type": "string",
      "maxLength": 50,
      "description": "The mobile number of the contact person"
    },
    "email": {
      "type": "string",
      "maxLength": 100,
      "description": "The email address of the contact person"
    },
    "fax": {
      "type": "string",
      "maxLength": 50,
      "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": {
      "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 address of the contact person",
      "x-sage-menusection": "Settings"
    },
    "is_preferred_contact": {
      "type": "boolean",
      "description": "Indicates whether this contact person is a preferred contact"
    }
  },
  "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: `Contacts`: Restricted Access, Full Access",
  "x-sage-menusection": "Contacts, Addresses & Countries"
}

Code samples

@ECHO OFF

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


            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/contact_persons?" + $.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/contact_persons";
    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/contact_persons');
$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/contact_persons?%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/contact_persons?%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/contact_persons')

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