Appearance

List Company info ​

Endpoint ​

http
GET /unified/accounting/company_info
Integrations supported
  • FreeAgent
  • QuickBooks
  • Xero

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.

  • 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.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

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.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
created_at
string · date-time

This represents the date when the company info was created

Supported in
  • QuickBooks
updated_at
string · date-time

This represents the date when the company info was updated

Supported in
  • QuickBooks

Response Body ​

result
object[]

List of Company info

id
string
REQUIRED · 

The unique identifier for company info

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
name
string

The name of the company

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
legal_name
string

The legal name of the company

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
emails
object[]
Supported in
  • FreeAgent
  • QuickBooks
email
string

The company's email

type
string

The company's email type

tax_number
string

The tax number of the company

Supported in
  • FreeAgent
  • Xero
fiscal_year_end_month
string

The fiscal year end month

Supported in
  • FreeAgent
  • Xero
fiscal_year_end_day
string

The fiscal year end day

Supported in
  • Xero
currency
string

The currency of the company

Supported in
  • FreeAgent
  • Xero
urls
string[]

The urls of the company

Supported in
  • FreeAgent
  • Xero
addresses
object[]

The addresses of the company

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
street_1
string

The street 1 address of the company

street_2
string

The street 2 address of the company

city
string

The city of the company

state
string

The state of the company

country
string

The country of the company

postal_code
string

The postal code of the company

type
string

The type of the address

phones
object[]

The phone numbers of the company

Supported in
  • FreeAgent
  • QuickBooks
number
string

The phone number of the company

extension
string

The extension of the phone number

type
string

The type of the phone number

created_at
string · date-time

This represents the date when the company info was created

Supported in
  • FreeAgent
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the company info was updated

Supported in
  • FreeAgent
  • QuickBooks
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.