API Docs / Schemas / ClientBookkeepingLinkDto

ClientBookkeepingLinkDto

The organisation a client's record is bound to at the practice's bookkeeping-health provider,
and the connection the practice reaches it through.

Properties

Name Type Description
codestring

The link's own code.

The link's own code.

organisationCodeAndNameDto
connectionCodeAndNameDto
platformstring

The bookkeeping-health platform (e.g. "XenonConnect").

The bookkeeping-health platform (e.g. "XenonConnect").

connectionStatusenum

NotInitiated Initialising Active Expired Revoked Error

NotInitiated Initialising Active Expired Revoked Error

createdDatestring

When the client was linked to this organisation.

When the client was linked to this organisation.

externalUrlstring

A link straight into the organisation's page on the provider's own site, or null when the
provider has no addressable page per organisation.

A link straight into the organisation's page on the provider's own site, or null when the
provider has no addressable page per organisation.

JSON Example

{
  "code": "string",
  "organisation": {
    "code": "string",
    "name": "string"
  },
  "connection": {
    "code": "string",
    "name": "string"
  },
  "platform": "string",
  "connectionStatus": "NotInitiated"
}

Used By Operations