Reckon One API v1

API change history

A new generation, modular cloud accounting solution that scales with your business – perfect for startups.

03 Invoices > Supplier Credit Note By ID

This endpoint allows you to retrieve individual supplier credit notes via their unique id

Try it

Request

Request URL

Request parameters

  • string
  • string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from IdentityServer. Supported grant types: Implicit.

Request body

Responses

200 OK

You will get this response if the transaction is successfully retrieved

Representations

{"AccountsPayableAccountingCategoryID":"4ba37c05-eca4-4c02-a4d7-e72b3e9d4247","Address":{"AddressId":"00000000-0000-0000-0000-000000000000","Line1":null,"Line2":null,"Line3":null,"Town":null,"Suburb":null,"State":null,"Postcode":null,"Country":null,"AddressType":null,"IsInternational":null},"Allocations":[],"AmountTaxStatus":2,"CashbookId":"e17417ac-fc79-4d4d-9ee8-1780b3bc326f","ContactName":"City Rail Corp","Id":"11daf446-250e-4b16-ad4d-c2ee2db80693","LineItems":[{"AccountingCategoryId":"00000000-0000-0000-0000-000000000000","SupplierCreditNoteId":"11daf446-250e-4b16-ad4d-c2ee2db80693","DiscountAmountExTax":null,"DiscountAmountTax":null,"DiscountAccuracy":null,"DiscountPercent":null,"Amount":10.00,"AmountAccuracy":null,"InvoiceDiscountedAmountExTax":10.0000,"InvoiceDiscountedTaxAmount":null,"HasDataForPosting":true,"IsSubTotal":false,"IsParent":false,"IsHidden":false,"AccountId":"72df99c8-df36-487c-86b2-2e4efa373f3d","PrintGroupAsSingleLine":false,"Id":"4d9c977a-514a-46d2-ad5e-4ba392e887bb","ChargeableItemId":"00000000-0000-0000-0000-000000000000","LineNo":1,"Description":"D Expense Description","Quantity":null,"ProjectId":"00000000-0000-0000-0000-000000000000","UnitPriceExTax":0.0,"UnitPriceTax":0.0,"UnitPricePrecision":2.0,"UnitPriceIsTaxInclusive":false,"TaxGroupId":"00000000-0000-0000-0000-000000000000","TaxIsModified":false,"TaxAmount":null,"AmountExTax":10.0000}],"Notes":null,"Reference":null,"Status":2,"Supplier":{"ContactId":"b09da867-1e2c-48e3-a9db-dd21b427a6bb","CashbookId":"e17417ac-fc79-4d4d-9ee8-1780b3bc326f","PaymentTermId":null,"CustomerCreditLimit":null,"Description":"City Rail","FirstNameBranchName":"Sydney","SurnameBusinessName":"City Rail Corp","IsCustomer":false,"IsSupplier":true,"IsActive":true,"IsPerson":false,"IsTpar":true,"Email":"scott.montgomerie@reckon.com","Website":"www.reckon.com","BusinessNumber1":"14003348730","Notes":"Test notes for City Rail Corp","AreaCode":"02","PhoneNumber":"12345678","FaxCode":"02","FaxNumber":"87654321","MobileCode":null,"MobileNumber":null,"IsBusinessAddressDifferent":true,"IsEmployee":false,"Addresses":[{"AddressId":"aba3aaa9-3d21-4536-84cc-6c95a3cf48b0","Line1":"Level 12","Line2":"3 Main Rd","Line3":"","Town":null,"Suburb":"Sydney","State":"SA","Postcode":"2001","Country":null,"AddressType":"Business","IsInternational":false},{"AddressId":"953e1fda-e770-4360-a299-07ee5a54e53a","Line1":"Ground Floor","Line2":"1 Test St","Line3":"","Town":null,"Suburb":"Test","State":"SA","Postcode":"2000","Country":null,"AddressType":"Postal","IsInternational":false}]},"SupplierCreditNoteAmount":10.0000,"SupplierCreditNoteDate":"2015-06-03T00:00:00","SupplierCreditNoteNumber":"SAN0005","SupplierCreditNoteSourceId":"00000000-0000-0000-0000-000000000000","SupplierId":"b09da867-1e2c-48e3-a9db-dd21b427a6bb","SupplierName":"City Rail","Tax":0.0000,"TemplateId":"7984e6da-6f60-40a6-a667-70f0e645acc1"}

400 Bad Request

You will get this response if the transaction id that you are requesting is invalid

401 Unauthorized

You will get this response if you the user is not authorised to get the transaction they are requesting, or the token you are sending is expired

Code samples

@ECHO OFF

curl -v -X GET "https://api.reckon.com/R1/{cashbookid}/suppliercreditnotes/{supplierCreditNoteId}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

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


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            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}/suppliercreditnotes/{supplierCreditNoteId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            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.reckon.com/R1/{cashbookid}/suppliercreditnotes/{supplierCreditNoteId}";
    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 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}/suppliercreditnotes/{supplierCreditNoteId}');
$url = $request->getUrl();

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

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

params = urllib.urlencode({
})

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

params = urllib.parse.urlencode({
})

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

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# 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