Sage 200 Extra v1

GetBankPostedTransactions

GetBankPostedTransactions

Try it

Request URL

Request headers

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

Request body

Response 200

[
  {
    "id": 0,
    "bank_id": 0,
    "bank_transaction_type": "string",
    "entry_description": "string",
    "reference": "string",
    "second_reference": "string",
    "transaction_date": "string",
    "posted_date": "string",
    "cheque_value": 0.0,
    "cheque_discount_value": 0.0,
    "cheque_to_account_currency_rate": 0.0,
    "bank_cheque_to_base_currency_rate": 0.0,
    "cheque_currency_id": 0,
    "last_statement_date": "string",
    "statement_page_number": 0,
    "source": "string",
    "urn": 0,
    "user_name": "string",
    "tax_analysis_items": [
      {
        "id": 0,
        "code": 0,
        "name": "string",
        "entry_type": "string",
        "goods_amount": 0.0,
        "tax_amount": 0.0,
        "tax_discount_amount": 0.0
      }
    ],
    "nominal_analysis_items": [
      {
        "code": "string",
        "cost_centre": "string",
        "department": "string",
        "name": "string",
        "location": "string",
        "reference": "string",
        "narrative": "string",
        "value": 0.0,
        "base_value": 0.0,
        "transaction_analysis_code": "string",
        "source": "string"
      }
    ],
    "trade_items": [
      {
        "account_number": "string",
        "account_name": "string",
        "trading_entry_type": "string",
        "entry_type_string": "string",
        "reference": "string",
        "gross_value": 0.0,
        "tax_value": 0.0,
        "transaction_date": "string",
        "urn": 0
      }
    ],
    "bank": {},
    "cheque_currency": {},
    "date_time_created": "string",
    "date_time_updated": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "integer",
        "format": "int64"
      },
      "bank_id": {
        "type": "integer",
        "format": "int64"
      },
      "bank_transaction_type": {
        "type": "string",
        "maxLength": 30
      },
      "entry_description": {
        "type": "string",
        "maxLength": 6000
      },
      "reference": {
        "type": "string",
        "maxLength": 20
      },
      "second_reference": {
        "type": "string",
        "maxLength": 20
      },
      "transaction_date": {
        "type": "string",
        "format": "date-time"
      },
      "posted_date": {
        "type": "string",
        "format": "date-time"
      },
      "cheque_value": {
        "type": "number",
        "format": "decimal 2dp"
      },
      "cheque_discount_value": {
        "type": "number",
        "format": "decimal 2dp"
      },
      "cheque_to_account_currency_rate": {
        "type": "number",
        "format": "decimal 6dp"
      },
      "bank_cheque_to_base_currency_rate": {
        "type": "number",
        "format": "decimal 6dp"
      },
      "cheque_currency_id": {
        "type": "integer",
        "format": "int64"
      },
      "last_statement_date": {
        "type": "string",
        "format": "date-time"
      },
      "statement_page_number": {
        "type": "integer",
        "format": "int32"
      },
      "source": {
        "type": "string",
        "maxLength": 30
      },
      "urn": {
        "type": "integer",
        "format": "int64"
      },
      "user_name": {
        "type": "string",
        "maxLength": 20
      },
      "tax_analysis_items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer",
              "format": "int64"
            },
            "code": {
              "type": "integer",
              "format": "int16"
            },
            "name": {
              "type": "string",
              "maxLength": 60
            },
            "entry_type": {
              "type": "string",
              "maxLength": 20
            },
            "goods_amount": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "tax_amount": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "tax_discount_amount": {
              "type": "number",
              "format": "decimal 2dp"
            }
          }
        }
      },
      "nominal_analysis_items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "maxLength": 8
            },
            "cost_centre": {
              "type": "string",
              "maxLength": 3
            },
            "department": {
              "type": "string",
              "maxLength": 3
            },
            "name": {
              "type": "string",
              "maxLength": 60
            },
            "location": {
              "type": "string",
              "maxLength": 30
            },
            "reference": {
              "type": "string",
              "maxLength": 20
            },
            "narrative": {
              "type": "string",
              "maxLength": 6000
            },
            "value": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "base_value": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "transaction_analysis_code": {
              "type": "string",
              "maxLength": 20
            },
            "source": {
              "type": "string",
              "maxLength": 30
            }
          }
        }
      },
      "trade_items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "account_number": {
              "type": "string"
            },
            "account_name": {
              "type": "string",
              "maxLength": 60
            },
            "trading_entry_type": {
              "type": "string",
              "maxLength": 30
            },
            "entry_type_string": {
              "type": "string",
              "maxLength": 30
            },
            "reference": {
              "type": "string",
              "maxLength": 20
            },
            "gross_value": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "tax_value": {
              "type": "number",
              "format": "decimal 2dp"
            },
            "transaction_date": {
              "type": "string",
              "format": "date-time"
            },
            "urn": {
              "type": "integer",
              "format": "int32"
            }
          }
        }
      },
      "bank": {
        "type": "object",
        "readOnly": true
      },
      "cheque_currency": {
        "type": "object",
        "readOnly": true
      },
      "date_time_created": {
        "type": "string",
        "format": "date-time",
        "readOnly": true
      },
      "date_time_updated": {
        "type": "string",
        "format": "date-time",
        "readOnly": true
      }
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X GET "https://api.columbus.sage.com/uk/sage200extra/accounts/v1/bank_posted_transactions"
-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/uk/sage200extra/accounts/v1/bank_posted_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/uk/sage200extra/accounts/v1/bank_posted_transactions");


            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
        };
      
        $.ajax({
            url: "https://api.columbus.sage.com/uk/sage200extra/accounts/v1/bank_posted_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/uk/sage200extra/accounts/v1/bank_posted_transactions";
    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:@"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/uk/sage200extra/accounts/v1/bank_posted_transactions');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/uk/sage200extra/accounts/v1/bank_posted_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({
})

try:
    conn = http.client.HTTPSConnection('api.columbus.sage.com')
    conn.request("GET", "/uk/sage200extra/accounts/v1/bank_posted_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/uk/sage200extra/accounts/v1/bank_posted_transactions')

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