Skip to content

Update Employees

Endpoint

http
PATCH /unified/accounting/employees/{id}
Integrations supported
  • QuickBooks
  • Xero

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

first_name
string
The first name of the employee
Supported in
  • QuickBooks
  • Xero
last_name
string
The last name of the employee
Supported in
  • QuickBooks
  • Xero
id
string
REQUIRED · The unique identifier for employee
Supported in
  • QuickBooks
name
string
The display name of the employee
Supported in
  • QuickBooks
emails
object[]
The emails of the employee
Supported in
  • QuickBooks
email
string
The email of the employee
type
string
The type of the email
phones
object[]
The phone numbers of employee
Supported in
  • QuickBooks
number
string
The phone number
extension
string
The extension of the phone number
type
string
The type of phone
addresses
object[]
Supported in
  • QuickBooks
street_1
string
The street 1 of the address
street_2
string
The street 2 of the address
city
string
The city of the address
state
string
The state of the address
country
string
The country of the address
postal_code
string
The postal code of the address
type
string
The type of the address
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The unique identifier for employee
Supported in
  • QuickBooks
  • Xero
first_name
string
The first name of the employee
Supported in
  • QuickBooks
  • Xero
last_name
string
The last name of the employee
Supported in
  • QuickBooks
  • Xero
name
string
The display name of the employee
Supported in
  • QuickBooks
emails
object[]
The emails of the employee
Supported in
  • QuickBooks
email
string
The email of the employee
type
string
The type of the email
phones
object[]
The phone numbers of employee
Supported in
  • QuickBooks
number
string
The phone number
extension
string
The extension of the phone number
type
string
The type of phone
addresses
object[]
Supported in
  • QuickBooks
street_1
string
The street 1 of the address
street_2
string
The street 2 of the address
city
string
The city of the address
state
string
The state of the address
country
string
The country of the address
postal_code
string
The postal code of the address
type
string
The type of the address
created_at
string · date-time
This represents the date when the employee was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the employee was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.