Reckon One

API change history

Connect to your Reckon One book via API.

02 Core > Payments

Update an existing payment (money out).

Try it

Request

Request URL

Request parameters

  • string

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    OAuth 2.0 access token obtained from IdentityServer. Supported grant types: Implicit.

Request body

This is an example of the body you send when editing an existing payment. To get the GUIDs of the information required, use the other end points first. For example if you need to know the GUID of an account, use the accounts endpoint to get that information.


	  {
		  'Id':'f998eabe-550f-449b-87ec-278c7dc044ae',
		  'TransDate': '10/10/2015',
		  'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',
		  'Amount': 100,
		  'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',
		  'AllocateFullAmount': false,
		  'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',
		  'Details': 'azp_test_abc',
		  'Reference': 'azp_test_def',
		  'IsReconciled': false,
		  'Narration': 'azp_test',
		  'Allocations': [],
		  'AllocationSplit':[
			{
				'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',
				'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',
				'LineNo': 1,
				'Description': null,
				'Quantity': 0,
				'UnitPriceExTax': 10,
				'UnitPriceTax': 1,
				'UnitPricePrecision': 2,
				'DiscountAmountExTax': null,
				'DiscountAmountTax': null,
				'DiscountAccuracy': null,
				'DiscountPercent': null,
				'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',
				'TaxIsModified': false,
				'AmountExTax': 10,
				'Amount': 0,
				'TaxAmount': 1,
				'AmountAccuracy': null,
				'InvoiceDiscountedAmountExTax': null,
				'InvoiceDiscountedTaxAmount': null,
				'HasDataForPosting': false,
				'IsSubTotal': false,
				'IsParent': false,
				'AccountId': '00000000-0000-0000-0000-000000000000'
			}
		  ]
       }

Responses

200 OK

You will get this response if the payment was edited successfully.

401 Unauthorized

You will get this response if the user is not authorised to edit payments

500 Internal Server Error

You will get this response if there is a error on our end. Please email reckonapi@reckon.com if this continues

400 Bad Request

You will get this response if the JSON is not formed correctly, the data cannot be parsed by the existing payment or if you attempt to send a HTTP API call instead of HTTPS.

Code samples

@ECHO OFF

curl -v -X PUT "https://api.reckon.com/R1/{cashbookId}/payments"
-H "Content-Type: application/json"
-H "Authorization: {access token}"

--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("Authorization", "{access token}");

            var uri = "https://api.reckon.com/R1/{cashbookId}/payments?" + 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.reckon.com/R1/{cashbookId}/payments");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Authorization", "{access token}");


            // 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.reckon.com/R1/{cashbookId}/payments?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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.reckon.com/R1/{cashbookId}/payments";
    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:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // 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.reckon.com/R1/{cashbookId}/payments');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Authorization' => '{access token}',
);

$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',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/R1/{cashbookId}/payments?%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',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/R1/{cashbookId}/payments?%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.reckon.com/R1/{cashbookId}/payments')

request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Authorization'] = '{access token}'
# 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