Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Gets a list of time entries.

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

Get a paged list of time entries for the specified book.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries

Get a specific page of time entries. Find out more about paging.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?page=2&perpage=2

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?select=id,employee

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

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?filter=employee.name eq "Joe Bloggs"

Get the details of a single employee's time entries for a single day.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?filter=employee.id eq "d90ae40d-fe8c-4b77-8c75-aa5ad8351eed" and timeEntryDate eq "2021-10-19"

Get the details of multiple employees' time entries for a single day.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?filter=employee.id in ("d90ae40d-fe8c-4b77-8c75-aa5ad8351eed","61cf7acb-4519-4718-b1ed-1857ca9cc070") and timeEntryDate eq "2021-10-19"

Get the details of a single employee's time entries for a week.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?filter=employee.id eq "d90ae40d-fe8c-4b77-8c75-aa5ad8351eed" and timeEntryDate ge "2021-10-01" and timeEntryDate le "2021-10-07"

Sort in the required order, e.g. by time entry date and then by approval status. Find out more about sorting.

GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/timeentries?orderby=timeEntryDate, approvalStatus 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 time entries 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 time entries for the specified book.

Representations

{
  "list": [
    {
      "id": "c826f62a-bc45-40b9-af01-2ce6f3a8f23f",
      "employee": {
        "id": "1e6b6a42-263c-430c-93cd-bf95bd078021",
        "name": "Joe Bloggs"
      },
      "timeEntryDate": "2021-10-01T12:00:00Z",
      "project": {
        "id": "d3d31928-c98d-4aca-9295-61570c1e420d",
        "name": "Project A"
      },
      "customer": {
        "id": "675c9d07-128b-4818-be32-d6023d8baa9f",
        "name": "Customer A"
      },
      "classification": {
        "id": "3068a717-fbdb-4dc6-add3-038e37f8b46b",
        "name": "Classification A"
      },
      "billable": true,
      "billableStatus": "Unbilled",
      "approvalStatus": "Approved",
      "declineReason": "Project is missing.",
      "item": {
        "id": "1a9a5ed7-80a4-441f-93e8-6c5eb22635bc",
        "name": "Service A"
      },
      "payrollItem": {
        "id": "d5b84ae8-4d1e-4822-9b21-019184660c94",
        "name": "Standard hours"
      },
      "time": {
        "startTime": "08:00",
        "endTime": "12:00",
        "duration": 240
      },
      "notes": "Notes about my time.",
      "transactionLinks": [
        {
          "linkId": "INV-8cc23593-4790-4f56-b2a1-92396b3f2aaf",
          "transactionType": "Invoice",
          "transactionId": "8cc23593-4790-4f56-b2a1-92396b3f2aaf",
          "transactionNumber": "INV0028",
          "transactionDate": "2020-02-06",
          "transactionReference": "Ref 1234",
          "transactionAmount": 1000,
          "href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/invoices/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "list": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The time entry's id.",
            "format": "guid",
            "example": "c826f62a-bc45-40b9-af01-2ce6f3a8f23f"
          },
          "employee": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "The unique id.",
                    "format": "guid",
                    "nullable": true
                  },
                  "name": {
                    "type": "string",
                    "description": "The unique name.",
                    "nullable": true
                  },
                  "incompleteData": {
                    "type": "boolean",
                    "description": "The incomplete data flag.",
                    "example": "false"
                  }
                },
                "additionalProperties": false,
                "description": "Reference to an employee.",
                "example": {
                  "id": "f757807e-a294-494e-81c9-2b2bb9fa1d37",
                  "name": "Joe Bloggs"
                }
              }
            ],
            "description": "The employee.",
            "example": {
              "id": "1e6b6a42-263c-430c-93cd-bf95bd078021",
              "name": "Joe Bloggs"
            }
          },
          "timeEntryDate": {
            "type": "string",
            "description": "The date of the time entry.",
            "format": "date-time",
            "example": "2021-10-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 project.",
            "nullable": true,
            "example": {
              "id": "d3d31928-c98d-4aca-9295-61570c1e420d",
              "name": "Project A"
            }
          },
          "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": "Link to an organisation."
              }
            ],
            "description": "The customer.",
            "nullable": true,
            "example": {
              "id": "675c9d07-128b-4818-be32-d6023d8baa9f",
              "name": "Customer A"
            }
          },
          "classification": {
            "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 classification.",
                "example": {
                  "id": "9c533a04-8580-4513-ab12-129d99e53b5f",
                  "name": "My classification"
                }
              }
            ],
            "description": "The classification.",
            "nullable": true,
            "example": {
              "id": "3068a717-fbdb-4dc6-add3-038e37f8b46b",
              "name": "Classification A"
            }
          },
          "billable": {
            "type": "boolean",
            "description": "Whether the time entry is billable.",
            "example": true
          },
          "billableStatus": {
            "oneOf": [
              {
                "enum": [
                  "NonBillable",
                  "Unbilled",
                  "Invoiced",
                  "Billed"
                ],
                "type": "string",
                "description": "Time entry billable status.",
                "x-enumNames": [
                  "NonBillable",
                  "Unbilled",
                  "Invoiced",
                  "Billed"
                ]
              }
            ],
            "description": "The time entry's billable status.",
            "example": "Unbilled"
          },
          "approvalStatus": {
            "oneOf": [
              {
                "enum": [
                  "Draft",
                  "Submitted",
                  "Approved",
                  "Declined"
                ],
                "type": "string",
                "description": "Time entry approval status.",
                "x-enumNames": [
                  "Draft",
                  "Submitted",
                  "Approved",
                  "Declined"
                ]
              }
            ],
            "description": "The time entry's approval status.",
            "example": "Approved"
          },
          "declineReason": {
            "type": "string",
            "description": "The reason why a time entry has been declined.",
            "nullable": true,
            "example": "Project is missing."
          },
          "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.",
            "nullable": true,
            "example": {
              "id": "1a9a5ed7-80a4-441f-93e8-6c5eb22635bc",
              "name": "Service A"
            }
          },
          "payrollItem": {
            "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 payroll pay item.",
                "example": {
                  "id": "9c9456f7-c74c-4bd6-907d-7ffd9ad4acd9",
                  "name": "Annual leave"
                }
              }
            ],
            "description": "The payroll pay item.",
            "nullable": true,
            "example": {
              "id": "d5b84ae8-4d1e-4822-9b21-019184660c94",
              "name": "Standard hours"
            }
          },
          "time": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "startTime": {
                    "type": "string",
                    "description": "The start time.",
                    "format": "duration",
                    "nullable": true,
                    "example": "08:00"
                  },
                  "endTime": {
                    "type": "string",
                    "description": "The end time.",
                    "format": "duration",
                    "nullable": true,
                    "example": "12:00"
                  },
                  "duration": {
                    "type": "integer",
                    "description": "The duration in minutes.",
                    "format": "int32",
                    "example": 240
                  }
                },
                "additionalProperties": false,
                "description": "Time details for a time entry."
              }
            ],
            "description": "Details of the time."
          },
          "notes": {
            "type": "string",
            "description": "Notes.",
            "nullable": true,
            "example": "Notes about my time."
          },
          "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": "Transactions linked to the time entry.",
            "nullable": true,
            "example": [
              {
                "linkId": "INV-8cc23593-4790-4f56-b2a1-92396b3f2aaf",
                "transactionType": "Invoice",
                "transactionId": "8cc23593-4790-4f56-b2a1-92396b3f2aaf",
                "transactionNumber": "INV0028",
                "transactionDate": "2020-02-06",
                "transactionReference": "Ref 1234",
                "transactionAmount": 1000,
                "href": "/a5f4afcc-e50c-4780-909d-a9fffe16ba26/invoices/8cc23593-4790-4f56-b2a1-92396b3f2aaf"
              }
            ]
          }
        },
        "additionalProperties": false,
        "description": "A time entry."
      },
      "description": "The list of items.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "A list of time entries."
}

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 time entries.

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}/timeEntries?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}/timeEntries?" + 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}/timeEntries");

            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}/timeEntries?" + $.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}/timeEntries";
    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}/timeEntries');
$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}/timeEntries?%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}/timeEntries?%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}/timeEntries')

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