Skip to main content
API docs by Redocly

Account Management (3.0.0)

Account

Access and Manage Accounts

Retrieve Accounts

Retrieve a list of Account objects

query Parameters
required
object (Pageable)

Pageable parameters

modified-start
string <date-time>
Example: modified-start=2019-09-07T15:50:00.00Z
modified-end
string <date-time>
Example: modified-end=2019-09-07T15:50:00.00Z
location-uuid
string <uuid>
Example: location-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
include-deactivated
boolean
contact-uuid
string <uuid>
Example: contact-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
account-type-uuid
string <uuid>
Example: account-type-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
external-account-uuid
string <uuid>
Example: external-account-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
Array of objects (Account)
Array
account-uuid
string <uuid>
account-type
string
account-type-uuid
string <uuid>
registered-location-uuid
string <uuid>
account-number
string
treat-discount
number
print-summary-invoice
boolean
no-statements
boolean
monthly-surcharge
number
monthly-discount
number
miles-from-practice
number
last-visit-date
string <date-time>
early-settlement-discount
number
discount-category-uuid
string <uuid>
disallow-online-bookings
boolean
deactivated
boolean
charity-no-tax
boolean
charity-no-tax-stock
boolean
allow-sell-at-cost
boolean
registered-date
string <date-time>
introduced-by-type-uuid
string <uuid>
modified
string <date-time>
external-account-uuid
string <uuid>
charity-number
string
jurisdiction-uuid
string <uuid>
vat-number
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "account-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "account-type": "small animal",
      • "account-type-uuid": "GHBA8B0A-F279-4175-AB3C-4203103822CB",
      • "registered-location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "account-number": "ABC1234",
      • "treat-discount": "10.0",
      • "print-summary-invoice": false,
      • "no-statements": false,
      • "monthly-surcharge": "5.5",
      • "monthly-discount": "7.5",
      • "miles-from-practice": "75.3",
      • "last-visit-date": "2020-09-07T15:50:00.00Z",
      • "early-settlement-discount": "20.0",
      • "discount-category-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "disallow-online-bookings": false,
      • "deactivated": false,
      • "charity-no-tax": false,
      • "charity-no-tax-stock": false,
      • "allow-sell-at-cost": false,
      • "registered-date": "2019-09-07T15:50:00.00Z",
      • "introduced-by-type-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "modified": "2020-05-07T15:50:00.00Z",
      • "external-account-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "charity-number": "ABC1234",
      • "jurisdiction-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "vat-number": "ABC1234"
      }
    ]
}

Create an account

Create an account

Request Body schema: application/json
required
contact-uuid
required
string <uuid>
account-type-uuid
required
string <uuid>
treat-discount
number [ 0 .. 100 ]

Defaults to zero if left blank

print-summary-invoice
boolean

Defaults to false if left blank

no-statements
boolean

Defaults to false if left blank

monthly-surcharge
number [ 0 .. 100 ]

Defaults to zero if left blank

monthly-discount
number [ 0 .. 100 ]

Defaults to zero if left blank

miles-from-practice
number >= 0
early-settlement-discount
number [ 0 .. 100 ]

Defaults to zero if left blank

discount-category-uuid
string <uuid>
disallow-online-bookings
boolean

Defaults to false if left blank

charity-no-tax
boolean

Defaults to false if left blank

charity-no-tax-stock
boolean

Defaults to false if left blank

allow-sell-at-cost
boolean

Defaults to false if left blank

registered-date
string <date-time>

Defaults to the current date if left blank

introduced-by-type-uuid
string <uuid>
external-account-uuid
string <uuid>
charity-number
string
jurisdiction-uuid
string <uuid>
vat-number
string

Responses

Response Schema: application/json
account-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "contact-uuid": "05D95628-2B7A-480F-8577-59BB0214646A",
  • "account-type-uuid": "A5D85B42-EFFA-4954-B7EB-1E0F229B28BD",
  • "treat-discount": 10,
  • "print-summary-invoice": false,
  • "no-statements": false,
  • "monthly-surcharge": 5.5,
  • "monthly-discount": 7.5,
  • "miles-from-practice": 75.3,
  • "early-settlement-discount": 20,
  • "discount-category-uuid": "F227AB89-BE15-4800-83A0-7346D7E77960",
  • "disallow-online-bookings": false,
  • "charity-no-tax": false,
  • "charity-no-tax-stock": false,
  • "allow-sell-at-cost": false,
  • "registered-date": "2019-09-07T15:50:00.00Z",
  • "introduced-by-type-uuid": "05583CC2-1257-4229-816D-B0F2E01AF890",
  • "external-account-uuid": "05583CC2-1257-4229-816D-B0F2E01AF890",
  • "charity-number": "ABC1234",
  • "jurisdiction-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "vat-number": "ABC1234"
}

