API Docs / Schemas / ClientBooksLinkDto

ClientBooksLinkDto

The organisation a client's record is bound to in that client's own accounting software, 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 accounting platform (e.g. "Xero", "QuickBooks").

The accounting platform (e.g. "Xero", "QuickBooks").

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 this organisation's own dashboard on its platform, where the platform
can target one organisation specifically. Null on QuickBooks and Sage.

A link straight into this organisation's own dashboard on its platform, where the platform
can target one organisation specifically. Null on QuickBooks and Sage.

JSON Example

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

Used By Operations