Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a line item from an invoice.

Get a line item from an invoice.

`GET /5af6572c-9771-4b86-995d-3374d3bc683c/invoices/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2/lineitems/55bc4aef-1492-459e-8fe4-a947c490fe09

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/invoices/b696b9f5-e1e7-41f1-9f44-fa047e5e9ad2/lineitems/55bc4aef-1492-459e-8fe4-a947c490fe09?select=lineid,description

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • string

    Format - guid. The invoice's id.

  • string

    Format - guid. The line item's id.

Request headers

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

Request body

Responses

200 OK

The line item.

Representations

{
  "lineNumber": 1,
  "lineId": "d2dbe1ff-5c32-4ee3-b333-643aae358338",
  "parentLineId": "80d4e5f5-6f4f-4be6-9f5a-15790f8ad402",
  "serviceDate": "2020-01-01T12:00:00Z",
  "project": {
    "id": "40f4ab48-4be1-4b47-842a-dc9b3973b3fd",
    "name": "Project A:Project B"
  },
  "itemDetails": {
    "item": {
      "id": "fae9eb95-6878-442a-8f33-950b59420380",
      "name": "Parent item:Child item"
    },
    "price": 5.5,
    "quantity": 1.0,
    "discountAmount": 10.0,
    "discountPercent": 25.0
  },
  "accountDetails": {
    "ledgerAccount": {
      "id": "9e59aeeb-d5b4-4e4d-bed7-22bf68cd5f32",
      "name": "Expenses:Accounting Fees"
    },
    "quantity": 1.0,
    "amount": 110.0
  },
  "description": "My item",
  "taxRate": {
    "id": "2d276d3a-85cb-4ae3-b23c-cfcdb26510b8",
    "name": "GST",
    "percent": 10
  },
  "taxAmount": 10.0,
  "taxIsModified": false,
  "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": {
    "lineNumber": {
      "type": "integer",
      "description": "The line number.",
      "format": "int32",
      "example": 1
    },
    "lineId": {
      "type": "string",
      "description": "The line item's unique id.",
      "format": "guid",
      "example": "d2dbe1ff-5c32-4ee3-b333-643aae358338"
    },
    "parentLineId": {
      "type": "string",
      "description": "The parent line item's unique id.",
      "format": "guid",
      "nullable": true,
      "example": "80d4e5f5-6f4f-4be6-9f5a-15790f8ad402"
    },
    "serviceDate": {
      "type": "string",
      "description": "The date when the service was provided.",
      "format": "date-time",
      "nullable": true,
      "example": "2020-01-01T12:00:00Z"
    },
    "project": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique id.",
              "format": "guid",
              "nullable": true
            },
            "name": {
              "type": "string",
              "description": "The unique name.",
              "nullable": true
            }
          },
          "additionalProperties": false,
          "description": "Reference to a project.",
          "example": {
            "id": "40f4ab48-4be1-4b47-842a-dc9b3973b3fd",
            "name": "Project A:Project B"
          }
        }
      ],
      "description": "The id and full name of the project that the line item relates to.",
      "nullable": true,
      "example": {
        "id": "40f4ab48-4be1-4b47-842a-dc9b3973b3fd",
        "name": "Project A:Project B"
      }
    },
    "itemDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "item": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique id.",
                      "format": "guid",
                      "nullable": true
                    },
                    "name": {
                      "type": "string",
                      "description": "The unique name.",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false,
                  "description": "Reference to an item."
                }
              ],
              "description": "The id and full name of the item that the line relates to.",
              "example": {
                "id": "fae9eb95-6878-442a-8f33-950b59420380",
                "name": "Parent item:Child item"
              }
            },
            "price": {
              "type": "number",
              "description": "The price of each item.",
              "format": "decimal",
              "nullable": true,
              "example": 5.5
            },
            "quantity": {
              "type": "number",
              "description": "The quantity sold.",
              "format": "decimal",
              "nullable": true,
              "example": 1.0
            },
            "discountAmount": {
              "type": "number",
              "description": "The total discount for the line item.",
              "format": "decimal",
              "nullable": true,
              "example": 10.0
            },
            "discountPercent": {
              "type": "number",
              "description": "The discount percentage for the line item.",
              "format": "decimal",
              "nullable": true,
              "example": 25.0
            }
          },
          "additionalProperties": false,
          "description": "Details of an item used on an invoice line item."
        }
      ],
      "description": "Details of an item used on an invoice line item.",
      "nullable": true
    },
    "accountDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "ledgerAccount": {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique id.",
                      "format": "guid",
                      "nullable": true
                    },
                    "name": {
                      "type": "string",
                      "description": "The unique name.",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false,
                  "description": "Reference to a ledger account."
                }
              ],
              "description": "The id and full name of the ledger account that the line relates to.",
              "example": {
                "id": "9e59aeeb-d5b4-4e4d-bed7-22bf68cd5f32",
                "name": "Expenses:Accounting Fees"
              }
            },
            "quantity": {
              "type": "number",
              "description": "The quantity sold.",
              "format": "decimal",
              "nullable": true,
              "example": 1.0
            },
            "amount": {
              "type": "number",
              "description": "The amount.",
              "format": "decimal",
              "nullable": true,
              "example": 110.0
            }
          },
          "additionalProperties": false,
          "description": "Details of an account used on an invoice line item."
        }
      ],
      "description": "Details of an account used on an invoice line item.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "The description of the item.",
      "nullable": true,
      "example": "My item"
    },
    "taxRate": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique id.",
              "format": "guid",
              "nullable": true
            },
            "name": {
              "type": "string",
              "description": "The unique name.",
              "nullable": true
            },
            "percent": {
              "type": "number",
              "description": "Tax rate value as a percentage.",
              "format": "decimal"
            }
          },
          "additionalProperties": false,
          "description": "Reference to a tax rate."
        }
      ],
      "description": "The tax rate.",
      "nullable": true,
      "example": {
        "id": "2d276d3a-85cb-4ae3-b23c-cfcdb26510b8",
        "name": "GST",
        "percent": 10
      }
    },
    "taxAmount": {
      "type": "number",
      "description": "The tax amount.",
      "format": "decimal",
      "nullable": true,
      "example": 10.0
    },
    "taxIsModified": {
      "type": "boolean",
      "description": "Whether the tax amount has been modified.",
      "nullable": true,
      "example": false
    },
    "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. expenses and timesheets) that are linked to the invoice's line items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "An invoice line item."
}

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 invoice 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, invoice or 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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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}/invoices/{invoiceId}/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