Skip to main content
Link a connection's company

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
company_id
string<uuid> | null
required

The workspace company to link to; null removes the link.

Response

The company with its link.

id
string<uuid>
required
external_company_id
string | null
required

The provider's ID for the company in the connection. Null for a login that reaches one company.

name
string
required

The name the provider states for the company; the connection's own name for a login that reaches one company.

registration_number
string | null
required

The registration number the provider states, where it states one.

country
string | null
required

Two-letter country code the provider states.

company_id
string<uuid> | null
required

The workspace company new recipients of this company's invoices belong to, and whose accounting data it reads. Null when not linked.

linked_by
enum<string> | null
required

rule: linked because one workspace company has its registration number. person: chosen by hand, linked or not, which no rule changes. Null while nobody has decided.

Available options:
rule,
person,
null
can_create_company
boolean
required

Whether createCompaniesFromLinks can make a workspace company of it: the provider states a registration number that can be one of its country's (the country the workspace's companies share, when it states none). Otherwise it can only be linked to a company the workspace has.