List Contacts ​
Endpoint ​
GET /unified/accounting/contacts
Integrations supported
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
The format of the response.
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.
Defaults to unified
.
unified
raw
normalized
unified
By default the result
attribute is an array of objects. This parameter allows you to specify a field in each result
objects to use as key, which transforms the result
array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
id
Ignores the limit
query parameter.
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
The type of the contact
customer
vendor
Required in
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
The status of the contact
active
archived
Supported in
- QuickBooks
- Xero
This represents the date when the contact was created
Supported in
- QuickBooks
- Xero
This represents the date when the contact was updated
Supported in
- QuickBooks
- Xero
The tax number of the contact
Supported in
- Xero
The name of the contact
Supported in
- Xero
The currency of the contact
Supported in
- Xero
Response Body ​
List of Contacts
The unique identifier for the contact
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The name of the contact
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The type of the contact
customer
vendor
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The emails of the contact
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The email of the contact
The type of the email
The tax number of the contact
Supported in
- Coupa
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Xero
The status of the contact
active
archived
Supported in
- Coupa
- FreeAgent
- QuickBooks
- Wave
- Xero
The currency of the contact
Supported in
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The ID of company the contact belongs to
Supported in
- FreeAgent
The addresses of the contact
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The unique identifier for address
The street 1 address of the contact
The street 2 address of the contact
The city of the contact
The state of the contact
The country of the contact
The postal code of the contact
The type of the address
The phone numbers of the contact
Supported in
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
The phone number of the contact
The extension of the phone number
The type of the phone number
This represents the date when the contact was created
Supported in
- Coupa
- FreeAgent
- QuickBooks
- Wave
- Xero
This represents the date when the contact was updated
Supported in
- Coupa
- FreeAgent
- Microsoft Dynamics 365 Business Central
- QuickBooks
- Wave
- Xero
Raw data returned from the remote API call.
The cursor to use for the next page of results. Pass this value as next_cursor
in the query parameter in the next request to get the next page of results.