The Lodgeit API lets your practice management system, CRM or own scripts read and update data in Lodgeit directly, so you don't have to export files or key in the same details twice. It is in public preview and covers clients and your organisation's members and teams.

In this article

What the API covers

  • Clients and their details: create, update and archive clients, and find them by code.
  • Client groups.
  • Relations between clients, such as director or trustee.
  • Client assignments: the owner and the members and teams assigned to a client.
  • Your organisation's members and teams.

For example, an integration can add a client to Lodgeit when you sign them up in your CRM, assign new clients to the right team, or record a company's directors.

Tax file numbers, dates of birth and director identification numbers stay hidden unless you allow an application to see them. The API documentation lists every operation and field.

Looking for Xero, QuickBooks or MYOB imports?

Importing financials and BAS values from accounting software is a separate feature. See Settings - Import (Financials).

Before you start

  • You have Owner access to your Lodgeit organisation.
  • You, or the developer who builds the integration, can work with a REST API that uses OAuth 2.0.

Test in a separate organisation

The API works on live data. Create a separate test organisation and try your integration there before you connect it to your real clients.

Connect an application

An integration connects to Lodgeit as a service application with its own client ID and secret.

  1. Open Service applications in Lodgeit SSO and sign in as an Owner.
  2. Select New application and enter a name.
  3. Under Scopes, choose what the application can access. A read scope lets it read data, and a manage scope lets it make changes as well. Give it only the access it needs.
  4. Under Personal data, allow tax file numbers, dates of birth or director identification numbers only if the integration needs them.
  5. Select Confirm. The application opens without a secret.
  6. Under Secrets, select Add secret, then Confirm.
  7. Copy the client ID and client secret. Lodgeit shows the secret only once. Keep it as safe as a password, because anyone who has it can access your client data.
  8. Give the client ID and secret to whoever builds the integration.

To cut off an integration's access, open its service application and revoke the secret or disable the application.

For developers

  • The API uses the OAuth 2.0 client credentials flow. Exchange the client ID and secret for an access token at https://sso.lodgeit.com/connect/token.
  • Each operation in the API documentation lists the scopes that grant it. A manage scope includes its read scope, and manage:core grants every operation.
  • When a request fails, the response describes the error and includes a traceId. Send us the traceId when you report the problem.
  • Download the OpenAPI definition if your tools can generate an API client from it.

During the preview

Endpoints and fields may still change based on feedback, so expect to update your integration before the stable version.

Tell us what you need

Email support@lodgeit.net.au with what you'd like to connect to Lodgeit. It helps to include:

  • the system you want to connect, and whether it's for your own practice or a product you build for others;
  • what data you want to read from Lodgeit or send to it.