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 |
OAuth ApiKey Basic | ||
| 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) |
Capabilities available from this platform connection (e.g., Accounting, ClientImport) | ||
| 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) | ||
| 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 | ||
JSON Example
{
"code": "string",
"platform": "string",
"name": "string",
"authenticationType": "OAuth",
"apiKey": "string"
}