CData Python Connector for FreshBooks

Build 20.0.7587

Clients

A list of clients stored in FreshBooks. Staff can view and edit clients they are assigned to.

Table Specific Information

Select

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:

  • ClientId
  • Email
  • UserName
  • Updated

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.

Insert

To insert, the Email field is required.

Contact Aggregate

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', 'jane.doe@abccorp.com',
'<contact><username>john</username><first_name></first_name>
<last_name></last_name><email>john@abccorp.com</email>
<phone1></phone1><phone2></phone2></contact>')

Note: Updating this field will remove all previously stored contact information.

Columns

Name Type ReadOnly Description
ClientId [KEY] String True

The unique identifier of a client.

FirstName String False

The primary first name associated with a client.

LastName String False

The primary last name associated with a client.

Organization String False

The organization name for a client.

Email String False

The primary email address for a client.

Username String False

The username associated with a client.

Password String False

The password associated with a client.

ContactAggregate String False

An aggregate containing additional contact information about a client. See the help file for the Clients table for more details.

WorkPhone String False

The business phone number for a client.

HomePhone String False

The home phone number for a client.

Mobile String False

The mobile phone number for a client.

Fax String False

The fax number for a with a client.

Language String False

The default language for a client.

CurrencyCode String False

The default currency for a client.

Credit Decimal True

The credit amount attached to a client.

CreditAggregate String True

An aggregate containing information about credits for a client. This field is read-only.

Notes String False

A custom internal note for a client.

PrimaryStreet1 String False

The first line of a primary street address for a client.

PrimaryStreet2 String False

The second line of a primary street address for a client.

PrimaryCity String False

The primary city for a client.

PrimaryState String False

The primary state or province for a client.

PrimaryCountry String False

The primary country for a client.

PrimaryCode String False

The primary Postal/ZIP code for a client.

SecondaryStreet1 String False

The first line of a secondary street address for a client.

SecondaryStreet2 String False

The second line of a secondary street address for a client.

SecondaryCity String False

The secondary city for a client.

SecondaryState String False

The secondary state or province for a client.

SecondaryCountry String False

The secondary country for a client.

SecondaryCode String False

The secondary Postal/ZIP code for a client.

Url String True

The Url for a client. This value is deprecated in favor of LinksClientView.

AuthUrl String True

The auth_url for a client. This value is deprecated in favor of LinksView.

LinksClientView String True

Client view for a link to a client.

LinksView String True

View for a link to a client.

LinksStatement String True

Statement for a link to a client.

VatName String False

The VAT name associated with a client.

VatNumber String False

The VAT number associated with a client.

Updated Datetime True

A time value representing the last time the client was updated.

Folder String True

The folder category for the client.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587