Staff
Staff are your employees. Staff created via this endpoint are only Accounting representations of the staff members of your business, for the purpose of ownership of invoices, expenses, etc. To create staff members for actual use please use the Staff Invitation flow in the new FreshBooks' web interface.
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | Integer | False |
The unique identifier of the staff member to this business id. |
AccountingSystemId | String | False |
The unique identifier of the business staff member exists on. |
APIToken | String | False |
Token used for Classic API. (deprecated) |
BusinessPhone | String | False |
The business phone number. |
CurrencyCode | String | False |
Three-digit shortcode for preferred currency. |
DisplayName | String | False |
Name chosen by staff member to display. |
String | False |
Email address for staff member. | |
Fax | String | False |
Fax number for staff member. |
FirstName | String | False |
First name of staff member. |
HomePhone | String | False |
Staff member's home phone number. |
Language | String | False |
Staff member's selected language. |
LastLogin | Datetime | False |
Date and time the staff account was last logged into. |
Level | Integer | False |
Description of staff member access level. (deprecated) |
LastName | String | False |
Last name of staff member. |
MobilePhone | String | False |
Staff member's mobile phone number. |
Note | String | False |
Notes about staff member. |
Logins | Integer | False |
Number of times the staff member has logged in. |
Organization | String | False |
Organization the staff member is affiliated with. |
BillingCity | String | False |
Staff member's billing address city. |
BillingCode | String | False |
Staff member's billing address zip code. |
BillingCountry | String | False |
Staff member's billing address country. |
BillingProvince | String | False |
Staff member's billing address province. |
BillingStreet | String | False |
Staff member's billing address primary street information. |
BillingStreet2 | String | False |
Staff member's billing address secondary street information. |
Rate | String | False |
Rate this staff member is billed at. |
SignupDate | Datetime | False |
Date the staff member account was created. (YYYY-MM-DD HH:MM:SS) |
Updated | Datetime | False |
Date the staff member account was last updated. (YYYY-MM-DD HH:MM:SS) |
Username | String | False |
Username specified for the staff member; randomly assigned if none specified at creation time. |
VisState | Integer | False |
Visibility state: 'active,' 'deleted,' or 'archived.' |