Module reckon.one
ballerinax/reckon.one Ballerina library
1.3.1
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 runcommand to compile and run the Ballerina program.
Clients
reckon.one: Client
Isolated
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
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 (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api-v2.reckonone.com/" - URL of the target service
getBooks
Isolated FunctionRemote Function
Gets a list of books that the current user has access to.
getBook
Isolated FunctionRemote Function
Gets details of the specified book.
Parameters
- bookId string - The book's id.
getCreditNotes
Isolated FunctionRemote Function
function getCreditNotes(string bookId, int page, int perPage) returns CreditNotes|errorGets 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
Isolated FunctionRemote Function
function getCreditNote(string bookId, string creditNoteId, string? format) returns CreditNote|errorGets 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
Isolated FunctionRemote Function
function updateCreditNote(string bookId, string creditNoteId, CreditNoteInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing credit note.
patchCreditNote
Isolated FunctionRemote Function
function patchCreditNote(string bookId, string creditNoteId, CreditNotePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function createCreditNote(string bookId, CreditNoteInput payload) returns IdResponse|errorCreates a new credit note.
Return Type
- IdResponse|error - The id of the credit note that has been created.
getCreditNoteLineItem
Isolated FunctionRemote Function
function getCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId) returns CreditNoteLineItem|errorGets 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
Isolated FunctionRemote Function
function updateCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId, CreditNoteLineItemInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteLineItem(string bookId, string creditNoteId, string lineItemId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchCreditNoteLineItem(string bookId, string creditNoteId, string lineItemId, CreditNoteLineItemPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function addLineItemToCreditNote(string bookId, string creditNoteId, CreditNoteLineItemInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function createCreditNoteTransactionLink(string bookId, string creditNoteId, CreditNoteTransactionLinkInput payload) returns StringIdResponse|errorCreates 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
Isolated FunctionRemote Function
function unlinkTransaction(string bookId, string creditNoteId, string linkId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function patchCreditNoteTransactionLink(string bookId, string creditNoteId, string linkId, CreditNoteTransactionLinkPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createCustomer(string bookId, CustomerInput payload) returns IdNameResponse|errorCreates a new customer.
Return Type
- IdNameResponse|error - The id of the customer that has been created.
getCustomer
Isolated FunctionRemote Function
Gets a customer.
updateCustomer
Isolated FunctionRemote Function
function updateCustomer(string bookId, string customerId, CustomerInput payload) returns Response|errorUpdates an existing customer.
Parameters
- bookId string - The book's id.
- customerId string - The customer's id.
- payload CustomerInput - Details of the updated customer.
deleteCustomer
Isolated FunctionRemote Function
Deletes an existing customer.
patchCustomer
Isolated FunctionRemote Function
function patchCustomer(string bookId, string customerId, CustomerPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function linkExistingContactToCustomer(string bookId, string customerId, string contactId) returns Response|errorLinks 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
Isolated FunctionRemote Function
function unlinkCustomerLinkedContact(string bookId, string customerId, string contactId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function addNewContactToCustomer(string bookId, string customerId, LinkedContactInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getCustomerLinkedContact(string bookId, string customerId, string contactId) returns Contact|errorGets 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
Isolated FunctionRemote Function
function deleteContactFromCustomer(string bookId, string customerId, string contactId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function getCustomerPhoneNumbers(string bookId, string customerId) returns PhoneNumbers|errorGets a customer's phone numbers.
Return Type
- PhoneNumbers|error - The requested customer's phone numbers.
createCustomerPhoneNumber
Isolated FunctionRemote Function
function createCustomerPhoneNumber(string bookId, string customerId, PhoneNumberInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getCustomerPhoneNumber(string bookId, string customerId, string 'type) returns PhoneNumber|errorGet 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
Isolated FunctionRemote Function
function updateCustomerPhoneNumber(string bookId, string customerId, string 'type, UpdatePhoneNumberInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteCustomerPhoneNumber(string bookId, string customerId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchCustomerPhoneNumber(string bookId, string customerId, string 'type, PhoneNumberPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Gets a customer's addresses.
createCustomerAddress
Isolated FunctionRemote Function
function createCustomerAddress(string bookId, string customerId, AddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateCustomerAddress(string bookId, string customerId, string 'type, UpdateAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteCustomerAddress(string bookId, string customerId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchCustomerAddress(string bookId, string customerId, string 'type, AddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getCustomerElectronicAddress(string bookId, string customerId, string 'type) returns ElectronicAddress|errorGets 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
Isolated FunctionRemote Function
function updateCustomerElectronicAddress(string bookId, string customerId, string 'type, UpdateElectronicAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteCustomerElectronicAddress(string bookId, string customerId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchCustomerElectronicAddress(string bookId, string customerId, string 'type, ElectronicAddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getCustomerElectronicAddresses(string bookId, string customerId) returns ElectronicAddresses|errorGets a customer's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested customer's electronic addresses.
createCustomerElectronicAddress
Isolated FunctionRemote Function
function createCustomerElectronicAddress(string bookId, string customerId, ElectronicAddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getDepartments(string bookId, int page, int perPage) returns Departments|errorGets 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
Isolated FunctionRemote Function
function createDepartment(string bookId, DepartmentInput payload) returns IdResponse|errorCreates a new department.
Return Type
- IdResponse|error - The id of the department that has been created.
getDepartment
Isolated FunctionRemote Function
function getDepartment(string bookId, string departmentId) returns Department|errorGets a department.
Return Type
- Department|error - The requested department.
updateDepartment
Isolated FunctionRemote Function
function updateDepartment(string bookId, string departmentId, DepartmentInput payload) returns Response|errorUpdates an existing department.
Parameters
- bookId string - The book's id.
- departmentId string - The department's id.
- payload DepartmentInput - Details of the department.
deleteDepartment
Isolated FunctionRemote Function
Deletes an existing department.
patchDepartment
Isolated FunctionRemote Function
function patchDepartment(string bookId, string departmentId, DepartmentPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function linkManagerToDepartment(string bookId, string departmentId, string employeeId) returns Response|errorLinks 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
Isolated FunctionRemote Function
function unlinkDepartmentLinkedManager(string bookId, string departmentId, string employeeId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function linkEmployeeToDepartment(string bookId, string departmentId, string employeeId) returns Response|errorLinks 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
Isolated FunctionRemote Function
function unlinkDepartmentLinkedEmployee(string bookId, string departmentId, string employeeId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function getPaymentMethods(string bookId) returns PaymentMethods|errorGets 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function getUserPermissions(string bookId) returns Permissions|errorGets 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createReceipt(string bookId, ReceiptInput payload) returns IdResponse|errorCreates a new receipt.
Return Type
- IdResponse|error - The id of the receipt that has been created.
getReceipt
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateReceipt(string bookId, string receiptId, ReceiptInput payload) returns Response|errorUpdates an existing receipt.
Parameters
- bookId string - The book's id.
- receiptId string - The receipt's id.
- payload ReceiptInput - Details of the updated receipt.
deleteReceipt
Isolated FunctionRemote Function
Deletes an existing receipt.
patchReceipt
Isolated FunctionRemote Function
function patchReceipt(string bookId, string receiptId, ReceiptPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getReceiptLineItem(string bookId, string receiptId, string lineItemId) returns ReceiptLineItem|errorGets 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
Isolated FunctionRemote Function
function updateReceiptLineItem(string bookId, string receiptId, string lineItemId, ReceiptLineItemInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function addLineItemToReceipt(string bookId, string receiptId, ReceiptLineItemInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function patchReceiptLineItem(string bookId, string receiptId, string lineItemId, ReceiptLineItemPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteReceiptLineItem(string bookId, string receiptId, string lineId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function createReceiptTransactionLink(string bookId, string receiptId, ReceiptTransactionLinkInput payload) returns StringIdResponse|errorCreates 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
Isolated FunctionRemote Function
function deleteReceiptTransactionLink(string bookId, string receiptId, string linkId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchReceiptTransactionLink(string bookId, string receiptId, string linkId, ReceiptTransactionLinkPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
Gets a role.
linkUserToRole
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function getSuperfundProviders(string bookId, int page, int perPage) returns SuperfundProviders|errorGets 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
Isolated FunctionRemote Function
function getSuperfundProvidersHavingUsi(string bookId, string usi, int page, int perPage) returns SuperfundProviders|errorGets 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
Isolated FunctionRemote Function
function getSuperfundProvider(string bookId, string superfundProviderId) returns SuperfundProvider|errorGets a super fund provider.
Return Type
- SuperfundProvider|error - The requested super fund provider.
getSuperfundProviderProducts
Isolated FunctionRemote Function
function getSuperfundProviderProducts(string bookId, string superfundProviderId, int page, int perPage) returns SuperfundProviderProducts|errorGets 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
Isolated FunctionRemote Function
Gets a list of reports.
Parameters
- bookId string - The book's id.
getPayrollLeaveBalancesAndAccrualValueReport2
Isolated FunctionRemote Function
function getPayrollLeaveBalancesAndAccrualValueReport2(string bookId, PayrollLeaveBalancesAndAccrualValueReportParameters payload, string? format) returns PayrollLeaveBalancesAndAccrualValueReport|errorGets 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createSupplier(string bookId, SupplierInput payload) returns IdNameResponse|errorCreates a new supplier.
Return Type
- IdNameResponse|error - The id of the supplier that has been created.
getSupplier
Isolated FunctionRemote Function
Gets a supplier.
updateSupplier
Isolated FunctionRemote Function
function updateSupplier(string bookId, string supplierId, SupplierInput payload) returns Response|errorUpdates an existing supplier.
Parameters
- bookId string - The book's id.
- supplierId string - The suppliers's id.
- payload SupplierInput - Details of the updated supplier.
deleteSupplier
Isolated FunctionRemote Function
Deletes an existing supplier.
patchSupplier
Isolated FunctionRemote Function
function patchSupplier(string bookId, string supplierId, SupplierPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Gets a supplier's addresses.
createSupplierAddress
Isolated FunctionRemote Function
function createSupplierAddress(string bookId, string supplierId, AddressInput payload) returns Response|errorAdds 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateSupplierAddress(string bookId, string supplierId, string 'type, UpdateAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteSupplierAddress(string bookId, string supplierId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchSupplierAddress(string bookId, string supplierId, string 'type, AddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSuppliersLinkedContacts(string bookId, string supplierId, int page, int perPage) returns Contacts|errorGets 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
Isolated FunctionRemote Function
function addNewContactToSupplier(string bookId, string supplierId, LinkedContactInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getSuppliersLinkedContact(string bookId, string supplierId, string contactId) returns Contact|errorGets 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
Isolated FunctionRemote Function
function linkExistingContactToSupplier(string bookId, string supplierId, string contactId) returns Response|errorLinks 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
Isolated FunctionRemote Function
function unlinkSupplierLinkedContact(string bookId, string supplierId, string contactId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function getSupplierElectronicAddresses(string bookId, string supplierId) returns ElectronicAddresses|errorGets a supplier's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested supplier's electronic addresses.
createSupplierElectronicAddress
Isolated FunctionRemote Function
function createSupplierElectronicAddress(string bookId, string supplierId, ElectronicAddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getSupplierElectronicAddress(string bookId, string supplierId, string 'type) returns ElectronicAddress|errorGets 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
Isolated FunctionRemote Function
function updateSupplierElectronicAddress(string bookId, string supplierId, string 'type, UpdateElectronicAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteElectronicAddress(string bookId, string supplierId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchSupplierElectronicAddress(string bookId, string supplierId, string 'type, ElectronicAddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSupplierPhoneNumbers(string bookId, string supplierId) returns PhoneNumbers|errorGets a supplier's phone numbers.
Return Type
- PhoneNumbers|error - The requested supplier's phone numbers.
createSupplierPhoneNumber
Isolated FunctionRemote Function
function createSupplierPhoneNumber(string bookId, string supplierId, PhoneNumberInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getSupplierPhoneNumber(string bookId, string supplierId, string 'type) returns PhoneNumber|errorGet 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
Isolated FunctionRemote Function
function patchSupplierPhoneNumber(string bookId, string supplierId, string 'type, PhoneNumberPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSuperfunds(string bookId, int page, int perPage) returns Superfunds|errorGets 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
Isolated FunctionRemote Function
function createSuperfund(string bookId, SuperfundInput payload) returns IdNameResponse|errorCreates a new super fund.
Return Type
- IdNameResponse|error - The id of the super fund that has been created.
getSuperfund
Isolated FunctionRemote Function
Gets a super fund.
updateSuperfund
Isolated FunctionRemote Function
function updateSuperfund(string bookId, string superfundId, SuperfundInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing super fund.
patchSuperfund
Isolated FunctionRemote Function
function patchSuperfund(string bookId, string superfundId, SuperfundPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSuperfundsLinkedContacts(string bookId, string superfundId, int page, int perPage) returns Contacts|errorGets 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
Isolated FunctionRemote Function
function addNewContactToSuperfund(string bookId, string superfundId, LinkedContactInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getSuperfundsLinkedContact(string bookId, string superfundId, string contactId) returns Contact|errorGets 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
Isolated FunctionRemote Function
function linkExistingContactToSuperfund(string bookId, string superfundId, string contactId) returns Response|errorLinks 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
Isolated FunctionRemote Function
function unlinkSuperfundsLinkedContact(string bookId, string superfundId, string contactId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
function getSuperfundPhoneNumbers(string bookId, string superfundId) returns PhoneNumbers|errorGets a super fund's phone numbers.
Return Type
- PhoneNumbers|error - The requested super fund's phone numbers.
createSuperfundPhoneNumber
Isolated FunctionRemote Function
function createSuperfundPhoneNumber(string bookId, string superfundId, PhoneNumberInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getSuperfundPhoneNumber(string bookId, string superfundId, string 'type) returns PhoneNumber|errorGet 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
Isolated FunctionRemote Function
function patchSuperfundPhoneNumber(string bookId, string superfundId, string 'type, PhoneNumberPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Gets a super fund's addresses.
createSuperfundAddress
Isolated FunctionRemote Function
function createSuperfundAddress(string bookId, string superfundId, AddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateSuperfundAddress(string bookId, string superfundId, string 'type, UpdateAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteSuperfundAddress(string bookId, string superfundId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchSuperfundAddress(string bookId, string superfundId, string 'type, AddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSuperfundElectronicAddresses(string bookId, string superfundId) returns ElectronicAddresses|errorGets a super fund's electronic addresses.
Return Type
- ElectronicAddresses|error - The requested super fund's electronic addresses.
createSuperfundElectronicAddress
Isolated FunctionRemote Function
function createSuperfundElectronicAddress(string bookId, string superfundId, ElectronicAddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getSuperfundElectronicAddress(string bookId, string superfundId, string 'type) returns ElectronicAddress|errorGets 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
Isolated FunctionRemote Function
function updateSuperfundElectronicAddress(string bookId, string superfundId, string 'type, UpdateElectronicAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteSuperfundPhoneNumber(string bookId, string superfundId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchSuperfundElectronicAddress(string bookId, string superfundId, string 'type, ElectronicAddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getPhoneTypes(string bookId) returns PhoneTypes|errorGets 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
Isolated FunctionRemote Function
function createPhoneType(string bookId, PhoneTypeInput payload) returns IdResponse|errorCreates a new phone type.
Return Type
- IdResponse|error - The id of the phone type that has been created.
getPhoneType
Isolated FunctionRemote Function
Gets a phone type.
updatePhoneType
Isolated FunctionRemote Function
function updatePhoneType(string bookId, string phoneTypeId, PhoneTypeInput payload) returns IdResponse|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing phone type.
patchPhoneType
Isolated FunctionRemote Function
function patchPhoneType(string bookId, string phoneTypeId, PhoneTypePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getAddressTypes(string bookId) returns AddressTypes|errorGets 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
Isolated FunctionRemote Function
function createAddressType(string bookId, AddressTypeInput payload) returns IdResponse|errorCreates a new address type.
Return Type
- IdResponse|error - The id of the address type that has been created.
getAddressType
Isolated FunctionRemote Function
function getAddressType(string bookId, string addressTypeId) returns AddressType|errorGets an address type.
Return Type
- AddressType|error - The requested address type.
updateAddressType
Isolated FunctionRemote Function
function updateAddressType(string bookId, string addressTypeId, AddressTypeInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing address type.
patchAddressType
Isolated FunctionRemote Function
function patchAddressType(string bookId, string addressTypeId, AddressTypePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createContact(string bookId, ContactInput payload) returns IdResponse|errorCreates a new contact.
Return Type
- IdResponse|error - The id of the contact that has been created.
getContact
Isolated FunctionRemote Function
Gets a contact.
updateContact
Isolated FunctionRemote Function
function updateContact(string bookId, string contactId, ContactInput payload) returns Response|errorUpdates an existing contact.
Parameters
- bookId string - The book's id.
- contactId string - The contact's id.
- payload ContactInput - Details of the updated contact.
deleteContact
Isolated FunctionRemote Function
Deletes an existing contact.
patchContact
Isolated FunctionRemote Function
function patchContact(string bookId, string contactId, ContactPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getContactElectronicAddresses(string bookId, string contactId) returns ElectronicAddresses|errorGets a contact's electronic addresses.
Return Type
- ElectronicAddresses|error - A list of contact's electronic addresses for the specified book.
createContactElectronicAddress
Isolated FunctionRemote Function
function createContactElectronicAddress(string bookId, string contactId, ElectronicAddressInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getContactElectronicAddress(string bookId, string contactId, string 'type) returns ElectronicAddress|errorGets 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
Isolated FunctionRemote Function
function updateContactElectronicAddress(string bookId, string contactId, string 'type, UpdateElectronicAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteContactElectronicAddress(string bookId, string contactId, string 'type) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchContactElectronicAddress(string bookId, string contactId, string 'type, ElectronicAddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getContactPhoneNumbers(string bookId, string contactId) returns PhoneNumbers|errorGets a contact's phone numbers.
Return Type
- PhoneNumbers|error - A list of contact's phone numbers.
createContactPhoneNumber
Isolated FunctionRemote Function
function createContactPhoneNumber(string bookId, string contactId, PhoneNumberInput payload) returns TypeResponse|errorAdds 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
Isolated FunctionRemote Function
function getContactPhoneNumber(string bookId, string contactId, string 'type) returns PhoneNumber|errorGets 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
Isolated FunctionRemote Function
function updateContactPhoneNumber(string bookId, string contactId, string 'type, UpdatePhoneNumberInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteContactPhoneNumber(string bookId, string contactId, string 'type) returns Response|errorDelete 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
Isolated FunctionRemote Function
function patchContactPhoneNumber(string bookId, string contactId, string 'type, PhoneNumberPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Gets a contact's addresses.
createContactAddress
Isolated FunctionRemote Function
function createContactAddress(string bookId, string contactId, AddressInput payload) returns TypeResponse|errorCreate 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateContactAddress(string bookId, string contactId, string 'type, UpdateAddressInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function patchContactAddress(string bookId, string contactId, string 'type, AddressPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getElectronicAddressTypes(string bookId) returns ElectronicAddressTypes|errorGets 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
Isolated FunctionRemote Function
function createElectronicAddressType(string bookId, ElectronicAddressTypeInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getElectronicAddressType(string bookId, string electronicAddressTypeId) returns ElectronicAddressType|errorGets 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
Isolated FunctionRemote Function
function updateElectronicAddressType(string bookId, string electronicAddressTypeId, ElectronicAddressTypeInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteElectronicAddressType(string bookId, string electronicAddressTypeId) returns Response|errorDeletes an existing electronic address type.
Parameters
- bookId string - The book's id.
- electronicAddressTypeId string - The electronic address type's id.
patchElectronicAddressType
Isolated FunctionRemote Function
function patchElectronicAddressType(string bookId, string electronicAddressTypeId, ElectronicAddressTypePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getLedgerAccounts(string bookId, int page, int perPage) returns LedgerAccounts|errorGets 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
Isolated FunctionRemote Function
function createLedgerAccount(string bookId, LedgerAccountInput payload) returns IdResponse|errorCreates a new ledger account.
Return Type
- IdResponse|error - The id of the account that has been created.
getLedgerAccount
Isolated FunctionRemote Function
function getLedgerAccount(string bookId, string accountId) returns LedgerAccount|errorGets a ledger account.
Return Type
- LedgerAccount|error - The requested ledger account.
updateLedgerAccount
Isolated FunctionRemote Function
function updateLedgerAccount(string bookId, string ledgerAccountId, LedgerAccountInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing ledger account.
patchLedgerAccount
Isolated FunctionRemote Function
function patchLedgerAccount(string bookId, string ledgerAccountId, LedgerAccountPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getFinancialInstitutions(string bookId) returns FinancialInstitutions|errorGets a list of financial institutions.
Parameters
- bookId string - The book's id.
Return Type
- FinancialInstitutions|error - A list of financial institutions.
getEmployees
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createEmployee(string bookId, EmployeeInput payload) returns IdResponse|errorCreates a new employee.
Return Type
- IdResponse|error - The id of the employee that has been created.
getEmployee
Isolated FunctionRemote Function
Gets an employee.
updateEmployee
Isolated FunctionRemote Function
function updateEmployee(string bookId, string employeeId, EmployeeInput payload) returns Response|errorUpdates an existing employee.
Parameters
- bookId string - The book's id.
- employeeId string - The employee's id.
- payload EmployeeInput - Details of the updated employee.
deleteEmployee
Isolated FunctionRemote Function
Deletes an existing employee.
patchEmployee
Isolated FunctionRemote Function
function patchEmployee(string bookId, string employeeId, EmployeePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getExpenseClaims(string bookId, int page, int perPage) returns ExpenseClaims|errorGets 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
Isolated FunctionRemote Function
function createExpenseClaim(string bookId, ExpenseClaimInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getExpenseClaim(string bookId, string expenseClaimId, string? format) returns ExpenseClaim|errorGets 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
Isolated FunctionRemote Function
function updateExpensClaim(string bookId, string expenseClaimId, ExpenseClaimInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing expense claim.
patchExpenseClaim
Isolated FunctionRemote Function
function patchExpenseClaim(string bookId, string expenseClaimId, ExpenseClaimPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function addLineItemToExpenseClaim(string bookId, string expenseClaimId, ExpenseClaimLineItemInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function updateExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId, ExpenseClaimLineItemInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchExpenseClaimLineItem(string bookId, string expenseClaimId, string lineItemId, ExpenseClaimLineItemPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function downloadAttachment(string bookId, string expenseClaimId, string lineItemId, string attachmentId) returns Response|errorDownloads 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
Isolated FunctionRemote Function
function deleteAttachment(string bookId, string expenseClaimId, string lineItemId, string attachmentId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function addAttachment(string bookId, string expenseClaimId, string lineItemId, string? fileName) returns AddAttachmentResponses|errorAttaches 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
Isolated FunctionRemote Function
function getHeartbeat() returns HeartbeatStatus|errorReckon One API heartbeat.
Return Type
- HeartbeatStatus|error - The status of the API.
getClassifications
Isolated FunctionRemote Function
function getClassifications(string bookId, int page, int perPage) returns Classifications|errorGets 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
Isolated FunctionRemote Function
function createClassification(string bookId, ClassificationInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function getClassification(string bookId, string classificationId) returns Classification|errorGets a classification.
Return Type
- Classification|error - The requested classification.
updateClassification
Isolated FunctionRemote Function
function updateClassification(string bookId, string classificationId, ClassificationInput payload) returns Response|errorUpdates an existing classification.
Parameters
- bookId string - The book's id.
- classificationId string - The classification's id.
- payload ClassificationInput - Details of the updated classification.
deleteClassification
Isolated FunctionRemote Function
Deletes an existing classification.
patchClassification
Isolated FunctionRemote Function
function patchClassification(string bookId, string classificationId, ClassificationPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getPaymentTerms(string bookId, int page, int perPage) returns PaymentTerms|errorGets 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
Isolated FunctionRemote Function
function createPaymentTerm(string bookId, PaymentTermInput payload) returns IdResponse|errorCreates a new payment term.
Return Type
- IdResponse|error - The id of the payment term that has been created.
getPaymentTerm
Isolated FunctionRemote Function
function getPaymentTerm(string bookId, string termId) returns PaymentTerm|errorGets a payment term.
Return Type
- PaymentTerm|error - The requested payment term.
updatePaymentTerm
Isolated FunctionRemote Function
function updatePaymentTerm(string bookId, string termId, PaymentTermInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing payment term.
patchPaymentTerm
Isolated FunctionRemote Function
function patchPaymentTerm(string bookId, string termId, PaymentTermPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getPaymentTermDueDate(string bookId, string termId, string baseDate) returns PaymentTermDueDate|errorGets a calculated due date from a specified base date.
Return Type
- PaymentTermDueDate|error - A calculated due date.
getInvoices
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createInvoice(string bookId, InvoiceInput payload) returns IdResponse|errorCreates a new invoice.
Return Type
- IdResponse|error - The id of the invoice that has been created.
getInvoice
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function updateInvoice(string bookId, string invoiceId, InvoiceInput payload) returns Response|errorUpdates an existing invoice.
Parameters
- bookId string - The book's id.
- invoiceId string - The invoice's id.
- payload InvoiceInput - Details of the updated invoice.
deleteInvoice
Isolated FunctionRemote Function
Deletes an existing invoice.
patchInvoice
Isolated FunctionRemote Function
function patchInvoice(string bookId, string invoiceId, InvoicePatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getInvoiceSummary(string bookId, string? baseDate) returns InvoicesSummary|errorGets 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
Isolated FunctionRemote Function
function getCustomerInvoiceSummary(string bookId, string customerId, string? baseDate) returns InvoicesSummary|errorGets 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
Isolated FunctionRemote Function
function convertInvoiceFrom(string bookId, InvoiceConvertFromInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function unlinkInvoiceTransaction(string bookId, string invoiceId, string linkId) returns Response|errorUnlinks 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
Isolated FunctionRemote Function
Gets an email template populated with details from the specified invoice.
emailInvoice
Isolated FunctionRemote Function
function emailInvoice(string bookId, string invoiceId, EmailInput payload) returns Response|errorEmails 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
Isolated FunctionRemote Function
Marks an existing invoice as sent.
markInvoiceEmailAsUnsent
Isolated FunctionRemote Function
Marks an existing invoice as unsent.
getInvoiceLineItem
Isolated FunctionRemote Function
function getInvoiceLineItem(string bookId, string invoiceId, string lineItemId) returns InvoiceLineItem|errorGets 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
Isolated FunctionRemote Function
function updateInvoiceLineItem(string bookId, string invoiceId, string lineItemId, InvoiceLineItemInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function addLineItemToInvoice(string bookId, string invoiceId, InvoiceLineItemInput payload) returns IdResponse|errorCreates 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
Isolated FunctionRemote Function
function deleteInvoiceLineItem(string bookId, string invoiceId, string lineItemId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchInvoiceLineItem(string bookId, string invoiceId, string lineItemId, InvoiceLineItemPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getRecurringInvoiceTemplate(string bookId, string templateId) returns RecurringInvoiceTemplate|errorGets a recurring invoice template.
Return Type
- RecurringInvoiceTemplate|error - The requested recurring invoice template.
getProjects
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createProject(string bookId, ProjectInput payload) returns IdResponse|errorCreates a new project.
Return Type
- IdResponse|error - The id of the project that has been created.
getProject
Isolated FunctionRemote Function
Gets a project.
updateProject
Isolated FunctionRemote Function
function updateProject(string bookId, string projectId, ProjectInput payload) returns Response|errorUpdates an existing project.
Parameters
- bookId string - The book's id.
- projectId string - The project's id.
- payload ProjectInput - Details of the updated project.
deleteProject
Isolated FunctionRemote Function
Deletes an existing project.
patchProject
Isolated FunctionRemote Function
function patchProject(string bookId, string projectId, ProjectPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function patchProjectItem(string bookId, string projectId, string lineId, ProjectItemPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteProjectCustomer(string bookId, string projectId, string lineId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchProjectCustomer(string bookId, string projectId, string lineId, ProjectCustomerPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function deleteProjectSupplier(string bookId, string projectId, string lineId) returns Response|errorDeletes 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
Isolated FunctionRemote Function
function patchProjectSupplier(string bookId, string projectId, string lineId, ProjectSupplierPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getSettings(string bookId) returns BookSettings|errorGet a book's general settings.
Parameters
- bookId string - The book's id.
Return Type
- BookSettings|error - The general settings for the specified book.
patchSettings
Isolated FunctionRemote Function
function patchSettings(string bookId, BookSettingsPatch payload) returns Response|errorUpdates selected fields of a book's settings.
Parameters
- bookId string - The book's id.
- payload BookSettingsPatch - The book settings being altered.
patchSettingsAddress
Isolated FunctionRemote Function
function patchSettingsAddress(string bookId, string 'type, BookAddressPatch payload) returns Response|errorUpdates 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,physicalor the address type id.
- payload BookAddressPatch - The address being altered.
patchSettingsContactPhoneNumber
Isolated FunctionRemote Function
function patchSettingsContactPhoneNumber(string bookId, string 'type, BookPhoneNumberPatch payload) returns Response|errorUpdates 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,faxor the phone number type id.
- payload BookPhoneNumberPatch - The phone number being altered.
patchSettingsContactElectronicAddress
Isolated FunctionRemote Function
function patchSettingsContactElectronicAddress(string bookId, string 'type, BookElectronicAddressPatch payload) returns Response|errorUpdates 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
emailorweb.
- payload BookElectronicAddressPatch - The electronic address being altered.
getTaxSettings
Isolated FunctionRemote Function
function getTaxSettings(string bookId) returns TaxSettings|errorGet a book's tax settings.
Parameters
- bookId string - The book's id.
Return Type
- TaxSettings|error - The tax settings for the specified book.
patchTaxSettings
Isolated FunctionRemote Function
function patchTaxSettings(string bookId, TaxSettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getInvoiceSettings(string bookId) returns InvoiceSettings|errorGets a book's invoice settings.
Parameters
- bookId string - The book's id.
Return Type
- InvoiceSettings|error - The invoice settings for the specified book.
patchInvoiceSettings
Isolated FunctionRemote Function
function patchInvoiceSettings(string bookId, InvoiceSettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getCreditNoteSettings(string bookId) returns CreditNoteSettings|errorGets 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
Isolated FunctionRemote Function
function patchCreditNoteSettings(string bookId, CreditNoteSettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getReceiptSettings(string bookId) returns ReceiptSettings|errorGets a book's receipt settings.
Parameters
- bookId string - The book's id.
Return Type
- ReceiptSettings|error - The receipt settings for the specified book.
patchReceiptSettings
Isolated FunctionRemote Function
function patchReceiptSettings(string bookId, ReceiptSettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getPayrollSettings(string bookId) returns PayrollSettings|errorGet a book's payroll settings.
Parameters
- bookId string - The book's id.
Return Type
- PayrollSettings|error - The payroll settings for the specified book.
patchPayrollSettings
Isolated FunctionRemote Function
function patchPayrollSettings(string bookId, PayrollSettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function patchPayrollSettingsContactPhoneNumber(string bookId, string 'type, BookPhoneNumberPatch payload) returns Response|errorUpdates 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
phoneor the phone number type id.
- payload BookPhoneNumberPatch - The phone number being altered.
patchPayrollSettingsElectronicAddress
Isolated FunctionRemote Function
function patchPayrollSettingsElectronicAddress(string bookId, string 'type, BookElectronicAddressPatch payload) returns Response|errorUpdates 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
emailor the email type id.
- payload BookElectronicAddressPatch - The electronic address being altered.
getTimeEntrySettings
Isolated FunctionRemote Function
function getTimeEntrySettings(string bookId) returns TimeEntrySettings|errorGet 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
Isolated FunctionRemote Function
function patchTimeEntrySettings(string bookId, TimeEntrySettingsPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
function getTemplates(string bookId, int page, int perPage) returns TemplateTypeRef|errorGets 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
Isolated FunctionRemote Function
function getTemplateLogo(string bookId, string templateId) returns FileContentResult|errorGets a template's logo for the specified book.
Return Type
- FileContentResult|error - The template.
getInvoiceTemplates
Isolated FunctionRemote Function
function getInvoiceTemplates(string bookId, int page, int perPage) returns InvoiceTemplates|errorGets 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
Isolated FunctionRemote Function
function getInvoiceTemplate(string bookId, string templateId) returns InvoiceTemplate|errorGets an invoice template for the specified book.
Return Type
- InvoiceTemplate|error - The template.
getEstimateTemplates
Isolated FunctionRemote Function
function getEstimateTemplates(string bookId, int page, int perPage) returns EstimateTemplates|errorGets 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
Isolated FunctionRemote Function
function getEstimateTemplate(string bookId, string templateId) returns EstimateTemplate|errorGets an estimate template for the specified book.
Return Type
- EstimateTemplate|error - The template.
getCustomerAdjustmentNotesTemplates
Isolated FunctionRemote Function
function getCustomerAdjustmentNotesTemplates(string bookId, int page, int perPage) returns Templates|errorGets 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
Isolated FunctionRemote Function
function getCustomerAdjustmentNotesTemplate(string bookId, string templateId) returns Template|errorGets a customer adjustment note template for the specified book.
getBillTemplates
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
Gets a bill template for the specified book.
getSupplierAdjustmentNotesTemplates
Isolated FunctionRemote Function
function getSupplierAdjustmentNotesTemplates(string bookId, int page, int perPage) returns Templates|errorGets 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
Isolated FunctionRemote Function
function getSupplierAdjustmentNotesTemplate(string bookId, string templateId) returns Template|errorGets a supplier adjustment note template for the specified book.
getExpenseclaimsTemplates
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
Gets an expense claim template for the specified book.
getCustomerStatementsTemplates
Isolated FunctionRemote Function
function getCustomerStatementsTemplates(string bookId, int page, int perPage) returns CustomerStatementsTemplates|errorGets 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
Isolated FunctionRemote Function
function getCustomerStatementsTemplate(string bookId, string templateId) returns CustomerStatementsTemplate|errorGets a customer statement template for the specified book.
Return Type
- CustomerStatementsTemplate|error - The template.
getTaxGroups
Isolated FunctionRemote Function
function getTaxGroups(string bookId, string effectiveDate, int page, int perPage) returns TaxGroups|errorGets 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
Isolated FunctionRemote Function
function getTaxGroup(string bookId, string taxGroupId, string effectiveDate) returns TaxGroups|errorGets 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
Isolated FunctionRemote Function
function getTaxRates(string bookId, string effectiveDate, int page, int perPage) returns TaxRates|errorGets 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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function createItem(string bookId, ItemInput payload) returns IdResponse|errorCreates a new item.
Return Type
- IdResponse|error - The id of the item that has been created.
getItem
Isolated FunctionRemote Function
Gets an item.
updateItem
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
Deletes an existing item.
patchItem
Isolated FunctionRemote Function
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
Isolated FunctionRemote Function
function getTimeEntries(string bookId, int page, int perPage) returns TimeEntries|errorGets 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
Isolated FunctionRemote Function
Gets a time entry.
updateTimeEntry
Isolated FunctionRemote Function
function updateTimeEntry(string bookId, string timeEntryId, TimeEntryInput payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Deletes an existing time entry.
createTimeEntry
Isolated FunctionRemote Function
function createTimeEntry(string bookId, TimeEntryInput payload) returns IdResponse|errorCreates a new time entry.
Return Type
- IdResponse|error - The id of the time entry that has been created.
patchTimeEntry
Isolated FunctionRemote Function
function patchTimeEntry(string bookId, string timeEntryId, TimeEntryPatch payload) returns Response|errorUpdates 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
Isolated FunctionRemote Function
Gets a list of users.
Records
reckon.one: AddAttachmentResponse
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
A list of document attachment responses.
Fields
- list AddAttachmentResponse[]? - The list of responses for each document in the request.
reckon.one: Address
An address.
Fields
- id string? - The address's unique id.
- 'type AddressTypeRef? - 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
A list of electronic addresses.
Fields
- list Address[]? - The list of items.
reckon.one: AddressInput
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
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
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
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
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
Reference to an address type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: AddressTypes
Address types.
Fields
- list AddressType[]? - The list of items.
reckon.one: BankAccount
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 FinancialInstitutionRef? - 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
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
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
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
An address.
Fields
- id string? - The address's unique id.
- 'type BookTypeRef? - 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
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
An electronic address.
Fields
- id string? - The electronic address's unique id.
- 'type BookTypeRef? - Type of electronic address.
- address string? - The electronic address.
reckon.one: BookElectronicAddressPatch
An electronic address.
Fields
- address string? - The electronic address.
reckon.one: BookPhoneNumber
A phone number.
Fields
- id string? - The phone number's unique id.
- 'type BookTypeRef? - The type of phone number.
- areaCode string? - The area code.
- number string? - The number.
reckon.one: BookPhoneNumberPatch
A phone number.
Fields
- areaCode string? - The area code.
- number string? - The number.
reckon.one: BookProduct
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
Books.
Fields
- list Book[]? - The list of items.
reckon.one: BookSettings
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 IndustryTypeDetail? - 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 GeneralDetail? - General company details
- addresses BookAddress[]? - List of addresses.
- contactDetails ContactDetail? - Business's contact details.
reckon.one: BookSettingsPatch
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 IndustryTypeDetailPatch? - 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 GeneralDetailPatch? - General company details
- contactDetails ContactDetailPatch? - Business's contact details.
reckon.one: BookTypeRef
Type reference.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Classification
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
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(default false) - Whether the classification is the default for the transaction.
reckon.one: ClassificationPatch
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
Reference to a classification.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Classifications
A list of classifications.
Fields
- list Classification[]? - The list of items.
reckon.one: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
reckon.one: ConnectionConfig
Closed record
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 HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - 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-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
reckon.one: Contact
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 OrganisationRef? - 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
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
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
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
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
Reference to a contact.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Contacts
A list of contacts.
Fields
- list Contact[]? - The list of items.
reckon.one: CreditAccount
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
A credit note.
Fields
- id string - The credit note's unique id.
- creditNoteNumber string? - The credit note's number.
- customer ContactRef? - The customer that the credit note was issued to.
- billingAddress Address? - The address that the credit note was sent to.
- shippingAddress Address? - 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 LedgerAccountRef? - The accounts receivable ledger account.
- classification ClassificationRef? - The classification.
- template TemplateRef? - 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
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(default "The default Accounts Receivable account") - 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(default "The default credit note template") - 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
A credit note line item.
Fields
- lineNumber int - The line number.
- lineId string - The line item's unique id.
- project ProjectRef? - The id and full name of the project that the line item relates to.
- itemDetails CreditNoteLineItemItemDetails? - Details of an item used on a credit note line item.
- accountDetails CreditNoteLineItemAccountDetails? - Details of an account used on a credit note line item.
- description string? - The description of the item.
- taxRate TaxRateRef? - The tax rate.
- taxAmount decimal? - The tax amount.
- taxIsModified boolean? - Whether the tax amount has been modified.
reckon.one: CreditNoteLineItemAccountDetails
Details of an account used on a credit note line item.
Fields
- ledgerAccount LedgerAccountRef? - 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
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
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
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 CreditNoteLineItemItemDetailsInput? - Details of an item used on an invoice line item.
This must be omitted if
accountDetailshave been provided.
- accountDetails CreditNoteLineItemAccountDetailsInput? - Details of an account used on an invoice line item.
This must be omitted if
itemDetailshave been provided.
- description string? - The description of the line.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean(default false) - Whether the tax amount has been modified.
reckon.one: CreditNoteLineItemItemDetails
Details of an item used on an credit note line item.
Fields
- item ItemRef? - 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
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
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
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 CreditNoteLineItemItemDetailsPatch? - Details of an item used on an invoice line item.
This must be omitted if
accountDetailshave been provided.
- accountDetails CreditNoteLineItemAccountDetailsPatch? - Details of an account used on an invoice line item.
This must be omitted if
itemDetailshave 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
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
A list of credit notes.
Fields
- list CreditNote[]? - The list of items.
reckon.one: CreditNoteSettings
A book's credit note settings.
Fields
- prefix string? - The invoice prefix.
- defaultTemplate TemplateRef? - The default invoice template.
- emailSettings EmailTemplate? - Email settings.
reckon.one: CreditNoteSettingsPatch
Credit note settings to patch.
Fields
- prefix string? - The credit note prefix.
- defaultTemplate string? - The default credit note template.
- emailSettings EmailTemplatePatch? - Email settings.
reckon.one: CreditNoteTransactionLinkInput
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
Selected fields to update in a credit note's transaction link.
Fields
- transactionAmount decimal - The transaction's amount.
reckon.one: Customer
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 EntityType? - 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 PaymentTermRef? - 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
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 EntityType? - The organisation's entity types.
- creditLimit decimal? - The customer's credit limit.
- paymentTerms string? - The customer's payment term id.
reckon.one: CustomerPatch
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 EntityTypePatch? - 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
A list of customers.
Fields
- list Customer[]? - The list of items.
reckon.one: CustomerStatementsTemplate
Details of a template.
Fields
- id string - The template's id.
- name string? - The template's name.
- header TemplateHeaderBase? - The header detail of a template.
reckon.one: CustomerStatementsTemplates
A list of templates.
Fields
- list CustomerStatementsTemplate[]? - The list of items.
reckon.one: Department
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
Employee belonging to department.
Fields
- id string - An employee's Id.
reckon.one: DepartmentInput
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
Manager belonging to department.
Fields
- id string - A manager's Id.
reckon.one: DepartmentPatch
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
A list of departments.
Fields
- list Department[]? - The list of items.
reckon.one: DocumentAttachment
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
An electronic address.
Fields
- id string? - The electronic address's unique id.
- 'type ElectronicAddressTypeRef? - Type of electronic address.
- address string? - The electronic address.
reckon.one: ElectronicAddresses
A list of electronic addresses.
Fields
- list ElectronicAddress[]? - The list of items.
reckon.one: ElectronicAddressInput
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
Details of a electronic address to update.
Fields
- address string? - The electronic address.
reckon.one: ElectronicAddressType
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
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
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
Reference to an electronic address type.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: ElectronicAddressTypes
Electronic address types.
Fields
- list ElectronicAddressType[]? - The list of items.
reckon.one: Email
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
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
The book's tax email settings.
Fields
- bas EmailTemplate? - BAS default email settings.
reckon.one: EmailSettingsPatch
The book's tax email settings to patch.
Fields
- bas EmailTemplatePatch? - BAS default email settings.
reckon.one: EmailTemplate
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
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
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
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
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
Reference to an employee.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: Employees
A list of employees.
Fields
- list Employee[]? - The list of items.
reckon.one: EntityType
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
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
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
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
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
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
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
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
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 EstimateTemplateHeader? - The header details of the template.
- content EstimateTemplateContent? - The content's details of the template.
reckon.one: EstimateTemplateContent
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
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
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 Logo? - 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
A list of estimate templates.
Fields
- list EstimateTemplate[]? - The list of items.
reckon.one: ExpenseClaim
An expense claim.
Fields
- id string - The expense claim's unique id.
- claimNumber string? - The expense claim's number.
- employee ContactRef? - The employee who lodged the expense claim.
- claimDate string - The date of the expense claim.
- reference string? - The reference entered by the employee.
- project ProjectRef? - The project that the expense claim relates to.
- customer ContactRef? - 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
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
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 ProjectRef? - The id and full name of the project that the line item relates to.
- itemDetails ExpenseClaimLineItemItemDetails? - Details of an item used on an expense claim line item.
- accountDetails ExpenseClaimLineItemAccountDetails? - Details of an account used on an expense claim line item.
- supplier ContactRef? - The supplier that the line item relates to.
- customer ContactRef? - 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 TaxRateRef? - 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
Details of an account used on an expense claim line item.
Fields
- ledgerAccount LedgerAccountRef? - 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
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
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
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(default "The project from the expense claim header") - 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(default "The customer from the expense claim header") - The customer that the line item relates to.
- isBillable boolean(default false) - Whether the line item is billable to the customer.
- billableStatus BillableStatus? - The billable status.
- itemDetails ExpenseClaimLineItemItemDetailsInput? - Details of an item used on an expense claim line item.
This must be omitted if
accountDetailshave been provided.
- accountDetails ExpenseClaimLineItemAccountDetailsInput? - Details of an account used on an expense claim line item.
This must be omitted if
itemDetailshave been provided.
- description string? - The description of the expense.
- taxAmount decimal? - The tax amount.
- taxRate string? - The tax rate.
- taxIsModified boolean(default false) - Whether the tax amount has been modified.
- notes string? - Notes relating to the expense.
reckon.one: ExpenseClaimLineItemItemDetails
Details of an item used on an expense claim line item.
Fields
- item ItemRef? - 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
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
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
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 ExpenseClaimLineItemItemDetailsPatch? - Details of an item used on an expense claim line item.
This must be omitted if
accountDetailshave been provided.
- accountDetails ExpenseClaimLineItemAccountDetailsPatch? - Details of an account used on an expense claim line item.
This must be omitted if
itemDetailshave 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
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
A list of expense claims.
Fields
- list ExpenseClaim[]? - The list of items.
reckon.one: FileContentResult
A file content result.
reckon.one: FinancialInstitution
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
Reference to a financial institution.
Fields
- id string? - The unique id.
- name string? - The unique name.
reckon.one: FinancialInstitutions
A list of financial institutions.
Fields
- list FinancialInstitution[]? - The list of financial institutions.
reckon.one: FundDetails
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
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
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
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
A response that contains the resource's id and display name.
Fields
- id string - The resource's id.
- name<