Skip to content
Merged
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
1 change: 1 addition & 0 deletions static/oas/Codat-Accounting.json
Original file line number Diff line number Diff line change
Expand Up @@ -147934,6 +147934,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
1 change: 1 addition & 0 deletions static/oas/Codat-Assess.json
Original file line number Diff line number Diff line change
Expand Up @@ -5253,6 +5253,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
4 changes: 4 additions & 0 deletions static/oas/Codat-Bank-Feeds.json
Original file line number Diff line number Diff line change
Expand Up @@ -5752,6 +5752,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand All @@ -5762,6 +5763,7 @@
"description": "A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future."
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -7300,6 +7302,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down Expand Up @@ -7383,6 +7386,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down
1 change: 1 addition & 0 deletions static/oas/Codat-Banking.json
Original file line number Diff line number Diff line change
Expand Up @@ -1928,6 +1928,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
3 changes: 2 additions & 1 deletion static/oas/Codat-Commerce.json
Original file line number Diff line number Diff line change
Expand Up @@ -7425,7 +7425,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/codat-api#/operations/refresh-company-data).\n"
"description": "The *Get product category* endpoint returns a single product category for a given productId.\n\n[Product categories](https://docs.codat.io/commerce-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\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-taxComponents": {
Expand Down Expand Up @@ -9859,6 +9859,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
1 change: 1 addition & 0 deletions static/oas/Codat-Files.json
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
2 changes: 2 additions & 0 deletions static/oas/Codat-Intuit-IDX.json
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down Expand Up @@ -1312,6 +1313,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down
6 changes: 5 additions & 1 deletion static/oas/Codat-Lending.json
Original file line number Diff line number Diff line change
Expand Up @@ -84578,7 +84578,7 @@
"$ref": "#/components/responses/Service-Unavailable"
}
},
"description": "The *Get product* endpoint returns a single product for a given productId.\n\n[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
"description": "The *Get product category* endpoint returns a single product category for a given productId.\n\n[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
}
},
"/companies/{companyId}/connections/{connectionId}/data/commerce-products": {
Expand Down Expand Up @@ -119241,6 +119241,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand All @@ -119251,6 +119252,7 @@
"description": "A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future."
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -122475,6 +122477,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand All @@ -122498,6 +122501,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down
53 changes: 30 additions & 23 deletions static/oas/Codat-Platform.json
Original file line number Diff line number Diff line change
Expand Up @@ -5185,6 +5185,7 @@
"$ref": "#/components/schemas/Branding/definitions/brandingButton"
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -5376,7 +5377,7 @@
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId"
"$ref": "#/components/parameters/companyId/schema"
},
"name": {
"type": "string",
Expand Down Expand Up @@ -5463,7 +5464,7 @@
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId"
"$ref": "#/components/parameters/companyId/schema"
},
"name": {
"$ref": "#/components/schemas/Company/definitions/companyDetails/properties/name"
Expand Down Expand Up @@ -5665,6 +5666,25 @@
"name"
]
},
"CompanySyncSettings": {
"title": "Company sync settings",
"type": "object",
"properties": {
"companyId": {
"$ref": "#/components/parameters/companyId/schema"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncSetting"
}
},
"overridesDefaults": {
"type": "boolean",
"description": "Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings)."
}
}
},
"CompanyUpdateRequest": {
"title": "Update company request",
"x-internal": true,
Expand All @@ -5685,25 +5705,6 @@
}
}
},
"CompanySyncSettings": {
"title": "Company sync settings",
"type": "object",
"properties": {
"companyId": {
"$ref": "#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SyncSetting"
}
},
"overridesDefaults": {
"type": "boolean",
"description": "Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings)."
}
}
},
"CompanyWebhook": {
"title": "Company webhook",
"type": "object",
Expand Down Expand Up @@ -5740,6 +5741,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand Down Expand Up @@ -7064,7 +7066,7 @@
"description": "The type of data being pushed, eg invoices, customers."
},
"companyId": {
"$ref": "#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId"
"$ref": "#/components/parameters/companyId/schema"
},
"pushOperationKey": {
"type": "string",
Expand Down Expand Up @@ -8134,7 +8136,10 @@
"in": "path",
"required": true,
"schema": {
"$ref": "#/paths/~1companies~1%7BcompanyId%7D~1syncSettings/post/requestBody/content/application~1json/schema/allOf/0/properties/companyId"
"type": "string",
"format": "uuid",
"example": "8a210b68-6988-11ed-a1eb-0242ac120002",
"description": "Unique identifier for your SMB in Codat."
},
"description": "Unique identifier for a company."
},
Expand All @@ -8143,6 +8148,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down Expand Up @@ -8236,6 +8242,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down
4 changes: 4 additions & 0 deletions static/oas/Codat-Sync-Commerce-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -15816,6 +15816,7 @@
"$ref": "#/components/schemas/Branding/definitions/brandingButton"
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -17747,6 +17748,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand Down Expand Up @@ -19405,6 +19407,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down Expand Up @@ -19482,6 +19485,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down
3 changes: 3 additions & 0 deletions static/oas/Codat-Sync-Commerce.json
Original file line number Diff line number Diff line change
Expand Up @@ -1530,6 +1530,7 @@
"$ref": "#/components/schemas/Branding/definitions/brandingButton"
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -2437,6 +2438,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand Down Expand Up @@ -3648,6 +3650,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
3 changes: 3 additions & 0 deletions static/oas/Codat-Sync-Expenses-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -2621,6 +2621,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand All @@ -2631,6 +2632,7 @@
"description": "A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future."
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -3875,6 +3877,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
4 changes: 4 additions & 0 deletions static/oas/Codat-Sync-Expenses.json
Original file line number Diff line number Diff line change
Expand Up @@ -3422,6 +3422,7 @@
"schema": {
"type": "string",
"format": "uuid",
"title": "Dataset ID",
"description": "Unique identifier for the dataset that completed its sync."
},
"description": "Unique identifier for the dataset that completed its sync."
Expand Down Expand Up @@ -15957,6 +15958,7 @@
"$ref": "#/components/parameters/connectionId/schema"
},
"integrationId": {
"title": "Integration ID",
"type": "string",
"format": "uuid",
"example": "fd321cb6-7963-4506-b873-e99593a45e30",
Expand All @@ -15967,6 +15969,7 @@
"description": "A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future."
},
"sourceId": {
"title": "Source ID",
"type": "string",
"format": "uuid",
"example": "35b92968-9851-4095-ad60-395c95cbcba4",
Expand Down Expand Up @@ -18733,6 +18736,7 @@
"in": "path",
"required": true,
"schema": {
"title": "Connection ID",
"type": "string",
"format": "uuid",
"example": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
Expand Down
Loading
Loading