Appearance

Create Contacts ​

Endpoint ​

http
POST /unified/accounting/contacts
Integrations supported
  • QuickBooks
  • Xero

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
contact_type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
Required in
  • QuickBooks

Request Body ​

Refer Writing data using Unified APIs

name
string
The name of the contact
Required in
  • Xero
status
string
The status of the contact
All possible enum values:
  • active
  • archived
Supported in
  • Xero
tax_number
string
The tax number of the contact
Supported in
  • Xero
emails
object[]
The emails of the contact
Supported in
  • Xero
email
string
The email of the contact
type
string
The type of the email
type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
Supported in
  • Xero
currency
string
The currency of the contact
Supported in
  • Xero
addresses
object[]
The addresses of the contact
Supported in
  • Xero
id
string
The unique identifier for address
street_1
string
The street 1 address of the contact
street_2
string
The street 2 address of the contact
city
string
The city of the contact
state
string
The state of the contact
country
string
The country of the contact
postal_code
string
The postal code of the contact
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 the contact
Supported in
  • QuickBooks
  • Xero
name
string
The name of the contact
Supported in
  • QuickBooks
  • Xero
type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
Supported in
  • QuickBooks
  • Xero
emails
object[]
The emails of the contact
Supported in
  • QuickBooks
  • Xero
email
string
The email of the contact
type
string
The type of the email
tax_number
string
The tax number of the contact
Supported in
  • QuickBooks
  • Xero
status
string
The status of the contact
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
currency
string
The currency of the contact
Supported in
  • QuickBooks
  • Xero
company
string
The ID of company the contact belongs to
addresses
object[]
The addresses of the contact
Supported in
  • QuickBooks
  • Xero
id
string
The unique identifier for address
street_1
string
The street 1 address of the contact
street_2
string
The street 2 address of the contact
city
string
The city of the contact
state
string
The state of the contact
country
string
The country of the contact
postal_code
string
The postal code of the contact
type
string
The type of the address
phones
object[]
The phone numbers of the contact
Supported in
  • QuickBooks
  • Xero
number
string
The phone number of the contact
type
string
The type of the phone number
created_at
string
This represents the date when the contact was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the contact was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.