Sage One - Accounts - v3 DE

Documentation of the Sage Business Cloud Accounting API.

Updates a Bank Reconciliation

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 Bank: Full Access

Try it

Request URL

Request parameters

string

The Bank Reconciliation Key.

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

{
  "bank_reconciliation": {
    "bank_account_id": "string",
    "statement_date": "string",
    "statement_end_balance": 0.0,
    "reference": "string",
    "total_received": 0.0,
    "total_paid": 0.0,
    "starting_balance": 0.0,
    "closing_balance": 0.0,
    "reconciled_balance": 0.0,
    "balance_difference": 0.0,
    "status_id": "string"
  }
}
{
  "type": "object",
  "properties": {
    "bank_reconciliation": {
      "type": "object",
      "properties": {
        "bank_account_id": {
          "type": "string",
          "description": "The bank account the reconciliation relates to"
        },
        "statement_date": {
          "type": "string",
          "format": "date",
          "description": "The date of the bank reconciliation"
        },
        "statement_end_balance": {
          "type": "number",
          "format": "double",
          "description": "The statement end balance for the reconciliation"
        },
        "reference": {
          "type": "string",
          "description": "A reference for the bank reconciliation"
        },
        "total_received": {
          "type": "number",
          "format": "double",
          "description": "The total amount received"
        },
        "total_paid": {
          "type": "number",
          "format": "double",
          "description": "The total amount paid"
        },
        "starting_balance": {
          "type": "number",
          "format": "double",
          "description": "The starting balance of the bank reconciliation"
        },
        "closing_balance": {
          "type": "number",
          "format": "double",
          "description": "The closing balance of the bank reconciliation"
        },
        "reconciled_balance": {
          "type": "number",
          "format": "double",
          "description": "The reconciled balance of the bank reconciliation"
        },
        "balance_difference": {
          "type": "number",
          "format": "double",
          "description": "The difference between the statement end balance and the reconciled balance"
        },
        "status_id": {
          "type": "string",
          "description": "The ID of the Status."
        }
      }
    }
  },
  "required": [
    "bank_reconciliation"
  ],
  "description": "Updates a Bank Reconciliation"
}

Response 200

Updates a Bank Reconciliation

{
  "legacy_id": 0,
  "id": "string",
  "displayed_as": "string",
  "$path": "string",
  "created_at": "string",
  "updated_at": "string",
  "bank_account": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "statement_date": "string",
  "statement_end_balance": 0.0,
  "reference": "string",
  "total_received": 0.0,
  "total_paid": 0.0,
  "starting_balance": 0.0,
  "closing_balance": 0.0,
  "reconciled_balance": 0.0,
  "balance_difference": 0.0,
  "status": {
    "id": "string",
    "displayed_as": "string"
  }
}
{
  "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"
    },
    "bank_account": {
      "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 bank account the reconciliation relates to",
      "x-sage-menusection": "Settings"
    },
    "statement_date": {
      "type": "string",
      "format": "date",
      "description": "The date of the bank reconciliation"
    },
    "statement_end_balance": {
      "type": "number",
      "format": "double",
      "description": "The statement end balance for the reconciliation"
    },
    "reference": {
      "type": "string",
      "maxLength": 255,
      "description": "A reference for the bank reconciliation"
    },
    "total_received": {
      "type": "number",
      "format": "double",
      "description": "The total amount received"
    },
    "total_paid": {
      "type": "number",
      "format": "double",
      "description": "The total amount paid"
    },
    "starting_balance": {
      "type": "number",
      "format": "double",
      "description": "The starting balance of the bank reconciliation"
    },
    "closing_balance": {
      "type": "number",
      "format": "double",
      "description": "The closing balance of the bank reconciliation"
    },
    "reconciled_balance": {
      "type": "number",
      "format": "double",
      "description": "The reconciled balance of the bank reconciliation"
    },
    "balance_difference": {
      "type": "number",
      "format": "double",
      "description": "The difference between the statement end balance and the reconciled balance"
    },
    "status": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The bank reconciliation status id"
        },
        "displayed_as": {
          "type": "string",
          "description": "The bank reconciliation status name"
        }
      },
      "description": "The status of the bank reconciliation"
    }
  },
  "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 `Bank`: Full Access",
  "x-sage-menusection": "Bank, Payments & Receipts"
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.columbus.sage.com/de/sageone/accounts/v3/bank_reconciliations/{key}"
-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/de/sageone/accounts/v3/bank_reconciliations/{key}?" + 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.PutAsync(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/de/sageone/accounts/v3/bank_reconciliations/{key}");


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

// 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("PUT", "/de/sageone/accounts/v3/bank_reconciliations/{key}?%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("PUT", "/de/sageone/accounts/v3/bank_reconciliations/{key}?%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/bank_reconciliations/{key}')

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