Response samples

Content type
application/json
{
  • "account-uuid": "DC675B61-8F90-4D5A-8D49-6E948B3D4695"
}

Retrieve an account

Retrieve a account object from its id

path Parameters
account-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
account-uuid
string <uuid>
account-type
string
account-type-uuid
string <uuid>
registered-location-uuid
string <uuid>
account-number
string
treat-discount
number
print-summary-invoice
boolean
no-statements
boolean
monthly-surcharge
number
monthly-discount
number
miles-from-practice
number
last-visit-date
string <date-time>
early-settlement-discount
number
discount-category-uuid
string <uuid>
disallow-online-bookings
boolean
deactivated
boolean
charity-no-tax
boolean
charity-no-tax-stock
boolean
allow-sell-at-cost
boolean
registered-date
string <date-time>
introduced-by-type-uuid
string <uuid>
modified
string <date-time>
external-account-uuid
string <uuid>
charity-number
string
jurisdiction-uuid
string <uuid>
vat-number
string

Response samples

Content type
application/json
{
  • "account-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "account-type": "small animal",
  • "account-type-uuid": "GHBA8B0A-F279-4175-AB3C-4203103822CB",
  • "registered-location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "account-number": "ABC1234",
  • "treat-discount": "10.0",
  • "print-summary-invoice": false,
  • "no-statements": false,
  • "monthly-surcharge": "5.5",
  • "monthly-discount": "7.5",
  • "miles-from-practice": "75.3",
  • "last-visit-date": "2020-09-07T15:50:00.00Z",
  • "early-settlement-discount": "20.0",
  • "discount-category-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "disallow-online-bookings": false,
  • "deactivated": false,
  • "charity-no-tax": false,
  • "charity-no-tax-stock": false,
  • "allow-sell-at-cost": false,
  • "registered-date": "2019-09-07T15:50:00.00Z",
  • "introduced-by-type-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "modified": "2020-05-07T15:50:00.00Z",
  • "external-account-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "charity-number": "ABC1234",
  • "jurisdiction-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "vat-number": "ABC1234"
}

Update an account

Update an account

path Parameters
account-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
account-type-uuid
required
string or null <uuid>
registered-location-uuid
required
string or null <uuid>
treat-discount
required
number or null [ 0 .. 100 ]

Defaults to zero if set to null

print-summary-invoice
boolean or null

Nothing will change if set to null

no-statements
boolean or null

Nothing will change if set to null

monthly-surcharge
required
number or null [ 0 .. 100 ]

Defaults to zero if set to null

monthly-discount
required
number or null [ 0 .. 100 ]

Defaults to zero if set to null

miles-from-practice
number or null >= 0
early-settlement-discount
required
number or null [ 0 .. 100 ]

Defaults to zero if set to null

discount-category-uuid
string or null <uuid>
disallow-online-bookings
boolean or null

Nothing will change if set to null

charity-no-tax
boolean or null

Nothing will change if set to null

charity-no-tax-stock
boolean or null

Nothing will change if set to null

allow-sell-at-cost
boolean or null

Nothing will change if set to null

registered-date
string or null <date-time>
introduced-by-type-uuid
string or null <uuid>
external-account-uuid
string or null <uuid>
charity-number
string or null
jurisdiction-uuid
string or null <uuid>
vat-number
string or null

Responses

