Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets the line item details of a bank payment.

Get a line item of a bank payment.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/banking/bankpayments/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2/lineitems/9e70f78c-5892-4ffa-ab17-6c1698f2098f

Get just the required fields, e.g. id and reference. Find out more about selecting.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/banking/bankpayments/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2/lineitems/9e70f78c-5892-4ffa-ab17-6c1698f2098f?select=id,reference

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • string

    Format - guid. The bank payment's id

  • string

    Format - guid. The bank payment's line item id.

Request headers

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

Request body

Responses

200 OK

The requested bank payment line item detail.

Representations

{
  "lineId": "9fa81eaa-d5e9-4bdb-8079-e29acfcf35f0",
  "paymentId": "2289ceec-6cb6-46e1-aa21-1d3c3b105971",
  "entity": {
    "id": "247c6bd2-ee8d-4f61-a050-a1267a5804c8",
    "name": "ACME",
    "entityTypes": {
      "isCustomer": false,
      "isSupplier": true,
      "isEmployee": false,
      "isSuperfund": false
    }
  },
  "entityBankAccountDetails": {
    "bankBranchNumber": "124987",
    "bankAccountNumber": "320033245407"
  },
  "payableType": "PayrollPayable",
  "lodgementReference": "5550033890123456",
  "amount": 499.99,
  "transactionLinks": [
    {
      "linkId": "EST-8cc23593-4790-4f56-b2a1-92396b3f2aaf",
      "transactionType": "Estimate",
      "transactionId": "8cc23593-4790-4f56-b2a1-92396b3f2aaf",
      "transactionNumber": "EST0028",
      "transactionDate": "2020-02-06T12:00:00Z",
      "transactionReference": "Ref 1234",
      "transactionAmount": 1000.0,
      "href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/estimates/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "lineId": {
      "type": "string",
      "description": "The bank payment line item's unique id.",
      "format": "guid",
      "example": "9fa81eaa-d5e9-4bdb-8079-e29acfcf35f0"
    },
    "paymentId": {
      "type": "string",
      "description": "Id of linked transaction.",
      "format": "guid",
      "example": "2289ceec-6cb6-46e1-aa21-1d3c3b105971"
    },
    "entity": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique id.",
              "format": "guid",
              "nullable": true
            },
            "name": {
              "type": "string",
              "description": "The unique name.",
              "nullable": true
            },
            "entityTypes": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "isCustomer": {
                      "type": "boolean",
                      "description": "Is the entity a customer.",
                      "default": false,
                      "nullable": true,
                      "example": false
                    },
                    "isSupplier": {
                      "type": "boolean",
                      "description": "Is the entity a suppleir.",
                      "default": false,
                      "nullable": true,
                      "example": false
                    },
                    "isEmployee": {
                      "type": "boolean",
                      "description": "Is the entity an employee.",
                      "default": false,
                      "nullable": true,
                      "example": false
                    },
                    "isSuperfund": {
                      "type": "boolean",
                      "description": "Is the entity a superfund.",
                      "default": false,
                      "nullable": true,
                      "example": false
                    }
                  },
                  "additionalProperties": false,
                  "description": "Contact's entity types."
                }
              ],
              "description": "Organisation entity types.",
              "nullable": true
            }
          },
          "additionalProperties": false,
          "description": "Link to an organisation with type informaton."
        }
      ],
      "description": "Entity with whom the transaction has occurred.",
      "nullable": true,
      "example": {
        "id": "247c6bd2-ee8d-4f61-a050-a1267a5804c8",
        "name": "ACME",
        "entityTypes": {
          "isCustomer": false,
          "isSupplier": true,
          "isEmployee": false,
          "isSuperfund": false
        }
      }
    },
    "entityBankAccountDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "bankBranchNumber": {
              "type": "string",
              "description": "Bank's branch number (BSB).",
              "nullable": true,
              "example": "124987"
            },
            "bankAccountNumber": {
              "type": "string",
              "description": "Bank's account number.",
              "nullable": true,
              "example": "320033245407"
            }
          },
          "additionalProperties": false,
          "description": "Bank account details of entity."
        }
      ],
      "description": "Details of entities bank account.",
      "nullable": true
    },
    "payableType": {
      "oneOf": [
        {
          "enum": [
            "None",
            "PayrollPayable",
            "AccountsPayable",
            "SuperPayable"
          ],
          "type": "string",
          "description": "Type of payable transaction.",
          "x-enumNames": [
            "None",
            "PayrollPayable",
            "AccountsPayable",
            "SuperPayable"
          ]
        }
      ],
      "description": "The type of payable.",
      "example": "PayrollPayable"
    },
    "lodgementReference": {
      "type": "string",
      "description": "Transaction reference.",
      "nullable": true,
      "example": "5550033890123456"
    },
    "amount": {
      "type": "number",
      "description": "Amount of the transaction.",
      "format": "decimal",
      "example": 499.99
    },
    "transactionLinks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "linkId": {
            "type": "string",
            "description": "The link's unique id.",
            "example": "EST-8cc23593-4790-4f56-b2a1-92396b3f2aaf"
          },
          "transactionType": {
            "oneOf": [
              {
                "enum": [
                  "Estimate",
                  "Expense",
                  "Timesheet",
                  "Receipt",
                  "CreditNote",
                  "Payment",
                  "Invoice",
                  "Journal",
                  "Bill",
                  "PayRun",
                  "ReversedJournal",
                  "ReversalJournal",
                  "BankPayment",
                  "SupplierCreditNote"
                ],
                "type": "string",
                "description": "Type of transaction linked to an invoice or bill.",
                "x-enumNames": [
                  "Estimate",
                  "Expense",
                  "Timesheet",
                  "Receipt",
                  "CreditNote",
                  "Payment",
                  "Invoice",
                  "Journal",
                  "Bill",
                  "PayRun",
                  "ReversedJournal",
                  "ReversalJournal",
                  "BankPayment",
                  "SupplierCreditNote"
                ]
              }
            ],
            "description": "The type of linked transaction.",
            "example": "Estimate"
          },
          "transactionId": {
            "type": "string",
            "description": "The unique id of the linked transaction.",
            "format": "guid",
            "example": "8cc23593-4790-4f56-b2a1-92396b3f2aaf"
          },
          "transactionNumber": {
            "type": "string",
            "description": "The transaction number of the linked transaction.",
            "nullable": true,
            "example": "EST0028"
          },
          "transactionDate": {
            "type": "string",
            "description": "The transaction's date.",
            "format": "date-time",
            "nullable": true,
            "example": "2020-02-06T12:00:00Z"
          },
          "transactionReference": {
            "type": "string",
            "description": "The transaction's reference.",
            "nullable": true,
            "example": "Ref 1234"
          },
          "transactionAmount": {
            "type": "number",
            "description": "The total amount of the transaction. ",
            "format": "decimal",
            "nullable": true,
            "example": 1000.0
          },
          "href": {
            "type": "string",
            "description": "The URL to use to retrieve the linked transaction.",
            "nullable": true,
            "example": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/estimates/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
          }
        },
        "additionalProperties": false,
        "description": "A transaction linked to another transaction."
      },
      "description": "Details of transactions (e.g. Payments) that are linked to the bank payment.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Details of transaction included in a bank payment."
}

401 Unauthorized

The authentication token is missing, expired or invalid.

Representations

{
  "message": "Authorization has been denied for this request.",
  "code": 401
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "Authorization has been denied for this request."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 401
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 401 Unauthorized error occurs."
}

403 Forbidden

The user does not have permission to retrieve the bank payment line item .

Representations

{
  "message": "User does not have permission to access this resource.",
  "code": 403
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "User does not have permission to access this resource."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 403
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 403 Forbidden error occurs."
}

404 Not Found

The specified book or bank payment line item does not exist.

Representations

{
  "message": "Resource not found.",
  "code": 404
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "Resource not found."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 404
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 404 Forbidden error occurs."
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.reckon.com/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}"
-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.reckon.com/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}?" + 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/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}");


            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.reckon.com/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}?" + $.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.reckon.com/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}";
    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.reckon.com/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}');
$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.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}?%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.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}?%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/v2/{bookId}/banking/bankpayments/{bankPaymentId}/lineitems/{lineItemId}')

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