Sage One - Accounts - v3 UKI

Documentation of the Sage Business Cloud Accounting API.

Creates a Attachment

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: Sales: Restricted Access, Full Access
  • Area: Purchases: 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

{
  "attachment": {
    "file": "string",
    "file_name": "string",
    "mime_type": "string",
    "description": "string",
    "file_extension": "string",
    "transaction_id": "string",
    "file_size": 0,
    "attachment_context_type_id": "string",
    "attachment_context_id": "string",
    "is_public": true
  }
}
{
  "type": "object",
  "properties": {
    "attachment": {
      "type": "object",
      "properties": {
        "file": {
          "type": "string",
          "description": "The base64 encoded representation of the file"
        },
        "file_name": {
          "type": "string",
          "description": "The file name of the attachment"
        },
        "mime_type": {
          "type": "string",
          "description": "The mime type of the attachment"
        },
        "description": {
          "type": "string",
          "description": "The description of the attachment"
        },
        "file_extension": {
          "type": "string",
          "description": "The file extension of the attachment"
        },
        "transaction_id": {
          "type": "string",
          "description": "The ID of the Transaction."
        },
        "file_size": {
          "type": "integer",
          "format": "int32",
          "description": "The file size of the attachment in Bytes",
          "minimum": 0,
          "maximum": 2621440
        },
        "attachment_context_type_id": {
          "type": "string",
          "description": "The ID of the Attachment Context Type."
        },
        "attachment_context_id": {
          "type": "string",
          "description": "The ID of the Attachment Context."
        },
        "is_public": {
          "type": "boolean",
          "description": "Flag to determine whether the attachment should be visible to customers"
        }
      },
      "required": [
        "file",
        "file_name",
        "mime_type"
      ]
    }
  },
  "required": [
    "attachment"
  ],
  "description": "Creates a Attachment"
}

Response 201

Creates a Attachment

{
  "id": "string",
  "displayed_as": "string",
  "$path": "string",
  "deleted_at": "string",
  "file": "string",
  "mime_type": "string",
  "description": "string",
  "file_extension": "string",
  "transaction": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "file_size": 0,
  "file_name": "string",
  "$file_path": "string",
  "attachment_context_type": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "attachment_context": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "is_public": true,
  "created_at": "string",
  "updated_at": "string"
}
{
  "type": "object",
  "properties": {
    "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"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the item was deleted"
    },
    "file": {
      "type": "string",
      "description": "The base64 encoded representation of the file"
    },
    "mime_type": {
      "type": "string",
      "description": "The mime type of the attachment"
    },
    "description": {
      "type": "string",
      "description": "The description of the attachment"
    },
    "file_extension": {
      "type": "string",
      "description": "The file extension of the attachment"
    },
    "transaction": {
      "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 transaction the attachment belongs to",
      "x-sage-menusection": "Settings"
    },
    "file_size": {
      "type": "integer",
      "format": "int32",
      "description": "The file size of the attachment in Bytes"
    },
    "file_name": {
      "type": "string",
      "description": "The file name of the attachment"
    },
    "$file_path": {
      "type": "string",
      "description": "The file path of the attachment"
    },
    "attachment_context_type": {
      "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 context type of the attachment",
      "x-sage-menusection": "Settings"
    },
    "attachment_context": {
      "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 context of the attachment",
      "x-sage-menusection": "Settings"
    },
    "is_public": {
      "type": "boolean",
      "description": "Flag to determine whether the attachment should be visible to customers"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the attachment was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the attachment was last updated"
    }
  },
  "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: `Sales`: Read Only, Restricted Access, Full Access\n* Area: `Purchases`: Read Only, Restricted Access, Full Access",
  "x-sage-menusection": "Attachments"
}

Code samples

@ECHO OFF

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


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

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