Table of Contents

Books

Overview

Reckon One API v2 is now available.
Books API v2 endpoints provides you with more information about your books. You can also obtain the details of a single book by providing the Id.

Retrieve a list of cashbook IDs that a user (username) can access. The cashbook ID is required in all API call URLs (excluding heartbeat). There is no body required as the user will be matched with their allowed books via our identity server.

 

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Request URL

API Portal Link

Countries

 

  • Cashbooks (v1)
  • Books (v2)
  •  bookId (v2) - Optional

GET

  • API v1: https://api.reckon.com/R1/cashbooks
  • API v2: https://api.reckon.com/r1/v2/books

AU/NZ/UK

 

Books can be shared with users across regions/countries so it's common for developers to support all the countries.

To use a demo book in your testing (recommended) you should open the demo book and copy the book's GUID and use this in your Postman collection / testing. If you get "Invalid BookID" error, please email the Support team at apisupport@reckon.com.

 

Sample response

API v1
{
"BookId": "13bcd0f5-5066-4892-9b9a-b565555d25435",
"BookName": "Rental Property",
"Bookstatus": 3,
"Country": "AU"
}

  

Details

Data Field

Description

Data Type

BookId

The unique ID of the Reckon One Book

GUID

BookName

The name of the Book

Alphanumeric

Bookstatus

 

 

The status of active books.

Demo books are not currently returned with GET Cashbooks/Books endpoint.

If the book is deactived (cancelled) they are not accessible via the API.
  • -1 = Unknown
  • 0 = Demo
  • 1 = Trial
  • 2 = New
  • 3 = Active ** Active book that I own
  • 4 = InActive
  • 5 = Deleted
  • 6 = Expired
  • 7 = Trial Expired
  • 8 = Shared ** Active book that is shared with me
  • 9 = CanOpen

Country

 

 

The Country of the Book

Set data types:

  • AU – Australia
  • NZ – New Zealand
  • GB – Great Britain / United Kingdom

 


API v2
{
    "list": [{
        "id": "5c933c97-e9bf-427c-a2b5-a4ddd539d575",
        "name": "My book",
        "status": "Active",
        "ownership": "Owned",
        "country": "AU",
        "bookCreated": true,
        "products": [{
            "id": "7445ce22-d894-4fe4-88ee-ed96862939ca",
            "name": "InvoicingMedium",
            "portalProductId": "CICL0UD1M"
        }]
    }]
}

Details

Find out the details from here.

How did we do?

Heartbeat

Company Info

Related Articles

Books API v2
Closing Your Books
Integrating with IPA Books+
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)