diff --git a/static/oas/Codat-Accounting.json b/static/oas/Codat-Accounting.json
index 80615a966..b7d49b295 100644
--- a/static/oas/Codat-Accounting.json
+++ b/static/oas/Codat-Accounting.json
@@ -144011,8 +144011,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -148259,9 +148259,12 @@
"required": true,
"schema": {
"type": "string",
- "examples": {
- "$ref": "#/components/parameters/itemId/schema/examples"
- }
+ "examples": [
+ "13d946f0-c5d5-42bc-b092-97ece17923ab",
+ "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+ 7110701885,
+ "EILBDVJVNUAGVKRQ"
+ ]
},
"description": "Unique identifier for a credit note."
},
@@ -148286,9 +148289,12 @@
"required": true,
"schema": {
"type": "string",
- "examples": {
- "$ref": "#/components/parameters/itemId/schema/examples"
- }
+ "examples": [
+ "13d946f0-c5d5-42bc-b092-97ece17923ab",
+ "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+ 7110701885,
+ "EILBDVJVNUAGVKRQ"
+ ]
},
"description": "Unique identifier for an item receipt."
},
@@ -148328,9 +148334,12 @@
"required": true,
"schema": {
"type": "string",
- "examples": {
- "$ref": "#/components/parameters/itemId/schema/examples"
- }
+ "examples": [
+ "13d946f0-c5d5-42bc-b092-97ece17923ab",
+ "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+ 7110701885,
+ "EILBDVJVNUAGVKRQ"
+ ]
},
"description": "Unique identifier for a purchase order."
},
@@ -148340,9 +148349,12 @@
"required": true,
"schema": {
"type": "string",
- "examples": {
- "$ref": "#/components/parameters/itemId/schema/examples"
- }
+ "examples": [
+ "13d946f0-c5d5-42bc-b092-97ece17923ab",
+ "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+ 7110701885,
+ "EILBDVJVNUAGVKRQ"
+ ]
},
"description": "Unique identifier for a sales order."
},
diff --git a/static/oas/Codat-Assess.json b/static/oas/Codat-Assess.json
index 1d3247566..975d605fc 100644
--- a/static/oas/Codat-Assess.json
+++ b/static/oas/Codat-Assess.json
@@ -4153,8 +4153,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Bank-Feeds.json b/static/oas/Codat-Bank-Feeds.json
index 2799a7768..0b9f42def 100644
--- a/static/oas/Codat-Bank-Feeds.json
+++ b/static/oas/Codat-Bank-Feeds.json
@@ -3547,7 +3547,7 @@
"accountInfo": {
"description": "account description 1",
"nickname": "account 123",
- "accountOpenDate": "2023-05-06T00:00:00.000Z",
+ "accountOpenDate": "2023-05-06",
"availableBalance": 10
},
"modifiedDate": "2024-08-02T00:00:00.000Z"
@@ -4781,7 +4781,7 @@
"accountNumber": "12345678",
"currency": "GBP",
"balance": 99.99,
- "modifiedDate": "2023-01-09T14:14:14.105Z",
+ "modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
}
}
@@ -4831,7 +4831,7 @@
"accountNumber": "12345678",
"currency": "GBP",
"balance": 99.99,
- "modifiedDate": "2023-01-09T14:14:14.105Z",
+ "modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
}
}
@@ -6367,8 +6367,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -7372,12 +7372,12 @@
"accountInfo": {
"description": "account description 1",
"nickname": "account 123",
- "accountOpenDate": "2023-05-06T00:00:00.000Z",
+ "accountOpenDate": "2023-05-06",
"availableBalance": 10
},
"modifiedDate": "2024-08-02T00:00:00.000Z",
"status": "pending",
- "feedStartDate": "2024-05-01T00:00:00.000Z"
+ "feedStartDate": "2024-05-01"
},
{
"id": "acc-002",
@@ -7393,12 +7393,12 @@
"accountInfo": {
"description": "account description 2",
"nickname": "account 1290",
- "accountOpenDate": "2023-05-23T00:00:00.000Z",
+ "accountOpenDate": "2023-05-23",
"availableBalance": 400
},
"modifiedDate": "2024-08-02T00:00:00.000Z",
"status": "pending",
- "feedStartDate": "2024-05-01T00:00:00.000Z"
+ "feedStartDate": "2024-05-01"
}
]
},
diff --git a/static/oas/Codat-Banking.json b/static/oas/Codat-Banking.json
index ce15cf78a..a9cabde32 100644
--- a/static/oas/Codat-Banking.json
+++ b/static/oas/Codat-Banking.json
@@ -1460,8 +1460,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Commerce.json b/static/oas/Codat-Commerce.json
index ee7403b97..415e432bc 100644
--- a/static/oas/Codat-Commerce.json
+++ b/static/oas/Codat-Commerce.json
@@ -7606,9 +7606,12 @@
"required": true,
"schema": {
"type": "string",
- "examples": {
- "$ref": "#/components/schemas/Order/allOf/0/properties/id/examples"
- }
+ "examples": [
+ "13d946f0-c5d5-42bc-b092-97ece17923ab",
+ "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
+ 7110701885,
+ "EILBDVJVNUAGVKRQ"
+ ]
},
"description": "Unique identifier for a tax component."
}
@@ -8076,8 +8079,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Files.json b/static/oas/Codat-Files.json
index 87ed53dd0..922dde410 100644
--- a/static/oas/Codat-Files.json
+++ b/static/oas/Codat-Files.json
@@ -219,8 +219,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Intuit-IDX.json b/static/oas/Codat-Intuit-IDX.json
index 1de6ee244..5b6c0d01b 100644
--- a/static/oas/Codat-Intuit-IDX.json
+++ b/static/oas/Codat-Intuit-IDX.json
@@ -577,8 +577,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Lending.json b/static/oas/Codat-Lending.json
index b32f707a4..e5a76e8ec 100644
--- a/static/oas/Codat-Lending.json
+++ b/static/oas/Codat-Lending.json
@@ -93520,7 +93520,7 @@
"accountInfo": {
"description": "account description 1",
"nickname": "account 123",
- "accountOpenDate": "2023-05-06T00:00:00.000Z",
+ "accountOpenDate": "2023-05-06",
"availableBalance": 10
},
"modifiedDate": "2024-08-02T00:00:00.000Z"
@@ -119852,8 +119852,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -122238,12 +122238,12 @@
"accountInfo": {
"description": "account description 1",
"nickname": "account 123",
- "accountOpenDate": "2023-05-06T00:00:00.000Z",
+ "accountOpenDate": "2023-05-06",
"availableBalance": 10
},
"modifiedDate": "2024-08-02T00:00:00.000Z",
"status": "pending",
- "feedStartDate": "2024-05-01T00:00:00.000Z"
+ "feedStartDate": "2024-05-01"
},
{
"id": "acc-002",
@@ -122259,12 +122259,12 @@
"accountInfo": {
"description": "account description 2",
"nickname": "account 1290",
- "accountOpenDate": "2023-05-23T00:00:00.000Z",
+ "accountOpenDate": "2023-05-23",
"availableBalance": 400
},
"modifiedDate": "2024-08-02T00:00:00.000Z",
"status": "pending",
- "feedStartDate": "2024-05-01T00:00:00.000Z"
+ "feedStartDate": "2024-05-01"
}
]
},
diff --git a/static/oas/Codat-Platform.json b/static/oas/Codat-Platform.json
index 677cd5d56..a5175c389 100644
--- a/static/oas/Codat-Platform.json
+++ b/static/oas/Codat-Platform.json
@@ -940,10 +940,41 @@
"summary": "Refresh product data",
"operationId": "refresh-product-data",
"x-speakeasy-name-override": "refresh-product-data",
- "description": "Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.\n\n### Tips and traps\n\n- This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.\n- If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.\n- If a company has multiple custom products enabled, you can refresh data for each product individually.",
+ "description": "Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.\n\n### Tips and traps\n\n- This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.\n- If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.\n- If a company has multiple custom products enabled, you can refresh data for each product individually.\n - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product's scheduled refresh is triggered as usual.\n - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.",
"tags": [
"Companies"
],
+ "requestBody": {
+ "required": false,
+ "description": "Optionally specify one or more data types to refresh for the given custom product. If omitted, the product's scheduled refresh is triggered as usual. When provided, each data type must be valid for the specified product.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "dataTypes": {
+ "type": "array",
+ "description": "One or more data types to refresh for the product.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "examples": {
+ "Filter specific data types": {
+ "value": {
+ "dataTypes": [
+ "invoices",
+ "payments"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
"responses": {
"202": {
"description": "OK"
@@ -4136,8 +4167,8 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "PendingAuth",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
}
@@ -4190,8 +4221,8 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
}
@@ -4244,14 +4275,14 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "PendingAuth",
- "created": "2022-10-27T09:53:29.000Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking",
"dataConnectionErrors": [
{
"statusCode": "403",
"statusText": "User cancelled linking",
"errorMessage": "User cancelled",
- "erroredOnUtc": "2022-10-27T09:53:29.000Z",
+ "erroredOnUtc": "2022-10-27T09:53:29Z",
"status": "Active"
}
]
@@ -4306,8 +4337,8 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Unlinked",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
}
@@ -4339,15 +4370,15 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Deauthorized",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking",
"dataConnectionErrors": [
{
"statusCode": "401",
"statusText": "The integration de-authorized access to the connection.",
"errorMessage": "The integration de-authorized access to the connection.",
- "erroredOnUtc": "2022-12-27T09:53:29.000Z",
+ "erroredOnUtc": "2022-12-27T09:53:29Z",
"status": "Active"
}
]
@@ -4402,8 +4433,8 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
}
@@ -4456,8 +4487,8 @@
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
- "lastSync": "2022-10-27T10:22:43.646Z",
- "created": "2022-10-27T09:53:29.000Z",
+ "lastSync": "2022-10-27T10:22:43.6464237Z",
+ "created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
}
@@ -4658,7 +4689,7 @@
"value": {
"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
"eventType": "{dataType}.write.successful",
- "generatedDate": "2023-05-03T10:00:23.000Z",
+ "generatedDate": "2023-05-03T10:00:23Z",
"payload": {
"id": "a9367074-b5c3-42c4-9be4-be129f43577e",
"type": "Create",
@@ -4668,8 +4699,8 @@
"description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
},
"connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5",
- "requestedOnDate": "2023-05-03T10:00:00.000Z",
- "completedOnDate": "2023-05-03T10:00:23.000Z",
+ "requestedOnDate": "2023-05-03T10:00:00Z",
+ "completedOnDate": "2023-05-03T10:00:23Z",
"status": "Success",
"record": {
"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"
@@ -4681,7 +4712,7 @@
"value": {
"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
"eventType": "{dataType}.write.successful",
- "generatedDate": "2023-05-03T10:00:23.000Z",
+ "generatedDate": "2023-05-03T10:00:23Z",
"payload": {
"id": "a9367074-b5c3-42c4-9be4-be129f43577e",
"type": "UploadAttachment",
@@ -4691,8 +4722,8 @@
"description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
},
"connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5",
- "requestedOnDate": "2023-05-03T10:00:00.000Z",
- "completedOnDate": "2023-05-03T10:00:23.000Z",
+ "requestedOnDate": "2023-05-03T10:00:00Z",
+ "completedOnDate": "2023-05-03T10:00:23Z",
"status": "Success",
"record": {
"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"
@@ -4726,7 +4757,7 @@
"value": {
"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
"eventType": "{dataType}.write.unsuccessful",
- "generatedDate": "2023-05-03T10:00:23.000Z",
+ "generatedDate": "2023-05-03T10:00:23Z",
"payload": {
"id": "a9367074-b5c3-42c4-9be4-be129f43577e",
"type": "Update",
@@ -4736,8 +4767,8 @@
"description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
},
"connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5",
- "requestedOnDate": "2023-05-03T10:00:00.000Z",
- "completedOnDate": "2023-05-03T10:00:23.000Z",
+ "requestedOnDate": "2023-05-03T10:00:00Z",
+ "completedOnDate": "2023-05-03T10:00:23Z",
"status": "Failed"
}
}
@@ -4746,7 +4777,7 @@
"value": {
"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
"eventType": "{dataType}.write.unsuccessful",
- "generatedDate": "2023-05-03T10:00:23.000Z",
+ "generatedDate": "2023-05-03T10:00:23Z",
"payload": {
"id": "a9367074-b5c3-42c4-9be4-be129f43577e",
"type": "Delete",
@@ -4756,8 +4787,8 @@
"description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
},
"connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5",
- "requestedOnDate": "2023-05-03T10:00:00.000Z",
- "completedOnDate": "2023-05-03T10:00:23.000Z",
+ "requestedOnDate": "2023-05-03T10:00:00Z",
+ "completedOnDate": "2023-05-03T10:00:23Z",
"status": "TimedOut"
}
}
@@ -4766,7 +4797,7 @@
"value": {
"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
"eventType": "{dataType}.write.unsuccessful",
- "generatedDate": "2023-05-03T10:00:23.000Z",
+ "generatedDate": "2023-05-03T10:00:23Z",
"payload": {
"id": "a9367074-b5c3-42c4-9be4-be129f43577e",
"type": "UploadAttachment",
@@ -4776,8 +4807,8 @@
"description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"
},
"connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5",
- "requestedOnDate": "2023-05-03T10:00:00.000Z",
- "completedOnDate": "2023-05-03T10:00:23.000Z",
+ "requestedOnDate": "2023-05-03T10:00:00Z",
+ "completedOnDate": "2023-05-03T10:00:23Z",
"status": "TimedOut",
"record": {
"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"
@@ -6114,8 +6145,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -7154,6 +7185,7 @@
},
"dataTypes": {
"type": "array",
+ "description": "Contains all data types configured for the product or a subset of data types defined in the manual refresh call.",
"items": {
"type": "object",
"title": "Summary of data type reads",
diff --git a/static/oas/Codat-Spend-Insights.json b/static/oas/Codat-Spend-Insights.json
index fafb6c99f..9dd095b50 100644
--- a/static/oas/Codat-Spend-Insights.json
+++ b/static/oas/Codat-Spend-Insights.json
@@ -578,8 +578,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Sync-Commerce-v1.json b/static/oas/Codat-Sync-Commerce-v1.json
index 35f4fa5f9..76724d09c 100644
--- a/static/oas/Codat-Sync-Commerce-v1.json
+++ b/static/oas/Codat-Sync-Commerce-v1.json
@@ -18036,8 +18036,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Sync-Commerce.json b/static/oas/Codat-Sync-Commerce.json
index 8af09c75f..f0f59c445 100644
--- a/static/oas/Codat-Sync-Commerce.json
+++ b/static/oas/Codat-Sync-Commerce.json
@@ -2458,8 +2458,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -3177,11 +3177,9 @@
}
},
"properties": {
- "companyId": [
- {
- "$ref": "#/components/parameters/companyId"
- }
- ],
+ "companyId": {
+ "$ref": "#/components/parameters/companyId/schema"
+ },
"commerceSyncId": {
"type": "string",
"format": "guid",
diff --git a/static/oas/Codat-Sync-Expenses-v1.json b/static/oas/Codat-Sync-Expenses-v1.json
index 6846a1702..c1e8136f1 100644
--- a/static/oas/Codat-Sync-Expenses-v1.json
+++ b/static/oas/Codat-Sync-Expenses-v1.json
@@ -912,9 +912,11 @@
"type": "string",
"description": "Unique identifier for the updated sync."
}
- },
- "examples": {
- "Example 1": {
+ }
+ },
+ "examples": {
+ "Example 1": {
+ "value": {
"syncId": "1ad0695c-4566-4715-918c-adbb03eac81e"
}
}
@@ -2655,8 +2657,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
@@ -3712,24 +3714,10 @@
"UpdateExpenseRequest": {
"title": "Updating Expense Transaction Request",
"type": "object",
- "examples": {
- "Payment": {
- "value": {
- "type": "Payment",
- "issueDate": "2023-05-22T00:00:00+00:00",
- "currency": "GBP",
- "currencyRate": 1.18,
- "notes": "New notes",
- "contactRef": {
- "id": "f5244103-5223-4b0a-857f-50566ac86c11",
- "type": "Supplier"
- },
- "merchantName": "My Merchant"
- }
- }
- },
"properties": {
- "type": "#/definitions/expenseType",
+ "type": {
+ "$ref": "#/components/schemas/UpdateExpenseRequest/definitions/expenseType"
+ },
"issueDate": {
"type": "string",
"description": "Date the transaction was recorded.",
diff --git a/static/oas/Codat-Sync-Expenses.json b/static/oas/Codat-Sync-Expenses.json
index f3edf5e0c..caaded538 100644
--- a/static/oas/Codat-Sync-Expenses.json
+++ b/static/oas/Codat-Sync-Expenses.json
@@ -2395,7 +2395,7 @@
"post": {
"summary": "Create reimbursable expense transaction",
"operationId": "create-reimbursable-expense-transaction",
- "description": "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Zoho Books | Yes |",
+ "description": "Use the *Create reimbursable expense* endpoint to submit an employee expense claim in the accounting platform for a given company's connection.\r\n\r\n[Reimbursable expense requests](https://docs.codat.io/sync-for-expenses-api#/schemas/ReimbursableExpenseTransactionRequest) are reflected in the accounting software in the form of **Bills** against an employee (who exists as a supplier in the accounting platform).\r\n\r\n### Supported Integrations\r\n| Integration | Supported |\r\n|-----------------------|-----------|\r\n| FreeAgent | Yes |\r\n| QuickBooks Desktop | Yes |\r\n| QuickBooks Online | Yes |\r\n| Oracle NetSuite | Yes |\r\n| Zoho Books | Yes |\r\n| Sage Intacct | Yes |",
"tags": [
"Reimbursements"
],
@@ -18338,8 +18338,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
}
@@ -18519,12 +18519,8 @@
"properties": {
"syncId": {
"type": "string",
- "description": "Unique identifier for the update expense sync."
- }
- },
- "examples": {
- "Example 1": {
- "syncId": "1ad0695c-4566-4715-918c-adbb03eac81e"
+ "description": "Unique identifier for the update expense sync.",
+ "example": "1ad0695c-4566-4715-918c-adbb03eac81e"
}
}
},
diff --git a/static/oas/Codat-Sync-Payables-v1.json b/static/oas/Codat-Sync-Payables-v1.json
index 7c9219068..663810520 100644
--- a/static/oas/Codat-Sync-Payables-v1.json
+++ b/static/oas/Codat-Sync-Payables-v1.json
@@ -46439,8 +46439,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Sync-Payables.json b/static/oas/Codat-Sync-Payables.json
index 20009a9c2..fd32a2a3a 100644
--- a/static/oas/Codat-Sync-Payables.json
+++ b/static/oas/Codat-Sync-Payables.json
@@ -1884,7 +1884,7 @@
"$ref": "#/components/schemas/Attachment/definitions/attachments"
},
"examples": {
- "Attachments": {
+ "Success": {
"value": [
{
"id": "422f093f-e556-4bf3-91c0-93af70c3e850",
@@ -2388,7 +2388,7 @@
"currency": "GBP",
"accountType": "Debit",
"status": "Active",
- "sourceModifiedDate": "2024-02-22T14:46:43.990Z"
+ "sourceModifiedDate": "2024-02-22T14:46:43.99Z"
}
}
}
@@ -2577,7 +2577,7 @@
"contentType": {
"type": "string",
"nullable": true,
- "description": "File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.\n\nSupported file types vary per platform. "
+ "description": "File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.\n\nSupported file types vary per platform."
},
"dateCreated": {
"$ref": "#/components/schemas/Connection/properties/created"
@@ -2608,9 +2608,6 @@
"definitions": {
"attachments": {
"title": "Attachments",
- "description": {
- "$ref": "#/components/schemas/Attachment/description"
- },
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
@@ -3030,7 +3027,7 @@
"type": "string",
"description": "The datetime in UTC of when the webhook event was produced by Codat.",
"examples": [
- "2022-10-23T11:03:35.000Z"
+ "2022-10-23T11:03:35Z"
]
},
"payload": {
@@ -3620,8 +3617,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},
diff --git a/static/oas/Codat-Sync-Payroll.json b/static/oas/Codat-Sync-Payroll.json
index a45616fa5..0c2cf2913 100644
--- a/static/oas/Codat-Sync-Payroll.json
+++ b/static/oas/Codat-Sync-Payroll.json
@@ -15465,8 +15465,8 @@
"title": "Date time",
"type": "string",
"examples": [
- "2022-10-23T00:00:00.000Z",
- "2022-10-23T00:00:00.000Z"
+ "2022-10-23T00:00:00Z",
+ "2022-10-23"
],
"description": "In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones. \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
},