Subsidiaries

Subsidiary Tax ID

The Tax ID displayed in Settings → Company info → Edit Subsidiary can be retrieved through the API via the related bill_from contact entry by calling:

GET /api/v2/subsidiaries/{id}?include=bill_from

The Tax ID is returned in the included section, inside the contact_entries object, where type is bill_from, under the vat attribute.

Attributes

archived_at string
Response

Timestamp when the subsidiary was archived, or null if active.
bill_from contact entry
Response

Billing address details used on invoices issued by this subsidiary.
custom_domain custom domain
Response

Custom email domain linked to this subsidiary for outgoing communication.
custom_domain_id integer
Request

ID of the custom domain linked to this subsidiary for email sending.
default_bank_account bank account
Response

Default bank account used for outgoing payments from this subsidiary.
default_bank_account_id integer
Request

ID of the default bank account for this subsidiary.
default_document_type document type
Response

Default document type template applied to invoices from this subsidiary.
default_document_type_id integer
Request

Default document type (PDF template) applied to invoices from this subsidiary.
default_tax_rate tax rate
Response

Default tax rate applied to invoice line items for this subsidiary.
default_tax_rate_id integer
Request

ID of the default tax rate for this subsidiary.
einvoice_configuration einvoice configuration
Response

E-invoicing configuration for this subsidiary (formats, routing, transmission settings).
einvoice_identity einvoice identity
Response

E-invoicing identity details for this subsidiary (PEPPOL endpoint, routing identifiers).
export_integration_type_id integer
Response Enum

Integration type used for exporting documents from this subsidiary.

Enum Values (11 values)

  • 1
    CPP
  • 2
    Quickbooks
  • 3
    Xero
  • 4
    Exact
  • 5
    Economic
  • 6
    Fortnox
  • 7
    Custom
  • 8
    Twinfield
  • 9
    Sage Accounting
  • 10
    Sage Intacct
  • 11
    Netsuite
facility_costs object
Response Request

Monthly facility/overhead costs allocated to this subsidiary.
facility_costs_breakdown object
Response Request

Breakdown of facility costs into component categories.
facility_costs_default object
Response

Facility costs in the organization's default currency.
facility_costs_normalized object
Response

Facility costs normalized to a common currency for cross-subsidiary comparison.
id integer
Parameter `filter`

The unique identifier of this subsidiary.
integration integration
Response

Linked accounting or export integration for this subsidiary.
invoice_logo_url string
Response Request

The URL of the logo image used on invoices for this subsidiary.
invoice_number_format string
Response Request

The format template for generating invoice numbers for this subsidiary (e.g. INV-{year}-{number}).
invoice_number_scope string
Response Request

The scope that determines invoice number sequencing — whether numbers are shared across the organization or unique per subsidiary.
name string
Response Request Parameter `sort`

Display name of the subsidiary legal entity.
organization organization
Response

The organization this subsidiary belongs to.
show_delivery_date boolean
Response Request

When true, the delivery date is shown on invoices generated for this subsidiary.
status integer
Parameter `filter`

The status of this subsidiary, indicating whether it is active or archived.

Operations

GET /api/v2/subsidiaries
Gets all subsidiaries
POST /api/v2/subsidiaries
Create a subsidiary
GET /api/v2/subsidiaries/{id}
Gets a subsidiary
PATCH /api/v2/subsidiaries/{id}
Update a subsidiary
PATCH /api/v2/subsidiaries/{id}/archive
Archives a subsidiary