Companies

Company resources are used to keep track of clients and manage their associated deals, budgets, contacts (people) and projects.
More information about Companies can be found in our Help documentation: Adding Client Companies.

The /companies endpoint allows you to create, update, delete, archive or unarchive (restore) Companies.

The following diagram shows Companies in our data hierarchy:

CompanyDealsProjectsPeopleSubsidiary

Since companies can have custom fields, please refer to the Working with custom fields guide for more details on how to work with them.

Attributes

archived_at string
Response Parameter `filter`

Timestamp when the company was archived.

avatar_url string
Response Request

URL of the company avatar image.

billing_name string
Response Request Parameter `filter`

The billing name used on invoices, if different from the company's display name.

company_code string
Response Request Parameter `filter` Parameter `sort`

An internal or external company code used for integrations or accounting references.

company_id integer
Parameter `filter`

The parent company ID if this company is a subsidiary of another company.

contact object
Response Request

Primary contact details for the company (name, email, phone).

created_at string
Response Parameter `filter` Parameter `sort`

Date when the company was created.

custom_field_attachments array of attachment
Response

Files in file-type custom fields.

custom_field_people array of person
Response

People in person-type custom fields.

custom_fields object
Response Request Parameter `filter` Parameter `sort`

Custom field values for this company.

default_currency string
Response Request Parameter `filter`

Default currency for this company's deals and invoices.

default_document_type document type
Response

The default document type applied to invoices and proposals for this company.

default_document_type_id integer
Response Request

ID of the default document type template used for PDF generation.

default_subsidiary subsidiary
Response

Default subsidiary for this company's invoices.

default_subsidiary_id integer
Response Request Parameter `filter`

ID of the default subsidiary used for this company's invoices.

default_tax_rate tax rate
Response

Default tax rate for this company.

default_tax_rate_id integer
Response Request Parameter `filter`

ID of the default tax rate applied to this company's invoices.

domain string
Response Request

Email domain associated with this company.

due_days integer
Response Request Parameter `filter`

Default payment terms in days.

einvoice_identity einvoice identity
Response

E-invoicing identity configuration for this company.

exclude_company_and_children integer
Parameter `filter`

When true, excludes this company and all its subsidiaries from results when filtering by parent company.

external_id string
Response

External ID from an integrated third-party system.

external_sync boolean
Response

Indicates whether this company is synced with an external integration (e.g. accounting software).

full_query string
Parameter `filter`

A concatenated string used for full-text search across company fields.

fuzzy_dates string
Parameter `filter`

Company-level settings for displaying approximate or fuzzy dates on documents.

fuzzy_people string
Parameter `filter`

Fuzzy person search value.

has_parent_company boolean
Parameter `filter`

When true, this company has a parent company in the hierarchy.

id integer
Parameter `filter`

Unique identifier for this company.

integration_exporter_configuration integration exporter configuration
Response

Integration exporter configuration linked to this company.

invoice_email_recipients string
Response

Email addresses to receive invoices for this company.

jump_query string
Parameter `filter`

Quick jump search query used to navigate to this company.

last_activity_at string
Response Parameter `filter` Parameter `sort`

Timestamp of the most recent activity on this company.

name string
Response Request Parameter `filter` Parameter `sort`

The name of this company.

organization organization
Response

The organization this company belongs to.

original_avatar_url object
Response

URL of the original full-size avatar image for this company before resizing.

parent_company company
Response Parameter `sort`

The parent company of this company in the hierarchy.

parent_company_id integer
Response Request Parameter `filter`

ID of the parent company in the organizational hierarchy.

payment_terms integer
Parameter `filter`

Payment terms label (e.g. Net 30).

project_id integer
Parameter `filter`

ID of the project associated with this company.

projectless_budgets boolean
Response

Whether this company allows budgets without an associated project.

query string
Parameter `filter`

Keyword query used for searching this company.

sample_data boolean
Response

Whether this record is demo/sample data.

settings object
Response Request

Company-level settings controlling notification preferences and other configuration options.

status integer
Parameter `filter` Enum

The current status of this company (e.g. active or archived).

Enum Values (2 values)

  • 1
  • 2
subscriber_id integer
Parameter `filter`

ID of a person subscribed to follow updates on this company.

subscriber_ids object
Request

IDs of people subscribed to follow updates on this company.

subsidiary_id integer
Parameter `filter`

ID of the subsidiary associated with this company.

tag_list string
Response Request

Tags applied to this company.

tags string
Parameter `filter`

Tags applied to this company.

vat string
Response Request Parameter `filter`

Tax ID / VAT number.