diff --git a/static/oas/Codat-Bank-Feeds.json b/static/oas/Codat-Bank-Feeds.json index 88b847cc98..fb1fcd9458 100644 --- a/static/oas/Codat-Bank-Feeds.json +++ b/static/oas/Codat-Bank-Feeds.json @@ -5521,6 +5521,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -5584,6 +5596,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Commerce.json b/static/oas/Codat-Commerce.json index e2a573382a..a70d93d86b 100644 --- a/static/oas/Codat-Commerce.json +++ b/static/oas/Codat-Commerce.json @@ -6773,7 +6773,8 @@ "503": { "$ref": "#/components/responses/Service-Unavailable" } - } + }, + "description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Products](https://docs.codat.io/commerce-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n" } }, "/companies/{companyId}/connections/{connectionId}/data/commerce-transactions": { diff --git a/static/oas/Codat-Lending.json b/static/oas/Codat-Lending.json index 0ab8789bac..a013248d84 100644 --- a/static/oas/Codat-Lending.json +++ b/static/oas/Codat-Lending.json @@ -119088,6 +119088,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -119151,6 +119163,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Platform.json b/static/oas/Codat-Platform.json index 5880036c9e..38a6b343ed 100644 --- a/static/oas/Codat-Platform.json +++ b/static/oas/Codat-Platform.json @@ -4276,6 +4276,85 @@ } } }, + "company.product.added": { + "post": { + "description": "Called when a product is added to a company in Codat.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyProductWebhook" + }, + "examples": { + "Product added": { + "value": { + "id": "ba29118f-5406-4e59-b05c-ba307ca38d01", + "eventType": "company.product.added", + "generatedDate": "2024-08-08T17:10:34.015Z", + "payload": { + "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", + "name": "Bank of Dave", + "description": "Requested early access to the new financing scheme.", + "productId": "lending", + "productName": "Lending", + "products": [ + "accounting", + "banking", + "lending" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the webhook was received successfully." + } + } + } + }, + "company.product.removed": { + "post": { + "description": "Called when a product is removed from a company in Codat.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompanyProductWebhook" + }, + "examples": { + "Product removed": { + "value": { + "id": "ba29118f-5406-4e59-b05c-ba307ca38d01", + "eventType": "company.product.removed", + "generatedDate": "2024-08-08T17:10:34.015Z", + "payload": { + "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", + "name": "Bank of Dave", + "description": "Requested early access to the new financing scheme.", + "productId": "lending", + "productName": "Lending", + "products": [ + "accounting", + "banking" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the webhook was received successfully." + } + } + } + }, "connection.created": { "post": { "description": "Called when a connection is created by the SMB.", @@ -5346,6 +5425,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -5409,6 +5500,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", @@ -5474,6 +5568,78 @@ } ] }, + "CompanyProductWebhook": { + "title": "Company product webhook", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "example": "ba29118f-5406-4e59-b05c-ba307ca38d01", + "description": "Unique identifier of the event." + }, + "eventType": { + "type": "string", + "description": "The type of event.", + "examples": [ + "company.product.added", + "company.product.removed" + ] + }, + "generatedDate": { + "$ref": "#/components/schemas/DateTime", + "description": "The date time in UTC the event was generated in Codat." + }, + "payload": { + "$ref": "#/components/schemas/CompanyProductWebhook/definitions/companyProductWebhookPayload" + } + }, + "definitions": { + "companyProductWebhookPayload": { + "title": "Company product webhook payload", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "example": "0498e921-9b53-4396-a412-4f2f5983b0a2", + "description": "Unique identifier of the company the product change applies to." + }, + "name": { + "type": "string", + "example": "Bank of Dave", + "description": "Name of the company." + }, + "description": { + "$ref": "#/components/schemas/CompanyRequestBody/properties/description", + "nullable": true + }, + "productId": { + "type": "string", + "example": "lending", + "description": "Unique identifier of the product that was added to or removed from the company." + }, + "productName": { + "type": "string", + "example": "Lending", + "description": "Name of the product that was added to or removed from the company." + }, + "products": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "accounting", + "banking", + "lending" + ], + "description": "The full list of products currently enabled for the company." + } + } + } + } + }, "CompanyRequestBody": { "title": "Create company request", "x-internal": true, diff --git a/static/oas/Codat-Sync-Commerce-v1.json b/static/oas/Codat-Sync-Commerce-v1.json index 52ee021649..43e49ac51e 100644 --- a/static/oas/Codat-Sync-Commerce-v1.json +++ b/static/oas/Codat-Sync-Commerce-v1.json @@ -17561,6 +17561,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -17624,6 +17636,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Commerce.json b/static/oas/Codat-Sync-Commerce.json index 4774dfbda6..7284016988 100644 --- a/static/oas/Codat-Sync-Commerce.json +++ b/static/oas/Codat-Sync-Commerce.json @@ -1717,6 +1717,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -1780,6 +1792,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Expenses-v1.json b/static/oas/Codat-Sync-Expenses-v1.json index 3bf402f08d..3336969021 100644 --- a/static/oas/Codat-Sync-Expenses-v1.json +++ b/static/oas/Codat-Sync-Expenses-v1.json @@ -2363,6 +2363,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -2426,6 +2438,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Expenses.json b/static/oas/Codat-Sync-Expenses.json index 831e44abe9..8a567ce964 100644 --- a/static/oas/Codat-Sync-Expenses.json +++ b/static/oas/Codat-Sync-Expenses.json @@ -15427,6 +15427,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -15490,6 +15502,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Payables-v1.json b/static/oas/Codat-Sync-Payables-v1.json index 554515c54a..d5f6d49226 100644 --- a/static/oas/Codat-Sync-Payables-v1.json +++ b/static/oas/Codat-Sync-Payables-v1.json @@ -46113,6 +46113,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -46176,6 +46188,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Payables.json b/static/oas/Codat-Sync-Payables.json index 345d4ed066..b19aebc32c 100644 --- a/static/oas/Codat-Sync-Payables.json +++ b/static/oas/Codat-Sync-Payables.json @@ -3726,6 +3726,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -3789,6 +3801,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", diff --git a/static/oas/Codat-Sync-Payroll.json b/static/oas/Codat-Sync-Payroll.json index e8f4faed3d..88b8ef2da4 100644 --- a/static/oas/Codat-Sync-Payroll.json +++ b/static/oas/Codat-Sync-Payroll.json @@ -15142,6 +15142,18 @@ }, "description": "A collection of user-defined key-value pairs that store custom metadata against the company." }, + "ownerUserIds": { + "type": "array", + "nullable": false, + "readOnly": true, + "description": "The IDs of the users assigned as owners of the company in the Codat Portal. Empty if the company has no owners assigned. Owners are managed in the Codat Portal and can't be set via the API.", + "minItems": 0, + "items": { + "type": "string", + "format": "uuid", + "example": "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + } + }, "referenceParentCompany": { "$ref": "#/components/schemas/Company/definitions/companyReference", "nullable": true, @@ -15205,6 +15217,9 @@ "region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c" }, + "ownerUserIds": [ + "3f1a2b4c-5d6e-7f80-91a2-b3c4d5e6f708" + ], "dataConnections": [ { "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",