Articles in this section

See more

B4T API: Clients

Avatar
Suzie K.
  • Updated
Follow

v2 Available Routes

get {API Key}/v2/clients

Data Format

Client
Field Name Type Values Description
InternalClientID number   Unique ID for the client (Bill4Time Generated)
ClientID text   Unique ID for the client (User Generated Custom ID). Normally the same as id
ClientName text   Name for the client
BillingName text   Name for the client as will appear on invoices
ClientType text   Type of client
CreationDate datetime   Date that the client was created
AccountManagerId number   User ID of the account manager for the client
AccountManagerName text   Full name of the account manager for the client
ClientStatus text Active, Disabled Status of Client
Address1 text   Address line 1 of the client
Address2 text   Address line 2 of the client
Address3 text   Address line 3 of the client
City text   Client's City
State text   Client's state
Country text   Client's Country
PostalCode text   Client's postalCode
Phone text   Client's phone number
Mobile text   Client's mobile phone number
Fax text   Client's fax number
Email text   Client's email
PrimaryContactId Number   Contact ID (Bill4Time Generated)
PrimaryContactFirstName Text   First Name of Contact
PrimaryContactLastName Text   Last Name of Contact
CurrencyCode Text   Currency code of the client.
CurrencySymbol Text   Currency symbol of the client.
Custom Fields Text   Custom Fields Client level

Usage Examples

Find all clients
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v2/clients
Find client with id = 751
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v2/clients?$filter=id eq 751
Find All Active Clients
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v2/clients?$filter=status eq 'Active'
Find All Active clients created after January 1st, 2017
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v2/clients?$filter=status eq 'Active' AND creation Date gt '2017-01-01'

 

v1 Available Routes

get {API Key}/v1/clients

Data Format

Field Name Type Description
id number Unique ID for the client (Bill4Time Generated)
customId text Unique ID for the client (User Generated). Normally the same as id
clientName text Name for the client
billingName text Name for the client as will appear on invoices
address1 text Address line 1 of the client
address2 text Address line 2 of the client
address3 text Address line 3 of the client
city text Client's City
state text Client's state
country text Client's Country
postalCode text Client's postalCode
phone text Client's phone number
mobile text Client's mobile phone number
fax text Client's fax number
email text Client's email
accountManagerId number User ID of the account manager for the client
accountManagerName text Full name of the account manager for the client
status text Status of Client.
Values
  • Active
  • Disabled
clientType text Type of client
creationDate datetime Date that the client was created
billingRateType text Billing rate type for client. Rates are either flat rate or per employee.
Values
  • PEREMP
  • FLATRATE
billingFlatRate text Billing rate for client as long as the billing rate type has the value 'FLATRATE'
overtimeBillingFlatRate text Overtime billing rate for client as long as the billing rate type has the value 'FLATRATE'
customFields json JSON object containing custom fields (not searchable).
ledesClientTaxId text Ledes tax id of the client.
currencyCode text Currency code of the client.
currencySymbol text Currency symbol of the client.
acctIsolation text Client account isolation level
Values
  • Client
  • Project

Usage Examples

Find all clients
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v1/clients
Find client with id = 751
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v1/clients?$filter=id eq 751
Find All Active Clients
gethttps://secure.bill4time.com/b4t-api/{Api Key}/v1/clients?$filter=status eq 'Active'
Find All Active clients created after January 1st, 2017

 

gethttps://secure.bill4time.com/b4t-api/{Api Key}/v1/clients?$filter=status eq 'Active' AND creationDate gt '2017-01-01'

Related articles

Comments

0 comments

Please sign in to leave a comment.