ThirdPartyConnectionDto

Represents an OAuth or API key connection to a third-party platform such as Xero, FreeAgent, Sage, or QuickBooks.
Used for integrating accounting platforms, client imports, and other external services.

Properties

Name	Type	Description
code	string	The unique code for this connection
The unique code for this connection
platform	string	The platform identifier (e.g., "Xero", "FreeAgent", "Sage", "QuickBooks")
The platform identifier (e.g., "Xero", "FreeAgent", "Sage", "QuickBooks")
name	string	Display name for the connection
Display name for the connection
authenticationType	enum	OAuth ApiKey Basic OAuthClientCredentials
OAuth ApiKey Basic OAuthClientCredentials
apiKey	string	The API key (only populated if AuthenticationType is ApiKey)
The API key (only populated if AuthenticationType is ApiKey)
status	enum	NotInitiated Initialising Active Expired Revoked Error
NotInitiated Initialising Active Expired Revoked Error
capabilities	array of enum	Capabilities available from this platform connection (e.g., Accounting, ClientImport) None Accounting CRM DocumentManagement Communication ProjectManagement TimeTracking Payments ClientImport DirectDebit AML Proposals BookkeepingHealth ESignature
Capabilities available from this platform connection (e.g., Accounting, ClientImport) None Accounting CRM DocumentManagement Communication ProjectManagement TimeTracking Payments ClientImport DirectDebit AML Proposals BookkeepingHealth ESignature
redirectUrl	string	URL to redirect the user back to after OAuth flow completes
URL to redirect the user back to after OAuth flow completes
authorizationUrl	string	OAuth authorization URL for initiating the connection flow
OAuth authorization URL for initiating the connection flow
organization	CodeAndNameDto
availableOrganizations	array of CodeAndNameDto	List of available organizations from the connected platform (populated during OAuth callback)
List of available organizations from the connected platform (populated during OAuth callback)
supportsMultipleStorageLocations	boolean	Whether this connection supports assigning different storage locations to individual clients (e.g. per-client SharePoint sites). When true, the storage-locations endpoint is available and the frontend should show a location picker on client folder assignment.
Whether this connection supports assigning different storage locations to individual clients (e.g. per-client SharePoint sites). When true, the storage-locations endpoint is available and the frontend should show a location picker on client folder assignment.
supportsFileMove	boolean	Whether files can be moved between folders on this platform. When true, the frontend enables drag-and-drop of files onto folders in the client documents list.
Whether files can be moved between folders on this platform. When true, the frontend enables drag-and-drop of files onto folders in the client documents list.
useExtendedScopes	boolean	Whether this connection was authorised with the platform's extended scopes as well as its base scopes. Immutable — the frontend must carry it through when reconnecting, or the reconnection silently drops back to the narrower access.
Whether this connection was authorised with the platform's extended scopes as well as its base scopes. Immutable — the frontend must carry it through when reconnecting, or the reconnection silently drops back to the narrower access.
createdDate	string	When the connection was created
When the connection was created
updatedDate	string	When the connection was last updated
When the connection was last updated
lastUsedDate	string	When this connection was last used to call the platform, or null if it has not been used since usage tracking was introduced (it cannot be backfilled). Excludes automatic token refreshes, so a long-idle value here means nobody is using the connection and it can be disconnected.
When this connection was last used to call the platform, or null if it has not been used since usage tracking was introduced (it cannot be backfilled). Excludes automatic token refreshes, so a long-idle value here means nobody is using the connection and it can be disconnected.

JSON Example

{
  "code": "string",
  "platform": "string",
  "name": "string",
  "authenticationType": "OAuth",
  "apiKey": "string"
}

Used By Operations

Contained in Schemas

ThirdPartyConnectionDtoPagedResult