From 250283c3a7b18ae98718cc583c1040b31410fc8c Mon Sep 17 00:00:00 2001 From: RobHarrison Date: Tue, 14 Jul 2026 16:53:53 +0100 Subject: [PATCH 1/2] [PEP-1898] Document ownerUserIds on company responses Company responses from the public API now include a read-only ownerUserIds property (codat-internal/public-api#131). Adds a changelog post and a section in the managing-companies guide. Co-Authored-By: Claude Fable 5 --- ...714-company-owners-on-company-responses.md | 61 +++++++++++++++++++ blog/authors.yml | 6 ++ docs/using-the-api/managing-companies.md | 6 ++ 3 files changed, 73 insertions(+) create mode 100644 blog/260714-company-owners-on-company-responses.md diff --git a/blog/260714-company-owners-on-company-responses.md b/blog/260714-company-owners-on-company-responses.md new file mode 100644 index 000000000..629a10434 --- /dev/null +++ b/blog/260714-company-owners-on-company-responses.md @@ -0,0 +1,61 @@ +--- +title: "Introducing company owners on company responses" +date: "2026-07-14" +tags: ["Product", "Update"] +hide_table_of_contents: true +authors: rharrison +--- + +import Diff from "@components/Diff"; + +We've enhanced our `company` data model to reflect ownership. +Company responses now include an `ownerUserIds` property that lists the users who own the company. + + + +### What's new? + +We've introduced an `ownerUserIds` property to our `company` [data model](/platform-api#/schemas/Company). It contains the IDs of the [users](/configure/user-management/adding-users) assigned as owners of the company, making it easy to connect companies in Codat to the team members responsible for them. + +Every endpoint that returns a company includes the new property, such as [Get company](/platform-api#/operations/get-company) and [List companies](/platform-api#/operations/list-companies). If a company has no owners assigned, `ownerUserIds` is an empty array. + +The property is read-only. Owners are assigned and managed in the Codat Portal, so requests to the [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept it. + + + +### Who is it relevant for? + +Any client who assigns owners to their companies and wants to surface that ownership in their own systems — for example, to route notifications or reports to the right team members. + +### How to get started? + +No changes to your integration are required. Company responses automatically include the `ownerUserIds` property. diff --git a/blog/authors.yml b/blog/authors.yml index 7b7ff5cd3..4489a20e0 100644 --- a/blog/authors.yml +++ b/blog/authors.yml @@ -189,3 +189,9 @@ brucepouncey: title: Product Engineer url: https://github.com/brucepouncey image_url: https://avatars.githubusercontent.com/u/229920420?v=4 + +rharrison: + name: Rob Harrison + title: Software Engineer + url: https://github.com/Rob-Codat + image_url: https://github.com/Rob-Codat.png diff --git a/docs/using-the-api/managing-companies.md b/docs/using-the-api/managing-companies.md index f66d06f3b..2b6bcaf52 100644 --- a/docs/using-the-api/managing-companies.md +++ b/docs/using-the-api/managing-companies.md @@ -375,6 +375,12 @@ res, err := platformClient.Companies.List(ctx, operations.ListCompaniesRequest{ +### View company owners + +Companies can be assigned one or more owners — [users](/configure/user-management/adding-users) in Codat who are responsible for that company. Every company response includes a read-only `ownerUserIds` property that lists the IDs of the company's owners. If a company has no owners assigned, `ownerUserIds` is an empty array. + +Owners are assigned and managed in the Codat Portal. The [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept the `ownerUserIds` property in request bodies. + ### Authorize access to company data Once you've created the company, they'll need to give you permission to read their data from a given source, like their accounting software. There are several approaches to doing this, but for simplicity we've just covered our out-of-the-box [hosted link](/auth-flow/authorize-hosted-link) approach. From 9fab418db9292e88d973feabfa0b824400ecfbc8 Mon Sep 17 00:00:00 2001 From: RobHarrison Date: Tue, 14 Jul 2026 16:59:21 +0100 Subject: [PATCH 2/2] [PEP-1898] Address PR feedback: active voice, drop changelog post Rewrites the company-owners section in active voice per the Vale Google.Passive findings, and removes the changelog post (and its authors.yml entry) from this PR. Co-Authored-By: Claude Fable 5 --- ...714-company-owners-on-company-responses.md | 61 ------------------- blog/authors.yml | 6 -- docs/using-the-api/managing-companies.md | 4 +- 3 files changed, 2 insertions(+), 69 deletions(-) delete mode 100644 blog/260714-company-owners-on-company-responses.md diff --git a/blog/260714-company-owners-on-company-responses.md b/blog/260714-company-owners-on-company-responses.md deleted file mode 100644 index 629a10434..000000000 --- a/blog/260714-company-owners-on-company-responses.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "Introducing company owners on company responses" -date: "2026-07-14" -tags: ["Product", "Update"] -hide_table_of_contents: true -authors: rharrison ---- - -import Diff from "@components/Diff"; - -We've enhanced our `company` data model to reflect ownership. -Company responses now include an `ownerUserIds` property that lists the users who own the company. - - - -### What's new? - -We've introduced an `ownerUserIds` property to our `company` [data model](/platform-api#/schemas/Company). It contains the IDs of the [users](/configure/user-management/adding-users) assigned as owners of the company, making it easy to connect companies in Codat to the team members responsible for them. - -Every endpoint that returns a company includes the new property, such as [Get company](/platform-api#/operations/get-company) and [List companies](/platform-api#/operations/list-companies). If a company has no owners assigned, `ownerUserIds` is an empty array. - -The property is read-only. Owners are assigned and managed in the Codat Portal, so requests to the [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept it. - - - -### Who is it relevant for? - -Any client who assigns owners to their companies and wants to surface that ownership in their own systems — for example, to route notifications or reports to the right team members. - -### How to get started? - -No changes to your integration are required. Company responses automatically include the `ownerUserIds` property. diff --git a/blog/authors.yml b/blog/authors.yml index 4489a20e0..7b7ff5cd3 100644 --- a/blog/authors.yml +++ b/blog/authors.yml @@ -189,9 +189,3 @@ brucepouncey: title: Product Engineer url: https://github.com/brucepouncey image_url: https://avatars.githubusercontent.com/u/229920420?v=4 - -rharrison: - name: Rob Harrison - title: Software Engineer - url: https://github.com/Rob-Codat - image_url: https://github.com/Rob-Codat.png diff --git a/docs/using-the-api/managing-companies.md b/docs/using-the-api/managing-companies.md index 2b6bcaf52..da82a64d3 100644 --- a/docs/using-the-api/managing-companies.md +++ b/docs/using-the-api/managing-companies.md @@ -377,9 +377,9 @@ res, err := platformClient.Companies.List(ctx, operations.ListCompaniesRequest{ ### View company owners -Companies can be assigned one or more owners — [users](/configure/user-management/adding-users) in Codat who are responsible for that company. Every company response includes a read-only `ownerUserIds` property that lists the IDs of the company's owners. If a company has no owners assigned, `ownerUserIds` is an empty array. +A company can have one or more owners — [users](/configure/user-management/adding-users) in Codat responsible for that company. Every company response includes a read-only `ownerUserIds` property that lists the IDs of the company's owners. If a company has no owners, `ownerUserIds` is an empty array. -Owners are assigned and managed in the Codat Portal. The [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept the `ownerUserIds` property in request bodies. +You assign and manage owners in the Codat Portal. The [Create company](/platform-api#/operations/create-company) and [Update company](/platform-api#/operations/update-company) endpoints don't accept the `ownerUserIds` property in request bodies. ### Authorize access to company data