Sage One - Accounts - v3 DE

Documentation of the Sage Business Cloud Accounting API.

Returns all Transactions

Endpoint Availability

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

Access Control Restrictions

Requires the authenticated user to have any of the following roles in the area Journals: Read Only, Full Access

Try it

Request URL

Request parameters

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to limit the response to Transactions 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.

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to filter by Transactions dates

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to filter by Transactions dates

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to filter Transactions by the date they were last updated

(optional)
string

Format - date-time (as date-time in RFC3339). Use this to filter Transactions by the date they were last updated

(optional)
boolean

Use this to filter Transactions by whether they have attachments or not

(optional)
boolean

Display the legacy_id for the Transactions.

(optional)
integer

Format - int32. Returns the given number of Transactions per request.

(optional)
integer

Format - int32. Go to specific page of Transactions

(optional)
string

Specify the attributes that you want to expose for the Transactions (expose all attributes with 'all'). These are in addition to the base attributes (name, path)

(optional)
string

Use this to filter by transaction type id

Request headers

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

Returns all Transactions

[
  {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string",
    "created_at": "string",
    "updated_at": "string",
    "date": "string",
    "deleted": true,
    "reference": "string",
    "total": 0.0,
    "total_in_transaction_currency": 0.0,
    "contact": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    },
    "transaction_type": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string"
    },
    "origin": {
      "legacy_id": 0,
      "id": "string",
      "displayed_as": "string",
      "$path": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "type": "string"
        }
      ],
      "due_date": "string",
      "outstanding_amount": 0.0,
      "currency": {
        "legacy_id": 0,
        "id": "string",
        "displayed_as": "string",
        "$path": "string"
      },
      "status": {
        "legacy_id": 0,
        "id": "string",
        "displayed_as": "string",
        "$path": "string"
      },
      "sent": true
    },
    "audit_trail_id": "string",
    "number_of_attachments": "string"
  }
]
{
  "type": "array",
  "items": {
    "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"
      },
      "date": {
        "type": "string",
        "format": "date",
        "description": "The date of the transaction"
      },
      "deleted": {
        "type": "boolean",
        "description": "Indicates whether the transaction has been deleted"
      },
      "reference": {
        "type": "string",
        "maxLength": 255,
        "description": "The transaction reference"
      },
      "total": {
        "type": "number",
        "format": "double",
        "description": "The transaction total in the base currency"
      },
      "total_in_transaction_currency": {
        "type": "number",
        "format": "double",
        "description": "The transaction total in the transaction's origin's currency. This is null for some origin types."
      },
      "contact": {
        "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 contact for the transaction",
        "x-sage-menusection": "Settings"
      },
      "transaction_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 transaction type",
        "x-sage-menusection": "Settings"
      },
      "origin": {
        "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"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "href": {
                  "type": "string",
                  "description": "The link path"
                },
                "rel": {
                  "type": "string",
                  "description": "The relationship of the link to the resource"
                },
                "type": {
                  "type": "string",
                  "description": "The content-type of the link"
                }
              }
            },
            "description": "Links for the resource"
          },
          "due_date": {
            "type": "string",
            "format": "date",
            "description": "The due date of the associated item, e.g. an invoice\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute."
          },
          "outstanding_amount": {
            "type": "number",
            "format": "double",
            "description": "The outstanding amount of the associated item, e.g. an invoice\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute."
          },
          "currency": {
            "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 currency of the transaction\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute.",
            "x-sage-menusection": "Settings"
          },
          "status": {
            "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 status of the associated item, e.g. an invoice\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute.",
            "x-sage-menusection": "Settings"
          },
          "sent": {
            "type": "boolean",
            "description": "Indicates whether the associated item, e.g. an invoice, has been sent. This attribute is only present for sales items (not purchase)\nThis attribute is only part of the response when the GET paremeter `expand_origin=true` is set in the request URL. Even then, it is only available on transaction origins found at the following endpoints: [\"/contact_opening_balance\", \"/purchase_corrective_invoice\", \"/sales_corrective_invoice\", \"/purchase_credit_note\", \"/purchase_invoice\", \"/purchase_quick_entry\", \"/sales_credit_note\", \"/sales_estimate\", \"/sales_invoice\", \"/sales_quick_entry\", \"/sales_quote\"]. There are other resources, e.g. bank transfers, bank opening balances, or journals, which--though possibly origins of a transaction--can never have this attribute."
          }
        },
        "description": "The original entity that generated the transaction"
      },
      "audit_trail_id": {
        "type": "string",
        "description": "The original entity that generated the transaction"
      },
      "number_of_attachments": {
        "type": "string",
        "description": "The number of attachments related to the transaction"
      }
    },
    "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 of the following roles in the area `Journals`: Read Only, Full Access",
    "x-sage-menusection": "Bank, Payments & Receipts"
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.columbus.sage.com/de/sageone/accounts/v3/transactions?updated_or_created_since={string}&from_date={string}&to_date={string}&updated_from_date={string}&updated_to_date={string}&has_attachments={boolean}&show_legacy_id={boolean}&items_per_page=20&page=1&attributes={string}&transaction_type_id={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["from_date"] = "{string}";
            queryString["to_date"] = "{string}";
            queryString["updated_from_date"] = "{string}";
            queryString["updated_to_date"] = "{string}";
            queryString["has_attachments"] = "{boolean}";
            queryString["show_legacy_id"] = "{boolean}";
            queryString["items_per_page"] = "20";
            queryString["page"] = "1";
            queryString["attributes"] = "{string}";
            queryString["transaction_type_id"] = "{string}";
            var uri = "https://api.columbus.sage.com/de/sageone/accounts/v3/transactions?" + 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/transactions");

            builder.setParameter("updated_or_created_since", "{string}");
            builder.setParameter("from_date", "{string}");
            builder.setParameter("to_date", "{string}");
            builder.setParameter("updated_from_date", "{string}");
            builder.setParameter("updated_to_date", "{string}");
            builder.setParameter("has_attachments", "{boolean}");
            builder.setParameter("show_legacy_id", "{boolean}");
            builder.setParameter("items_per_page", "20");
            builder.setParameter("page", "1");
            builder.setParameter("attributes", "{string}");
            builder.setParameter("transaction_type_id", "{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}",
            "from_date": "{string}",
            "to_date": "{string}",
            "updated_from_date": "{string}",
            "updated_to_date": "{string}",
            "has_attachments": "{boolean}",
            "show_legacy_id": "{boolean}",
            "items_per_page": "20",
            "page": "1",
            "attributes": "{string}",
            "transaction_type_id": "{string}",
        };
      
        $.ajax({
            url: "https://api.columbus.sage.com/de/sageone/accounts/v3/transactions?" + $.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/transactions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"updated_or_created_since={string}",
                         @"from_date={string}",
                         @"to_date={string}",
                         @"updated_from_date={string}",
                         @"updated_to_date={string}",
                         @"has_attachments={boolean}",
                         @"show_legacy_id={boolean}",
                         @"items_per_page=20",
                         @"page=1",
                         @"attributes={string}",
                         @"transaction_type_id={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/transactions');
$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}',
    'from_date' => '{string}',
    'to_date' => '{string}',
    'updated_from_date' => '{string}',
    'updated_to_date' => '{string}',
    'has_attachments' => '{boolean}',
    'show_legacy_id' => '{boolean}',
    'items_per_page' => '20',
    'page' => '1',
    'attributes' => '{string}',
    'transaction_type_id' => '{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}',
    'from_date': '{string}',
    'to_date': '{string}',
    'updated_from_date': '{string}',
    'updated_to_date': '{string}',
    'has_attachments': '{boolean}',
    'show_legacy_id': '{boolean}',
    'items_per_page': '20',
    'page': '1',
    'attributes': '{string}',
    'transaction_type_id': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/de/sageone/accounts/v3/transactions?%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}',
    'from_date': '{string}',
    'to_date': '{string}',
    'updated_from_date': '{string}',
    'updated_to_date': '{string}',
    'has_attachments': '{boolean}',
    'show_legacy_id': '{boolean}',
    'items_per_page': '20',
    'page': '1',
    'attributes': '{string}',
    'transaction_type_id': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/de/sageone/accounts/v3/transactions?%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/transactions')

query = URI.encode_www_form({
    # Request parameters
    'updated_or_created_since' => '{string}',
    'from_date' => '{string}',
    'to_date' => '{string}',
    'updated_from_date' => '{string}',
    'updated_to_date' => '{string}',
    'has_attachments' => '{boolean}',
    'show_legacy_id' => '{boolean}',
    'items_per_page' => '20',
    'page' => '1',
    'attributes' => '{string}',
    'transaction_type_id' => '{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