Skip to content

LawVu Account (1.0)

Apis for account related resources (authentication, profiles, organisation details etc)

Download OpenAPI description
LawVu Account.openapi.json
LawVu Account.openapi.yaml
Languages
Servers
Sandbox API

https://api-sandbox.lawvu.com/account-apis/

Production API

https://api.lawvu.com/account-apis/

Auth

Operations

Emails

Operations

Features

Operations

Organisations

Operations

Get organisations

Request

Returns an array of organisations the current user is linked to

No request payload

Responses

Success

Body
Array [
idinteger(int32)
namestring or null
]
Response
No response example

Get departments

Request

Returns an array of departments for the given organisation

Path
organisationIdinteger(int32)required

The organisation to get departments

No request payload

Responses

Success

Body
Array [
idinteger(int32)
namestring or null
parentIdinteger or null(int32)
deletedDateUtcstring or null(date-time)
]
Response
No response example

Get regions

Request

Returns an array of regions for the given organisation

Path
organisationIdinteger(int32)required

The organisation to get regions

No request payload

Responses

Success

Body
Array [
idinteger(int32)
namestring or null
]
Response
No response example

Get clients

Request

Returns an array of clients the current user is linked to

No request payload

Responses

Success

Body
Array [
idinteger(int32)

The organisation id of the client

namestring or null

The name of the client organisation

typestring

The type of the organisation

Options:

  • ServiceProvider
  • Customer

Enum"ServiceProvider""Customer"
permissionsArray of integers or null(int32)

The permissions the user has for the organisation

]
Response
[
  {
    "id": 1,
    "name": "My organisation",
    "type": "ServiceProvider",
    "permissions": []
  },
  {
    "id": 4,
    "name": "Client 1 organisation",
    "type": "Customer",
    "permissions": []
  }
]

Get financial settings

Request

Returns the organisation financial settings the current user is linked to

No request payload

Responses

Success

Body
idinteger(int32)

The organisation ID that the financial settings belong to

yearEndDayinteger(int32)

The day of the month corresponding to financial year end

yearEndMonthinteger(int32)

The month corresponding to financial year end

accountsPayableContactsstring or null

Accounts payable contact details

currencystring or null

ISO code of the organisation's default currency e.g. USD

currencyNamestring or nullread-only

The Name of the organisation's default currency e.g. US Dollar

currencySymbolstring or nullread-only

The Symbol of the organisation's default currency e.g. $

Response
{
  "id": 1,
  "yearEndDay": 31,
  "yearEndMonth": 3,
  "accountsPayableContacts": null,
  "currency": "NZD",
  "currencyName": "New Zealand Dollar",
  "currencySymbol": "$"
}

Recents

Operations

Teams

Operations

Users

Operations

WebhookSubscriptions

Operations