Response Schema: application/json
account-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "account-type-uuid": "05D95628-2B7A-480F-8577-59BB0214646A",
  • "registered-location-uuid": "A5D85B42-EFFA-4954-B7EB-1E0F229B28BD",
  • "treat-discount": 10,
  • "print-summary-invoice": false,
  • "no-statements": false,
  • "monthly-surcharge": 5.5,
  • "monthly-discount": 7.5,
  • "miles-from-practice": 75.3,
  • "early-settlement-discount": 20,
  • "discount-category-uuid": "F227AB89-BE15-4800-83A0-7346D7E77960",
  • "disallow-online-bookings": false,
  • "charity-no-tax": false,
  • "charity-no-tax-stock": false,
  • "allow-sell-at-cost": false,
  • "registered-date": "2019-09-07T15:50:00.00Z",
  • "introduced-by-type-uuid": "05583CC2-1257-4229-816D-B0F2E01AF890",
  • "external-account-uuid": "05583CC2-1257-4229-816D-B0F2E01AF890",
  • "charity-number": "ABC1234",
  • "jurisdiction-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "vat-number": "ABC1234"
}

Response samples

Content type
application/json
{
  • "account-uuid": "DC675B61-8F90-4D5A-8D49-6E948B3D4695"
}

Account Relationship

Data Relationship between Account and Contacts

Retrieve account contacts

Retrieve a list of contacts associated with the specified account

path Parameters
account-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
results
Array of strings <uuid> [ items <uuid > ]

Response samples

Content type
application/json
{
  • "results": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

Account Category

Access and Manage Account Categories metadata

Retrieve Account Categories

Retrieve a list of account categories

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (AccountCategory)
Array
account-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "account-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "BANNEDCLIENT",
      • "description": "Banned Client"
      }
    ]
}

Retrieve Account Category

Retrieve an account category

path Parameters
account-category-uuid
required
string <uuid>
Example: 6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json
account-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "account-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "BANNEDCLIENT",
  • "description": "Banned Client"
}

Retrieve accounts' categories

Retrieve a list of account categories on the specified account id

path Parameters
account-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
Array of objects (AccountCategory)
Array
account-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "account-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "BANNEDCLIENT",
      • "description": "Banned Client"
      }
    ]
}

Account Type

Access and Manage Account Type metadata

Retrieve Account Types

Retrieve a account types

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (AccountType)
Array
account-type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "account-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "name": "Small Animal",
      • "description": "Small Animal",
      • "view-order": 2
      }
    ]
}

Retrieve an Account Type

Retrieve a account type object from its id

path Parameters
account-type-uuid
required
string <uuid>
Example: 6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json
account-type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "account-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "name": "Small Animal",
  • "description": "Small Animal",
  • "view-order": 2
}

Introduced By Type

Access and Manage Introduced By metadata

Retrieve Introduced-By Types

Retrieve a list of introduced-by types

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (IntroducedBy)
Array
introduced-by-type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "introduced-by-type-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "name": "Referral",
      • "description": "Referral",
      • "view-order": 4,
      • "active": true
      }
    ]
}

Create an introduced by type

Create an introduced by type

Request Body schema: application/json
required
name
required
string [ 1 .. 100 ] characters
description
string <= 255 characters
view-order
required
integer <int32> >= 1
active
required
boolean

Responses

Response Schema: application/json
introduced-by-type-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "name": "Referral",
  • "description": "Referral",
  • "view-order": 4,
  • "active": true
}

Response samples

Content type
application/json
{
  • "introduced-by-type-uuid": "31285F77-B963-4F25-B60F-73A6EF5B1C8C"
}

Retrieve an introduced-by type

Retrieve a introduced-by type by id

path Parameters
introduced-by-type-uuid
required
string <uuid>
Example: BE2BBEEA-30D0-4547-AF96-E756A3F25E84

Responses

Response Schema: application/json
introduced-by-type-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
active
boolean

Response samples

Content type
application/json
{
  • "introduced-by-type-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
  • "name": "Referral",
  • "description": "Referral",
  • "view-order": 4,
  • "active": true
}

Jurisdiction Type

Access and Manage Tax Jurisdictions

Retrieve Jurisdiction Types

Retrieve a jurisdiction types

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (JurisdictionType)
Array
jurisdiction-type-uuid
string <uuid>
name
string
sort-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "jurisdiction-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "name": "Scotland",
      • "sort-order": 2
      }
    ]
}

Retrieve an Jurisdiction Type

Retrieve a jurisdiction type object from its id

path Parameters
jurisdiction-type-uuid
required
string <uuid>
Example: 6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3

Responses

Response Schema: application/json
jurisdiction-type-uuid
string <uuid>
name
string
sort-order
integer <int32>

Response samples

Content type
application/json
{
  • "jurisdiction-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "name": "Scotland",
  • "sort-order": 2
}