Endpoints Overview
Supported Endpoints and Methods
Reckon One Module | Endpoint | Additional Parameter(s) | HTTP Method | Description | API Portal | Countries |
|
| GET | Ping this endpoint to determine if the service is available. No cashbook ID is required | AU/NZ/UK | ||
|
| 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) | AU/NZ/UK | ||
Core |
| GET | Allows you to read the company information of the book you have requested API data from | AU/NZ/UK | ||
Core | /effectiveDate | GET | Read the list of tax groups from a book. Tax groups are required for endpoints such as accounts and items | AU/NZ/UK | ||
Core |
| GET | Read the list of classifications from a book. | AU/NZ/UK | ||
Core | /templateType | GET | Retrieve the template list | AU/NZ/UK | ||
Core |
| GET | Retrieve the chart of accounts list | AU/NZ/UK | ||
Core |
| PUT | Update a general ledger account from the book's chart of accounts | AU/NZ/UK | ||
Core |
| POST | Create a general ledger account in the book's chart of accounts | AU/NZ/UK | ||
Core | /accountId | DELETE | Delete a general ledger account in the book's chart of accounts | AU/NZ/UK | ||
Core |
| GET | Retrieve the list of bank accounts as per the chart of accounts UI | AU/NZ/UK | ||
Core | /bankaccounts | POST | Post a new bank account to the Reckon One book | AU/NZ/UK | ||
Core | /contactId | GET | Retrieve information about a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund | AU/NZ/UK | ||
Core | /contactId /activate | POST | Activate a contact | AU/NZ/UK | ||
Core | /contactId /deactivate | POST | Deactivate a contact | AU/NZ/UK | ||
Core |
| GET | Retrieve contacts list | AU/NZ/UK | ||
Core |
| PUT | Update a contact | AU/NZ/UK | ||
Core |
| POST | Create a contact | AU/NZ/UK | ||
Core | /contactId | DELETE | Delete a contact | AU/NZ/UK | ||
Core |
| GET | Retrieve a list of items | AU/NZ/UK | ||
Core |
| PUT | Update an item | AU/NZ/UK | ||
Core |
| POST | Create an item | AU/NZ/UK | ||
Core | /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 | AU/NZ/UK | ||
Core | /journalId | GET | Retrieve a specific journal using its unique ID | AU/NZ/UK | ||
Core |
| GET | Retrieve the list of journals | AU/NZ/UK | ||
Core |
| PUT | Update a journal | AU/NZ/UK | ||
Core |
| POST | Create a journal | AU/NZ/UK | ||
Core | /journalId | DELETE | Delete a specific journal | AU/NZ/UK | ||
Core |
| POST | Create a bank transfer | Portal | AU/NZ/UK | |
Core |
| GET | Retrieve a list of payments (money out) | AU/NZ/UK | ||
Core |
| PUT | Update an existing payment (money out) | AU/NZ/UK | ||
Core |
| POST | Create a payment (money out) | AU/NZ/UK | ||
Core | /receipts | GET | Retrieve a list of receipts (money in) | AU/NZ/UK | ||
Core | /receipts | POST | Create a receipt (money in) | AU/NZ/UK | ||
Core | /receipts | PUT | Allocate a receipt (money in) to an invoice |
| AU/NZ/UK | |
Core |
| GET | Retrieve a list of activity statements | AU/NZ/UK | ||
Core | /gstReportId | GET | Allows you to retrieve detailed information from a single activity statement by sending its ID to the API endpoint | AU | ||
Estimates | /estimates | GET | Allows you to retrieve a list of estimates from the Reckon One Book | AU/NZ/UK | ||
Estimates | /estimates | POST | Allows you to post a estimate to the Reckon One book | AU/NZ/UK | ||
Estimates | /estimates/{estimateId} | GET | Allows you to retrieve a single estimate via the unique GUID of the transaction | AU/NZ/UK | ||
Estimates | /estimates/{estimateId} | DELETE | Allows you to delete a single estimate via the unique GUID of the transaction | AU/NZ/UK | ||
Invoices | /invoiceId | GET | Retrieve an invoice by its unique ID. More information is returned to you when you search for an invoice by ID. | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the list of [customer] invoices | AU/NZ/UK | ||
Invoices |
| POST | Create a [customer] invoice | AU/NZ/UK | ||
Invoices | /invoiceId /approve | POST | Approve a [customer] invoice in a book. Only required if the invoices module level is 'medium' | AU/NZ/UK | ||
Invoices |
| DELETE | Delete a [customer] invoice | AU/NZ/UK | ||
Invoices | /creditNoteId | GET | Retrieve credit notes (invoice adjustments) by their unique ID | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the credit notes (invoice adjustments) listing | AU/NZ/UK | ||
Invoices |
| POST | Create credit notes (invoice adjustments) | AU/NZ/UK | ||
Invoices | /allocations /applyCredit | POST | Apply a credit note to a customer invoice | AU/NZ/UK | ||
Invoices | /billId | GET | Allows you to retrieve a single bill by its unique ID | AU/NZ/UK | ||
Invoices | /billId /approve | POST | Approve a bill by its unique ID | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the list of the [supplier] bills | AU/NZ/UK | ||
Invoices |
| POST | Create a [supplier] bill | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the list of supplier credit notes | AU/NZ/UK | ||
Invoices |
| POST | Post a supplier credit note | AU/NZ/UK | ||
Invoices | /suppliercreditnoteid | DELETE | Delete a supplier credit note | AU/NZ/UK | ||
Invoices |
| GET | Retrieve the list of customer payments terms | AU/NZ/UK | ||
Projects |
| GET | Retrieve the list of projects | AU/NZ/UK | ||
Projects |
| POST | Create a project | AU/NZ/UK | ||
Time and Expenses | /entry /timesheetEntryId | GET | Retrieve a specific timesheet by its ID | AU/NZ/UK | ||
Time and Expenses | /summary /employeeId | GET | Retrieve the an employees timesheets by employee ID | AU/NZ/UK | ||
Time and Expenses | /week /employeeId /startDate | GET | Retrieve a timesheet list for a specific employee ID with a specific starting date | AU/NZ/UK | ||
Time and Expenses | /employee | GET | Retrieve a list of the employees who have timesheets | AU/NZ/UK | ||
Time and Expenses | /entry | GET | Retrieve the timesheets list within the book with more details than the summary endpoint | AU/NZ/UK | ||
Time and Expenses | /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 | AU/NZ/UK | ||
Time and Expenses |
| PUT | Update an existing timesheet entry | AU/NZ/UK | ||
Time and Expenses |
| POST | Create a timesheet for a single day | AU/NZ/UK | ||
Time and Expenses | /week | POST | Create a timesheet for a week | AU/NZ/UK | ||
Time and Expenses | /timesheetID | DELETE | Delete a timesheet using a timesheet ID | AU/NZ/UK | ||
Time and Expenses | /expenseclaims | GET | Get a list of the expense claims in the book | AU/NZ/UK | ||
Time and Expenses | /expenseclaims/{id} | GET | Get a specific expense claim from the book returned with additional data | AU/NZ/UK | ||
Time and Expenses | /expenseclaims | POST | Post an expense claim to the book | AU/NZ/UK |
Reports Endpoints
Reckon One Module | Endpoint | Endpoint Parameter(s) | HTTP Method | Description | Release Version | API Portal | Countries |
Core | /accountEnquiry /false | POST | Retrieve all transactions from the book based on the parameters specified in the POST request |
| AU/NZ/UK | ||
Core | /profitLoss | POST | Retrieve the profit and loss report from the book based on the parameters specified in the POST request | 1.8 | AU/NZ/UK | ||
Core | /balanceSheet | POST | Retrieve the balance sheet report from the book based on the parameters specified in the POST request | 1.10 | AU/NZ/UK | ||
Core | /trialbalance | POST | Retrieve the trial balance report from a book based on the parameters specified in the POST request | 1.9 | AU/NZ/UK |
