Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of projects.

See here for details of paging, filtering, sorting and selecting.

Get a paged list of projects for the specified book.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/projects

Get a specific page of projects. Find out more about paging.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/projects?page=3&perpage=15

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

GET /5af6572c-9771-4b86-995d-3374d3bc683c/projects?select=id,status

Filter the results to return just the projects you want. Find out more about filtering.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/projects?filter=startdate le "2020-03-31"

Sort in the required order, e.g. by project name and then by start date. Find out more about sorting.

GET /5af6572c-9771-4b86-995d-3374d3bc683c/projects?orderby=name,startdate desc

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • (optional)
    integer

    Format - int32. The page to retrieve.

  • (optional)
    integer

    Format - int32. The number of projects per page.

Request headers

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

Request body

Responses

200 OK

A paged list of projects for the specified book.

Representations

{
  "list": [
    {
      "id": "156871D3-DFDD-4C4D-9331-FD964AA73AB6",
      "name": "My Project",
      "fullName": "Parent Project/Child Project",
      "parentProject": {
        "id": "076A532A-47FA-4BB8-B91F-D3752B5CBD68",
        "name": "Parent Project"
      },
      "status": {},
      "startDate": "2020-01-01T12:00:00Z",
      "endDate": "2020-06-30T12:00:00Z",
      "description": "This is a description of the project.",
      "amountTaxStatus": "Inclusive",
      "customers": [
        {
          "lineId": "F08AE449-20E0-4B5D-B9A5-F032465A85A3",
          "customer": {
            "id": "fa900bde-b588-4088-be5f-63375f6a693f",
            "name": "Company Ltd"
          },
          "weighting": 50.0
        }
      ],
      "suppliers": [
        {
          "lineId": "F05D36E3-9CCD-4141-8074-D0540D0E5212",
          "supplier": {
            "id": "a7b9a76f-8e22-43f0-a569-46754b6b6a06",
            "name": "ACME"
          },
          "weighting": 75.5
        }
      ],
      "items": [
        {
          "lineId": "016821B8-BE1E-4215-AEB0-F413F2919C9A",
          "item": {
            "id": "fae9eb95-6878-442a-8f33-950b59420380",
            "name": "Item 1"
          },
          "description": "Some lumber.",
          "regularRate": 150.0,
          "projectRate": 175.0,
          "taxRate": {
            "id": "15D7ACE9-DD96-4BAC-8E74-BFA61797BE09",
            "name": "GST",
            "percent": 10
          }
        }
      ],
      "lastModifiedDateTime": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The project's unique id.",
            "format": "guid",
            "example": "156871D3-DFDD-4C4D-9331-FD964AA73AB6"
          },
          "name": {
            "type": "string",
            "description": "The project's name.",
            "example": "My Project"
          },
          "fullName": {
            "type": "string",
            "description": "The project's full name.",
            "example": "Parent Project/Child Project"
          },
          "parentProject": {
            "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 parent project.",
            "nullable": true,
            "example": {
              "id": "076A532A-47FA-4BB8-B91F-D3752B5CBD68",
              "name": "Parent Project"
            }
          },
          "status": {
            "oneOf": [
              {
                "enum": [
                  "Active",
                  "Inactive",
                  "Cancelled",
                  "Completed"
                ],
                "type": "string",
                "description": "The status of a project.",
                "x-enumNames": [
                  "Active",
                  "Inactive",
                  "Cancelled",
                  "Completed"
                ]
              }
            ],
            "description": "The projects status."
          },
          "startDate": {
            "type": "string",
            "description": "The date the project starts.",
            "format": "date-time",
            "nullable": true,
            "example": "2020-01-01T12:00:00Z"
          },
          "endDate": {
            "type": "string",
            "description": "The date the project ends.",
            "format": "date-time",
            "nullable": true,
            "example": "2020-06-30T12:00:00Z"
          },
          "description": {
            "type": "string",
            "description": "A description of the project.",
            "nullable": true,
            "example": "This is a description of the project."
          },
          "amountTaxStatus": {
            "oneOf": [
              {
                "enum": [
                  "Inclusive",
                  "Exclusive"
                ],
                "type": "string",
                "description": "The tax status of an item's amount.",
                "x-enumNames": [
                  "Inclusive",
                  "Exclusive"
                ]
              }
            ],
            "description": "The amount tax status of the amounts in the project.",
            "example": "Inclusive"
          },
          "customers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineId": {
                  "type": "string",
                  "description": "Record identifier.",
                  "format": "guid",
                  "example": "F08AE449-20E0-4B5D-B9A5-F032465A85A3"
                },
                "customer": {
                  "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 contact."
                    }
                  ],
                  "description": "The customer.",
                  "example": {
                    "id": "fa900bde-b588-4088-be5f-63375f6a693f",
                    "name": "Company Ltd"
                  }
                },
                "weighting": {
                  "type": "number",
                  "description": "Weighting.",
                  "format": "decimal",
                  "example": 50.0
                }
              },
              "additionalProperties": false,
              "description": "A customer linked to a project."
            },
            "description": "Customers linked to the project.",
            "nullable": true
          },
          "suppliers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineId": {
                  "type": "string",
                  "description": "Record identifier.",
                  "format": "guid",
                  "example": "F05D36E3-9CCD-4141-8074-D0540D0E5212"
                },
                "supplier": {
                  "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 contact."
                    }
                  ],
                  "description": "The supplier.",
                  "example": {
                    "id": "a7b9a76f-8e22-43f0-a569-46754b6b6a06",
                    "name": "ACME"
                  }
                },
                "weighting": {
                  "type": "number",
                  "description": "Weighting.",
                  "format": "decimal",
                  "example": 75.5
                }
              },
              "additionalProperties": false,
              "description": "A supplier linked to a project."
            },
            "description": "Suppliers linked to the project.",
            "nullable": true
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineId": {
                  "type": "string",
                  "description": "Record identifier.",
                  "format": "guid",
                  "example": "016821B8-BE1E-4215-AEB0-F413F2919C9A"
                },
                "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 item.",
                  "example": {
                    "id": "fae9eb95-6878-442a-8f33-950b59420380",
                    "name": "Item 1"
                  }
                },
                "description": {
                  "type": "string",
                  "description": "Description of the linked item.",
                  "nullable": true,
                  "example": "Some lumber."
                },
                "regularRate": {
                  "type": "number",
                  "description": "Rate at which item is usually charged.",
                  "format": "decimal",
                  "nullable": true,
                  "example": 150.0
                },
                "projectRate": {
                  "type": "number",
                  "description": "Rate at which item is charged for this project.",
                  "format": "decimal",
                  "nullable": true,
                  "example": 175.0
                },
                "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": "Tax rate of item.",
                  "nullable": true,
                  "example": {
                    "id": "15D7ACE9-DD96-4BAC-8E74-BFA61797BE09",
                    "name": "GST",
                    "percent": 10
                  }
                }
              },
              "additionalProperties": false,
              "description": "An item linked to a project."
            },
            "description": "Items used in the project.",
            "nullable": true
          },
          "lastModifiedDateTime": {
            "type": "string",
            "description": "Timestamp of when project record was last modified.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "A project"
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of projects."
}

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 projects.

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 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}/projects?page=1&perPage=0"
-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}");

            // Request parameters
            queryString["page"] = "1";
            queryString["perPage"] = "0";
            var uri = "https://api.reckon.com/r1/v2/{bookId}/projects?" + 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}/projects");

            builder.setParameter("page", "1");
            builder.setParameter("perPage", "0");

            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
            "page": "1",
            "perPage": "0",
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/projects?" + $.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}/projects";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"page=1",
                         @"perPage=0",
                      ];
    
    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}/projects');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'page' => '1',
    'perPage' => '0',
);

$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({
    # Request parameters
    'page': '1',
    'perPage': '0',
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/projects?%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({
    # Request parameters
    'page': '1',
    'perPage': '0',
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("GET", "/r1/v2/{bookId}/projects?%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}/projects')

query = URI.encode_www_form({
    # Request parameters
    'page' => '1',
    'perPage' => '0'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

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