AvailableClientDto

A customer/client retrieved from a third-party accounting platform (Xero, QuickBooks, FreeAgent, etc.)
that is available to be imported into SodiumHQ as a client.
Shows the platform's data and indicates whether it has already been imported.

Properties

Name	Type	Description
externalId	string	Platform-specific customer identifier (used to perform the import)
Platform-specific customer identifier (used to perform the import)
name	string	Customer/company name from the accounting platform
Customer/company name from the accounting platform
code	string	Customer code/reference from the accounting platform (if available)
Customer code/reference from the accounting platform (if available)
email	string	Primary email address
Primary email address
phone	string	Primary phone number
Primary phone number
address	string	Street address
Street address
city	string	City/town
City/town
postalCode	string	Postal/ZIP code
Postal/ZIP code
country	string	Country
Country
isActive	boolean	Whether the customer is active in the accounting platform
Whether the customer is active in the accounting platform
contactCount	integer	Number of contacts associated with this customer in the accounting platform
Number of contacts associated with this customer in the accounting platform
importedAs	CodeAndNameDto

JSON Example

{
  "externalId": "string",
  "name": "string",
  "code": "string",
  "email": "string",
  "phone": "string"
}

Contained in Schemas

AvailableClientsResponseDto Paginated list of clients available for import from a third-party accounting platform. Includes pagi...