reckon.one
Module reckon.one
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_reckon.one_1.0.0.png)
ballerinax/reckon.one Ballerina library
Overview
This is a generated connector for Reckon One API v2 OpenAPI specification. Reckon One is a new generation, modular cloud accounting solution that scales with your business – perfect for startups. This is version 2 of the Reckon One API.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Reckon account
- Obtain tokens by following this guide
Quickstart
To use the Reckon One connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/reckon.one
module into the Ballerina project.
import ballerinax/reckon.one;
Step 2: Create a new connector instance
Create a one:ClientConfig
with the Bearer_Token
obtained, and initialize the connector with it.
one:ClientConfig clientConfig = { auth: { token: <Bearer_Token> } }; one:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to list books that the current user has access to, using the connector.
Gets a list of books that the current user has access to.
public function main() returns error? { one:Books response = check baseClient->getBooks(); log:printInfo(response.toString()); }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
reckon.one: Client![](/images/permalink.svg)
This is a generated connector for Reckon One API v2 OpenAPI specification. Reckon One is a new generation, modular cloud accounting solution that scales with your business – perfect for startups. This is version 2 of the Reckon One API.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Reckon account and obtain tokens by following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api-v2.reckonone.com/" - URL of the target service
getBooks![](/images/permalink.svg)
Gets a list of books that the current user has access to.
getBook![](/images/permalink.svg)
Gets details of the specified book.
Parameters
- bookId string - The book's id.
getCreditNotes![](/images/permalink.svg)
function getCreditNotes(string bookId, int page, int perPage) returns CreditNotes|error
Gets a list of credit notes.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of credit notes per page.
Return Type
- CreditNotes|error - A paged list of credit notes for the specified book.
getCreditNote![](/images/permalink.svg)
function getCreditNote(string bookId, string creditNoteId, string? format) returns CreditNote|error
Gets a credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- format string? (default ()) - The format to use, e.g. pdf.
Return Type
- CreditNote|error - The requested credit note.
updateCreditNote![](/images/permalink.svg)
function updateCreditNote(string bookId, string creditNoteId, CreditNoteInput payload) returns Response|error
Updates an existing credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- payload CreditNoteInput - Details of the updated credit note.
deleteCreditNote![](/images/permalink.svg)
Deletes an existing credit note.
patchCreditNote![](/images/permalink.svg)
function patchCreditNote(string bookId, string creditNoteId, CreditNotePatch payload) returns Response|error
Updates selected fields of an existing credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- payload CreditNotePatch - Details to update.
createCreditNote![](/images/permalink.svg)
function createCreditNote(string bookId, CreditNoteInput payload) returns IdResponse|error
Creates a new credit note.
Return Type
- IdResponse|error - The id of the credit note that has been created.
getCreditNoteLineItem![](/images/permalink.svg)
function getCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId) returns CreditNoteLineItem|error
Gets a line item from a credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- lineItemId string - The line item's id.
Return Type
- CreditNoteLineItem|error - The requested credit note line item.
updateCreditNoteLineItem![](/images/permalink.svg)
function updateCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId, CreditNoteLineItemInput payload) returns Response|error
Updates an existing credit note's line item.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- lineItemId string - The credit note line item's id.
- payload CreditNoteLineItemInput - Details of the updated credit note's line item.
deleteLineItem![](/images/permalink.svg)
function deleteLineItem(string bookId, string creditNoteId, string lineItemId) returns Response|error
Deletes an existing credit note line item.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- lineItemId string - The id of the line item to delete.
patchCreditNoteLineItem![](/images/permalink.svg)
function patchCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId, CreditNoteLineItemPatch payload) returns Response|error
Updates selected fields of an existing credit note's line item.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- lineItemId string - The credit note line item's id.
- payload CreditNoteLineItemPatch - Details to update.
addLineItemToCreditNote![](/images/permalink.svg)
function addLineItemToCreditNote(string bookId, string creditNoteId, CreditNoteLineItemInput payload) returns IdResponse|error
Creates a new line item within an existing credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- payload CreditNoteLineItemInput - Details of the new line item.
Return Type
- IdResponse|error - The id of the line item that has been created.
createCreditNoteTransactionLink![](/images/permalink.svg)
function createCreditNoteTransactionLink(string bookId, string creditNoteId, CreditNoteTransactionLinkInput payload) returns StringIdResponse|error
Creates a new transaction link.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- payload CreditNoteTransactionLinkInput - Details of the transaction to link.
Return Type
- StringIdResponse|error - The linked transaction's id.
unlinkTransaction![](/images/permalink.svg)
function unlinkTransaction(string bookId, string creditNoteId, string linkId) returns Response|error
Unlinks an existing transaction from a credit note.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- linkId string - The link's id.
patchCreditNoteTransactionLink![](/images/permalink.svg)
function patchCreditNoteTransactionLink(string bookId, string creditNoteId, string linkId, CreditNoteTransactionLinkPatch payload) returns Response|error
Updates selected fields of an existing credit note's linked transaction.
Parameters
- bookId string - The book's id.
- creditNoteId string - The credit note's id.
- linkId string - The linked transaction's id.
- payload CreditNoteTransactionLinkPatch - Details of the linked transaction to update.
getCustomers![](/images/permalink.svg)
Gets a list of customers.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of customers per page.
createCustomer![](/images/permalink.svg)
function createCustomer(string bookId, CustomerInput payload) returns IdNameResponse|error
Creates a new customer.
Return Type
- IdNameResponse|error - The id of the customer that has been created.
getCustomer![](/images/permalink.svg)
Gets a customer.
updateCustomer![](/images/permalink.svg)
function updateCustomer(string bookId, string customerId, CustomerInput payload) returns Response|error
Updates an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload CustomerInput - Details of the updated customer.
deleteCustomer![](/images/permalink.svg)
Deletes an existing customer.
patchCustomer![](/images/permalink.svg)
function patchCustomer(string bookId, string customerId, CustomerPatch payload) returns Response|error
Updates selected fields of an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload CustomerPatch - Details of the customer to change.
linkExistingContactToCustomer![](/images/permalink.svg)
function linkExistingContactToCustomer(string bookId, string customerId, string contactId) returns Response|error
Links an existing contact to a customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- contactId string - The contact's id to be linked to the customer.
unlinkCustomerLinkedContact![](/images/permalink.svg)
function unlinkCustomerLinkedContact(string bookId, string customerId, string contactId) returns Response|error
Unlinks a customer's linked contact.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- contactId string - The customer's linked contact's id.
addNewContactToCustomer![](/images/permalink.svg)
function addNewContactToCustomer(string bookId, string customerId, LinkedContactInput payload) returns IdResponse|error
Creates a new contact and links it to the customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload LinkedContactInput - Details of the new contact.
Return Type
- IdResponse|error - The id of the contact that has been created.
getCustomerLinkedContact![](/images/permalink.svg)
function getCustomerLinkedContact(string bookId, string customerId, string contactId) returns Contact|error
Gets a customer's linked Contact details.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- contactId string - The contact's id.
deleteContactFromCustomer![](/images/permalink.svg)
function deleteContactFromCustomer(string bookId, string customerId, string contactId) returns Response|error
Deletes a contact from a customer
Parameters
- bookId string - The book's id
- customerId string - The customer's id
- contactId string - The contact's id being deleted
getCustomerPhoneNumbers![](/images/permalink.svg)
function getCustomerPhoneNumbers(string bookId, string customerId) returns PhoneNumbers|error
Gets a customer's phone numbers.
Return Type
- PhoneNumbers|error - The requested customer's phone numbers.
createCustomerPhoneNumber![](/images/permalink.svg)
function createCustomerPhoneNumber(string bookId, string customerId, PhoneNumberInput payload) returns TypeResponse|error
Adds a new phone number to an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload PhoneNumberInput - The details of the phone number to add.
Return Type
- TypeResponse|error - The id and name of the phone number type that has been created.
getCustomerPhoneNumber![](/images/permalink.svg)
function getCustomerPhoneNumber(string bookId, string customerId, string 'type) returns PhoneNumber|error
Get a customer's phone number.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The phone number's type by name or id.
Return Type
- PhoneNumber|error - The customer's specific phone number.
updateCustomerPhoneNumber![](/images/permalink.svg)
function updateCustomerPhoneNumber(string bookId, string customerId, string 'type, UpdatePhoneNumberInput payload) returns Response|error
Updates a customer's phone number.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The phone number type by name or id.
- payload UpdatePhoneNumberInput - The phone number.
deleteCustomerPhoneNumber![](/images/permalink.svg)
function deleteCustomerPhoneNumber(string bookId, string customerId, string 'type) returns Response|error
Deletes an existing customer phone number.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The phone number's type by name or id.
patchCustomerPhoneNumber![](/images/permalink.svg)
function patchCustomerPhoneNumber(string bookId, string customerId, string 'type, PhoneNumberPatch payload) returns Response|error
Updates selected fields of an existing customer phone number.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The phone number's type by name or id.
- payload PhoneNumberPatch - Details of the phone number to change.
getCustomerAddresses![](/images/permalink.svg)
Gets a customer's addresses.
createCustomerAddress![](/images/permalink.svg)
function createCustomerAddress(string bookId, string customerId, AddressInput payload) returns TypeResponse|error
Adds a new address to an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload AddressInput - Details of the new address.
Return Type
- TypeResponse|error - The id of the address that has been created.
getCustomerAddress![](/images/permalink.svg)
Gets a customer's address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The address's type by name or id.
updateCustomerAddress![](/images/permalink.svg)
function updateCustomerAddress(string bookId, string customerId, string 'type, UpdateAddressInput payload) returns Response|error
Updates a customer's address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The address's type by name or id.
- payload UpdateAddressInput - The address.
deleteCustomerAddress![](/images/permalink.svg)
function deleteCustomerAddress(string bookId, string customerId, string 'type) returns Response|error
Deletes an existing customer address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The address's type by name or id.
patchCustomerAddress![](/images/permalink.svg)
function patchCustomerAddress(string bookId, string customerId, string 'type, AddressPatch payload) returns Response|error
Updates selected fields of an existing customer address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The address's type by name or id.
- payload AddressPatch - Details of the customer's address to change.
getCustomerElectronicAddress![](/images/permalink.svg)
function getCustomerElectronicAddress(string bookId, string customerId, string 'type) returns ElectronicAddress|error
Gets a customer's electronic address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The electronic address's type by name or id.
Return Type
- ElectronicAddress|error - The customer's specific electronic address.
updateCustomerElectronicAddress![](/images/permalink.svg)
function updateCustomerElectronicAddress(string bookId, string customerId, string 'type, UpdateElectronicAddressInput payload) returns Response|error
Updates a customer's electronic address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The electronic address's type by name or id.
- payload UpdateElectronicAddressInput - The electronic address.
deleteCustomerElectronicAddress![](/images/permalink.svg)
function deleteCustomerElectronicAddress(string bookId, string customerId, string 'type) returns Response|error
Deletes an existing customer electronic address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The electronic address's type by name or id.
patchCustomerElectronicAddress![](/images/permalink.svg)
function patchCustomerElectronicAddress(string bookId, string customerId, string 'type, ElectronicAddressPatch payload) returns Response|error
Updates selected fields of an existing customer electronic address.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- 'type string - The electronic address type by name or id.
- payload ElectronicAddressPatch - Details of the customer's electronic address to update.
getCustomerElectronicAddresses![](/images/permalink.svg)
function getCustomerElectronicAddresses(string bookId, string customerId) returns ElectronicAddresses|error
Gets a customer's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested customer's electronic addresses.
createCustomerElectronicAddress![](/images/permalink.svg)
function createCustomerElectronicAddress(string bookId, string customerId, ElectronicAddressInput payload) returns TypeResponse|error
Adds a new electronic address to an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload ElectronicAddressInput - The details of the electronic address to add.
Return Type
- TypeResponse|error - The id and name of the electronic address type that has been created.
getDepartments![](/images/permalink.svg)
function getDepartments(string bookId, int page, int perPage) returns Departments|error
Gets a list of departments.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of departments per page.
Return Type
- Departments|error - A paged list of departments for the specified book.
createDepartment![](/images/permalink.svg)
function createDepartment(string bookId, DepartmentInput payload) returns IdResponse|error
Creates a new department.
Return Type
- IdResponse|error - The id of the department that has been created.
getDepartment![](/images/permalink.svg)
function getDepartment(string bookId, string departmentId) returns Department|error
Gets a department.
Return Type
- Department|error - The requested department.
updateDepartment![](/images/permalink.svg)
function updateDepartment(string bookId, string departmentId, DepartmentInput payload) returns Response|error
Updates an existing department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- payload DepartmentInput - Details of the department.
deleteDepartment![](/images/permalink.svg)
Deletes an existing department.
patchDepartment![](/images/permalink.svg)
function patchDepartment(string bookId, string departmentId, DepartmentPatch payload) returns Response|error
Updates selected fields of an existing department.
Parameters
- bookId string - The book's id.
- departmentId string - The departments's id.
- payload DepartmentPatch - Details to update.
linkManagerToDepartment![](/images/permalink.svg)
function linkManagerToDepartment(string bookId, string departmentId, string employeeId) returns Response|error
Links a manager to a department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- employeeId string - The manager's id to be linked to the department.
unlinkDepartmentLinkedManager![](/images/permalink.svg)
function unlinkDepartmentLinkedManager(string bookId, string departmentId, string employeeId) returns Response|error
Unlinks a manager from a department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- employeeId string - The manager's id linked to the department.
linkEmployeeToDepartment![](/images/permalink.svg)
function linkEmployeeToDepartment(string bookId, string departmentId, string employeeId) returns Response|error
Links an employee to a department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- employeeId string - The employees id to be linked to the department.
unlinkDepartmentLinkedEmployee![](/images/permalink.svg)
function unlinkDepartmentLinkedEmployee(string bookId, string departmentId, string employeeId) returns Response|error
Unlinks an employee from a department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- employeeId string - The employees id linked to the department.
getPaymentMethods![](/images/permalink.svg)
function getPaymentMethods(string bookId) returns PaymentMethods|error
Gets a list of payment methods.
Parameters
- bookId string - The book's id.
Return Type
- PaymentMethods|error - A list of payment methods for the specified book.
getPayments![](/images/permalink.svg)
Get a list of payments.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of payments per page.
getPayment![](/images/permalink.svg)
Get a payment.
Parameters
- bookId string - The book's id.
- paymentId string - The payments id.
- format string? (default ()) - The format to use, e.g. pdf.
getUserPermissions![](/images/permalink.svg)
function getUserPermissions(string bookId) returns Permissions|error
Gets the current user's permissions.
Parameters
- bookId string - The book's id.
Return Type
- Permissions|error - An array of the current user's permissions.
getReceipts![](/images/permalink.svg)
Gets a list of receipts.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of receipts per page.
createReceipt![](/images/permalink.svg)
function createReceipt(string bookId, ReceiptInput payload) returns IdResponse|error
Creates a new receipt.
Return Type
- IdResponse|error - The id of the receipt that has been created.
getReceipt![](/images/permalink.svg)
Gets a receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- format string? (default ()) - The format to use, e.g. pdf.
updateReceipt![](/images/permalink.svg)
function updateReceipt(string bookId, string receiptId, ReceiptInput payload) returns Response|error
Updates an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- payload ReceiptInput - Details of the updated receipt.
deleteReceipt![](/images/permalink.svg)
Deletes an existing receipt.
patchReceipt![](/images/permalink.svg)
function patchReceipt(string bookId, string receiptId, ReceiptPatch payload) returns Response|error
Updates selected fields of an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- payload ReceiptPatch - Details of the receipt to update.
getReceiptLineItem![](/images/permalink.svg)
function getReceiptLineItem(string bookId, string receiptId, string lineItemId) returns ReceiptLineItem|error
Gets a line item from a receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- lineItemId string - The line item's id.
Return Type
- ReceiptLineItem|error - The line item.
updateReceiptLineItem![](/images/permalink.svg)
function updateReceiptLineItem(string bookId, string receiptId, string lineItemId, ReceiptLineItemInput payload) returns Response|error
Updates an existing line item within an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- lineItemId string - The line item's id.
- payload ReceiptLineItemInput - Details of the line item.
addLineItemToReceipt![](/images/permalink.svg)
function addLineItemToReceipt(string bookId, string receiptId, ReceiptLineItemInput payload) returns IdResponse|error
Creates a new line item within an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- payload ReceiptLineItemInput - Details of the new line item.
Return Type
- IdResponse|error - The id of the line item that has been created.
patchReceiptLineItem![](/images/permalink.svg)
function patchReceiptLineItem(string bookId, string receiptId, string lineItemId, ReceiptLineItemPatch payload) returns Response|error
Updates selected fields of an existing line item within an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- lineItemId string - The id of the line item to update.
- payload ReceiptLineItemPatch - Details to update.
deleteReceiptLineItem![](/images/permalink.svg)
function deleteReceiptLineItem(string bookId, string receiptId, string lineId) returns Response|error
Deletes an existing receipt's line item.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- lineId string - The receipt's line item id.
createReceiptTransactionLink![](/images/permalink.svg)
function createReceiptTransactionLink(string bookId, string receiptId, ReceiptTransactionLinkInput payload) returns StringIdResponse|error
Creates a new transaction link.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- payload ReceiptTransactionLinkInput - Details of the transaction to link.
Return Type
- StringIdResponse|error - The linked transaction's id.
deleteReceiptTransactionLink![](/images/permalink.svg)
function deleteReceiptTransactionLink(string bookId, string receiptId, string linkId) returns Response|error
Deletes an existing receipt's linked transaction.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- linkId string - The receipt's allocation link id.
patchReceiptTransactionLink![](/images/permalink.svg)
function patchReceiptTransactionLink(string bookId, string receiptId, string linkId, ReceiptTransactionLinkPatch payload) returns Response|error
Updates selected fields of an existing receipt's linked transaction.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- linkId string - The linked transaction's id.
- payload ReceiptTransactionLinkPatch - Details of the linked transaction to update.
getRoles![](/images/permalink.svg)
Gets a list of roles.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of roles per page.
getRole![](/images/permalink.svg)
Gets a role.
linkUserToRole![](/images/permalink.svg)
Links a user to a role.
Parameters
- bookId string - The book's id.
- roleId int - The role's id.
- userId string - The user's id to be linked to the role.
getSuperfundProviders![](/images/permalink.svg)
function getSuperfundProviders(string bookId, int page, int perPage) returns SuperfundProviders|error
Gets a list of super fund providers.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super fund providers per page.
Return Type
- SuperfundProviders|error - A paged list of super fund providers for the specified book.
getSuperfundProvidersHavingUsi![](/images/permalink.svg)
function getSuperfundProvidersHavingUsi(string bookId, string usi, int page, int perPage) returns SuperfundProviders|error
Gets a list of super fund providers having a product with the provided USI.
Parameters
- bookId string - The book Id.
- usi string - The USI of a fund product.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super fund providers having a product with the provided USI per page.
Return Type
- SuperfundProviders|error - A paged list of super fund providers having a product with the provided USI for the specified book.
getSuperfundProvider![](/images/permalink.svg)
function getSuperfundProvider(string bookId, string superfundProviderId) returns SuperfundProvider|error
Gets a super fund provider.
Return Type
- SuperfundProvider|error - The requested super fund provider.
getSuperfundProviderProducts![](/images/permalink.svg)
function getSuperfundProviderProducts(string bookId, string superfundProviderId, int page, int perPage) returns SuperfundProviderProducts|error
Gets a list of a super fund provider's products.
Parameters
- bookId string - The book's id.
- superfundProviderId string - The super fund provider's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super fund provider products per page.
Return Type
- SuperfundProviderProducts|error - A paged list of a super fund provider's products for the specified book.
getReports![](/images/permalink.svg)
Gets a list of reports.
Parameters
- bookId string - The book's id.
getPayrollLeaveBalancesAndAccrualValueReport2![](/images/permalink.svg)
function getPayrollLeaveBalancesAndAccrualValueReport2(string bookId, PayrollLeaveBalancesAndAccrualValueReportParameters payload, string? format) returns PayrollLeaveBalancesAndAccrualValueReport|error
Gets the payroll leave balances and accrual value report.
Parameters
- bookId string - The book's id.
- payload PayrollLeaveBalancesAndAccrualValueReportParameters - The report parameters.
- format string? (default ()) - The format to use, e.g. pdf.
Return Type
- PayrollLeaveBalancesAndAccrualValueReport|error - The report.
getSuppliers![](/images/permalink.svg)
Gets a list of suppliers.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of suppliers per page.
createSupplier![](/images/permalink.svg)
function createSupplier(string bookId, SupplierInput payload) returns IdNameResponse|error
Creates a new supplier.
Return Type
- IdNameResponse|error - The id of the supplier that has been created.
getSupplier![](/images/permalink.svg)
Gets a supplier.
updateSupplier![](/images/permalink.svg)
function updateSupplier(string bookId, string supplierId, SupplierInput payload) returns Response|error
Updates an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The suppliers's id.
- payload SupplierInput - Details of the updated supplier.
deleteSupplier![](/images/permalink.svg)
Deletes an existing supplier.
patchSupplier![](/images/permalink.svg)
function patchSupplier(string bookId, string supplierId, SupplierPatch payload) returns Response|error
Updates selected fields of an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- payload SupplierPatch - Details of the supplier to change.
getSupplierAddresses![](/images/permalink.svg)
Gets a supplier's addresses.
createSupplierAddress![](/images/permalink.svg)
function createSupplierAddress(string bookId, string supplierId, AddressInput payload) returns Response|error
Adds a new address to an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- payload AddressInput - The address.
getSupplierAddress![](/images/permalink.svg)
Gets a supplier's address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The type of address by name or id.
updateSupplierAddress![](/images/permalink.svg)
function updateSupplierAddress(string bookId, string supplierId, string 'type, UpdateAddressInput payload) returns Response|error
Updates an existing supplier address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The address type by name or id.
- payload UpdateAddressInput - The address.
deleteSupplierAddress![](/images/permalink.svg)
function deleteSupplierAddress(string bookId, string supplierId, string 'type) returns Response|error
Deletes an existing supplier address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The address's type by name or id.
patchSupplierAddress![](/images/permalink.svg)
function patchSupplierAddress(string bookId, string supplierId, string 'type, AddressPatch payload) returns Response|error
Updates selected fields of an existing supplier address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The address type by name or id.
- payload AddressPatch - Details of the supplier's address to change.
getSuppliersLinkedContacts![](/images/permalink.svg)
function getSuppliersLinkedContacts(string bookId, string supplierId, int page, int perPage) returns Contacts|error
Gets the supplier's linked contacts.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of supplier's contact per page.
addNewContactToSupplier![](/images/permalink.svg)
function addNewContactToSupplier(string bookId, string supplierId, LinkedContactInput payload) returns IdResponse|error
Creates a new contact and links it to the supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- payload LinkedContactInput - Details of the new contact.
Return Type
- IdResponse|error - The id of the contact that has been created.
getSuppliersLinkedContact![](/images/permalink.svg)
function getSuppliersLinkedContact(string bookId, string supplierId, string contactId) returns Contact|error
Gets a supplier's linked contact details.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- contactId string - The supplier's linked contact id.
linkExistingContactToSupplier![](/images/permalink.svg)
function linkExistingContactToSupplier(string bookId, string supplierId, string contactId) returns Response|error
Links an existing contact to a supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- contactId string - The contact's id to be linked to the supplier.
unlinkSupplierLinkedContact![](/images/permalink.svg)
function unlinkSupplierLinkedContact(string bookId, string supplierId, string contactId) returns Response|error
Unlinks a supplier's linked contact.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- contactId string - The supplier's linked contact's id.
getSupplierElectronicAddresses![](/images/permalink.svg)
function getSupplierElectronicAddresses(string bookId, string supplierId) returns ElectronicAddresses|error
Gets a supplier's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested supplier's electronic addresses.
createSupplierElectronicAddress![](/images/permalink.svg)
function createSupplierElectronicAddress(string bookId, string supplierId, ElectronicAddressInput payload) returns TypeResponse|error
Adds a new electronic address to an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- payload ElectronicAddressInput - The details of the electronic address to add.
Return Type
- TypeResponse|error - The id and name of the electronic address type that has been created.
getSupplierElectronicAddress![](/images/permalink.svg)
function getSupplierElectronicAddress(string bookId, string supplierId, string 'type) returns ElectronicAddress|error
Gets a supplier's electronic address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The electronic address type as either name or id.
Return Type
- ElectronicAddress|error - The supplier's requested electronic address.
updateSupplierElectronicAddress![](/images/permalink.svg)
function updateSupplierElectronicAddress(string bookId, string supplierId, string 'type, UpdateElectronicAddressInput payload) returns Response|error
Updates an existing supplier electronic address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The electronic address's type by name or id.
- payload UpdateElectronicAddressInput - Details of the supplier's electronic address to update.
deleteElectronicAddress![](/images/permalink.svg)
function deleteElectronicAddress(string bookId, string supplierId, string 'type) returns Response|error
Deletes an existing supplier's electronic address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The electronic address type's id or name.
patchSupplierElectronicAddress![](/images/permalink.svg)
function patchSupplierElectronicAddress(string bookId, string supplierId, string 'type, ElectronicAddressPatch payload) returns Response|error
Updates selected fields of an existing supplier electronic address.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The electronic address's type by name or id.
- payload ElectronicAddressPatch - Details of the supplier's electronic address to update.
getSupplierPhoneNumbers![](/images/permalink.svg)
function getSupplierPhoneNumbers(string bookId, string supplierId) returns PhoneNumbers|error
Gets a supplier's phone numbers.
Return Type
- PhoneNumbers|error - The requested supplier's phone numbers.
createSupplierPhoneNumber![](/images/permalink.svg)
function createSupplierPhoneNumber(string bookId, string supplierId, PhoneNumberInput payload) returns TypeResponse|error
Adds a new phone number to an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- payload PhoneNumberInput - Details of the phone number to add.
Return Type
- TypeResponse|error - The id and name of the phone number type that has been created.
getSupplierPhoneNumber![](/images/permalink.svg)
function getSupplierPhoneNumber(string bookId, string supplierId, string 'type) returns PhoneNumber|error
Get a supplier's phone number.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The phone number's type by name or id.
Return Type
- PhoneNumber|error - The supplier's specific phone number.
patchSupplierPhoneNumber![](/images/permalink.svg)
function patchSupplierPhoneNumber(string bookId, string supplierId, string 'type, PhoneNumberPatch payload) returns Response|error
Updates selected fields of an existing supplier phone number.
Parameters
- bookId string - The book's id.
- supplierId string - The supplier's id.
- 'type string - The phone number type by name or id.
- payload PhoneNumberPatch - Details of the phone number to change.
getSuperfunds![](/images/permalink.svg)
function getSuperfunds(string bookId, int page, int perPage) returns Superfunds|error
Gets a list of super funds.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
Return Type
- Superfunds|error - A paged list of super funds for the specified book.
createSuperfund![](/images/permalink.svg)
function createSuperfund(string bookId, SuperfundInput payload) returns IdNameResponse|error
Creates a new super fund.
Return Type
- IdNameResponse|error - The id of the super fund that has been created.
getSuperfund![](/images/permalink.svg)
Gets a super fund.
updateSuperfund![](/images/permalink.svg)
function updateSuperfund(string bookId, string superfundId, SuperfundInput payload) returns Response|error
Updates an existing super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload SuperfundInput - Details of the updated super fund.
deleteSuperfund![](/images/permalink.svg)
Deletes an existing super fund.
patchSuperfund![](/images/permalink.svg)
function patchSuperfund(string bookId, string superfundId, SuperfundPatch payload) returns Response|error
Updates selected fields of an existing super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload SuperfundPatch - Details of the updated super fund to change.
getSuperfundsLinkedContacts![](/images/permalink.svg)
function getSuperfundsLinkedContacts(string bookId, string superfundId, int page, int perPage) returns Contacts|error
Gets a super fund's linked contacts.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super fund's contact per page.
addNewContactToSuperfund![](/images/permalink.svg)
function addNewContactToSuperfund(string bookId, string superfundId, LinkedContactInput payload) returns IdResponse|error
Creates a new contact and links it to the super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload LinkedContactInput - Details of the new contact.
Return Type
- IdResponse|error - The id of the contact that has been created.
getSuperfundsLinkedContact![](/images/permalink.svg)
function getSuperfundsLinkedContact(string bookId, string superfundId, string contactId) returns Contact|error
Gets a super fund's linked contact.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- contactId string - The super fund's linked contact's id.
linkExistingContactToSuperfund![](/images/permalink.svg)
function linkExistingContactToSuperfund(string bookId, string superfundId, string contactId) returns Response|error
Links an existing contact to a specified super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- contactId string - The contact's id to be linked to the super fund.
unlinkSuperfundsLinkedContact![](/images/permalink.svg)
function unlinkSuperfundsLinkedContact(string bookId, string superfundId, string contactId) returns Response|error
Unlinks a specified super fund's linked contact from that super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- contactId string - The super fund's linked contact's id.
getSuperfundPhoneNumbers![](/images/permalink.svg)
function getSuperfundPhoneNumbers(string bookId, string superfundId) returns PhoneNumbers|error
Gets a super fund's phone numbers.
Return Type
- PhoneNumbers|error - The requested super fund's phone numbers.
createSuperfundPhoneNumber![](/images/permalink.svg)
function createSuperfundPhoneNumber(string bookId, string superfundId, PhoneNumberInput payload) returns TypeResponse|error
Adds a new phone number to an existing super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload PhoneNumberInput - Details of the phone number to add.
Return Type
- TypeResponse|error - The id and name of the phone number type that has been created.
getSuperfundPhoneNumber![](/images/permalink.svg)
function getSuperfundPhoneNumber(string bookId, string superfundId, string 'type) returns PhoneNumber|error
Get a super fund's phone number.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The phone number's type by name or id.
Return Type
- PhoneNumber|error - The super fund's specific phone number.
patchSuperfundPhoneNumber![](/images/permalink.svg)
function patchSuperfundPhoneNumber(string bookId, string superfundId, string 'type, PhoneNumberPatch payload) returns Response|error
Updates selected fields of an existing super fund phone number.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The phone number's type by name or id.
- payload PhoneNumberPatch - Details of the phone number to change.
getSuperfundAddresses![](/images/permalink.svg)
Gets a super fund's addresses.
createSuperfundAddress![](/images/permalink.svg)
function createSuperfundAddress(string bookId, string superfundId, AddressInput payload) returns TypeResponse|error
Adds a new address to an existing super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload AddressInput - The details of the address to add.
Return Type
- TypeResponse|error - The id and name of the address type that has been created.
getSuperfundAddress![](/images/permalink.svg)
Gets a super fund's address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The type of address by name or id.
updateSuperfundAddress![](/images/permalink.svg)
function updateSuperfundAddress(string bookId, string superfundId, string 'type, UpdateAddressInput payload) returns Response|error
Updates an existing super fund address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The address's type by name or id.
- payload UpdateAddressInput - The address.
deleteSuperfundAddress![](/images/permalink.svg)
function deleteSuperfundAddress(string bookId, string superfundId, string 'type) returns Response|error
Deletes an existing super fund address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The address's type by name or id.
patchSuperfundAddress![](/images/permalink.svg)
function patchSuperfundAddress(string bookId, string superfundId, string 'type, AddressPatch payload) returns Response|error
Updates selected fields of an existing super fund address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The address's type by name or id.
- payload AddressPatch - Details of the super fund's address to change.
getSuperfundElectronicAddresses![](/images/permalink.svg)
function getSuperfundElectronicAddresses(string bookId, string superfundId) returns ElectronicAddresses|error
Gets a super fund's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested super fund's electronic addresses.
createSuperfundElectronicAddress![](/images/permalink.svg)
function createSuperfundElectronicAddress(string bookId, string superfundId, ElectronicAddressInput payload) returns TypeResponse|error
Adds a new electronic address to an existing super fund.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- payload ElectronicAddressInput - The details of the electronic address to add.
Return Type
- TypeResponse|error - The id and name of the electronic address type that has been created.
getSuperfundElectronicAddress![](/images/permalink.svg)
function getSuperfundElectronicAddress(string bookId, string superfundId, string 'type) returns ElectronicAddress|error
Gets a super fund's electronic address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The electronic address's type by name or id.
Return Type
- ElectronicAddress|error - The super fund's requested electronic address.
updateSuperfundElectronicAddress![](/images/permalink.svg)
function updateSuperfundElectronicAddress(string bookId, string superfundId, string 'type, UpdateElectronicAddressInput payload) returns Response|error
Updates an existing super fund electronic address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The electronic address's type by name or id.
- payload UpdateElectronicAddressInput - Details of the super fund's electronic address to update.
deleteSuperfundPhoneNumber![](/images/permalink.svg)
function deleteSuperfundPhoneNumber(string bookId, string superfundId, string 'type) returns Response|error
Deletes an existing super fund electronic address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The electronic address's type by name or id.
patchSuperfundElectronicAddress![](/images/permalink.svg)
function patchSuperfundElectronicAddress(string bookId, string superfundId, string 'type, ElectronicAddressPatch payload) returns Response|error
Updates selected fields of an existing super fund electronic address.
Parameters
- bookId string - The book's id.
- superfundId string - The super fund's id.
- 'type string - The electronic address's type by name or id.
- payload ElectronicAddressPatch - Details of the super fund's electronic address to update.
getPhoneTypes![](/images/permalink.svg)
function getPhoneTypes(string bookId) returns PhoneTypes|error
Gets a list of phone types.
Parameters
- bookId string - The book's id.
Return Type
- PhoneTypes|error - A list of phone types for the specified book.
createPhoneType![](/images/permalink.svg)
function createPhoneType(string bookId, PhoneTypeInput payload) returns IdResponse|error
Creates a new phone type.
Return Type
- IdResponse|error - The id of the phone type that has been created.
getPhoneType![](/images/permalink.svg)
Gets a phone type.
updatePhoneType![](/images/permalink.svg)
function updatePhoneType(string bookId, string phoneTypeId, PhoneTypeInput payload) returns IdResponse|error
Updates an existing phone type.
Parameters
- bookId string - The book's id.
- phoneTypeId string - The phone type's id.
- payload PhoneTypeInput - Details of the updated phone type.
Return Type
- IdResponse|error - The result of the update.
deletePhoneType![](/images/permalink.svg)
Deletes an existing phone type.
patchPhoneType![](/images/permalink.svg)
function patchPhoneType(string bookId, string phoneTypeId, PhoneTypePatch payload) returns Response|error
Updates selected fields of an existing phone type.
Parameters
- bookId string - The book's id.
- phoneTypeId string - The phone type's id.
- payload PhoneTypePatch - Details of the updated phone type.
getAddressTypes![](/images/permalink.svg)
function getAddressTypes(string bookId) returns AddressTypes|error
Gets a list of address types.
Parameters
- bookId string - The book's id.
Return Type
- AddressTypes|error - A list of address types for the specified book.
createAddressType![](/images/permalink.svg)
function createAddressType(string bookId, AddressTypeInput payload) returns IdResponse|error
Creates a new address type.
Return Type
- IdResponse|error - The id of the address type that has been created.
getAddressType![](/images/permalink.svg)
function getAddressType(string bookId, string addressTypeId) returns AddressType|error
Gets an address type.
Return Type
- AddressType|error - The requested address type.
updateAddressType![](/images/permalink.svg)
function updateAddressType(string bookId, string addressTypeId, AddressTypeInput payload) returns Response|error
Updates an existing address type.
Parameters
- bookId string - The book's id.
- addressTypeId string - The address type's id.
- payload AddressTypeInput - Details of the updated address type.
deleteAddressType![](/images/permalink.svg)
Deletes an existing address type.
patchAddressType![](/images/permalink.svg)
function patchAddressType(string bookId, string addressTypeId, AddressTypePatch payload) returns Response|error
Updates selected fields of an existing address type.
Parameters
- bookId string - The book's id.
- addressTypeId string - The address type's id.
- payload AddressTypePatch - Details of the updated address type.
getContacts![](/images/permalink.svg)
Gets a list of contacts.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of contacts per page.
createContact![](/images/permalink.svg)
function createContact(string bookId, ContactInput payload) returns IdResponse|error
Creates a new contact.
Return Type
- IdResponse|error - The id of the contact that has been created.
getContact![](/images/permalink.svg)
Gets a contact.
updateContact![](/images/permalink.svg)
function updateContact(string bookId, string contactId, ContactInput payload) returns Response|error
Updates an existing contact.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload ContactInput - Details of the updated contact.
deleteContact![](/images/permalink.svg)
Deletes an existing contact.
patchContact![](/images/permalink.svg)
function patchContact(string bookId, string contactId, ContactPatch payload) returns Response|error
Updates selected fields of an existing contact.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload ContactPatch - Details of the contact to change.
getContactElectronicAddresses![](/images/permalink.svg)
function getContactElectronicAddresses(string bookId, string contactId) returns ElectronicAddresses|error
Gets a contact's electronic addresses.
Return Type
- ElectronicAddresses|error - A list of contact's electronic addresses for the specified book.
createContactElectronicAddress![](/images/permalink.svg)
function createContactElectronicAddress(string bookId, string contactId, ElectronicAddressInput payload) returns TypeResponse|error
Adds a new electronic address to an existing contact.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload ElectronicAddressInput - Details of the electronic address to add.
Return Type
- TypeResponse|error - The id and name of the contact electronic address type that has been created.
getContactElectronicAddress![](/images/permalink.svg)
function getContactElectronicAddress(string bookId, string contactId, string 'type) returns ElectronicAddress|error
Gets a contact's electronic address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The electronic address's type by name or id.
Return Type
- ElectronicAddress|error - A contact's electronic address.
updateContactElectronicAddress![](/images/permalink.svg)
function updateContactElectronicAddress(string bookId, string contactId, string 'type, UpdateElectronicAddressInput payload) returns Response|error
Updates an existing contact electronic address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The electronic address's type by name or id.
- payload UpdateElectronicAddressInput - The electronic address.
deleteContactElectronicAddress![](/images/permalink.svg)
function deleteContactElectronicAddress(string bookId, string contactId, string 'type) returns Response|error
Deletes an existing contact electronic address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The electronic address's type by name or id.
patchContactElectronicAddress![](/images/permalink.svg)
function patchContactElectronicAddress(string bookId, string contactId, string 'type, ElectronicAddressPatch payload) returns Response|error
Updates selected fields of an existing contact electronic address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The electronic address's type by name or id
- payload ElectronicAddressPatch - Details of the contact electronic address to update.
getContactPhoneNumbers![](/images/permalink.svg)
function getContactPhoneNumbers(string bookId, string contactId) returns PhoneNumbers|error
Gets a contact's phone numbers.
Return Type
- PhoneNumbers|error - A list of contact's phone numbers.
createContactPhoneNumber![](/images/permalink.svg)
function createContactPhoneNumber(string bookId, string contactId, PhoneNumberInput payload) returns TypeResponse|error
Adds a new phone number to an existing contact.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload PhoneNumberInput - Details of the phone number to add.
Return Type
- TypeResponse|error - The id and name of the contact phone number type that has been created.
getContactPhoneNumber![](/images/permalink.svg)
function getContactPhoneNumber(string bookId, string contactId, string 'type) returns PhoneNumber|error
Gets a contact's phone number.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The phone number's type by name or id.
Return Type
- PhoneNumber|error - The contact's specific phone number.
updateContactPhoneNumber![](/images/permalink.svg)
function updateContactPhoneNumber(string bookId, string contactId, string 'type, UpdatePhoneNumberInput payload) returns Response|error
Updates an existing contact phone number.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The phone number's type by name or id.
- payload UpdatePhoneNumberInput - Details of the phone number to update.
deleteContactPhoneNumber![](/images/permalink.svg)
function deleteContactPhoneNumber(string bookId, string contactId, string 'type) returns Response|error
Delete an existing contact phone number.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The phone number's type by name or id.
patchContactPhoneNumber![](/images/permalink.svg)
function patchContactPhoneNumber(string bookId, string contactId, string 'type, PhoneNumberPatch payload) returns Response|error
Updates selected fields of an existing contact phone number.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The phone number's type by name or id.
- payload PhoneNumberPatch - Details of the contact phone number to update.
getContactAddresses![](/images/permalink.svg)
Gets a contact's addresses.
createContactAddress![](/images/permalink.svg)
function createContactAddress(string bookId, string contactId, AddressInput payload) returns TypeResponse|error
Create a new contact adress.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload AddressInput - Details of the new address.
Return Type
- TypeResponse|error - The id of the address that has been created.
getContactAddress![](/images/permalink.svg)
Get a contact's address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The address's type by name or id.
updateContactAddress![](/images/permalink.svg)
function updateContactAddress(string bookId, string contactId, string 'type, UpdateAddressInput payload) returns Response|error
Updates an existing contact address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The address's type by name or id.
- payload UpdateAddressInput - The address.
deleteContactAddress![](/images/permalink.svg)
Deletes an existing contact address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The address's type by name or id.
patchContactAddress![](/images/permalink.svg)
function patchContactAddress(string bookId, string contactId, string 'type, AddressPatch payload) returns Response|error
Updates selected fields of an existing contact address.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- 'type string - The address's type by name or id.
- payload AddressPatch - Details of the contact address to update.
getElectronicAddressTypes![](/images/permalink.svg)
function getElectronicAddressTypes(string bookId) returns ElectronicAddressTypes|error
Gets a list of electronic address types.
Parameters
- bookId string - The book's id.
Return Type
- ElectronicAddressTypes|error - A list of electronic address types for the specified book.
createElectronicAddressType![](/images/permalink.svg)
function createElectronicAddressType(string bookId, ElectronicAddressTypeInput payload) returns IdResponse|error
Creates a new electronic address type.
Parameters
- bookId string - The book's id.
- payload ElectronicAddressTypeInput - Details of the new electronic address type.
Return Type
- IdResponse|error - The id of the electronic address type that has been created.
getElectronicAddressType![](/images/permalink.svg)
function getElectronicAddressType(string bookId, string electronicAddressTypeId) returns ElectronicAddressType|error
Gets an electronic address type.
Parameters
- bookId string - The book's id.
- electronicAddressTypeId string - The electronic address type's id.
Return Type
- ElectronicAddressType|error - The requested electronic address type.
updateElectronicAddressType![](/images/permalink.svg)
function updateElectronicAddressType(string bookId, string electronicAddressTypeId, ElectronicAddressTypeInput payload) returns Response|error
Updates an existing electronic address type.
Parameters
- bookId string - The book's id.
- electronicAddressTypeId string - The electronic address type's id.
- payload ElectronicAddressTypeInput - Details of the updated electronic address type.
deleteElectronicAddressType![](/images/permalink.svg)
function deleteElectronicAddressType(string bookId, string electronicAddressTypeId) returns Response|error
Deletes an existing electronic address type.
Parameters
- bookId string - The book's id.
- electronicAddressTypeId string - The electronic address type's id.
patchElectronicAddressType![](/images/permalink.svg)
function patchElectronicAddressType(string bookId, string electronicAddressTypeId, ElectronicAddressTypePatch payload) returns Response|error
Updates selected fields of an existing electronic address type.
Parameters
- bookId string - The book's id.
- electronicAddressTypeId string - The electronic address type's id.
- payload ElectronicAddressTypePatch - Details of the updated electronic address type.
getLedgerAccounts![](/images/permalink.svg)
function getLedgerAccounts(string bookId, int page, int perPage) returns LedgerAccounts|error
Gets a list of ledger accounts.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of accounts per page.
Return Type
- LedgerAccounts|error - A paged list of ledger accounts for the specified book.
createLedgerAccount![](/images/permalink.svg)
function createLedgerAccount(string bookId, LedgerAccountInput payload) returns IdResponse|error
Creates a new ledger account.
Return Type
- IdResponse|error - The id of the account that has been created.
getLedgerAccount![](/images/permalink.svg)
function getLedgerAccount(string bookId, string accountId) returns LedgerAccount|error
Gets a ledger account.
Return Type
- LedgerAccount|error - The requested ledger account.
updateLedgerAccount![](/images/permalink.svg)
function updateLedgerAccount(string bookId, string ledgerAccountId, LedgerAccountInput payload) returns Response|error
Updates an existing ledger account.
Parameters
- bookId string - The book's id.
- ledgerAccountId string - The ledger account's id.
- payload LedgerAccountInput - Details of the updated ledger account.
deleteLedgerAccount![](/images/permalink.svg)
Deletes an existing ledger account.
patchLedgerAccount![](/images/permalink.svg)
function patchLedgerAccount(string bookId, string ledgerAccountId, LedgerAccountPatch payload) returns Response|error
Updates selected fields of an existing ledger account.
Parameters
- bookId string - The book's id.
- ledgerAccountId string - The ledger account's id.
- payload LedgerAccountPatch - Details of the updated ledger account.
getFinancialInstitutions![](/images/permalink.svg)
function getFinancialInstitutions(string bookId) returns FinancialInstitutions|error
Gets a list of financial institutions.
Parameters
- bookId string - The book's id.
Return Type
- FinancialInstitutions|error - A list of financial institutions.
getEmployees![](/images/permalink.svg)
Gets a list of employees.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of employees per page.
createEmployee![](/images/permalink.svg)
function createEmployee(string bookId, EmployeeInput payload) returns IdResponse|error
Creates a new employee.
Return Type
- IdResponse|error - The id of the employee that has been created.
getEmployee![](/images/permalink.svg)
Gets an employee.
updateEmployee![](/images/permalink.svg)
function updateEmployee(string bookId, string employeeId, EmployeeInput payload) returns Response|error
Updates an existing employee.
Parameters
- bookId string - The book's id.
- employeeId string - The employee's id.
- payload EmployeeInput - Details of the updated employee.
deleteEmployee![](/images/permalink.svg)
Deletes an existing employee.
patchEmployee![](/images/permalink.svg)
function patchEmployee(string bookId, string employeeId, EmployeePatch payload) returns Response|error
Updates selected fields of an existing employee.
Parameters
- bookId string - The book's id.
- employeeId string - The employee's id.
- payload EmployeePatch - Details of the employee to change.
getExpenseClaims![](/images/permalink.svg)
function getExpenseClaims(string bookId, int page, int perPage) returns ExpenseClaims|error
Gets a list of expense claims.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of expense claims per page.
Return Type
- ExpenseClaims|error - A paged list of expense claims for the specified book.
createExpenseClaim![](/images/permalink.svg)
function createExpenseClaim(string bookId, ExpenseClaimInput payload) returns IdResponse|error
Creates a new expense claim.
Parameters
- bookId string - The book's id.
- payload ExpenseClaimInput - Details of the new expense claim.
Return Type
- IdResponse|error - The id of the expense claim that has been created.
getExpenseClaim![](/images/permalink.svg)
function getExpenseClaim(string bookId, string expenseClaimId, string? format) returns ExpenseClaim|error
Gets an expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- format string? (default ()) - The format to use, e.g. pdf.
Return Type
- ExpenseClaim|error - The requested expense claim.
updateExpensClaim![](/images/permalink.svg)
function updateExpensClaim(string bookId, string expenseClaimId, ExpenseClaimInput payload) returns Response|error
Updates an existing expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- payload ExpenseClaimInput - Details of the updated expense claim.
deleteExpenseClaim![](/images/permalink.svg)
Deletes an existing expense claim.
patchExpenseClaim![](/images/permalink.svg)
function patchExpenseClaim(string bookId, string expenseClaimId, ExpenseClaimPatch payload) returns Response|error
Updates selected fields of an existing expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- payload ExpenseClaimPatch - Details to update.
addLineItemToExpenseClaim![](/images/permalink.svg)
function addLineItemToExpenseClaim(string bookId, string expenseClaimId, ExpenseClaimLineItemInput payload) returns IdResponse|error
Creates a new line item within an existing expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- payload ExpenseClaimLineItemInput - Details of the new line item.
Return Type
- IdResponse|error - The id of the line item that has been created.
updateExpenseClaimLineItem![](/images/permalink.svg)
function updateExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId, ExpenseClaimLineItemInput payload) returns Response|error
Updates an existing line item within an existing expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The id of the line item to update.
- payload ExpenseClaimLineItemInput - Details of the updated line item.
deleteExpenseClaimLineItem![](/images/permalink.svg)
function deleteExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId) returns Response|error
Deletes an existing line item.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The id of the line item to delete.
patchExpenseClaimLineItem![](/images/permalink.svg)
function patchExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId, ExpenseClaimLineItemPatch payload) returns Response|error
Updates selected fields of an existing line item within an existing expense claim.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The id of the line item to update.
- payload ExpenseClaimLineItemPatch - Details to update.
downloadAttachment![](/images/permalink.svg)
function downloadAttachment(string bookId, string expenseClaimId, string lineItemId, string attachmentId) returns Response|error
Downloads a document that is attached to an expense claim line item.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The line item's id.
- attachmentId string - The id of the attachment to download.
Return Type
deleteAttachment![](/images/permalink.svg)
function deleteAttachment(string bookId, string expenseClaimId, string lineItemId, string attachmentId) returns Response|error
Deletes an attachment.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The id of the line item to delete the document from.
- attachmentId string - The attachment's id.
addAttachment![](/images/permalink.svg)
function addAttachment(string bookId, string expenseClaimId, string lineItemId, string? fileName) returns AddAttachmentResponses|error
Attaches one or more documents to an expense claim line item.
Parameters
- bookId string - The book's id.
- expenseClaimId string - The expense claim's id.
- lineItemId string - The id of the line item to attach the document(s) to.
- fileName string? (default ()) - The name of the file when passing a single document in the body of the request.
Return Type
- AddAttachmentResponses|error - A list of document attachment responses.
getHeartbeat![](/images/permalink.svg)
function getHeartbeat() returns HeartbeatStatus|error
Reckon One API heartbeat.
Return Type
- HeartbeatStatus|error - The status of the API.
getClassifications![](/images/permalink.svg)
function getClassifications(string bookId, int page, int perPage) returns Classifications|error
Gets a list of classifications.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of classifications per page.
Return Type
- Classifications|error - A paged list of classifications for the specified book.
createClassification![](/images/permalink.svg)
function createClassification(string bookId, ClassificationInput payload) returns IdResponse|error
Creates a new classification.
Parameters
- bookId string - The book's id.
- payload ClassificationInput - Details of the new classification.
Return Type
- IdResponse|error - The id of the classification that has been created.
getClassification![](/images/permalink.svg)
function getClassification(string bookId, string classificationId) returns Classification|error
Gets a classification.
Return Type
- Classification|error - The requested classification.
updateClassification![](/images/permalink.svg)
function updateClassification(string bookId, string classificationId, ClassificationInput payload) returns Response|error
Updates an existing classification.
Parameters
- bookId string - The book's id.
- classificationId string - The classification's id.
- payload ClassificationInput - Details of the updated classification.
deleteClassification![](/images/permalink.svg)
Deletes an existing classification.
patchClassification![](/images/permalink.svg)
function patchClassification(string bookId, string classificationId, ClassificationPatch payload) returns Response|error
Updates selected fields of an existing classification.
Parameters
- bookId string - The book's id.
- classificationId string - The classification's id.
- payload ClassificationPatch - Details to update.
getPaymentTerms![](/images/permalink.svg)
function getPaymentTerms(string bookId, int page, int perPage) returns PaymentTerms|error
Gets a list of payment terms.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of payment term per page.
Return Type
- PaymentTerms|error - A paged list of payment terms for the specified book.
createPaymentTerm![](/images/permalink.svg)
function createPaymentTerm(string bookId, PaymentTermInput payload) returns IdResponse|error
Creates a new payment term.
Return Type
- IdResponse|error - The id of the payment term that has been created.
getPaymentTerm![](/images/permalink.svg)
function getPaymentTerm(string bookId, string termId) returns PaymentTerm|error
Gets a payment term.
Return Type
- PaymentTerm|error - The requested payment term.
updatePaymentTerm![](/images/permalink.svg)
function updatePaymentTerm(string bookId, string termId, PaymentTermInput payload) returns Response|error
Updates an existing payment term.
Parameters
- bookId string - The book's id.
- termId string - The term's id.
- payload PaymentTermInput - Details of the updated payment term.
deletePaymentTerm![](/images/permalink.svg)
Deletes an existing payment term.
patchPaymentTerm![](/images/permalink.svg)
function patchPaymentTerm(string bookId, string termId, PaymentTermPatch payload) returns Response|error
Updates an existing payment term.
Parameters
- bookId string - The book's id.
- termId string - The term's id.
- payload PaymentTermPatch - Details of the updated payment term.
getPaymentTermDueDate![](/images/permalink.svg)
function getPaymentTermDueDate(string bookId, string termId, string baseDate) returns PaymentTermDueDate|error
Gets a calculated due date from a specified base date.
Return Type
- PaymentTermDueDate|error - A calculated due date.
getInvoices![](/images/permalink.svg)
Gets a list of invoices.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of invoices per page.
createInvoice![](/images/permalink.svg)
function createInvoice(string bookId, InvoiceInput payload) returns IdResponse|error
Creates a new invoice.
Return Type
- IdResponse|error - The id of the invoice that has been created.
getInvoice![](/images/permalink.svg)
Gets an invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- format string? (default ()) - The format to use, e.g. pdf.
updateInvoice![](/images/permalink.svg)
function updateInvoice(string bookId, string invoiceId, InvoiceInput payload) returns Response|error
Updates an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- payload InvoiceInput - Details of the updated invoice.
deleteInvoice![](/images/permalink.svg)
Deletes an existing invoice.
patchInvoice![](/images/permalink.svg)
function patchInvoice(string bookId, string invoiceId, InvoicePatch payload) returns Response|error
Updates selected fields of an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- payload InvoicePatch - Details to update.
getInvoiceSummary![](/images/permalink.svg)
function getInvoiceSummary(string bookId, string? baseDate) returns InvoicesSummary|error
Gets a summary of a book's invoices.
Parameters
- bookId string - The book's id.
- baseDate string? (default ()) - The base date to use when checking for overdue invoices.
Return Type
- InvoicesSummary|error - A summary of a book's invoices.
getCustomerInvoiceSummary![](/images/permalink.svg)
function getCustomerInvoiceSummary(string bookId, string customerId, string? baseDate) returns InvoicesSummary|error
Gets a summary of a book's invoices for a given customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer id to filter on.
- baseDate string? (default ()) - The base date to use when checking for overdue invoices.
Return Type
- InvoicesSummary|error - A summary of a book's invoices for a given customer.
convertInvoiceFrom![](/images/permalink.svg)
function convertInvoiceFrom(string bookId, InvoiceConvertFromInput payload) returns IdResponse|error
Creates a new invoice from an estimate.
Parameters
- bookId string - The book's id.
- payload InvoiceConvertFromInput - Details to convert into an invoice.
Return Type
- IdResponse|error - The id of the invoice that has been created.
unlinkInvoiceTransaction![](/images/permalink.svg)
function unlinkInvoiceTransaction(string bookId, string invoiceId, string linkId) returns Response|error
Unlinks an existing transaction from an invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- linkId string - The link's id.
getPopulatedEmail![](/images/permalink.svg)
Gets an email template populated with details from the specified invoice.
emailInvoice![](/images/permalink.svg)
function emailInvoice(string bookId, string invoiceId, EmailInput payload) returns Response|error
Emails an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- payload EmailInput - Details of an email to send.
markInvoiceEmailAsSent![](/images/permalink.svg)
Marks an existing invoice as sent.
markInvoiceEmailAsUnsent![](/images/permalink.svg)
Marks an existing invoice as unsent.
getInvoiceLineItem![](/images/permalink.svg)
function getInvoiceLineItem(string bookId, string invoiceId, string lineItemId) returns InvoiceLineItem|error
Gets a line item from an invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- lineItemId string - The line item's id.
Return Type
- InvoiceLineItem|error - The line item.
updateInvoiceLineItem![](/images/permalink.svg)
function updateInvoiceLineItem(string bookId, string invoiceId, string lineItemId, InvoiceLineItemInput payload) returns Response|error
Updates an existing line item within an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- lineItemId string - The line item's id.
- payload InvoiceLineItemInput - Details of the line item.
addLineItemToInvoice![](/images/permalink.svg)
function addLineItemToInvoice(string bookId, string invoiceId, InvoiceLineItemInput payload) returns IdResponse|error
Creates a new line item within an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- payload InvoiceLineItemInput - Details of the new line item.
Return Type
- IdResponse|error - The id of the line item that has been created.
deleteInvoiceLineItem![](/images/permalink.svg)
function deleteInvoiceLineItem(string bookId, string invoiceId, string lineItemId) returns Response|error
Deletes an existing line item.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- lineItemId string - The id of the line item to delete.
patchInvoiceLineItem![](/images/permalink.svg)
function patchInvoiceLineItem(string bookId, string invoiceId, string lineItemId, InvoiceLineItemPatch payload) returns Response|error
Updates selected fields of an existing line item within an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- lineItemId string - The id of the line item to update.
- payload InvoiceLineItemPatch - Details to update.
getRecurringInvoiceTemplate![](/images/permalink.svg)
function getRecurringInvoiceTemplate(string bookId, string templateId) returns RecurringInvoiceTemplate|error
Gets a recurring invoice template.
Return Type
- RecurringInvoiceTemplate|error - The requested recurring invoice template.
getProjects![](/images/permalink.svg)
Gets a list of projects.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of projects per page.
createProject![](/images/permalink.svg)
function createProject(string bookId, ProjectInput payload) returns IdResponse|error
Creates a new project.
Return Type
- IdResponse|error - The id of the project that has been created.
getProject![](/images/permalink.svg)
Gets a project.
updateProject![](/images/permalink.svg)
function updateProject(string bookId, string projectId, ProjectInput payload) returns Response|error
Updates an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- payload ProjectInput - Details of the updated project.
deleteProject![](/images/permalink.svg)
Deletes an existing project.
patchProject![](/images/permalink.svg)
function patchProject(string bookId, string projectId, ProjectPatch payload) returns Response|error
Updates selected fields of an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- payload ProjectPatch - The project's details being altered.
deleteProjectItem![](/images/permalink.svg)
Deletes an existing project item.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The id of the project item to delete.
patchProjectItem![](/images/permalink.svg)
function patchProjectItem(string bookId, string projectId, string lineId, ProjectItemPatch payload) returns Response|error
Updates selected fields of an existing project item within an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The project item's id.
- payload ProjectItemPatch - The project item's details being altered.
deleteProjectCustomer![](/images/permalink.svg)
function deleteProjectCustomer(string bookId, string projectId, string lineId) returns Response|error
Deletes an existing project customer.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The id of the project customer to delete.
patchProjectCustomer![](/images/permalink.svg)
function patchProjectCustomer(string bookId, string projectId, string lineId, ProjectCustomerPatch payload) returns Response|error
Updates selected fields of an existing project customer within an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The project customer's id.
- payload ProjectCustomerPatch - The project customer's details being altered.
deleteProjectSupplier![](/images/permalink.svg)
function deleteProjectSupplier(string bookId, string projectId, string lineId) returns Response|error
Deletes an existing project supplier.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The id of the project supplier to delete.
patchProjectSupplier![](/images/permalink.svg)
function patchProjectSupplier(string bookId, string projectId, string lineId, ProjectSupplierPatch payload) returns Response|error
Updates selected fields of an existing project supplier within an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- lineId string - The project suppliers's id.
- payload ProjectSupplierPatch - The project suppliers's details being altered.
getSettings![](/images/permalink.svg)
function getSettings(string bookId) returns BookSettings|error
Get a book's general settings.
Parameters
- bookId string - The book's id.
Return Type
- BookSettings|error - The general settings for the specified book.
patchSettings![](/images/permalink.svg)
function patchSettings(string bookId, BookSettingsPatch payload) returns Response|error
Updates selected fields of a book's settings.
Parameters
- bookId string - The book's id.
- payload BookSettingsPatch - The book settings being altered.
patchSettingsAddress![](/images/permalink.svg)
function patchSettingsAddress(string bookId, string 'type, BookAddressPatch payload) returns Response|error
Updates selected fields of an address in a book's settings.
Parameters
- bookId string - The book's id.
- 'type string - The type of address. This can either be
legal
,physical
or the address type id.
- payload BookAddressPatch - The address being altered.
patchSettingsContactPhoneNumber![](/images/permalink.svg)
function patchSettingsContactPhoneNumber(string bookId, string 'type, BookPhoneNumberPatch payload) returns Response|error
Updates selected fields of a contact phone number in a book's settings.
Parameters
- bookId string - The book's id.
- 'type string - The type of phone number. This can either be
phone
,mobile
,fax
or the phone number type id.
- payload BookPhoneNumberPatch - The phone number being altered.
patchSettingsContactElectronicAddress![](/images/permalink.svg)
function patchSettingsContactElectronicAddress(string bookId, string 'type, BookElectronicAddressPatch payload) returns Response|error
Updates selected fields of a contact electronic address in a book's settings.
Parameters
- bookId string - The book's id.
- 'type string - The type of electronic address. This can either be
email
orweb
.
- payload BookElectronicAddressPatch - The electronic address being altered.
getTaxSettings![](/images/permalink.svg)
function getTaxSettings(string bookId) returns TaxSettings|error
Get a book's tax settings.
Parameters
- bookId string - The book's id.
Return Type
- TaxSettings|error - The tax settings for the specified book.
patchTaxSettings![](/images/permalink.svg)
function patchTaxSettings(string bookId, TaxSettingsPatch payload) returns Response|error
Updates selected fields of a book's tax settings.
Parameters
- bookId string - The book's id.
- payload TaxSettingsPatch - The book's tax settings being updated.
getInvoiceSettings![](/images/permalink.svg)
function getInvoiceSettings(string bookId) returns InvoiceSettings|error
Gets a book's invoice settings.
Parameters
- bookId string - The book's id.
Return Type
- InvoiceSettings|error - The invoice settings for the specified book.
patchInvoiceSettings![](/images/permalink.svg)
function patchInvoiceSettings(string bookId, InvoiceSettingsPatch payload) returns Response|error
Updates selected fields of a book's invoice settings.
Parameters
- bookId string - The book's id.
- payload InvoiceSettingsPatch - The book's invoice settings to update.
getCreditNoteSettings![](/images/permalink.svg)
function getCreditNoteSettings(string bookId) returns CreditNoteSettings|error
Gets a book's credit note settings.
Parameters
- bookId string - The book's id.
Return Type
- CreditNoteSettings|error - The credit note settings for the specified book.
patchCreditNoteSettings![](/images/permalink.svg)
function patchCreditNoteSettings(string bookId, CreditNoteSettingsPatch payload) returns Response|error
Updates selected fields of a book's credit note settings.
Parameters
- bookId string - The book's id.
- payload CreditNoteSettingsPatch - The book's credit note settings to update.
getReceiptSettings![](/images/permalink.svg)
function getReceiptSettings(string bookId) returns ReceiptSettings|error
Gets a book's receipt settings.
Parameters
- bookId string - The book's id.
Return Type
- ReceiptSettings|error - The receipt settings for the specified book.
patchReceiptSettings![](/images/permalink.svg)
function patchReceiptSettings(string bookId, ReceiptSettingsPatch payload) returns Response|error
Updates selected fields of a book's receipt settings.
Parameters
- bookId string - The book's id.
- payload ReceiptSettingsPatch - The book's receipt settings to update.
getPayrollSettings![](/images/permalink.svg)
function getPayrollSettings(string bookId) returns PayrollSettings|error
Get a book's payroll settings.
Parameters
- bookId string - The book's id.
Return Type
- PayrollSettings|error - The payroll settings for the specified book.
patchPayrollSettings![](/images/permalink.svg)
function patchPayrollSettings(string bookId, PayrollSettingsPatch payload) returns Response|error
Updates selected fields of a book's payroll settings.
Parameters
- bookId string - The book's id.
- payload PayrollSettingsPatch - The book's payroll settings being altered.
patchPayrollSettingsContactPhoneNumber![](/images/permalink.svg)
function patchPayrollSettingsContactPhoneNumber(string bookId, string 'type, BookPhoneNumberPatch payload) returns Response|error
Updates selected fields of a legal contact's phone number in a book's payroll settings.
Parameters
- bookId string - The book's id.
- 'type string - The type of phone number. This can either be
phone
or the phone number type id.
- payload BookPhoneNumberPatch - The phone number being altered.
patchPayrollSettingsElectronicAddress![](/images/permalink.svg)
function patchPayrollSettingsElectronicAddress(string bookId, string 'type, BookElectronicAddressPatch payload) returns Response|error
Updates selected fields of a legal contact's electronic address in a book's payroll settings.
Parameters
- bookId string - The book's id.
- 'type string - The type of electronic address. This can either be
email
or the email type id.
- payload BookElectronicAddressPatch - The electronic address being altered.
getTimeEntrySettings![](/images/permalink.svg)
function getTimeEntrySettings(string bookId) returns TimeEntrySettings|error
Get a book's time entry settings.
Parameters
- bookId string - The book's id.
Return Type
- TimeEntrySettings|error - The time entry settings for the specified book.
patchTimeEntrySettings![](/images/permalink.svg)
function patchTimeEntrySettings(string bookId, TimeEntrySettingsPatch payload) returns Response|error
Updates selected fields of a book's time entry settings.
Parameters
- bookId string - The book's id.
- payload TimeEntrySettingsPatch - The book's time entry settings being altered.
getTemplates![](/images/permalink.svg)
function getTemplates(string bookId, int page, int perPage) returns TemplateTypeRef|error
Gets a list of templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
Return Type
- TemplateTypeRef|error - A list of templates for the specified book.
getTemplateLogo![](/images/permalink.svg)
function getTemplateLogo(string bookId, string templateId) returns FileContentResult|error
Gets a template's logo for the specified book.
Return Type
- FileContentResult|error - The template.
getInvoiceTemplates![](/images/permalink.svg)
function getInvoiceTemplates(string bookId, int page, int perPage) returns InvoiceTemplates|error
Gets a list of invoice templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
Return Type
- InvoiceTemplates|error - A list of invoices templates for the specified book.
getInvoiceTemplate![](/images/permalink.svg)
function getInvoiceTemplate(string bookId, string templateId) returns InvoiceTemplate|error
Gets an invoice template for the specified book.
Return Type
- InvoiceTemplate|error - The template.
getEstimateTemplates![](/images/permalink.svg)
function getEstimateTemplates(string bookId, int page, int perPage) returns EstimateTemplates|error
Gets a list of estimate templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
Return Type
- EstimateTemplates|error - A list of estimates templates for the specified book.
getEstimateTemplate![](/images/permalink.svg)
function getEstimateTemplate(string bookId, string templateId) returns EstimateTemplate|error
Gets an estimate template for the specified book.
Return Type
- EstimateTemplate|error - The template.
getCustomerAdjustmentNotesTemplates![](/images/permalink.svg)
function getCustomerAdjustmentNotesTemplates(string bookId, int page, int perPage) returns Templates|error
Gets a list of customer adjustment note templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
getCustomerAdjustmentNotesTemplate![](/images/permalink.svg)
function getCustomerAdjustmentNotesTemplate(string bookId, string templateId) returns Template|error
Gets a customer adjustment note template for the specified book.
getBillTemplates![](/images/permalink.svg)
Gets a list of bill templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
getBillTemplate![](/images/permalink.svg)
Gets a bill template for the specified book.
getSupplierAdjustmentNotesTemplates![](/images/permalink.svg)
function getSupplierAdjustmentNotesTemplates(string bookId, int page, int perPage) returns Templates|error
Gets a list of supplier adjustment note templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
getSupplierAdjustmentNotesTemplate![](/images/permalink.svg)
function getSupplierAdjustmentNotesTemplate(string bookId, string templateId) returns Template|error
Gets a supplier adjustment note template for the specified book.
getExpenseclaimsTemplates![](/images/permalink.svg)
Gets a list of expense claim templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
getExpenseclaimssTemplate![](/images/permalink.svg)
Gets an expense claim template for the specified book.
getCustomerStatementsTemplates![](/images/permalink.svg)
function getCustomerStatementsTemplates(string bookId, int page, int perPage) returns CustomerStatementsTemplates|error
Gets a list of customer statement templates for the specified book.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of super funds per page.
Return Type
- CustomerStatementsTemplates|error - A list of customer statements templates for the specified book.
getCustomerStatementsTemplate![](/images/permalink.svg)
function getCustomerStatementsTemplate(string bookId, string templateId) returns CustomerStatementsTemplate|error
Gets a customer statement template for the specified book.
Return Type
- CustomerStatementsTemplate|error - The template.
getTaxGroups![](/images/permalink.svg)
function getTaxGroups(string bookId, string effectiveDate, int page, int perPage) returns TaxGroups|error
Gets a paged list of tax groups for the specified book.
Parameters
- bookId string - The book's id.
- effectiveDate string - The effective date for the tax rates.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of groups per page.
getTaxGroup![](/images/permalink.svg)
function getTaxGroup(string bookId, string taxGroupId, string effectiveDate) returns TaxGroups|error
Gets a tax group with tax rates as at the supplied effective date.
Parameters
- bookId string - The book's id.
- taxGroupId string - The tax group's id.
- effectiveDate string - The effective date for the tax rates.
getTaxRates![](/images/permalink.svg)
function getTaxRates(string bookId, string effectiveDate, int page, int perPage) returns TaxRates|error
Gets tax rates as at the supplied effective date.
Parameters
- bookId string - The book's id.
- effectiveDate string - The effective date for the tax rates.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of rates per page.
getTaxRate![](/images/permalink.svg)
Gets a tax rate as at the supplied effective date.
Parameters
- bookId string - The book's id.
- taxRateId string - The tax rate's id.
- effectiveDate string - The effective date for the tax rate.
getItems![](/images/permalink.svg)
Gets a list of items.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of items per page.
createItem![](/images/permalink.svg)
function createItem(string bookId, ItemInput payload) returns IdResponse|error
Creates a new item.
Return Type
- IdResponse|error - The id of the item that has been created.
getItem![](/images/permalink.svg)
Gets an item.
updateItem![](/images/permalink.svg)
Updates an existing item.
Parameters
- bookId string - The book's id.
- itemId string - The item's id.
- payload ItemInput - Details of the updated item.
deleteItem![](/images/permalink.svg)
Deletes an existing item.
patchItem![](/images/permalink.svg)
Updates selected fields of an existing item.
Parameters
- bookId string - The book's id.
- itemId string - The item's id.
- payload ItemPatch - Details to update.
getTimeEntries![](/images/permalink.svg)
function getTimeEntries(string bookId, int page, int perPage) returns TimeEntries|error
Gets a list of time entries.
Parameters
- bookId string - The book's id.
- page int (default 1) - The page to retrieve.
- perPage int (default 0) - The number of time entries per page.
Return Type
- TimeEntries|error - A paged list of time entries for the specified book.
getTimeEntry![](/images/permalink.svg)
Gets a time entry.
updateTimeEntry![](/images/permalink.svg)
function updateTimeEntry(string bookId, string timeEntryId, TimeEntryInput payload) returns Response|error
Updates an existing time entry.
Parameters
- bookId string - The book's id.
- timeEntryId string - The time entry's id.
- payload TimeEntryInput - Details of the updated time entry.
deleteTimeEntry![](/images/permalink.svg)
Deletes an existing time entry.
createTimeEntry![](/images/permalink.svg)
function createTimeEntry(string bookId, TimeEntryInput payload) returns IdResponse|error
Creates a new time entry.
Return Type
- IdResponse|error - The id of the time entry that has been created.
patchTimeEntry![](/images/permalink.svg)
function patchTimeEntry(string bookId, string timeEntryId, TimeEntryPatch payload) returns Response|error
Updates selected fields of a time entry.
Parameters
- bookId string - The book's id.
- timeEntryId string - The time entry's id.
- payload TimeEntryPatch - Details to update.
getUsers![](/images/permalink.svg)
Gets a list of users.
Records![](/images/permalink.svg)
reckon.one: AddAttachmentResponse![](/images/permalink.svg)
A response that contains the outcome of a document attachment request.
Fields
- fileName string? - The name of the document.
- code int - The HTTP status code for this particular document.
- _error string? - The error message if a document could not be attached.
- id string? - The attached document's id.
- url string? - The URL to retrieve the document.
reckon.one: AddAttachmentResponses![](/images/permalink.svg)
A list of document attachment responses.
Fields
- list AddAttachmentResponse[]? - The list of responses for each document in the request.
reckon.one: Address![](/images/permalink.svg)
An address.
Fields
- id string? - The address's unique id.
- 'type record {}? - The address type.
- line1 string? - Line 1 of the address.
- line2 string? - Line 2 of the address.
- line3 string? - Line 3 of the address.
- suburb string? - The suburb.
- town string? - The town.
- state string? - The state.
- postcode string? - The post code.
- country string? - The country.
reckon.one: Addresses![](/images/permalink.svg)
A list of electronic addresses.
Fields
- list Address[]? - The list of items.
reckon.one: AddressInput![](/images/permalink.svg)
Details of an address to create or update.
Fields
- line1 string? - Line 1 of the address.
- line2 string? - Line 2 of the address.
- line3 string? - Line 3 of the address.
- suburb string? - The suburb.
- town string? - The town.
- state string? - The state.
- postcode string? - The post code.
- country string? - The country.
- 'type string - The id or name of the address type.
reckon.one: AddressPatch![](/images/permalink.svg)
Details of an address to update.
Fields
- line1 string? - Line 1 of the address.
- line2 string? - Line 2 of the address.
- line3 string? - Line 3 of the address.
- suburb string? - The suburb.
- town string? - The town.
- state string? - The state.
- postcode string? - The post code.
- country string? - The country.
reckon.one: AddressType![](/images/permalink.svg)
Details of an address type.
Fields
- id string - The type's id.
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus - Type status.
- createdDateTime string - The creation UTC date time.
- lastModifiedDateTime string - The last modified UTC date time.
reckon.one: AddressTypeInput![](/images/permalink.svg)
Details of an address type to create or update.
Fields
- name string - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: AddressTypePatch![](/images/permalink.svg)
Details of an address type to create or update.
Fields
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: AddressTypeRef![](/images/permalink.svg)
Reference to an address type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: AddressTypes![](/images/permalink.svg)
Address types.
Fields
- list AddressType[]? - The list of items.
reckon.one: BankAccount![](/images/permalink.svg)
Details of a bank account.
Fields
- dateOpened string? - When the account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- bankBranchNumber string? - The branch number (BSB or Sort Code).
- bankAccountNumber string? - The account number.
- openingBalance decimal? - The opening balance, if there is one.
- isCash boolean - Whether the account is cash.
- financialInstitution record {}? - Details of the financial institution.
- includeBalancingTransaction boolean - Whether to include a balancing transaction.
- payerIdentifier string? - The APCA number to identify the payer.
reckon.one: BasReportSettings![](/images/permalink.svg)
BAS reporting preference details.
Fields
- reportingPeriodType string? - The BAS reporting period.
- simplerBAS boolean - Indicates whether its a simpler BAS. Simpler BAS is only applicable for business reporting GST on Monthly, Annual or quarterly basis (option 1: Calculate GST and report quarterly).
- amountTaxStatus SettingsAmountTaxStatus - The sales figures type of tax.
- fbt boolean - Indicates whether Fringe Benefits Tax (FBT) applies to the business.
- ftc boolean - Indicates whether Fuel Tax Credits (FTC) applies to the business.
- lct boolean - Indicates whether Luxury Car Tax (LCT) applies to the business.
- paygiPayQuarterly boolean - Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Pay PAYG instalment quarterly.
- paygiCalculateUsingIncomeTimesRate boolean - Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Calculate PAYG instalment using income times rate.
- paygw boolean - Indicates whether Pay As You Go Tax Withheld (PAYG W) applies to the business.
- wet boolean - Indicates whether Wine Equalisation Tax (WET) applies to the business.
reckon.one: BasReportSettingsPatch![](/images/permalink.svg)
BAS report settings to patch.
Fields
- reportingPeriodType string? - The BAS reporting period.
- simplerBAS boolean? - Indicates whether its a simpler BAS. Simpler BAS is only applicable for business reporting GST on Monthly, Annual or quarterly basis (option 1: Calculate GST and report quarterly).
- amountTaxStatus SettingsAmountTaxStatus? - The sales figures type of tax.
- fbt boolean? - Indicates whether Fringe Benefits Tax (FBT) applies to the business.
- ftc boolean? - Indicates whether Fuel Tax Credits (FTC) applies to the business.
- lct boolean? - Indicates whether Luxury Car Tax (LCT) applies to the business.
- paygiPayQuarterly boolean? - Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Pay PAYG instalment quarterly.
- paygiCalculateUsingIncomeTimesRate boolean? - Indicates whether Pay As You Go Income Tax Instalment (PAYG I) applies to the business. Calculate PAYG instalment using income times rate.
- paygw boolean? - Indicates whether Pay As You Go Tax Withheld (PAYG W) applies to the business.
- wet boolean? - Indicates whether Wine Equalisation Tax (WET) applies to the business.
reckon.one: Book![](/images/permalink.svg)
Details of a book.
Fields
- id string - The book's id.
- name string? - The book's name.
- status BookStatus - A book's status.
- ownership BookOwnership - Book ownership.
- country string? - The book's country code.
- bookCreated boolean - Whether book creation has been completed.
- products BookProduct[]? - The products that are currently licensed.
reckon.one: BookAddress![](/images/permalink.svg)
An address.
Fields
- id string? - The address's unique id.
- 'type record {}? - The address type.
- line1 string? - First line of address.
- line2 string? - Second line of address.
- line3 string? - Third line of address.
- town string? - Town of address.
- suburb string? - Suburb of address.
- state string? - State of address.
- postcode string? - Postcode of address.
- country string? - Country of address.
reckon.one: BookAddressPatch![](/images/permalink.svg)
An address to patch.
Fields
- line1 string? - First line of address.
- line2 string? - Second line of address.
- line3 string? - Third line of address.
- town string? - Town of address.
- suburb string? - Suburb of address.
- state string? - State of address.
- postcode string? - Postcode of address.
- country string? - Country of address.
reckon.one: BookElectronicAddress![](/images/permalink.svg)
An electronic address.
Fields
- id string? - The electronic address's unique id.
- 'type record {}? - Type of electronic address.
- address string? - The electronic address.
reckon.one: BookElectronicAddressPatch![](/images/permalink.svg)
An electronic address.
Fields
- address string? - The electronic address.
reckon.one: BookPhoneNumber![](/images/permalink.svg)
A phone number.
Fields
- id string? - The phone number's unique id.
- 'type record {}? - The type of phone number.
- areaCode string? - The area code.
- number string? - The number.
reckon.one: BookPhoneNumberPatch![](/images/permalink.svg)
A phone number.
Fields
- areaCode string? - The area code.
- number string? - The number.
reckon.one: BookProduct![](/images/permalink.svg)
Details of a book product.
Fields
- id string - The products's id.
- name string? - The product's name.
- portalProductId string? - The Portal's product id.
reckon.one: Books![](/images/permalink.svg)
Books.
Fields
- list Book[]? - The list of items.
reckon.one: BookSettings![](/images/permalink.svg)
A book's general settings
Fields
- bookName string? - The book's name.
- startDate string - The first day of records for the book.
- bookCreatedDateTime string - Date and time when the book was created.
- lockOffDate string? - Transactions on or before this date cannot be changed.
- financialYearStartDay int - Day of month the financial year starts on.
- financialYearStartMonth int - Month as a number that the financial year starts in.
- entityType string? - Entity type of business.
- industryType record {}? - Industry details of business.
- replyToEmailAddress string? - The email address used by clients when replying to emails sent from Reckon One.
- showEmailSentFrom string? - The displayed name of sender in emails.
- bankDataRetrievalDays int - The number of most recent days bank data is retrieved for.
- generalDetails record {}? - General company details
- addresses BookAddress[]? - List of addresses.
- contactDetails record {}? - Business's contact details.
reckon.one: BookSettingsPatch![](/images/permalink.svg)
Details of a book's general settings to patch.
Fields
- startDate string? - The first day of records for the book.
- lockOffDate string? - Transactions on or before this date cannot be changed.
- entityType string? - Entity type of business.
- industryType record {}? - Industry details of business.
- replyToEmailAddress string? - The email address used by clients when replying to emails sent from Reckon One.
- showEmailSentFrom string? - The displayed name of sender in emails.
- bankDataRetrievalDays int? - The number of most recent days bank data is retrieved for.
- generalDetails record {}? - General company details
- contactDetails record {}? - Business's contact details.
reckon.one: BookTypeRef![](/images/permalink.svg)
Type reference.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Classification![](/images/permalink.svg)
A classification
Fields
- id string - The classification's unique id.
- name string? - The classification's name.
- description string? - The classification's description.
- status ClassificationStatus - Classification status
- isDefault boolean - Whether the classification is the default for the transaction.
reckon.one: ClassificationInput![](/images/permalink.svg)
Details of a classification to create or update.
Fields
- name string - The classification's name.
- description string? - The classification's description.
- status ClassificationStatus? - Classification status
- isDefault boolean? - Whether the classification is the default for the transaction.
reckon.one: ClassificationPatch![](/images/permalink.svg)
Details of the classification to patch.
Fields
- name string? - The classification's name.
- description string? - The classification's description.
- status ClassificationStatus? - Classification status
- isDefault boolean? - Whether the classification is the default for the transaction.
reckon.one: ClassificationRef![](/images/permalink.svg)
Reference to a classification.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Classifications![](/images/permalink.svg)
A list of classifications.
Fields
- list Classification[]? - The list of items.
reckon.one: ClientConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
reckon.one: Contact![](/images/permalink.svg)
A contact.
Fields
- id string - The contact's unique id.
- name string? - The contact's display name.
- salutation string? - The salutation to use in communications.
- department string? - The contact's department.
- position string? - The contact's position.
- organisation record {}? - The organisation that the contact is associated with.
- status ContactStatus - The status of a contact.
- notes string? - Notes for the contact.
- addresses Address[]? - List of addresses.
- phoneNumbers PhoneNumber[]? - List of phone numbers.
- electronicAddresses ElectronicAddress[]? - List of electronic addresses.
reckon.one: ContactDetail![](/images/permalink.svg)
Details on how to contact the business.
Fields
- contactName string? - Name of person who is primary contact within the business.
- phoneNumbers BookPhoneNumber[]? - List of phone numbers.
- electronicAddresses BookElectronicAddress[]? - List of electronic addresses.
reckon.one: ContactDetailPatch![](/images/permalink.svg)
Details on how to contact the business to be patched.
Fields
- contactName string? - Name of person who is primary contact within the business.
reckon.one: ContactInput![](/images/permalink.svg)
Details of a contact to create or update.
Fields
- name string - The contact's display name.
- salutation string? - The salutation to use in communications.
- department string? - The contact's department.
- position string? - The contact's position.
- status ContactStatus? - The status of a contact.
- notes string? - Notes for the contact.
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
- organisation string? - The id or name of the organisation that the contact is associated with.
reckon.one: ContactPatch![](/images/permalink.svg)
Details of a contact to patch.
Fields
- name string? - The contact's display name.
- salutation string? - The salutation to use in communications.
- department string? - The contact's department.
- position string? - The contact's position.
- organisation string? - The id or name of the organisation that the contact is associated with.
- status ContactStatus? - The status of a contact.
- notes string? - Notes for the contact.
reckon.one: ContactRef![](/images/permalink.svg)
Reference to a contact.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Contacts![](/images/permalink.svg)
A list of contacts.
Fields
- list Contact[]? - The list of items.
reckon.one: CreditAccount![](/images/permalink.svg)
Details of a credit account.
Fields
- dateOpened string? - When the account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- openingBalance decimal? - The opening balance, if there is one.
reckon.one: CreditNote![](/images/permalink.svg)
A credit note.
Fields
- id string - The credit note's unique id.
- creditNoteNumber string? - The credit note's number.
- customer record {}? - The customer that the credit note was issued to.
- billingAddress record {}? - The address that the credit note was sent to.
- shippingAddress record {}? - The address that the credit note was sent to.
- creditNoteDate string - The date of the credit note.
- totalAmount decimal - The total amount of the credit note.
- balance decimal - The balance that has not yet been paid by the customer.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- totalTaxAmount decimal? - The total tax amount of the credit note.
- status CreditNoteStatus - The status of a credit note.
- reference string? - The credit note reference.
- accountsReceivableLedgerAccount record {}? - The accounts receivable ledger account.
- classification record {}? - The classification.
- template record {}? - The template used to print or email the credit note.
- transactionLinks TransactionLink[]? - Details of transactions (e.g. Invoices) that are linked to the credit note.
- lineItems CreditNoteLineItem[]? - The individual items that make up the credit note.
- notes string? - Notes related to the credit note.
- emailStatus EmailStatus - The status of an emailed invoice.
reckon.one: CreditNoteInput![](/images/permalink.svg)
Details of a credit note to create or update.
Fields
- customer string - The customer that the credit note will be issued to.
- creditNoteDate string - The date of the credit note.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- reference string? - The credit note reference.
- accountsReceivableLedgerAccount string? - The accounts receivable ledger account. Note: It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.
- classification string? - The classification.
- template string? - The template used to print or email the credit note.
- lineItems CreditNoteLineItemInput[]? - The individual items that make up the credit note.
- notes string? - Notes related to the credit note.
reckon.one: CreditNoteLineItem![](/images/permalink.svg)
A credit note line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on a credit note line item.
- accountDetails record {}? - Details of an account used on a credit note line item.
- description string? - The description of the item.
- taxRate record {}? - The tax rate.
- taxAmount decimal? - The tax amount.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: CreditNoteLineItemAccountDetails![](/images/permalink.svg)
Details of an account used on a credit note line item.
Fields
- ledgerAccount record {}? - The id and full name of the ledger account that the line relates to.
- quantity decimal? - The quantity sold.
- amount decimal? - The amount.
reckon.one: CreditNoteLineItemAccountDetailsInput![](/images/permalink.svg)
Details of an account used on a credit note line item.
Fields
- ledgerAccount string - The id or full name of the ledger account that the line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the
amountTaxStatus
).
reckon.one: CreditNoteLineItemAccountDetailsPatch![](/images/permalink.svg)
Details of an account used on a credit note line item.
Fields
- ledgerAccount string? - The id or full name of the ledger account that the line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the
amountTaxStatus
).
reckon.one: CreditNoteLineItemInput![](/images/permalink.svg)
Details of a credit note line item to create or update.
Fields
- lineNumber int - The line number.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an invoice line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an invoice line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: CreditNoteLineItemItemDetails![](/images/permalink.svg)
Details of an item used on an credit note line item.
Fields
- item record {}? - The id and full name of the item that the line relates to.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
reckon.one: CreditNoteLineItemItemDetailsInput![](/images/permalink.svg)
Details of an item used on a credit note line item.
Fields
- item string - The id or full name of the item that the line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
reckon.one: CreditNoteLineItemItemDetailsPatch![](/images/permalink.svg)
Details of an item used on a credit note line item.
Fields
- item string? - The id or full name of the item that the line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
reckon.one: CreditNoteLineItemPatch![](/images/permalink.svg)
Details of a credit note line item to create or update.
Fields
- lineNumber int? - The line number.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an invoice line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an invoice line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: CreditNotePatch![](/images/permalink.svg)
Details of a credit note to patch.
Fields
- customer string? - The customer that the credit note will be issued to.
- creditNoteDate string? - The date of the credit note.
- status CreditNoteStatus? - The status of a credit note.
- reference string? - The credit note reference.
- accountsReceivableLedgerAccount string? - The accounts receivable ledger account. Note: It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.
- classification string? - The classification.
- template string? - The template used to print or email the credit note.
- notes string? - Notes related to the credit note.
reckon.one: CreditNotes![](/images/permalink.svg)
A list of credit notes.
Fields
- list CreditNote[]? - The list of items.
reckon.one: CreditNoteSettings![](/images/permalink.svg)
A book's credit note settings.
Fields
- prefix string? - The invoice prefix.
- defaultTemplate record {}? - The default invoice template.
- emailSettings record {}? - Email settings.
reckon.one: CreditNoteSettingsPatch![](/images/permalink.svg)
Credit note settings to patch.
Fields
- prefix string? - The credit note prefix.
- defaultTemplate string? - The default credit note template.
- emailSettings record {}? - Email settings.
reckon.one: CreditNoteTransactionLinkInput![](/images/permalink.svg)
Details of a transaction to link to a credit note.
Fields
- transactionId string - The unique id of the linked transaction.
- transactionAmount decimal - The transaction's amount.
- transactionType LinkedTransactionType - Type of transaction linked to an invoice.
reckon.one: CreditNoteTransactionLinkPatch![](/images/permalink.svg)
Selected fields to update in a credit note's transaction link.
Fields
- transactionAmount decimal - The transaction's amount.
reckon.one: Customer![](/images/permalink.svg)
A customer
Fields
- id string - The organisation's unique id.
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - The organisation's notes.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- entityTypes record {}? - The organisation's entity types.
- status string? - The organisation's status (Active or Inactive).
- electronicAddresses ElectronicAddress[]? - List of electronic addresses.
- phoneNumbers PhoneNumber[]? - List of phone numbers.
- addresses Address[]? - List of addresses.
- contacts ContactRef[]? - The organisation's contacts list.
- balance decimal? - The organisation's current balance.
- lastModifiedDateTime string - The organisation's last modified date.
- creditLimit decimal? - The customer's credit limit (null for other types).
- paymentTerms record {}? - The customer's peyment term (null for other types).
- invoiceCount int? - The total number of invoices that have been issued to the organisation.
reckon.one: CustomerInput![](/images/permalink.svg)
Details of a customer to create or update.
Fields
- name string - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
- entityTypes record {}? - The organisation's entity types.
- creditLimit decimal? - The customer's credit limit.
- paymentTerms string? - The customer's payment term id.
reckon.one: CustomerPatch![](/images/permalink.svg)
Details of a customer to patch.
Fields
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- entityTypes record {}? - If the entity has other entity types.
- creditLimit decimal? - The customer's credit limit.
- paymentTerms string? - The customer's peyment term id.
reckon.one: Customers![](/images/permalink.svg)
A list of customers.
Fields
- list Customer[]? - The list of items.
reckon.one: CustomerStatementsTemplate![](/images/permalink.svg)
Details of a template.
Fields
- id string - The template's id.
- name string? - The template's name.
- header record {}? - The header detail of a template.
reckon.one: CustomerStatementsTemplates![](/images/permalink.svg)
A list of templates.
Fields
- list CustomerStatementsTemplate[]? - The list of items.
reckon.one: Department![](/images/permalink.svg)
Details of a department.
Fields
- id string - The department's unique id.
- name string? - The department's unique name.
- code string? - The department's unique code.
- status DepartmentStatus - The status of a department.
- notes string? - Notes about the department.
- managers EmployeeRef[]? - A list of managers assigned to the department.
- employees EmployeeRef[]? - A list of employees assigned to the department.
- createdDateTime string - The date and time when the department was created.
- lastModifiedDateTime string - The date and time when the department was last modified.
reckon.one: DepartmentEmployeeInput![](/images/permalink.svg)
Employee belonging to department.
Fields
- id string - An employee's Id.
reckon.one: DepartmentInput![](/images/permalink.svg)
The department being created or updated.
Fields
- name string - The department's unique name.
- code string? - The department's unique code.
- status DepartmentStatus - The status of a department.
- notes string? - Notes about the department.
- managers DepartmentManagerInput[]? - A list of managers assigned to the department.
- employees DepartmentEmployeeInput[]? - A list of employees assigned to the department.
reckon.one: DepartmentManagerInput![](/images/permalink.svg)
Manager belonging to department.
Fields
- id string - A manager's Id.
reckon.one: DepartmentPatch![](/images/permalink.svg)
ThDetails of an department to patch.
Fields
- name string? - The department's unique name.
- code string? - The department's unique code.
- status DepartmentStatus? - The status of a department.
- notes string? - Notes about the department.
reckon.one: Departments![](/images/permalink.svg)
A list of departments.
Fields
- list Department[]? - The list of items.
reckon.one: DocumentAttachment![](/images/permalink.svg)
A document attachment.
Fields
- id string - The attachment's unique id.
- name string? - The attachment's name or file name.
- url string? - The URL to use to retrieve the attachment.
reckon.one: ElectronicAddress![](/images/permalink.svg)
An electronic address.
Fields
- id string? - The electronic address's unique id.
- 'type record {}? - Type of electronic address.
- address string? - The electronic address.
reckon.one: ElectronicAddresses![](/images/permalink.svg)
A list of electronic addresses.
Fields
- list ElectronicAddress[]? - The list of items.
reckon.one: ElectronicAddressInput![](/images/permalink.svg)
Details of an electronic address to create or update.
Fields
- 'type string - The id or name of the electronic address type.
- address string? - The electronic address.
reckon.one: ElectronicAddressPatch![](/images/permalink.svg)
Details of a electronic address to update.
Fields
- address string? - The electronic address.
reckon.one: ElectronicAddressType![](/images/permalink.svg)
Details of an electronic address type.
Fields
- id string - The type's id.
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus - Type status.
- createdDateTime string - The creation UTC date time.
- lastModifiedDateTime string - The last modified UTC date time.
reckon.one: ElectronicAddressTypeInput![](/images/permalink.svg)
Details of an electronic address type to create or update.
Fields
- name string - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: ElectronicAddressTypePatch![](/images/permalink.svg)
Details of an electronic address type to create or update.
Fields
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: ElectronicAddressTypeRef![](/images/permalink.svg)
Reference to an electronic address type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: ElectronicAddressTypes![](/images/permalink.svg)
Electronic address types.
Fields
- list ElectronicAddressType[]? - The list of items.
reckon.one: Email![](/images/permalink.svg)
Details of an email.
Fields
- toAddresses string[]? - A list of "To" addresses.
- ccAddresses string[]? - A list of "CC" addresses.
- bccAddresses string[]? - A list of "BCC" addresses.
- subject string? - The email subject.
- body string? - The email body.
- documentNumber string? - The number of the document that the email relates to.
reckon.one: EmailInput![](/images/permalink.svg)
Details of an email to send.
Fields
- toAddresses string[]? - A list of "To" addresses.
- ccAddresses string[]? - A list of "CC" addresses.
- bccAddresses string[]? - A list of "BCC" addresses.
- subject string - The email subject.
- body string - The email body.
- documentNumber string? - The number of the document that the email relates to.
reckon.one: EmailSettings![](/images/permalink.svg)
The book's tax email settings.
Fields
- bas record {}? - BAS default email settings.
reckon.one: EmailSettingsPatch![](/images/permalink.svg)
The book's tax email settings to patch.
Fields
- bas record {}? - BAS default email settings.
reckon.one: EmailTemplate![](/images/permalink.svg)
The email template.
Fields
- includeCc boolean - Indicates whether includes CC by default when emailing.
- ccAddress string? - Default CC email address.
- includeBcc boolean - Indicates whether includes BCC by default when emailing.
- bccAddress string? - Default BCC email address.
- emailSubject string? - Default email subject.
- emailContent string? - Default email content.
reckon.one: EmailTemplatePatch![](/images/permalink.svg)
The email template to patch.
Fields
- includeCc boolean? - Indicates whether includes CC by default when emailing.
- ccAddress string? - Default CC email address.
- includeBcc boolean? - Indicates whether includes BCC by default when emailing.
- bccAddress string? - Default BCC email address.
- emailSubject string? - Default email subject.
- emailContent string? - Default email content.
reckon.one: Employee![](/images/permalink.svg)
Details of an employee.
Fields
- id string - The employee's unique id.
- name string? - The employee's display name.
- firstName string? - The employee's first name.
- surname string? - The employee's last name.
- notes string? - Additional notes about the employee.
- businessNumber1 string? - The employee's business number 1.
- businessNumber2 string? - The employee's business number 2.
- addresses Address[]? - The employee's addresses.
- status ContactStatus - The status of a contact.
- electronicAddresses ElectronicAddress[]? - List of electronic addresses.
- phoneNumbers PhoneNumber[]? - List of phone numbers
- otherEntityTypes EntityType[]? - A list of other entity types this employee is assigned to.
- lastModifiedDateTime string - The UTC date and time when the employee's details were last modified.
reckon.one: EmployeeInput![](/images/permalink.svg)
Details of an employee.
Fields
- name string - The employee's display name.
- firstName string - The employee's first name.
- surname string - The employee's last name.
- notes string? - Additional notes about the employee.
- businessNumber1 string? - The employee's business number 1.
- businessNumber2 string? - The employee's business number 2.
- status ContactStatus? - The status of a contact.
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
reckon.one: EmployeePatch![](/images/permalink.svg)
Details of an employee.
Fields
- name string? - The employee's display name.
- firstName string? - The employee's first name.
- surname string? - The employee's last name.
- notes string? - Additional notes about the employee.
- businessNumber1 string? - The employee's business number 1.
- businessNumber2 string? - The employee's business number 2.
- status ContactStatus? - The status of a contact.
reckon.one: EmployeeRef![](/images/permalink.svg)
Reference to an employee.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Employees![](/images/permalink.svg)
A list of employees.
Fields
- list Employee[]? - The list of items.
reckon.one: EntityType![](/images/permalink.svg)
Contact's entity types.
Fields
- isCustomer boolean? - Is the entity a customer.
- isSupplier boolean? - Is the entity a suppleir.
- isEmployee boolean? - Is the entity an employee.
- isSuperfund boolean? - Is the entity a superfund.
reckon.one: EntityTypePatch![](/images/permalink.svg)
Contact's entity types.
Fields
- isCustomer boolean? - Is the entity a customer.
- isSupplier boolean? - Is the entity a supplier.
- isEmployee boolean? - Is the entity an employee.
- isSuperfund boolean? - Is the entity a superfund.
reckon.one: ErrorDetail![](/images/permalink.svg)
Details of a specific error.
Fields
- location string? - The location/path of the source of the error.
- message string? - The description of what was wrong at this location.
reckon.one: ErrorResponse![](/images/permalink.svg)
Response sent when an error occurs.
Fields
- message string? - The description of the error.
- code int - The HTTP status code of the error.
- errors ErrorDetail[]? - An array of specific errors where relevant.
reckon.one: ErrorResponseForbidden![](/images/permalink.svg)
Response sent when a 403 Forbidden error occurs.
Fields
- message string? - The description of the error.
- code int - The HTTP status code of the error.
reckon.one: ErrorResponseNotFound![](/images/permalink.svg)
Response sent when a 404 Forbidden error occurs.
Fields
- message string? - The description of the error.
- code int - The HTTP status code of the error.
reckon.one: ErrorResponseUnauthorized![](/images/permalink.svg)
Response sent when a 401 Unauthorized error occurs.
Fields
- message string? - The description of the error.
- code int - The HTTP status code of the error.
reckon.one: ErrorResponseUnsupportedMediaType![](/images/permalink.svg)
Response sent when a 415 Unsupported media type error occurs.
Fields
- message string? - The description of the error.
- code int - The HTTP status code of the error.
reckon.one: EstimateTemplate![](/images/permalink.svg)
Details of an estimate template.
Fields
- id string - The template's id.
- name string? - The template's name.
- font string? - The template's font.
- fontSize float - The template's font size.
- header record {}? - The header details of the template.
- content record {}? - The content's details of the template.
- footer record {}? - The footer details of the template.
reckon.one: EstimateTemplateContent![](/images/permalink.svg)
Details of the content of a template.
Fields
- project boolean - Is Project included in the template's content.
- item boolean - Is Item included in the template's content.
- itemPrice boolean - Is ItemPrice included in the template's content.
- description boolean - Is Description included in the template's content.
- quantity boolean - Is Quantity included in the template's content.
- taxCode boolean - Is TaxCode included in the template's content.
- tax boolean - Is Tax included in the template's content.
- amount boolean - Is Amount included in the template's content.
reckon.one: EstimateTemplateFooter![](/images/permalink.svg)
Details of the footer of an estimate template.
Fields
- note boolean - Is Note included in the template's footer.
- subtotal boolean - Is Subtotal included in the template's footer.
- taxAmount boolean - Is TaxAmount included in the template's footer.
- totalExcludingTax boolean - Is total excluding tax included in the template's footer.
- total boolean - Is total included in the template's footer.
- termsAndConditions boolean - Is terms and conditions included in the template's footer.
- paymentNotes boolean - Is payment notes included in the template's footer.
- signature boolean - Is signature included in the template's footer.
reckon.one: EstimateTemplateHeader![](/images/permalink.svg)
Details of the header of an estimate template.
Fields
- companyName boolean - Is CompanyName included in the template's header.
- companyAddress boolean - Is CompanyAddress included in the template's header.
- taxNumber boolean - Is TaxNumber included in the template's header.
- phoneNumber boolean - Is PhoneNumber included in the template's header.
- email boolean - Is Email included in the template's header.
- website boolean - Is Website included in the template's header.
- logo record {}? - Logo of the template's header.
- billingAddress boolean - Is billing address included in the template's header.
- shippingAddress boolean - Is shipping address included in the template's header.
- estimateDate boolean - Is estimate date included in the template's header.
- estimateNumber boolean - Is estimate number included in the template's header.
- expiryDate boolean - Is expiry date included in the template's header.
- referenceCode boolean - Is reference code included in the template's header.
- customText boolean - Is custom text included in the template's header.
- customTextValue string? - The custom text value of the template's header.
reckon.one: EstimateTemplates![](/images/permalink.svg)
A list of estimate templates.
Fields
- list EstimateTemplate[]? - The list of items.
reckon.one: ExpenseClaim![](/images/permalink.svg)
An expense claim.
Fields
- id string - The expense claim's unique id.
- claimNumber string? - The expense claim's number.
- employee record {}? - The employee who lodged the expense claim.
- claimDate string - The date of the expense claim.
- reference string? - The reference entered by the employee.
- project record {}? - The project that the expense claim relates to.
- customer record {}? - The customer that the expense claim relates to.
- totalAmount decimal - The total amount of the expense claim.
- balance decimal - The balance that has not yet been reimbursed to the employee.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- totalTaxAmount decimal? - The total tax amount of the expense claim.
- status ExpenseClaimStatus - The status of an expense claim.
- transactionLinks TransactionLink[]? - Details of transactions (e.g. payments) that are linked to the expense claim.
- lineItems ExpenseClaimLineItem[]? - The individual items that make up the expense claim.
- notes string? - The notes entered by the employee.
- declineReason string? - When an expense claim has been declined, this field will provide the reason.
reckon.one: ExpenseClaimInput![](/images/permalink.svg)
Details of an expense claim to create or update.
Fields
- employee string - The employee who lodged the expense claim.
- claimDate string - The date of the expense claim.
- reference string? - The reference entered by the employee.
- project string? - The project that the expense claim relates to.
- customer string? - The customer that the expense claim relates to.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- status ExpenseClaimStatus? - The status of an expense claim.
- lineItems ExpenseClaimLineItemInput[]? - The individual items that make up the expense claim.
- notes string? - The notes entered by the employee.
reckon.one: ExpenseClaimLineItem![](/images/permalink.svg)
An expense claim line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- date string - The date of the line item.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on an expense claim line item.
- accountDetails record {}? - Details of an account used on an expense claim line item.
- supplier record {}? - The supplier that the line item relates to.
- customer record {}? - The customer that the line item relates to.
- isBillable boolean? - Whether the line item is billable to the customer.
- billableStatus BillableStatus - The billable status.
- description string? - The description of the expense.
- taxAmount decimal? - The tax amount.
- taxRate record {}? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
- notes string? - Notes relating to the expense.
- attachments DocumentAttachment[]? - Document attachments related to the expense.
reckon.one: ExpenseClaimLineItemAccountDetails![](/images/permalink.svg)
Details of an account used on an expense claim line item.
Fields
- ledgerAccount record {}? - The id and full name of the ledger account that the expense claim line relates to.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount.
reckon.one: ExpenseClaimLineItemAccountDetailsInput![](/images/permalink.svg)
Details of an account used on an expense claim line item.
Fields
- ledgerAccount string - The id or full name of the ledger account that the expense claim line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the expense claim's
amountTaxStatus
).
reckon.one: ExpenseClaimLineItemAccountDetailsPatch![](/images/permalink.svg)
Details of an account used on an expense claim line item.
Fields
- ledgerAccount string? - The id or full name of the ledger account that the expense claim line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the expense claim's
amountTaxStatus
).
reckon.one: ExpenseClaimLineItemInput![](/images/permalink.svg)
Details of an expense claim line item to create or update.
Fields
- lineNumber int - The line number.
- date string - The date of the line item.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- supplier string? - The supplier that the line item relates to.
- customer string? - The customer that the line item relates to.
- isBillable boolean? - Whether the line item is billable to the customer.
- billableStatus BillableStatus? - The billable status.
- itemDetails record {}? - Details of an item used on an expense claim line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an expense claim line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the expense.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
- notes string? - Notes relating to the expense.
reckon.one: ExpenseClaimLineItemItemDetails![](/images/permalink.svg)
Details of an item used on an expense claim line item.
Fields
- item record {}? - The id and full name of the item that the expense claim line relates to.
- price decimal? - The price of each item.
- quantity decimal? - The quantity purchased.
reckon.one: ExpenseClaimLineItemItemDetailsInput![](/images/permalink.svg)
Details of an item used on an expense claim line item.
Fields
- item string - The id or full name of the item that the expense claim line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
reckon.one: ExpenseClaimLineItemItemDetailsPatch![](/images/permalink.svg)
Details of an item used on an expense claim line item.
Fields
- item string? - The id or full name of the item that the expense claim line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
reckon.one: ExpenseClaimLineItemPatch![](/images/permalink.svg)
Details of an expense claim line item to patch.
Fields
- lineNumber int? - The line number.
- date string? - The date of the line item.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- supplier string? - The supplier that the line item relates to.
- customer string? - The customer that the line item relates to.
- isBillable boolean? - Whether the line item is billable to the customer.
- billableStatus BillableStatus? - The billable status.
- itemDetails record {}? - Details of an item used on an expense claim line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an expense claim line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the expense.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
- notes string? - Notes relating to the expense.
reckon.one: ExpenseClaimPatch![](/images/permalink.svg)
Details of an expense claim to patch.
Fields
- employee string? - The employee who lodged the expense claim.
- claimDate string? - The date of the expense claim.
- reference string? - The reference entered by the employee.
- project string? - The project that the expense claim relates to.
- customer string? - The customer that the expense claim relates to.
- status ExpenseClaimStatus? - The status of an expense claim.
- declineReason string? - The decline reason when the status is set to Declined. This cannot be used with any other status.
- notes string? - The notes entered by the employee.
reckon.one: ExpenseClaims![](/images/permalink.svg)
A list of expense claims.
Fields
- list ExpenseClaim[]? - The list of items.
reckon.one: FileContentResult![](/images/permalink.svg)
A file content result.
reckon.one: FinancialInstitution![](/images/permalink.svg)
Details of a financial institution.
Fields
- id string - The financial institution's unique id.
- code string? - The financial institution's unique code.
- name string? - The financial institution's name.
reckon.one: FinancialInstitutionRef![](/images/permalink.svg)
Reference to a financial institution.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: FinancialInstitutions![](/images/permalink.svg)
A list of financial institutions.
Fields
- list FinancialInstitution[]? - The list of financial institutions.
reckon.one: FundDetails![](/images/permalink.svg)
Class for the fund details of the superfund provider
Fields
- id string? - The super fund provider's unique id.
- name string? - The name of the superfund
reckon.one: GeneralDetail![](/images/permalink.svg)
Basic business details
Fields
- companyName string? - The company's business/trading name.
- legalName string? - The name of the company that appears on legal documents.
- taxNumber string? - The tax number of the company.
- branchNumber string? - The branch number associated with the tax number.
reckon.one: GeneralDetailPatch![](/images/permalink.svg)
Basic business details to patch.
Fields
- companyName string? - The company's business/trading name.
- legalName string? - The name of the company that appears on legal documents.
- taxNumber string? - The tax number of the company.
- branchNumber string? - The branch number associated with the tax number.
reckon.one: HeartbeatStatus![](/images/permalink.svg)
The current API status.
Fields
- status string? - The status of the API.
- 'version string? - The current API version.
- description string? - The description of the API.
reckon.one: IdNameResponse![](/images/permalink.svg)
A response that contains the resource's id and display name.
Fields
- id string - The resource's id.
- name string? - The resource's display name.
reckon.one: IdResponse![](/images/permalink.svg)
A response that contains the resource's id.
Fields
- id string - The resource's id.
reckon.one: IndustryTypeDetail![](/images/permalink.svg)
Business's industry details.
Fields
- industry string? - Type of industry business belongs to.
- category string? - Category of industry.
- businessType string? - Type of business activity within specified industry.
reckon.one: IndustryTypeDetailPatch![](/images/permalink.svg)
Business's industry details to patch.
Fields
- industry string? - Type of industry business belongs to.
- category string? - Category of industry.
- businessType string? - Type of business activity within specified industry.
reckon.one: Invoice![](/images/permalink.svg)
An invoice
Fields
- id string - The invoice's unique id.
- invoiceNumber string? - The invoice's number.
- customer record {}? - The customer that was invoiced.
- billingAddress record {}? - The address that the invoice was sent to.
- shippingAddress record {}? - The address that the invoice was sent to.
- invoiceDate string - The date of the invoice.
- dueDate string? - The date payment is due by.
- totalAmount decimal - The total amount of the invoice.
- invoiceDiscountAmount decimal? - The invoice discount amount.
- invoiceDiscountPercent decimal? - The invoice discount percentage.
- balance decimal - The balance that has not yet been paid by the customer.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- totalTaxAmount decimal? - The total tax amount of the invoice.
- status InvoiceStatus - The status of an invoice.
- paymentTerms record {}? - Payment terms.
- reference string? - The invoice reference.
- accountsReceivableLedgerAccount record {}? - The accounts receivable ledger account.
- classification record {}? - The classification.
- template record {}? - The template used to print or email the invoice.
- recurringTemplate record {}? - Details of the recurring template.
- transactionLinks TransactionLink[]? - Details of transactions (e.g. Estimates) that are linked to the invoice.
- lineItems InvoiceLineItem[]? - The individual items that make up the invoice.
- notes string? - Notes related to the invoice.
- paymentDetails string? - Details of how to pay the invoice.
- emailStatus EmailStatus - The status of an emailed invoice.
reckon.one: InvoiceConvertFromInput![](/images/permalink.svg)
Details of an invoice to create from an estimate, sales order and etc.
Fields
- id string - The Id of the object that needs to be converted into an invoice.
- 'type InvoiceConvertFromType - Types of an invoice to create from, which can be an estimate, sales order and etc.
reckon.one: InvoiceInput![](/images/permalink.svg)
Details of an invoice to create or update.
Fields
- customer string - The customer that is being invoiced.
- invoiceDate string - The date of the invoice.
- dueDate string? - The date payment is due by.
- invoiceDiscountAmount decimal? - The invoice discount amount.
- invoiceDiscountPercent decimal? - The invoice discount percentage.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- paymentTerms string? - Payment terms.
- reference string? - The invoice reference.
- accountsReceivableLedgerAccount string? - The accounts receivable ledger account. Note: It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.
- classification string? - The classification.
- template string? - The template used to print or email the invoice.
- lineItems InvoiceLineItemInput[]? - The individual items that make up the invoice.
- notes string? - Notes related to the invoice.
- paymentDetails string? - Details of how to pay the invoice.
reckon.one: InvoiceLineItem![](/images/permalink.svg)
An invoice line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- parentLineId string? - The parent line item's unique id.
- serviceDate string? - The date when the service was provided.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on an invoice line item.
- accountDetails record {}? - Details of an account used on an invoice line item.
- description string? - The description of the item.
- taxRate record {}? - The tax rate.
- taxAmount decimal? - The tax amount.
- taxIsModified boolean? - Whether the tax amount has been modified.
- transactionLinks TransactionLink[]? - Details of transactions (e.g. expenses and timesheets) that are linked to the invoice's line items.
reckon.one: InvoiceLineItemAccountDetails![](/images/permalink.svg)
Details of an account used on an invoice line item.
Fields
- ledgerAccount record {}? - The id and full name of the ledger account that the line relates to.
- quantity decimal? - The quantity sold.
- amount decimal? - The amount.
reckon.one: InvoiceLineItemAccountDetailsInput![](/images/permalink.svg)
Details of an account used on an invoice line item.
Fields
- ledgerAccount string - The id or full name of the ledger account that the line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the
amountTaxStatus
).
reckon.one: InvoiceLineItemAccountDetailsPatch![](/images/permalink.svg)
Details of an account used on an invoice line item.
Fields
- ledgerAccount string? - The id or full name of the ledger account that the invoice line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the invoice's
amountTaxStatus
).
reckon.one: InvoiceLineItemInput![](/images/permalink.svg)
Details of an invoice line item to create or update.
Fields
- lineNumber int - The line number.
- serviceDate string? - The date when the service was provided.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an invoice line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an invoice line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: InvoiceLineItemItemDetails![](/images/permalink.svg)
Details of an item used on an invoice line item.
Fields
- item record {}? - The id and full name of the item that the line relates to.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: InvoiceLineItemItemDetailsInput![](/images/permalink.svg)
Details of an item used on an invoice line item.
Fields
- item string - The id or full name of the item that the line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: InvoiceLineItemItemDetailsPatch![](/images/permalink.svg)
Details of an item used on an invoice line item.
Fields
- item string? - The id or full name of the item that the invoice line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the invoice's
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: InvoiceLineItemPatch![](/images/permalink.svg)
Details of an invoice to patch.
Fields
- lineNumber int? - The line number.
- serviceDate string? - The date when the service was provided.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an invoice line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an invoice line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: InvoicePatch![](/images/permalink.svg)
Details of an invoice to patch.
Fields
- customer string? - The customer that is being invoiced.
- invoiceDate string? - The date of the invoice.
- dueDate string? - The date payment is due by.
- invoiceDiscountAmount decimal? - The invoice discount amount.
- invoiceDiscountPercent decimal? - The invoice discount percentage.
- status InvoiceStatus? - The status of an invoice.
- paymentTerms string? - Payment terms.
- reference string? - The invoice reference.
- accountsReceivableLedgerAccount string? - The accounts receivable ledger account. Note: It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.
- classification string? - The classification.
- template string? - The template used to print or email the invoice.
- notes string? - Notes related to the invoice.
- paymentDetails string? - Details of how to pay the invoice.
reckon.one: Invoices![](/images/permalink.svg)
A list of invoices.
Fields
- list Invoice[]? - The list of items.
reckon.one: InvoiceSettings![](/images/permalink.svg)
A book's invoice settings.
Fields
- approvalEnabled boolean - Indicates whether invoice approval is enabled.
- prefix string? - The invoice prefix.
- defaultTemplate record {}? - The default invoice template.
- nextInvoiceNumber int - The number that will be used for the next invoice.
- defaultPaymentDetails string? - The default payment details.
- serviceDateOnInvoice boolean - Indicates whether service date can be used on invoices.
- emailSettings record {}? - Email settings.
reckon.one: InvoiceSettingsPatch![](/images/permalink.svg)
Invoice settings to patch.
Fields
- approvalEnabled boolean - Indicates whether invoice approval is enabled.
- prefix string? - The invoice prefix.
- defaultTemplate string? - The default invoice template.
- nextInvoiceNumber int - The number that will be used for the next invoice.
- defaultPaymentDetails string? - The default payment details.
- serviceDateOnInvoice boolean - Indicates whether service date can be used on invoices.
- emailSettings record {}? - Email settings.
reckon.one: InvoicesSummary![](/images/permalink.svg)
Summary of a book's invoices.
Fields
- totalInvoiceCount int - The total number of invoices.
- totalInvoiceAmount decimal - The total monetary amount of included invoices.
- unpaidInvoiceCount int - The total number of unpaid invoices.
- unpaidInvoiceAmount decimal - The total monetary amount of unpaid invoices.
- overdueInvoiceCount int - The total number of unpaid invoices that are overdue.
- overdueInvoiceAmount decimal - The total monetary amount of unpaid invoices that are overdue.
reckon.one: InvoiceTemplate![](/images/permalink.svg)
Details of an invoice template.
Fields
- id string - The template's id.
- name string? - The template's name.
- font string? - The template's font.
- fontSize float - The template's font size.
- header record {}? - The header details of the template.
- content record {}? - The content's details of the template.
- footer record {}? - The footer details of the template.
reckon.one: InvoiceTemplateContent![](/images/permalink.svg)
Details of the content of an invoice template.
Fields
- project boolean - Is Project included in the template's content.
- item boolean - Is Item included in the template's content.
- itemPrice boolean - Is ItemPrice included in the template's content.
- description boolean - Is Description included in the template's content.
- quantity boolean - Is Quantity included in the template's content.
- taxCode boolean - Is TaxCode included in the template's content.
- tax boolean - Is Tax included in the template's content.
- amount boolean - Is Amount included in the template's content.
- serviceDate boolean - Is ServiceDate included in the template's content.
- account boolean - Is Account included in the template's content.
- discount boolean - Is Discount included in the template's content.
reckon.one: InvoiceTemplateFooter![](/images/permalink.svg)
Details of the footer of an invoice template.
Fields
- note boolean - Is Note included in the template's footer.
- subtotal boolean - Is Subtotal included in the template's footer.
- taxAmount boolean - Is TaxAmount included in the template's footer.
- invoiceDiscount boolean - Is InvoiceDiscount included in the template's footer.
- balanceDue boolean - Is BalanceDue included in the template's footer.
- totalExcludingTax boolean - Is TotalExcludingTax included in the template's footer.
- howToPay boolean - Is HowToPay included in the template's footer.
reckon.one: InvoiceTemplateHeader![](/images/permalink.svg)
Details of the header of an invoice template.
Fields
- companyName boolean - Is CompanyName included in the template's header.
- companyAddress boolean - Is CompanyAddress included in the template's header.
- taxNumber boolean - Is TaxNumber included in the template's header.
- phoneNumber boolean - Is PhoneNumber included in the template's header.
- email boolean - Is Email included in the template's header.
- website boolean - Is Website included in the template's header.
- logo record {}? - Logo of the template's header.
- invoiceTo boolean - Is InvoiceTo included in the template's header.
- shipTo boolean - Is ShipTo included in the template's header.
- invoiceDate boolean - Is InvoiceDate included in the template's header.
- invoiceNumber boolean - Is InvoiceNumber included in the template's header.
- dueDate boolean - Is DueDate included in the template's header.
- invoiceDiscount boolean - Is InvoiceDiscount included in the template's header.
- paymentTerms boolean - Is PaymentTerms included in the template's header.
- referenceCode boolean - Is reference code included in the template's header.
- customText boolean - Is custom text included in the template's header.
- customTextValue string? - The custom text value of the template's header.
reckon.one: InvoiceTemplates![](/images/permalink.svg)
A list of invoice templates.
Fields
- list InvoiceTemplate[]? - The list of items.
reckon.one: Item![](/images/permalink.svg)
Details of an item.
Fields
- id string - The item's unique id.
- name string? - The name of the item.
- parentItem record {}? - The parent item if there is one.
- itemType ItemType - The item type.
- itemCode string? - The item code.
- amountTaxStatus ItemAmountTaxStatus - The tax status of an item's amount.
- status ItemStatus - The status of an item.
- fullName string? - The full name of the item.
- purchase record {}? - Details for the item when it is purchased.
- sale record {}? - Details for the item when it is sold.
- createdDateTime string - The date and time when the item was created.
- lastModifiedDateTime string - The date and time when the item was last modified.
reckon.one: ItemInput![](/images/permalink.svg)
Details of an item to create or update.
Fields
- name string - The name of the item.
- parentItem string? - The parent item if there is one.
- itemType ItemType? - The item type.
- itemCode string? - The item code.
- status ItemStatus? - The status of an item.
- purchase record {}? - Details for the item when it is purchased.
- sale record {}? - Details for the item when it is sold.
- amountTaxStatus ItemAmountTaxStatus - The tax status of an item's amount.
reckon.one: ItemPatch![](/images/permalink.svg)
Details of an item to patch.
Fields
- name string? - The name of the item.
- parentItem string? - The parent item if there is one.
- itemType ItemType? - The item type.
- itemCode string? - The item code.
- status ItemStatus? - The status of an item.
- purchase record {}? - Details for the item when it is purchased.
- sale record {}? - Details for the item when it is sold.
- amountTaxStatus ItemAmountTaxStatus? - The tax status of an item's amount.
reckon.one: ItemRef![](/images/permalink.svg)
Reference to an item.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Items![](/images/permalink.svg)
A list of items.
Fields
- list Item[]? - The list of items.
reckon.one: ItemUse![](/images/permalink.svg)
Item usage details.
Fields
- price decimal? - The item's price.
If the item's
amountTaxStatus
isInclusive
then the price includes tax (gross). If the item'samountTaxStatus
isExclusive
then the price excludes tax (net).
- priceAccuracy int? - The accuracy (number of decimal places) of the price.
- ledgerAccount record {}? - The ledger account.
- description string? - The description.
- taxRate record {}? - The tax rate.
reckon.one: ItemUseInput![](/images/permalink.svg)
Item usage details.
Fields
- price decimal? - The item's price.
If the item's
amountTaxStatus
isInclusive
then the price includes tax (gross). If the item'samountTaxStatus
isExclusive
then the price excludes tax (net).
- priceAccuracy int? - The accuracy (number of decimal places) of the price.
- ledgerAccount string - The ledger account.
- description string? - The description.
- taxRate string? - The tax rate.
reckon.one: ItemUsePatch![](/images/permalink.svg)
Item usage details.
Fields
- price decimal? - The item's price.
If the item's
amountTaxStatus
isInclusive
then the price includes tax (gross). If the item'samountTaxStatus
isExclusive
then the price excludes tax (net).
- priceAccuracy int? - The accuracy (number of decimal places) of the price.
- ledgerAccount string? - The ledger account.
- description string? - The description.
- taxRate string? - The tax rate.
reckon.one: LeaveBalanceItem![](/images/permalink.svg)
Details of a leave balance item.
Fields
- payItem record {}? - The pay item.
- employee record {}? - The employee.
- leaveBalance decimal - The leave balance.
- leaveLoadingValue decimal - The leave loading currency value.
- oteValue decimal - The ordinary time earnings value.
- totalValue decimal - The total value.
reckon.one: LedgerAccount![](/images/permalink.svg)
Details of a ledger account.
Fields
- id string - The account's unique id.
- name string? - The name of the account.
- description string? - The description of the account.
- fullName string? - The full name of the account.
- isDebit boolean - Whether amounts in this account are usually debits.
- parentLedgerAccount record {}? - The parent ledger account if there is one.
- sortOrder int - The order in which the user would like to sort the account relative to other accounts.
- status LedgerAccountStatus - The status of a ledger account.
- defaultTaxRate record {}? - The default tax rate for the account.
- accountType LedgerAccountType - The ledger account type.
- accountCode string? - The account code.
- exportCode string? - The export code for the account.
- bankAccount record {}? - The bank account details when the
accountType
isCurrentAsset_Bank
.
- creditAccount record {}? - The credit account details when the
accountType
isCurrentLiability_CreditCard
.
- balance decimal? - The account's balance as of now.
- lastModifiedDateTime string - The date and time when the account was last modified.
reckon.one: LedgerAccountBankInput![](/images/permalink.svg)
Bank account details.
Fields
- dateOpened string? - When the bank account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- bankBranchNumber string? - The bank branch number (BSB in Australia, Sort Code in UK).
- bankAccountNumber string? - The bank account number.
- openingBalance decimal? - The bank account's opening balance.
- financialInstitution string? - The id of the financial institution.
- includeBalancingTransaction boolean - Whether to include a balancing transaction.
- payerIdentifier string? - The APCA number to identify the payer.
reckon.one: LedgerAccountBankPatch![](/images/permalink.svg)
Bank account details.
Fields
- dateOpened string? - When the bank account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- bankBranchNumber string? - The bank branch number (BSB in Australia, Sort Code in UK).
- bankAccountNumber string? - The bank account number.
- openingBalance decimal? - The bank account's opening balance.
- financialInstitution string? - The id of the financial institution.
- includeBalancingTransaction boolean - Whether to include a balancing transaction.
- payerIdentifier string? - The APCA number to identify the payer.
reckon.one: LedgerAccountCreditInput![](/images/permalink.svg)
Credit account details.
Fields
- dateOpened string? - When the credit account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- openingBalance decimal? - The credit account's opening balance.
reckon.one: LedgerAccountCreditPatch![](/images/permalink.svg)
Credit account details.
Fields
- dateOpened string? - When the credit account was opened.
- lockoffDate string? - The date when transactions are locked. Transactions dated on or before this date cannot be amended.
- openingBalance decimal? - The credit account's opening balance.
reckon.one: LedgerAccountInput![](/images/permalink.svg)
Details of a ledger account to create or update.
Fields
- name string - The name of the account.
- description string? - The description of the account.
- parentLedgerAccount string? - The parent ledger account if there is one.
- sortOrder int? - The order in which the user would like to sort the account relative to other accounts.
- status LedgerAccountStatus? - The status of a ledger account.
- defaultTaxRate string? - The default tax rate for the account.
- accountType LedgerAccountType - The ledger account type.
- accountCode string? - The account code.
- exportCode string? - The export code for the account.
- bankAccount record {}? - The bank account details - only when the
accountType
isCurrentAsset_Bank
.
- creditAccount record {}? - The credit account details - only when the
accountType
isCurrentLiability_CreditCard
.
reckon.one: LedgerAccountPatch![](/images/permalink.svg)
Details of a ledger account to patch.
Fields
- name string? - The name of the account.
- description string? - The description of the account.
- parentLedgerAccount string? - The parent ledger account if there is one.
- sortOrder int? - The order in which the user would like to sort the account relative to other accounts.
- status LedgerAccountStatus? - The status of a ledger account.
- defaultTaxRate string? - The default tax rate for the account.
- accountCode string? - The account code.
- exportCode string? - The export code for the account.
- bankAccount record {}? - The bank account details - only when the
accountType
isCurrentAsset_Bank
.
- creditAccount record {}? - The credit account details - only when the
accountType
isCurrentLiability_CreditCard
.
reckon.one: LedgerAccountRef![](/images/permalink.svg)
Reference to a ledger account.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: LedgerAccounts![](/images/permalink.svg)
A list of ledger accounts.
Fields
- list LedgerAccount[]? - The list of items.
reckon.one: LinkedContactInput![](/images/permalink.svg)
Details of a contact to create or update within an existing organisation.
Fields
- name string - The contact's display name.
- salutation string? - The salutation to use in communications.
- department string? - The contact's department.
- position string? - The contact's position.
- status ContactStatus? - The status of a contact.
- notes string? - Notes for the contact.
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
reckon.one: Logo![](/images/permalink.svg)
Details of a logo.
Fields
- name string? - Name of the logo.
- url string? - Url of the logo.
reckon.one: OrganisationRef![](/images/permalink.svg)
Link to an organisation.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: PayItemRef![](/images/permalink.svg)
Reference to a payroll pay item.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Payment![](/images/permalink.svg)
A Payment.
Fields
- id string - The payments unique id.
- paymentNumber string? - The payments number.
- supplier record {}? - The supplier that made the payment.
- paymentDate string - The date of the payment.
- ledgerAccount record {}? - The id of the bank/cash/credit account where the money was paid from.
- allocateFullAmount boolean - Whether the full amount of the payment has been allocated.
- paymentMethod record {}? - The payment method.
- reference string? - The payment reference.
- notes string? - Notes related to the payment.
- totalAmount decimal - The total amount of the bill.
- reconciliationStatus ReconciliationStatus - Reconciliation status.
- internalNotes string? - Internal Notes related to the payment.
- recurring record {}? - Details of the recurring transaction.
- accountsPayableLedgerAccount record {}? - The accounts receivable ledger account.
- classification record {}? - The classification.
- transactionLinks TransactionLink[]? - Details of transactions that the payment has been allocated to.
- lineItems PaymentLineItem[]? - The individual items that make up the payment.
- lastModifiedDateTime string - The last modified date of the payment
reckon.one: PaymentLineItem![](/images/permalink.svg)
A payment line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on a payment line item.
- accountDetails record {}? - Details of an account used on a payment line item.
- description string? - The description of the item.
- taxRate record {}? - The tax rate.
- taxAmount decimal? - The tax amount.
reckon.one: PaymentLineItemAccountDetails![](/images/permalink.svg)
Details of an account used on a payment line item.
Fields
- ledgerAccount record {}? - The id and full name of the ledger account that the line relates to.
- quantity decimal? - The quantity sold.
- amount decimal? - The amount.
reckon.one: PaymentLineItemItemDetails![](/images/permalink.svg)
Details of an item used on a payment line item.
Fields
- item record {}? - The id and full name of the item that the line relates to.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: PaymentMethod![](/images/permalink.svg)
Details of a payment method.
Fields
- id string - The payment method's id.
- name string? - The payment method's name.
reckon.one: PaymentMethodRef![](/images/permalink.svg)
Reference to a payment method.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: PaymentMethods![](/images/permalink.svg)
Payment methods.
Fields
- list PaymentMethod[]? - The list of items.
reckon.one: Payments![](/images/permalink.svg)
A list of payments.
Fields
- list Payment[]? - The list of items.
reckon.one: PaymentTerm![](/images/permalink.svg)
A payment term
Fields
- id string - The payment term's unique id.
- name string? - The payment term's name.
- description string? - The payment term's description.
- status PaymentTermStatus - The status of a payment term.
- isDefault boolean - Whether the payment term is the default for the transaction type.
- useForInvoice boolean - Whether the payment term is used for invoice type transaction.
- netDueDay int - Net Due day of the payment term.
- netDueDaySelection NetDueDateOptions - Net due date options.
- isDueDateWeekend boolean - Whether the due date falls on weekend. If due date is on a weekend, push due date to the first Monday.
- isIssuedWithinDays boolean - Whether push invoice issue date to following month if invoice issued within x day(s) of the due date.
- issuedWithinDays int - Invoice issued within x day(s) of the due date
reckon.one: PaymentTermDueDate![](/images/permalink.svg)
A payment term's due date
Fields
- dueDate string - The due day of the payment term.
reckon.one: PaymentTermInput![](/images/permalink.svg)
Details of a payment term to create or update.
Fields
- name string - The payment term's name.
- description string? - The payment term's description.
- status PaymentTermStatus? - The status of a payment term.
- isDefault boolean? - Whether the payment term is the default for the transaction type.
- useForInvoice boolean? - Whether the payment term is used for invoice type transaction.
- netDueDay int - Net Due day of the payment term.
- netDueDaySelection NetDueDateOptions - Net due date options.
- isDueDateWeekend boolean? - Whether the due date falls on weekend. If due date is on a weekend, push due date to the first Monday.
- isIssuedWithinDays boolean? - Whether push invoice issue date to following month if invoice issued within x day(s) of the due date.
- issuedWithinDays int? - Invoice issued within x day(s) of the due date
reckon.one: PaymentTermPatch![](/images/permalink.svg)
Details of the payment term to patch.
Fields
- name string? - The payment term's name.
- description string? - The payment term's description.
- status PaymentTermStatus? - The status of a payment term.
- isDefault boolean? - Whether the payment term is the default for the transaction type.
- useForInvoice boolean? - Whether the payment term is used for invoice type transaction.
- netDueDay int? - Net Due day of the payment term.
- netDueDaySelection NetDueDateOptions? - Net due date options.
- isDueDateWeekend boolean? - Whether the due date falls on weekend. If due date is on a weekend, push due date to the first Monday.
- isIssuedWithinDays boolean? - Whether push invoice issue date to following month if invoice issued within x day(s) of the due date.
- issuedWithinDays int? - Invoice issued within x day(s) of the due date
reckon.one: PaymentTermRef![](/images/permalink.svg)
Reference to a payment term.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: PaymentTerms![](/images/permalink.svg)
A list of payment terms.
Fields
- list PaymentTerm[]? - The list of items.
reckon.one: PayrollDefaultAccounts![](/images/permalink.svg)
The payroll settings' default accounts.
Fields
- expenseAccount record {}? - The expense account.
- expenseAccountForCompanySuperContributions record {}? - The expense account for company super contributions.
- liabilityAccount record {}? - The liability account.
- liabilityAccountForWithholdingAmounts record {}? - The liability account for withholding amount.
- payWitholdingAmountToSupplier boolean - Indicates whether pays to supplier through accounts payable.
- supplierForWithholdingAmounts record {}? - Supplier for withholding amounts.
reckon.one: PayrollDefaultAccountsPatch![](/images/permalink.svg)
The payroll settings' default accounts to patch.
Fields
- payWitholdingAmountToSupplier boolean? - Indicates whether pays to supplier through accounts payable.
- expenseAccount string? - The expense account.
- expenseAccountForCompanySuperContributions string? - The expense account for company super contributions.
- liabilityAccount string? - The liability account.
- liabilityAccountForWithholdingAmounts string? - The liability account for withholding amount.
- supplierForWithholdingAmounts string? - Supplier for withholding amounts.
reckon.one: PayrollDefaultBankAccounts![](/images/permalink.svg)
The details of payroll default bank accounts.
Fields
- directCreditPaymentsBankAccount record {}? - The direct credit payment bank account.
- cashPaymentsBankAccount record {}? - The cash payments account.
- superPaymentsBankAccount record {}? - The super payment bank account.
reckon.one: PayrollDefaultBankAccountsPatch![](/images/permalink.svg)
The details of payroll default bank accounts to patch.
Fields
- directCreditPaymentsBankAccount string? - The direct credit payment bank account.
- cashPaymentsBankAccount string? - The cash payments account.
- superPaymentsBankAccount string? - The super payment bank account.
reckon.one: PayrollDefaultPayments![](/images/permalink.svg)
The details of payroll default payments.
Fields
- roundToNearest decimal - Rounding settings of payments.
- expenseAccountForRounding record {}? - Expense account for rounding of cash payments.
reckon.one: PayrollDefaultPaymentsPatch![](/images/permalink.svg)
The details of payroll default payments to patch.
Fields
- roundToNearest decimal? - Rounding settings of payments.
- expenseAccountForRounding string? - Expense account for rounding of cash payments.
reckon.one: PayrollLeaveBalancesAndAccrualValueMetaData![](/images/permalink.svg)
Meta data for the Payroll Leave Balances and Accrual report.
Fields
- id string - The report's unique id.
- reportName string? - The report's name.
- bookName string? - The book's name.
- companyName string? - The company's name.
- period PayrollLeaveBalancesAndAccrualValueReportPeriod? - Periods that can be used for the Payroll Leave Balances And Accrual Value report.
- asAtDate string? - When using AsAtDate, the date that was used.
reckon.one: PayrollLeaveBalancesAndAccrualValueReport![](/images/permalink.svg)
The Payroll Leave Balances and Accrual report.
Fields
- data LeaveBalanceItem[]? - The report's data.
- metaData record {}? - Data about the report.
- message string? - A message that might contain warnings or additional information about the report contents.
reckon.one: PayrollLeaveBalancesAndAccrualValueReportParameters![](/images/permalink.svg)
The parameters for the Payroll Leave Balances And Accrual Value report.
Fields
- period PayrollLeaveBalancesAndAccrualValueReportPeriod? - Periods that can be used for the Payroll Leave Balances And Accrual Value report.
- asAtDate string? - When using AsAtDate, the date to use.
- leaveItems string[]? - A list of leave item IDs to include in the report. If omitted, all leave items will be included.
- employees string[]? - A list of employee IDs to include in the report. If omitted, all employees will be included.
reckon.one: PayrollLegalContact![](/images/permalink.svg)
The payroll settings' ledgal contact details.
Fields
- firstName string? - The first name of legal contact.
- lastName string? - The last name of legal contact.
- title string? - The legal contact's title.
- phoneNumbers BookPhoneNumber[]? - List of phone numbers.
- electronicAddresses BookElectronicAddress[]? - List of electronic addresses.
reckon.one: PayrollLegalContactPatch![](/images/permalink.svg)
The payroll settings' legal contact details to patch.
Fields
- firstName string? - The first name of legal contact.
- lastName string? - The last name of legal contact.
- title string? - The legal contact's title.
reckon.one: PayrollSettings![](/images/permalink.svg)
A book's payroll settings
Fields
- legalContact record {}? - The payroll settings' legal contact.
- payrollSetup record {}? - The payroll setup details.
- defaultAccounts record {}? - The default payroll accounts.
- defaultPayments record {}? - The default payroll payments.
- automaticPayrollPayments boolean - Indicates whether makes payroll salary and wages payments when users finish each pay run.
- defaultBankAccounts record {}? - The default payroll bank accounts.
reckon.one: PayrollSettingsPatch![](/images/permalink.svg)
A book's payroll settings to patch.
Fields
- legalContact record {}? - The payroll settings' legal contact.
- payrollSetup record {}? - The payroll setup details.
- defaultAccounts record {}? - The default payroll accounts.
- defaultPayments record {}? - The default payroll payments.
- automaticPayrollPayments boolean? - Indicates whether makes payroll salary and wages payments when users finish each pay run.
- defaultBankAccounts record {}? - The default payroll bank accounts.
reckon.one: PayrollSetup![](/images/permalink.svg)
A book's payroll setup.
Fields
- copyPayItemsFromPreviousPay boolean - Indicates whether the pay run copies pay items from previous pay (overrides default pay items).
- trackProjectCost boolean - Indicates whether it tracks project cost.
- allowPayRatesEditInPayRuns boolean - Indicates whether it allows editing of pay rates on pay runs.
- optionalEmailPasswordProtection boolean - Indicates whether it enables password protection for emailing pay slips and payment summaries.
- displayYTDOnPayrun boolean - Indicates whether it displays YTD amounts on pay run.
reckon.one: PayrollSetupPatch![](/images/permalink.svg)
A book's payroll setup to patch.
Fields
- copyPayItemsFromPreviousPay boolean? - Indicates whether the pay run copies pay items from previous pay (overrides default pay items).
- trackProjectCost boolean? - Indicates whether it tracks project cost.
- allowPayRatesEditInPayRuns boolean? - Indicates whether it allows editing of pay rates on pay runs.
- optionalEmailPasswordProtection boolean? - Indicates whether it enables password protection for emailing pay slips and payment summaries.
- displayYTDOnPayrun boolean? - Indicates whether it displays YTD amounts on pay run.
reckon.one: Permissions![](/images/permalink.svg)
List of permissions.
Fields
- list string[]? - The list of items.
reckon.one: PhoneNumber![](/images/permalink.svg)
A phone number.
Fields
- id string? - The phone number's unique id.
- 'type record {}? - The type of phone number.
- countryCode string? - The country code.
- areaCode string? - The area code.
- number string? - The number.
- extension string? - The extension.
reckon.one: PhoneNumberInput![](/images/permalink.svg)
Details of a phone number to create or update.
Fields
- countryCode string? - The country code.
- areaCode string? - The area code.
- number string? - The number.
- extension string? - The extension.
- 'type string - The id or name of the phone number type.
reckon.one: PhoneNumberPatch![](/images/permalink.svg)
Details of a phone number to update.
Fields
- countryCode string? - The country code.
- areaCode string? - The area code.
- number string? - The number.
- extension string? - The extension.
reckon.one: PhoneNumbers![](/images/permalink.svg)
A list of phone numbers.
Fields
- list PhoneNumber[]? - The list of items.
reckon.one: PhoneType![](/images/permalink.svg)
Details of a phone type.
Fields
- id string - The type's id.
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus - Type status.
- createdDateTime string - The creation UTC date time.
- lastModifiedDateTime string - The last modified UTC date time.
reckon.one: PhoneTypeInput![](/images/permalink.svg)
Details of a phone type to create or update.
Fields
- name string - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: PhoneTypePatch![](/images/permalink.svg)
Details of a phone type to create or update.
Fields
- name string? - The type's name.
- description string? - The type's description.
- status TypeStatus? - Type status.
reckon.one: PhoneTypeRef![](/images/permalink.svg)
Reference to a phone type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: PhoneTypes![](/images/permalink.svg)
Phone types.
Fields
- list PhoneType[]? - The list of items.
reckon.one: Project![](/images/permalink.svg)
A project
Fields
- id string - The project's unique id.
- name string? - The project's name.
- fullName string? - The project's full name.
- parentProject record {}? - The parent project.
- status ProjectStatus - The status of a project.
- startDate string? - The date the project starts.
- endDate string? - The date the project ends.
- description string? - A description of the project.
- amountTaxStatus ProjectAmountTaxStatus - The tax status of an item's amount.
- customers ProjectCustomer[]? - Customers linked to the project.
- suppliers ProjectSupplier[]? - Suppliers linked to the project.
- items ProjectItem[]? - Items used in the project.
- lastModifiedDateTime string - Timestamp of when project record was last modified.
reckon.one: ProjectCustomer![](/images/permalink.svg)
A customer linked to a project.
Fields
- lineId string - Record identifier.
- customer record {}? - The customer.
- weighting decimal - Weighting.
reckon.one: ProjectCustomerInput![](/images/permalink.svg)
Details of a project customer to create or update.
Fields
- weighting decimal? - Weighting assigned to contact.
- customer string - The id or name of the customer.
reckon.one: ProjectCustomerPatch![](/images/permalink.svg)
Details of a project customer to patch.
Fields
- customer string? - The id or name of the customer.
reckon.one: ProjectInput![](/images/permalink.svg)
Details of a project to create or update.
Fields
- name string - Name of project.
- status ProjectStatus? - The status of a project.
- amountTaxStatus ProjectAmountTaxStatus? - The tax status of an item's amount.
- parentProject string? - The parent project.
- startDate string? - The date the project starts.
- endDate string? - The date the project ends.
- description string? - A description of the project.
- items ProjectItemInput[]? - Items used in the project.
- customers ProjectCustomerInput[]? - Customers linked to the project.
- suppliers ProjectSupplierInput[]? - Suppliers linked to the project.
reckon.one: ProjectItem![](/images/permalink.svg)
An item linked to a project.
Fields
- lineId string - Record identifier.
- item record {}? - The item.
- description string? - Description of the linked item.
- regularRate decimal? - Rate at which item is usually charged.
- projectRate decimal? - Rate at which item is charged for this project.
- taxRate record {}? - Tax rate of item.
reckon.one: ProjectItemInput![](/images/permalink.svg)
Details of a project item to create or update.
Fields
- item string - The id or name of the item.
- projectRate decimal? - Rate at which item is charged for this project.
reckon.one: ProjectItemPatch![](/images/permalink.svg)
Details of a project item to patch.
Fields
- item string? - The id or name of the item.
- projectRate decimal? - Rate at which item is charged for this project.
reckon.one: ProjectPatch![](/images/permalink.svg)
Details of a project to patch.
Fields
- name string? - Name of project.
- status ProjectStatus? - The status of a project.
- amountTaxStatus ProjectAmountTaxStatus? - The tax status of an item's amount.
- parentProject string? - The parent project.
- startDate string? - The date the project starts.
- endDate string? - The date the project ends.
- description string? - A description of the project.
reckon.one: ProjectRef![](/images/permalink.svg)
Reference to a project.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Projects![](/images/permalink.svg)
A list of projects.
Fields
- list Project[]? - The list of items.
reckon.one: ProjectSupplier![](/images/permalink.svg)
A supplier linked to a project.
Fields
- lineId string - Record identifier.
- supplier record {}? - The supplier.
- weighting decimal - Weighting.
reckon.one: ProjectSupplierInput![](/images/permalink.svg)
Details of a project supplier to create or update.
Fields
- weighting decimal? - Weighting assigned to contact.
- supplier string - The id or name of the supplier.
reckon.one: ProjectSupplierPatch![](/images/permalink.svg)
Details of a project supplier to patch.
Fields
- supplier string? - The id or name of the suplier.
reckon.one: Receipt![](/images/permalink.svg)
A receipt.
Fields
- id string - The receipt's unique id.
- receiptNumber string? - The receipt's number.
- customer record {}? - The customer that made the payment.
- receiptDate string - The date of the receipt.
- ledgerAccount record {}? - The id of the bank/cash/credit account where the money was received.
- allocateFullAmount boolean - Whether the full amount of the receipt has been allocated.
- paymentMethod record {}? - The payment method.
- reference string? - The receipt reference.
- notes string? - Notes related to the receipt.
- totalAmount decimal - The total amount of the invoice.
- reconciliationStatus ReconciliationStatus - Reconciliation status.
- internalNotes string? - Internal Notes related to the receipt.
- recurring record {}? - Details of the recurring transaction.
- accountsReceivableLedgerAccount record {}? - The accounts receivable ledger account.
- classification record {}? - The classification.
- transactionLinks TransactionLink[]? - Details of transactions that the receipt has been allocated to.
- lineItems ReceiptLineItem[]? - The individual items that make up the receipt.
reckon.one: ReceiptInput![](/images/permalink.svg)
Details of a receipt to create or update.
Fields
- customer string - The customer that is being invoiced.
- receiptDate string - The date of the receipt.
- ledgerAccount string? - The id or name of the bank/cash/credit account where the money was received.
- paymentMethod string? - The id or name of the payment method used.
- reference string? - The receipt reference.
- notes string? - Notes related to the receipt.
- totalAmount decimal - The total amount of the invoice.
- reconciliationStatus ReconciliationStatus? - Reconciliation status.
- internalNotes string? - Internal Notes related to the receipt.
- accountsReceivableLedgerAccount string? - The accounts receivable ledger account. Note: It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.
- classification string? - The classification.
- lineItems ReceiptLineItemInput[]? - The individual items that make up the receipt.
- transactionLinks ReceiptTransactionLinkInput[]? - Details of transactions that the receipt should be allocated to.
reckon.one: ReceiptLineItem![](/images/permalink.svg)
A receipt line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on a receipt line item.
- accountDetails record {}? - Details of an account used on a receipt line item.
- description string? - The description of the item.
- taxRate record {}? - The tax rate.
- taxAmount decimal? - The tax amount.
reckon.one: ReceiptLineItemAccountDetails![](/images/permalink.svg)
Details of an account used on a receipt line item.
Fields
- ledgerAccount record {}? - The id and full name of the ledger account that the line relates to.
- quantity decimal? - The quantity sold.
- amount decimal? - The amount.
reckon.one: ReceiptLineItemAccountDetailsInput![](/images/permalink.svg)
Details of an account used on an receipt line item.
Fields
- ledgerAccount string - The id or full name of the ledger account that the line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the
amountTaxStatus
).
reckon.one: ReceiptLineItemAccountDetailsPatch![](/images/permalink.svg)
Details of an account used on an receipt line item.
Fields
- ledgerAccount string? - The id or full name of the ledger account that the invoice line relates to. Note that the full name includes the name(s) of any parent account(s) separated by colons.
- quantity decimal? - The quantity purchased.
- amount decimal? - The amount including or excluding tax (depending on the invoice's
amountTaxStatus
).
reckon.one: ReceiptLineItemInput![](/images/permalink.svg)
Details of a receipt line item to create or update.
Fields
- lineNumber int - The line number.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an invoice line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an invoice line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: ReceiptLineItemItemDetails![](/images/permalink.svg)
Details of an item used on a receipt line item.
Fields
- item record {}? - The id and full name of the item that the line relates to.
- price decimal? - The price of each item.
- quantity decimal? - The quantity sold.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: ReceiptLineItemItemDetailsInput![](/images/permalink.svg)
Details of an item used on an receipt line item.
Fields
- item string - The id or full name of the item that the line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: ReceiptLineItemItemDetailsPatch![](/images/permalink.svg)
Details of an item used on an receipt line item.
Fields
- item string? - The id or full name of the item that the invoice line relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- price decimal? - The price of each item including or excluding tax (depending on the invoice's
amountTaxStatus
).
- quantity decimal? - The quantity purchased.
- discountAmount decimal? - The total discount for the line item.
- discountPercent decimal? - The discount percentage for the line item.
reckon.one: ReceiptLineItemPatch![](/images/permalink.svg)
Details of a receipt line item to update.
Fields
- lineNumber int? - The line number.
- project string? - The id or full name of the project that the line item relates to. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- itemDetails record {}? - Details of an item used on an receipt line item.
This must be omitted if
accountDetails
have been provided.
- accountDetails record {}? - Details of an account used on an receipt line item.
This must be omitted if
itemDetails
have been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
reckon.one: ReceiptPatch![](/images/permalink.svg)
Details of a receipt to update.
Fields
- customer string? - The customer that is being invoiced.
- receiptDate string? - The date of the receipt.
- ledgerAccount string? - The id or name of the bank/cash/credit account where the money was received.
- paymentMethod string? - The id or name of the payment method used.
- reference string? - The receipt reference.
- notes string? - Notes related to the receipt.
- totalAmount decimal - The total amount of the invoice.
- reconciliationStatus ReconciliationStatus? - Reconciliation status.
- internalNotes string? - Internal Notes related to the receipt.
- classification string? - The classification.
reckon.one: Receipts![](/images/permalink.svg)
A list of receipts.
Fields
- list Receipt[]? - The list of items.
reckon.one: ReceiptSettings![](/images/permalink.svg)
A book's receipt settings.
Fields
- prefix string? - The receipt prefix.
- defaultBankAccount record {}? - The default invoice bank account.
- emailSettings record {}? - Email settings.
reckon.one: ReceiptSettingsPatch![](/images/permalink.svg)
Receipt settings to patch.
Fields
- prefix string? - The receipt prefix.
- defaultBankAccount string? - The default bank account.
- emailSettings record {}? - Email settings.
reckon.one: ReceiptTransactionLinkInput![](/images/permalink.svg)
Details of a transaction to link to a receipt.
Fields
- transactionId string - The unique id of the linked transaction.
- transactionAmount decimal - The transaction's amount.
- transactionType LinkedTransactionType - Type of transaction linked to an invoice.
reckon.one: ReceiptTransactionLinkPatch![](/images/permalink.svg)
Selected fields to update in receipt's transaction link.
Fields
- transactionAmount decimal - The transaction's amount.
reckon.one: RecurringInvoiceLineItemTemplateDetails![](/images/permalink.svg)
Details of a recurring invoice line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- parentLineId string? - The parent line item's unique id.
- project record {}? - The id and full name of the project that the line item relates to.
- itemDetails record {}? - Details of an item used on an invoice line item.
- accountDetails record {}? - Details of an account used on an invoice line item.
- description string? - The description of the item.
- taxRate record {}? - The tax rate.
- taxAmount decimal? - The tax amount.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: RecurringInvoiceTemplate![](/images/permalink.svg)
Recurring invoice template.
Fields
- id string - The recurring template's unique id.
- name string? - The recurring template's name.
- frequencyQuantity int - The number of days, weeks or months between each occurrence.
- frequencyPeriod FrequencyPeriod - Frequency period for a recurring template.
- startDate string - The date of the first occurrence.
- endOfSchedule FrequencyEndType - Frequency end type for a recurring template.
- endAfterOccurrences int? - Ends once the defined number of occurrences have occurred.
- endAfterDate string? - Ends once the defined date has been reached.
- useLastDayOfEachMonth boolean - Whether to always use the last day of each month for each occurrence.
- numberOfOccurrencesRemaining int? - The number of occurrences remaining.
- nextTransactionDate string? - The date of the next occurrence.
- status RecurringTemplateStatus - Recurring template status.
- emailAutomatically boolean - Whether to automatically email each occurrence.
- invoice record {}? - Details of the recurring invoice.
reckon.one: RecurringInvoiceTemplateDetails![](/images/permalink.svg)
Details of the recurring invoice.
Fields
- customer record {}? - The customer that will be invoiced.
- billingAddress record {}? - The address that the invoice will be sent to.
- shippingAddress record {}? - The address that the goods/service will be sent to.
- totalAmount decimal - The total amount of the invoice.
- invoiceDiscountAmount decimal? - The invoice discount amount.
- invoiceDiscountPercent decimal? - The invoice discount percentage.
- amountTaxStatus AmountTaxStatus - The tax status of an amount.
- totalTaxAmount decimal? - The total tax amount of the invoice.
- paymentTerms record {}? - Payment terms.
- reference string? - The invoice reference.
- accountsReceivableLedgerAccount record {}? - The accounts receivable ledger account.
- classification record {}? - The classification.
- template record {}? - The template used to print or email the invoice.
- transactionLinks TransactionLink[]? - Details of transactions (e.g. Invoices) that are linked to the recurring template.
- lineItems RecurringInvoiceLineItemTemplateDetails[]? - The individual items that make up the invoice.
- notes string? - Notes related to the invoice.
- paymentDetails string? - Details of how to pay the invoice.
reckon.one: RecurringTemplateRef![](/images/permalink.svg)
Reference to a recurring template.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: RecurringTransactionRef![](/images/permalink.svg)
Reference to a recurring transaction.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: ReportDefinition![](/images/permalink.svg)
Details of a report definition.
Fields
- id string - The report's unique id.
- name string? - The reports name.
- description string? - A description of the report.
- favourite boolean - Whether the report is a favourite of the user.
- category ReportCategory - Report categories.
reckon.one: Reports![](/images/permalink.svg)
Reports
Fields
- list ReportDefinition[]? - The list of items.
reckon.one: Role![](/images/permalink.svg)
A role.
Fields
- id int - The role's unique id.
- name string? - The role's unique name.
- description string? - A description of the role.
- systemRole boolean - Whether or not the role is a system role. System roles cannot be modified or deleted.
- permissions record {}? - The role's detailed permissions.
- users UserRef[]? - The users that are assigned to the role.
reckon.one: RolePermissions![](/images/permalink.svg)
Role permissions.
Fields
- accountEnquiryReport record {}? - Permissions for the Account Enquiry report.
- accountListReport record {}? - Permissions for the Account List report.
- accounts record {}? - Permissions for the Chart of Accounts.
- activityStatements record {}? - Permissions for Activity Statements.
- agedCreditorsSummaryReport record {}? - Permissions for the Aged Creditors summary report.
- agedCreditorsTransactionsReport record {}? - Permissions for the Aged Creditors transactions report.
- agedDebtorsSummaryReport record {}? - Permissions for the Aged Debtors summary report.
- agedDebtorsTransactionsReport record {}? - Permissions for the Aged Debtors transactions report.
- balanceSheetReport record {}? - Permissions for the Balance Sheet report.
- bankAccounts record {}? - Permissions for bank accounts.
- bankPayments record {}? - Permissions for bank payments.
- bankReconciliationReport record {}? - Permissions for the Bank Reconciliation report.
- bankStatementReport record {}? - Permissions for the Bank Statement report.
- bankTransfers record {}? - Permissions for bank transfers.
- billListReport record {}? - Permissions for the Bill List report.
- bills record {}? - Permissions for bills.
- bookSettings record {}? - Permissions for book settings.
- budgets record {}? - Permissions for budgets.
- budgetsReport record {}? - Permissions for the Budgets report.
- classifications record {}? - Permissions for classifications.
- contactDetailTypes record {}? - Permissions for contact detail types.
- contacts record {}? - Permissions for contacts.
- creditNotes record {}? - Permissions for credit notes.
- customerListReport record {}? - Permissions for the Customer List report.
- customers record {}? - Permissions for customers.
- customerStatements record {}? - Permissions for customer statements.
- customerTransactionsReport record {}? - Permssions for the Customer Transactions report.
- departments record {}? - Permissions for departments.
- documentStorage record {}? - Permissions for document storage.
- emails record {}? - Permissions for emails.
- emailSettings record {}? - Permissions for email settings.
- employees record {}? - Permissions for employees.
- employeeListReport record {}? - Permissions for the Employee List report.
- estimateListReport record {}? - Permissions for the Estimate List report.
- estimates record {}? - Permissions for estimates.
- expenseClaimListReport record {}? - Permissions for the Expense Claim List report.
- expenseClaims record {}? - Permissions for expense claims.
- expenseClaimSettings record {}? - Permissions for expense claim settings.
- expenseClaimTransactionsReport record {}? - Permissions for the Expense Claim Transactions report.
- gstSummaryReport record {}? - Permissions for the GST Summary report.
- invoiceListReport record {}? - Permissions for the Invoice List report.
- invoices record {}? - Permissions for invoices.
- itemListReport record {}? - Permissions for the Item List report.
- items record {}? - Permissions for items.
- journalListReport record {}? - Permissions for the Journal List report.
- journals record {}? - Permissions for journals.
- ledgerTransactionsReport record {}? - Permissions for the Ledger Transactions report.
- moneyInSettings record {}? - Settings for money in settings (invoices, receipts, credit notes etc.).
- moneyOutSettings record {}? - Permissions for money out settings (bills, payments, supplier credit notes etc.).
- paymentListReport record {}? - Permissions for the Payment List report.
- payments record {}? - Permissions for payments.
- payrollAdjustments record {}? - Permissions for payroll adjustments.
- payrollDetailReport record {}? - Permissions for the Payroll Detail report.
- payrollEmployeeListReport record {}? - Permissions for the Payroll Employee List report.
- payrollItems record {}? - Permissions for payroll pay items.
- payrollLeaveBalancesReport record {}? - Permissions for the Payroll Leave Balances report.
- payrollPayments record {}? - Permissions for payroll payments.
- payrollPaymentScheduleReport record {}? - Permissions for the Payroll Payment Schedule report.
- payrollSettings record {}? - Permissions for payroll settings.
- payrollSummaryReport record {}? - Permissions for the Payroll Summary report.
- payrollTransactionSummaryReport record {}? - Permissions for the Payroll Transaction Summary report.
- payrollPaymentSummaries record {}? - Permissions for payroll payment summaries.
- payruns record {}? - Permissions for pay runs.
- paySlips record {}? - Permissions for pay slips.
- profitAndLossReport record {}? - Permissions for the Profit And Loss report.
- projectListReport record {}? - Permissions for the Project List report.
- projects record {}? - Permissions for projects.
- receiptListReport record {}? - Permissions for the Receipts List report.
- receipts record {}? - Permissons for receipts.
- recurringTransactions record {}? - Permissions for recurring transactions.
- reportSettings record {}? - Permissions for settings.
- restHooks record {}? - Permissions for REST hooks.
- roles record {}? - Permissions for roles.
- salesByItemReport record {}? - Permissions for the Sales By Item report.
- singleTouchPayroll record {}? - Permissions for Single Touch Payroll.
- statementSettings record {}? - Permissions for statements.
- superContributionsByEmployeeReport record {}? - Permissions for the Super Contributions By Employee report.
- superFunds record {}? - Permissions for super funds.
- superStream record {}? - Permissions for SuperStream
- superTransactionsReport record {}? - Permissions for the Super Transactions report.
- supplierCreditNotes record {}? - Permissions for supplier credit notes.
- supplierListReport record {}? - Permissions for the Supplier List report.
- suppliers record {}? - Permissions for suppliers.
- supplierTransactionsReport record {}? - Permissions for the Supplier Transactions report.
- taxCodeExceptionReport record {}? - Permissions for the Tax Code Exception report.
- taxCodeListReport record {}? - Permissions for the Tax Code List report.
- taxCodeTransactionsReport record {}? - Permissions for the Tax Code Transactions report.
- taxSettings record {}? - Permissions for tax settings.
- terms record {}? - Permissions for payment terms.
- timeEntries record {}? - Permissions for time entries.
- timeEntriesReport record {}? - Permissions for the Time Entries report.
- timeSettings record {}? - Permissions for time settings.
- topCustomersReport record {}? - Permissions for the Top 10 Customers report.
- topExpenseAccountsReport record {}? - Permissions for the Top 10 Expense Accounts report.
- topIncomeAccountsReport record {}? - Permissions for the Top 10 Income Accounts report.
- topSuppliersReport record {}? - Permissions for the Top 10 Suppliers report.
- tpar record {}? - Permissions for TPAR.
- transactionLineItemsReport record {}? - Permissions for the Transaction Line Items report.
- trialBalanceReport record {}? - Permissions for the Trial Balance report.
- uninvoicedAmountsByCustomerReport record {}? - Permissions for the Uninvoiced Amounts By Customer report.
- uninvoicedAmountsByProjectReport record {}? - Permissions for the Uninvoiced Amounts By Project report.
- uninvoicedTransactionsByCustomerReport record {}? - Permissions for the Uninvoiced Amounts By Customer report.
- uninvoicedTransactionsByProjectReport record {}? - Permissions for the Uninvoiced Amounts By Project report.
- users record {}? - Permissions for users.
- vat record {}? - Permissions for UK VAT.
reckon.one: RolePermissionsCommon![](/images/permalink.svg)
Common role permissions.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
reckon.one: RolePermissionsForBankAccounts![](/images/permalink.svg)
Role permissions for bank accounts.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- 'import boolean - Whether the role has permission to import bank data.
- reconcile boolean - Whether the role has permission to reconcile a bank account.
reckon.one: RolePermissionsForCustomerStatements![](/images/permalink.svg)
Role permissions for customer statements.
Fields
- create boolean - Whether the role has permission to create.
reckon.one: RolePermissionsForDocumentStorage![](/images/permalink.svg)
Role permissions for document storage.
Fields
- upload boolean - Whether the role has permission to upload.
- download boolean - Whether the role has permission to download.
- delete boolean - Whether the role has permission to delete.
reckon.one: RolePermissionsForEmails![](/images/permalink.svg)
Role permissions for emails.
Fields
- viewHistory boolean - Whether the role has permission to view history.
- resend boolean - Whether the role has permission to resend.
reckon.one: RolePermissionsForEmployees![](/images/permalink.svg)
Role permissions for employees.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- managePayrollEmployeeDetails boolean - Whether the role can manage payroll employee's details.
- viewOwnDetails boolean - Whether the role can view own employee details.
- editOwnDetails boolean - Whether the role can edit own employee details.
reckon.one: RolePermissionsForPaySlips![](/images/permalink.svg)
Role permissions for pay slips.
Fields
- view boolean - Whether the role has permission to view.
- manage boolean - Whether the role has permission to manage.
- print boolean - Whether the role has permission to print.
- email boolean - Whether the role has permission to email.
reckon.one: RolePermissionsForReport![](/images/permalink.svg)
Role permissions for a report.
Fields
- view boolean - Whether the role has permission to view the report.
- export boolean - Whether the role has permission to export the report.
reckon.one: RolePermissionsForRestHooks![](/images/permalink.svg)
Role permissions for REST hooks.
Fields
- modify boolean - Whether the role can modify REST hooks.
reckon.one: RolePermissionsForSettings![](/images/permalink.svg)
Role permissions for settings.
Fields
- view boolean - Whether the role has permission to view.
- edit boolean - Whether the role has permission to edit/update/modify.
reckon.one: RolePermissionsForStp![](/images/permalink.svg)
Role permissions for Single Touch Payroll.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- send boolean - Whether the role has permission to send.
reckon.one: RolePermissionsForSuperStream![](/images/permalink.svg)
Role permissions for SuperStream.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- canLodge boolean - Whether the role has permission to lodge SuperStream.
reckon.one: RolePermissionsForTaxSettings![](/images/permalink.svg)
Role permissions for tax settings.
Fields
- view boolean - Whether the role has permission to view.
- edit boolean - Whether the role has permission to edit/update/modify.
- canDeleteCodeGroup boolean - Whether the role has permission to delete tax codes and tax groups.
reckon.one: RolePermissionsForTimeEntries![](/images/permalink.svg)
Role permissions for time entries.
Fields
- approve boolean - Whether the role has permission to approve.
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- manage boolean - Whether the role has permission to manage.
- assignPayItem boolean - Whether the role has permission to assign a payroll pay item to a time entry.
reckon.one: RolePermissionsForUsers![](/images/permalink.svg)
Role permissions for users.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- editOtherUser boolean - Whether the role has permission to edit another user's details.
- invite boolean - Whether the role has permission to invite a user.
reckon.one: RolePermissionsForVat![](/images/permalink.svg)
Role permissions for UK VAT.
Fields
- authorise boolean - Whether the role has permission to authorise.
- print boolean - Whether the role has permission to print.
- submit boolean - Whether the role has permission to submit.
- view boolean - Whether the role has permission to view.
reckon.one: RolePermissionsWithApproveManage![](/images/permalink.svg)
Common role permissions plus approve and manage actions.
Fields
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- approve boolean - Whether the role has permission to approve.
- manage boolean - Whether the role has permission to manage.
reckon.one: RolePermissionsWithPrintApprove![](/images/permalink.svg)
Common role permissions plus print and approve actions.
Fields
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- approve boolean - Whether the role has permission to approve.
reckon.one: RolePermissionsWithPrintEmail![](/images/permalink.svg)
Common role permissions plus print and email actions.
Fields
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- email boolean - Whether the role has permission to email.
reckon.one: RolePermissionsWithPrintEmailApprove![](/images/permalink.svg)
Common role permissions plus print, email and approve actions.
Fields
- email boolean - Whether the role has permission to email.
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- approve boolean - Whether the role has permission to approve.
reckon.one: RolePermissionsWithPrintEmailApproveManage![](/images/permalink.svg)
Common role permissions plus print, email, approve and manage actions.
Fields
- approve boolean - Whether the role has permission to approve.
- email boolean - Whether the role has permission to email.
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit/update/modify.
- delete boolean - Whether the role has permission to delete.
- manage boolean - Whether the role has permission to manage.
reckon.one: RolePermissionsWithPrintEmailLodge![](/images/permalink.svg)
Common role permissions plus print, email and lodge actions.
Fields
- email boolean - Whether the role has permission to email.
- print boolean - Whether the role has permission to print.
- view boolean - Whether the role has permission to view.
- create boolean - Whether the role has permission to create.
- edit boolean - Whether the role has permission to edit.
- delete boolean - Whether the role has permission to delete.
- lodge boolean - Whether the role has permission to lodge.
reckon.one: RoleRef![](/images/permalink.svg)
Reference to a role.
Fields
- id int? - The unique id.
- name string? - The unique name.
reckon.one: Roles![](/images/permalink.svg)
A list of roles.
Fields
- list Role[]? - The list of items.
reckon.one: SelfManagedSuperfund![](/images/permalink.svg)
A superfund’s details.
Fields
- fundName string? - The self-managed super fund’s (SMSF) name.
- electronicServiceAddress string? - The electronic address for service
reckon.one: SelfManagedSuperfundInput![](/images/permalink.svg)
Superfund’s details to create or update.
Fields
- fundName string? - The SelfManagedSuperfund (SMSF) Name
- electronicServiceAddress string? - The electronic address for service
reckon.one: SelfManagedSuperfundPatch![](/images/permalink.svg)
Superfund’s details to patch.
Fields
- fundName string? - The SelfManagedSuperfund (SMSF) Name
- electronicServiceAddress string? - The electronic address for service
reckon.one: StringIdResponse![](/images/permalink.svg)
A response that contains the resource's id.
Fields
- id string? - The resource's id.
reckon.one: Superfund![](/images/permalink.svg)
An organisations superfund.
Fields
- id string - The organisation's unique id.
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - The organisation's notes.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- entityTypes record {}? - The organisation's entity types.
- status string? - The organisation's status (Active or Inactive).
- electronicAddresses ElectronicAddress[]? - List of electronic addresses.
- phoneNumbers PhoneNumber[]? - List of phone numbers.
- addresses Address[]? - List of addresses.
- contacts ContactRef[]? - The organisation's contacts list.
- balance decimal? - The organisation's current balance.
- lastModifiedDateTime string - The organisation's last modified date.
- bankDetails record {}? - The superfund's bank account details.
- superfundDetails record {}? - The superfund fund details
- employees SuperfundEmployee[]? - The linked employee's.
reckon.one: SuperfundBankDetails![](/images/permalink.svg)
Details of a superfund's bank account.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SuperfundBankDetailsInput![](/images/permalink.svg)
Details of a superfund's bank account to create or update.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SuperfundBankDetailsPatch![](/images/permalink.svg)
Details of a superfund's bank account to patch.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SuperfundDetails![](/images/permalink.svg)
Details of a superfund to create or update.
Fields
- superfundProvider record {}? - The superfund provider details
- smsf record {}? - The SMSF provider details
reckon.one: SuperfundDetailsInput![](/images/permalink.svg)
Details of a superfund to create or update.
Fields
- superfundProvider record {}? - The superfundProvider details
- smsf record {}? - The SMSF provider details
reckon.one: SuperfundDetailsPatch![](/images/permalink.svg)
Details of a superfund to patch.
Fields
- superfundProvider record {}? - The superfundProvider details
- smsf record {}? - The SMSF provider details
reckon.one: SuperfundEmployee![](/images/permalink.svg)
An employee linked to a superfund.
Fields
- id string - Id of an employee.
- name string? - Name of an employee.
reckon.one: SuperfundInput![](/images/permalink.svg)
Details of a superfund to create or update.
Fields
- name string - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
- entityTypes record {}? - The organisation's entity types.
- bankDetails record {}? - The superfund's bank account details.
- superFundDetails record {}? - The superfund's details.
reckon.one: SuperfundPatch![](/images/permalink.svg)
Details of the superfund to patch.
Fields
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- entityTypes record {}? - If the entity has other entity types.
- bankDetails record {}? - The superfund's bank account details.
- superFundDetails record {}? - The superfund's details.
reckon.one: SuperfundProvider![](/images/permalink.svg)
A super fund provider.
Fields
- id string - The super fund provider's unique id.
- name string? - The super fund provider's name.
- abn string? - The super fund provider's ABN.
- status SuperfundProviderStatus - The status of a super fund provider.
reckon.one: SuperfundProvider2![](/images/permalink.svg)
Superfund’s details
Fields
- fund record {}? - The superfund provider details
- employerNumber string? - APRA type employee number
reckon.one: SuperfundProviderInput![](/images/permalink.svg)
Superfund’s details to create or update
Fields
- fund string? - The superfund provider id
- employerNumber string? - APRA type employee number
reckon.one: SuperfundProviderPatch![](/images/permalink.svg)
Superfund’s details to patch
Fields
- fund string? - The superfund provider id
- employerNumber string? - APRA type employee number
reckon.one: SuperfundProviderProduct![](/images/permalink.svg)
A super fund provider's product.
Fields
- id string - The super fund provider product's unique id.
- name string? - The super fund provider product's name.
- usi string? - The unique superannuation identifier (USI).
- spin string? - The superannuation product identification number (SPIN).
reckon.one: SuperfundProviderProducts![](/images/permalink.svg)
A list of a super fund provider's products.
Fields
- list SuperfundProviderProduct[]? - The list of items.
reckon.one: SuperfundProviders![](/images/permalink.svg)
A list of super fund providers.
Fields
- list SuperfundProvider[]? - The list of items.
reckon.one: Superfunds![](/images/permalink.svg)
A list of super funds.
Fields
- list Superfund[]? - The list of items.
reckon.one: Supplier![](/images/permalink.svg)
A supplier.
Fields
- id string - The organisation's unique id.
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - The organisation's notes.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- entityTypes record {}? - The organisation's entity types.
- status string? - The organisation's status (Active or Inactive).
- electronicAddresses ElectronicAddress[]? - List of electronic addresses.
- phoneNumbers PhoneNumber[]? - List of phone numbers.
- addresses Address[]? - List of addresses.
- contacts ContactRef[]? - The organisation's contacts list.
- balance decimal? - The organisation's current balance.
- lastModifiedDateTime string - The organisation's last modified date.
- isTpar boolean? - If the supplier is Tpar (null for other types).
- billCount int? - The total number of bills that have been received from the organisation.
- bankDetails record {}? - The supplier's bank account details.
reckon.one: SupplierBankDetails![](/images/permalink.svg)
Details of a supplier's bank account.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SupplierBankDetailsInput![](/images/permalink.svg)
Details of a supplier's bank account to create or update.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SupplierBankDetailsPatch![](/images/permalink.svg)
Details of a supplier's bank account to patch.
Fields
- name string? - The bank account's name.
- bankBranchNumber string? - The bank account's branch number.
- bankAccountNumber string? - The bank account's number.
reckon.one: SupplierInput![](/images/permalink.svg)
Details of a supplier to create or update.
Fields
- name string - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- addresses AddressInput[]? - List of addresses.
- phoneNumbers PhoneNumberInput[]? - List of phone numbers.
- electronicAddresses ElectronicAddressInput[]? - List of electronic addresses.
- entityTypes record {}? - The organisation's entity types.
- isTpar boolean - If the supplier is Tpar.
- bankDetails record {}? - The supplier's bank account details.
reckon.one: SupplierPatch![](/images/permalink.svg)
Details of a supplier to patch.
Fields
- name string? - The organisation's display name.
- organisationName string? - The organisation's name.
- branch string? - The organisation's branch.
- notes string? - Notes for the organisation.
- businessNumber1 string? - The organisation's business number 1.
- businessNumber2 string? - The organisation's business number 2.
- status string? - The status of the organisation. (Active/Inactive)
- entityTypes record {}? - If the entity has other entity types.
- isTpar boolean? - If the supplier is Tpar.
- bankDetails record {}? - The supplier's bank account details.
reckon.one: Suppliers![](/images/permalink.svg)
A list of suppliers.
Fields
- list Supplier[]? - The list of items.
reckon.one: TaxCode![](/images/permalink.svg)
Details of a tax code.
Fields
- id string - The tax code's id.
- name string? - The tax code's name.
- description string? - The description of the tax code.
- rate decimal - The rate for the tax code.
- purchaseTaxLedgerAccount record {}? - The ledger account to use for purchases.
- saleTaxLedgerAccount record {}? - The ledger account to use for sales.
- taxType record {}? - Type of tax.
- useCodeOnPurchases boolean - Whether the tax code is used for purchases.
- useCodeOnSales boolean - Whether the tax code is used for sales.
- isCodeForEuropeanCommunityGoods boolean? - Whether the tax code is used for European community goods (UK only).
- isWholeAmountTax boolean - Whether the whole amount is tax.
reckon.one: TaxGroup![](/images/permalink.svg)
Details of a tax group.
Fields
- id string - The tax group's id.
- name string? - The tax group's name.
- description string? - The description of the tax group.
- rate decimal - The rate for the tax group.
- exportCode string? - The export code for the tax group.
- status TaxStatus - The status of an accounting category.
- useOnPurchases boolean - Whether the tax group is used for purchases.
- useOnSales boolean - Whether the tax group is used for sales.
- taxCodes TaxCode[]? - Tax codes assigned to the tax group.
- reportingLocations TaxReportingLocation[]? - Locations where the tax group will be included in reports.
- purchaseTaxLedgerAccounts LedgerAccount[]? - Accounts to use for purchases.
- saleTaxLedgerAccounts LedgerAccount[]? - Accounts to use for sales.
- lastModifiedDateTime string - Timestamp of when tax group record was last modified.
reckon.one: TaxGroups![](/images/permalink.svg)
A list of tax groups.
Fields
- list TaxGroup[]? - The list of items.
reckon.one: TaxRate![](/images/permalink.svg)
A tax rate.
Fields
- id string - The tax rate's Id
- name string? - The tax rate's name.
- description string? - The description of the tax rate.
- rate decimal - The rate of tax.
- status TaxStatus - The status of an accounting category.
- useOnPurchases boolean - Whether the tax rate can be used on purchases.
- useOnSales boolean - Whether the tax rate can be used on sales.
reckon.one: TaxRateRef![](/images/permalink.svg)
Reference to a tax rate.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: TaxRates![](/images/permalink.svg)
A list of tax rates.
Fields
- list TaxRate[]? - The list of items.
reckon.one: TaxRef![](/images/permalink.svg)
Reference to a tax rate.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: TaxReportingLocation![](/images/permalink.svg)
Tax reporting location.
Fields
- id string - The tax reporting location's id.
- taxCodeId string? - The tax code's id.
- taxGroupId string? - The tax group's id.
- location string? - The location in the report.
- appliesToPurchases boolean - Whether it applies to purchases.
- appliesToSales boolean - Whether it applies to sales.
- reportAmountType AmountType - The type of an amount.
- reportLocationType TaxCodeReportLocationType - Tax code reporting location.
reckon.one: TaxSettings![](/images/permalink.svg)
A book's tax settings
Fields
- taxRegistered boolean - Indicates whether you registered for tax.
- reportingBasis AccountingMethodType - The sales figures type of tax.
- amountTaxStatus SettingsAmountTaxStatus - The sales figures type of tax.
- defaultSalesTaxLedgerAccount record {}? - Default tax account ledger for sales.
- defaultPurchasesTaxLedgerAccount record {}? - Default tax account ledger for purchases.
- taxAmountEditable boolean - Indicates whether allows users to edit tax amounts.
- chooseAmountTaxStatus boolean - Indicates whether a user can choose if amounts include or exclude tax.
- basSettings record {}? - The BAS reporting preference details.
- emailSettings record {}? - The email settings for tax.
reckon.one: TaxSettingsPatch![](/images/permalink.svg)
Tax settings to patch.
Fields
- taxRegistered boolean? - Indicates whether you registered for tax.
- reportingBasis AccountingMethodType? - The sales figures type of tax.
- amountTaxStatus SettingsAmountTaxStatus? - The sales figures type of tax.
- defaultSalesTaxLedgerAccount string? - Default tax account ledger for sales.
- defaultPurchasesTaxLedgerAccount string? - Default tax account ledger for purchases.
- taxAmountEditable boolean? - Indicates whether allows users to edit tax amounts.
- chooseAmountTaxStatus boolean? - Indicates whether a user can choose if amounts include or exclude tax.
- basSettings record {}? - The BAS reporting preference details.
- emailSettings record {}? - The email settings for tax.
reckon.one: TaxType![](/images/permalink.svg)
The tax type.
Fields
- id string - The tax type's id.
- description string? - The description of the tax type.
- isPrimary boolean - Whether this is a primary tax.
- systemType TaxSystemType - The system tax type.
reckon.one: Template![](/images/permalink.svg)
Details of a template.
Fields
- id string - The template's id.
- name string? - The template's name.
- header record {}? - The header detail of a template.
reckon.one: TemplateHeader![](/images/permalink.svg)
Details of the header of a template.
Fields
- logo record {}? - Logo of the template's header.
- companyName boolean - Is CompanyName included in the template's header.
- companyAddress boolean - Is CompanyAddress included in the template's header.
- taxNumber boolean - Is TaxNumber included in the template's header.
- phoneNumber boolean - Is PhoneNumber included in the template's header.
- email boolean - Is Email included in the template's header.
- website boolean - Is Website included in the template's header.
reckon.one: TemplateHeaderBase![](/images/permalink.svg)
Base details of the header of a template.
Fields
- logo record {}? - Logo of the template's header.
reckon.one: TemplateRef![](/images/permalink.svg)
Reference to a template.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Templates![](/images/permalink.svg)
A list of templates.
Fields
- list Template[]? - The list of items.
reckon.one: TemplateTypeRef![](/images/permalink.svg)
Reference to a template.
Fields
- id string? - The unique id.
- name string? - The unique name.
- 'type string? - The resource's type.
reckon.one: TimeDetails![](/images/permalink.svg)
Time details for a time entry.
Fields
- startTime string? - The start time.
- endTime string? - The end time.
- duration int - The duration in minutes.
reckon.one: TimeDetailsInput![](/images/permalink.svg)
Time details for a time entry being created or updated.
Fields
- startTime string? - The start time. Required if duration is not specified.
- endTime string? - The end time. Required if duration is not specified.
- duration int? - The duration in minutes. Used if specified, otherwise calculated from startTime and endTime.
reckon.one: TimeDetailsPatch![](/images/permalink.svg)
Time details for a time entry being patched.
Fields
- startTime string? - The start time. Required if duration is not specified.
- endTime string? - The end time. Required if duration is not specified.
- duration int? - The duration in minutes. Used if specified, otherwise calculated from startTime and endTime.
reckon.one: TimeEntries![](/images/permalink.svg)
A list of time entries.
Fields
- list TimeEntry[]? - The list of items.
reckon.one: TimeEntry![](/images/permalink.svg)
A time entry.
Fields
- id string - The time entry's id.
- employee record {}? - The employee.
- timeEntryDate string - The date of the time entry.
- project record {}? - The project.
- customer record {}? - The customer.
- classification record {}? - The classification.
- billable boolean - Whether the time entry is billable.
- billableStatus TimeEntryBillableStatus - Time entry billable status.
- approvalStatus TimeEntryApprovalStatus - Time entry approval status.
- declineReason string? - The reason why a time entry has been declined.
- item record {}? - The item.
- payrollItem record {}? - The payroll pay item.
- time record {}? - Details of the time.
- notes string? - Notes.
- transactionLinks TransactionLink[]? - Transactions linked to the time entry.
reckon.one: TimeEntryInput![](/images/permalink.svg)
Details of a time entry to create or update.
Fields
- employee string - The id or name of the employee that spent the time.
- timeEntryDate string - Date of the time entry.
- project string? - The id or full name of the project on which the time was spent on. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- customer string? - The id or name of the customer for whom the time was spent on.
- classification string? - The id or name of the classification.
- billable boolean? - Whether the time can be billed to a customer.
- approvalStatus TimeEntryApprovalStatus - Time entry approval status.
- item string? - The id or full name of the item that the time entry relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- payrollItem string? - The id or full name of the payroll pay item that the time entry relates to.
- time record {} - Details of the time spent.
- notes string? - Notes related to the time entry.
- declineReason string? - Reason why time entry approval was declined. Note that this cannot be set via POST.
reckon.one: TimeEntryPatch![](/images/permalink.svg)
Details of a time entry to patch.
Fields
- employee string? - The id or name of the employee that spent the time.
- timeEntryDate string - Date of the time entry.
- project string? - The id or full name of the project on which the time was spent on. Note that the full name includes the name(s) of any parent project(s) separated by colons.
- customer string? - The id or name of the customer for whom the time was spent on.
- classification string? - The id or name of the classification.
- billable boolean? - Whether the time can be billed to a customer.
- approvalStatus TimeEntryApprovalStatus - Time entry approval status.
- item string? - The id or full name of the item that the time entry relates to. Note that the full name includes the name(s) of any parent item(s) separated by colons.
- payrollItem string? - The id or full name of the payroll pay item that the time entry relates to.
- time record {}? - Details of the time spent.
- notes string? - Notes related to the time entry.
- declineReason string? - Reason why time entry approval was declined.
reckon.one: TimeEntrySettings![](/images/permalink.svg)
A book's time entry settings.
Fields
- approvalEnabled boolean - Indicates whether time entry approval is enabled.
- firstDayOfWeek TimeStartOfWeek - The start time of a week.
- transferBillableTimeAs record {}? - The transfer billable time settings.
reckon.one: TimeEntrySettingsPatch![](/images/permalink.svg)
Time entry settings to patch.
Fields
- approvalEnabled boolean? - Indicates whether time entry approval is enabled.
- firstDayOfWeek TimeStartOfWeek? - The start time of a week.
- transferBillableTimeAs record {}? - The transfer billable time settings.
reckon.one: TransactionLink![](/images/permalink.svg)
A transaction linked to another transaction.
Fields
- linkId string? - The link's unique id.
- transactionType LinkedTransactionType - Type of transaction linked to an invoice.
- transactionId string - The unique id of the linked transaction.
- transactionNumber string? - The transaction number of the linked transaction.
- transactionDate string? - The transaction's date.
- transactionReference string? - The transaction's reference.
- transactionAmount decimal? - The transacion's amount.
- href string? - The URL to use to retrieve the linked transaction.
reckon.one: TransferBillableTimeSettings![](/images/permalink.svg)
The billable time transfer settings.
Fields
- combineItemAndRate boolean - Indicates whether combines time item and rate when transferring billable time.
- transferNotes boolean - Indicates whether use time sheet entry note as line item description when transferring billable time separately.
- transferDescriptions boolean - Indicates whether use chargeable item description as line item description when transferring billable time separately.
reckon.one: TransferBillableTimeSettingsPatch![](/images/permalink.svg)
Transfer billable time settings to patch.
Fields
- combineItemAndRate boolean? - Indicates whether to combine the item and the rate when transferring billable time.
- transferNotes boolean? - Indicates whether to use time sheet entry notes as line item descriptions when transferring billable time separately.
- transferDescriptions boolean? - Indicates whether to use chargeable item descriptions as line item descriptions when transferring billable time separately.
reckon.one: TypeRef![](/images/permalink.svg)
Reference to a type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: TypeResponse![](/images/permalink.svg)
A response that contains the resource's type id and name.
Fields
- id string? - The resource's id.
- 'type record {}? - Reference to a type.
reckon.one: UpdateAddressInput![](/images/permalink.svg)
Details of an address to update.
Fields
- line1 string? - Line 1 of the address.
- line2 string? - Line 2 of the address.
- line3 string? - Line 3 of the address.
- suburb string? - The suburb.
- town string? - The town.
- state string? - The state.
- postcode string? - The post code.
- country string? - The country.
reckon.one: UpdateElectronicAddressInput![](/images/permalink.svg)
Details of a electronic address to update.
Fields
- address string? - The electronic address.
reckon.one: UpdatePhoneNumberInput![](/images/permalink.svg)
Details of a phone number to update.
Fields
- countryCode string? - The country code.
- areaCode string? - The area code.
- number string? - The number.
- extension string? - The extension.
reckon.one: User![](/images/permalink.svg)
A user.
Fields
- id string - Then user's unique id.
- name string? - The user's name.
- email string? - The user's email address.
- portalUserId string? - The user's unique Reckon Id.
- employee record {}? - The user's employee reference.
- roles RoleRef[]? - List of roles user is assigned to.
- currentUser boolean - Indicates whether this is the currently logged in user.
- lastLoggedInDateTime string? - The last time the user logged in.
- invitationStatus UserEmployeeInvitationStatus - Status of user employee invitation.
reckon.one: UserRef![](/images/permalink.svg)
Reference to a user.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Users![](/images/permalink.svg)
A list of users.
Fields
- list User[]? - The list of items.
Import
import ballerinax/reckon.one;
Metadata
Released date: over 2 years ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 2
Current verison: 0
Weekly downloads
Keywords
Finance/Accounting
Cost/Freemium
Contributors
Dependencies