Endpoints Overview

If you do not include a page limit the return is 50 by default. ie. https://api.reckon.com/r1/{cashbookid}/accounts will return 50 records maximum. This is due to the fact the Reckon One API did not have pagination in earlier versions, therefore we did not and could not enforce pagination in the later release. For more information see our Pagination help page
IPA Books+ uses the same baseURL and endpoints of Reckon One as it's the white labelled version of Reckon One. This will help you integrate with IPA Books+ easily.
Supported Endpoints and Methods

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Description

API Portal

Countries

 

Heartbeat

 

GET

Ping this endpoint to determine if the service is available. No cashbook ID is required

Portal

AU/NZ/UK

 

Books

 

GET

Retrieve a list of cashbook IDs that a user (username) can access. The cashbook ID is required in all API call URLs (excluding heartbeat)

Portal

AU/NZ/UK

Core

Company Info

 

GET

Allows you to read the company information of the book you have requested API data from

Portal

AU/NZ/UK

Core

Tax Groups

/effectiveDate

GET

Read the list of tax groups from a book. Tax groups are required for endpoints such as accounts and items

Portal

AU/NZ/UK

Core

Classifications

 

GET

Read the list of classifications from a book.

Portal

AU/NZ/UK

Core

Templates

/templateType

GET

Retrieve the template list

Portal

AU/NZ/UK

Core

Accounts

 

GET

Retrieve the chart of accounts list

Portal

AU/NZ/UK

Core

Accounts

 

PUT

Update a general ledger account from the book's chart of accounts

Portal

AU/NZ/UK

Core

Accounts

 

POST

Create a general ledger account in the book's chart of accounts 

Portal

AU/NZ/UK

Core

Accounts

/accountId

DELETE

Delete a general ledger account in the book's chart of accounts 

Portal

AU/NZ/UK

Core

Bank Accounts

 

GET

Retrieve the list of bank accounts as per the chart of accounts UI

Portal

AU/NZ/UK

Core

Bank Accounts

/bankaccounts

POST

Post a new bank account to the Reckon One book

Portal

AU/NZ/UK

Core

Contacts

/contactId

GET

Retrieve information about a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund

Portal

AU/NZ/UK

Core

Contacts

/contactId

/activate

POST

Activate a contact

Portal

AU/NZ/UK

Core

Contacts

/contactId

/deactivate

POST

Deactivate a contact

Portal

AU/NZ/UK

Core

Contacts

 

GET

Retrieve contacts list

Portal

AU/NZ/UK

Core

Contacts

 

PUT

Update a contact

Portal

AU/NZ/UK

Core

Contacts

 

POST

Create a contact

Portal

AU/NZ/UK

Core

Contacts

/contactId

DELETE

Delete a contact

Portal

AU/NZ/UK

Core

Items

 

GET

Retrieve a list of items

Portal

AU/NZ/UK

Core

Items

 

PUT

Update an item

Portal

AU/NZ/UK

Core

Items

 

POST

Create an item

Portal

AU/NZ/UK

Core

Items

/itemId

DELETE

Delete items. If the item is used on a transaction, those transactions will need to be deleted before you can delete the item

Portal

AU/NZ/UK

Core

Journals

/journalId

GET

Retrieve a specific journal using its unique ID

Portal

AU/NZ/UK

Core

Journals

 

GET

Retrieve the list of journals

Portal

AU/NZ/UK

Core

Journals

 

PUT

Update a journal

Portal

AU/NZ/UK

Core

Journals

 

POST

Create a journal

Portal

AU/NZ/UK

Core

Journals

/journalId

DELETE

Delete a specific journal

Portal

AU/NZ/UK

Core

Bank Transfer

 

POST

Create a bank transfer

Portal

AU/NZ/UK

Core

Payments

 

GET

Retrieve a list of payments (money out)

Portal

AU/NZ/UK

Core

Payments

 

PUT

Update an existing payment (money out)

Portal

AU/NZ/UK

Core

Payments

 

POST

Create a payment (money out)

Portal

AU/NZ/UK

Core

Receipts

/receipts

GET

Retrieve a list of receipts (money in)

Portal

AU/NZ/UK

Core

Receipts

/receipts

POST

Create a receipt (money in)

Portal

AU/NZ/UK

Core

Receipts

/receipts

PUT

Allocate a receipt (money in) to an invoice

 

AU/NZ/UK

Core

Activity Statements

 

GET

Retrieve a list of activity statements

Portal

AU/NZ/UK

Core

Activity Statements

/gstReportId

GET

Allows you to retrieve detailed information from a single activity statement by sending its ID to the API endpoint

Portal

AU

Estimates

Estimates

/estimates

GET

Allows you to retrieve a list of estimates from the Reckon One Book

Portal

AU/NZ/UK

Estimates

Estimates

/estimates

POST

Allows you to post a estimate to the Reckon One book

Portal

AU/NZ/UK

Estimates

Estimates

/estimates/{estimateId}

