ClientBooksLinkDto

Properties

Name	Type	Description
code	string	The link's own code.
The link's own code.
organisation	CodeAndNameDto
connection	CodeAndNameDto
platform	string	The accounting platform (e.g. "Xero", "QuickBooks").
The accounting platform (e.g. "Xero", "QuickBooks").
connectionStatus	enum	NotInitiated Initialising Active Expired Revoked Error
NotInitiated Initialising Active Expired Revoked Error
isOrganisationGranted	boolean	Whether the connection's grant still reaches this organisation. False when the client has removed Sodium from their own books, or the practice reauthorised the connection without granting this organisation: the connection is fine, this link is not, and the books cannot be read until the client is linked again.
Whether the connection's grant still reaches this organisation. False when the client has removed Sodium from their own books, or the practice reauthorised the connection without granting this organisation: the connection is fine, this link is not, and the books cannot be read until the client is linked again.
createdDate	string	When the client was linked to this organisation.
When the client was linked to this organisation.
externalUrl	string	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"
}

Properties

JSON Example

Used By Operations