Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions static/oas/Codat-Bank-Feeds.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Lending.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
166 changes: 166 additions & 0 deletions static/oas/Codat-Platform.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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,
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Sync-Commerce-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Sync-Commerce.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Sync-Expenses-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Sync-Expenses.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
15 changes: 15 additions & 0 deletions static/oas/Codat-Sync-Payables-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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",
Expand Down
Loading
Loading