A list of clients stored in FreshBooks. Staff can view and edit clients they are assigned to.
Table Specific Information
The Classic API allows only a subset of columns to be used as filter criteria in the WHERE clause. The following columns can be used:
Note: ClientId cannot be used at the same time as the other columns.
Other filters are processed client side by the provider. See SupportEnhancedSQL for more information.
To insert, the Email field is required.
You can use the ContactAggregate field to flatten contact items into a single field. This XML aggregate contains information about additional contact information beyond the primary contact for a client and can be inserted and updated directly using the proper XML formatting, as indicated by the example below:
INSERT INTO Clients (FirstName, LastName, Organization, Email, ContactAggregate) VALUES ('Jane', 'Doe', 'ABC Corp', 'email@example.com', '<contact><username>john</username><first_name></first_name> <last_name></last_name><email>firstname.lastname@example.org</email> <phone1></phone1><phone2></phone2></contact>')
Note: Updating this field will remove all previously stored contact information.
The unique identifier of a client.
The primary first name associated with a client.
The primary last name associated with a client.
The organization name for a client.
The primary email address for a client.
The username associated with a client.
The password associated with a client.
An aggregate containing additional contact information about a client. See the help file for the Clients table for more details.
The business phone number for a client.
The home phone number for a client.
The mobile phone number for a client.
The fax number for a with a client.
The default language for a client.
The default currency for a client.
The credit amount attached to a client.
An aggregate containing information about credits for a client. This field is read-only.
A custom internal note for a client.
The first line of a primary street address for a client.
The second line of a primary street address for a client.
The primary city for a client.
The primary state or province for a client.
The primary country for a client.
The primary Postal/ZIP code for a client.
The first line of a secondary street address for a client.
The second line of a secondary street address for a client.
The secondary city for a client.
The secondary state or province for a client.
The secondary country for a client.
The secondary Postal/ZIP code for a client.
The Url for a client. This value is deprecated in favor of LinksClientView.
The auth_url for a client. This value is deprecated in favor of LinksView.
Client view for a link to a client.
View for a link to a client.
Statement for a link to a client.
The VAT name associated with a client.
The VAT number associated with a client.
A time value representing the last time the client was updated.
The folder category for the client.