GET

Allows you to retrieve a single estimate via the unique GUID of the transaction

Portal

AU/NZ/UK

Estimates

Estimates

/estimates/{estimateId}

DELETE

Allows you to delete a single estimate via the unique GUID of the transaction

Portal

AU/NZ/UK

Invoices

Invoices

/invoiceId

GET

Retrieve an invoice by its unique ID. More information is returned to you when you search for an invoice by ID.

Portal

AU/NZ/UK

Invoices

Invoices

 

GET

Retrieve the list of [customer] invoices

Portal

AU/NZ/UK

Invoices

Invoices

 

POST

Create a [customer] invoice

Portal

AU/NZ/UK

Invoices

Invoices

/invoiceId

/approve

POST

Approve a [customer] invoice in a book. Only required if the invoices module level is 'medium'

Portal

AU/NZ/UK

Invoices

Invoices

 

DELETE

Delete a [customer] invoice

Portal

AU/NZ/UK

Invoices

Credit Notes

/creditNoteId

GET

Retrieve credit notes (invoice adjustments) by their unique ID

Portal

AU/NZ/UK

Invoices

Credit Notes

 

GET

Retrieve the credit notes (invoice adjustments) listing

Portal

AU/NZ/UK

Invoices

Credit Notes

 

POST

Create credit notes (invoice adjustments)

Portal

AU/NZ/UK

Invoices

Credit Notes

/allocations

/applyCredit

POST

Apply a credit note to a customer invoice

Portal

AU/NZ/UK

Invoices

Bills

/billId

GET

Allows you to retrieve a single bill by its unique ID

Portal

AU/NZ/UK

Invoices

Bills

/billId

/approve

POST

Approve a bill by its unique ID

Portal

AU/NZ/UK

Invoices

Bills

 

GET

Retrieve the list of the [supplier] bills

Portal

AU/NZ/UK

Invoices

Bills

 

POST

Create a [supplier] bill

Portal

AU/NZ/UK

Invoices

Supplier Credit Notes

 

GET

Retrieve the list of supplier credit notes

Portal

AU/NZ/UK

Invoices

Supplier Credit Notes

 

POST

Post a supplier credit note

Portal

AU/NZ/UK

Invoices

Supplier Credit Notes

/suppliercreditnoteid

DELETE

Delete a supplier credit note

Portal

AU/NZ/UK

Invoices

Terms

 

GET

Retrieve the list of customer payments terms

Portal

AU/NZ/UK

Projects

Projects

 

GET

Retrieve the list of projects

Portal

AU/NZ/UK

Projects

Projects

 

POST

Create a project

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/entry

/timesheetEntryId

GET

Retrieve a specific timesheet by its ID

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/summary

/employeeId

GET

Retrieve the an employees timesheets by employee ID

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/week

/employeeId

/startDate

GET

Retrieve a timesheet list for a specific employee ID with a specific starting date

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/employee

GET

Retrieve a list of the employees who have timesheets

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/entry

GET

Retrieve the timesheets list within the book with more details than the summary endpoint

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/summary

GET

Retrieve a summary of the timesheets within the book. The intention is to retrieve the ID of the timesheet to then be able to use that to gather further information via the /timesheetId service

Portal

AU/NZ/UK

Time and Expenses

Timesheets

 

PUT

Update an existing timesheet entry

Portal

AU/NZ/UK

Time and Expenses

Timesheets

 

POST

Create a timesheet for a single day

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/week

POST

Create a timesheet for a week

Portal

AU/NZ/UK

Time and Expenses

Timesheets

/timesheetID

DELETE

Delete a timesheet using a timesheet ID

Portal

AU/NZ/UK

Time and Expenses

Expenses

/expenseclaims

GET

Get a list of the expense claims in the book

Portal

AU/NZ/UK

Time and Expenses

Expenses

/expenseclaims/{id}

GET

Get a specific expense claim from the book returned with additional data

Portal

AU/NZ/UK

Time and Expenses

Expenses

/expenseclaims

POST

Post an expense claim to the book

Portal

AU/NZ/UK

 

 

 

Reports Endpoints

Reckon One Module

Endpoint

Endpoint Parameter(s)

HTTP Method

Description

Release Version

API Portal

Countries

Core

Reports

/accountEnquiry

/false

POST

Retrieve all transactions from the book based on the parameters specified in the POST request

 

Portal

AU/NZ/UK

Core

Reports

/profitLoss

POST

Retrieve the profit and loss report from the book based on the parameters specified in the POST request

1.8

Portal

AU/NZ/UK

Core

Reports

/balanceSheet

POST

Retrieve the balance sheet report from the book based on the parameters specified in the POST request

1.10

Portal

AU/NZ/UK

Core

Reports

/trialbalance

POST

Retrieve the trial balance report from a book based on the parameters specified in the POST request

1.9

Portal

AU/NZ/UK

 

 

How did we do?

Heartbeat

Related Articles

Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)