From 79f8ea49179539ed409316790e667c6191424591 Mon Sep 17 00:00:00 2001 From: Peter Simpson <40800258+pj-simpson@users.noreply.github.com> Date: Tue, 3 Feb 2026 14:38:07 +0000 Subject: [PATCH 1/4] Update advanced sync settings documentation Clarified sync settings details and added examples for retrieving and updating sync settings. --- docs/knowledge-base/advanced-sync-settings.md | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/knowledge-base/advanced-sync-settings.md b/docs/knowledge-base/advanced-sync-settings.md index 33c807200..776e40db4 100644 --- a/docs/knowledge-base/advanced-sync-settings.md +++ b/docs/knowledge-base/advanced-sync-settings.md @@ -4,9 +4,9 @@ description: "Review additional settings available to configure the sync of vari displayed_sidebar: "docs" --- -For most of our data types, we retrieve all available history. For financial statement data types (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. You can apply additional sync settings to change these defaults. This helps you limit the amount of data synchronized from the source platform. +For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. You can apply additional sync settings to change these defaults to help you limit the amount of data synchronized from the source platform. We reccomend that you only pull data from a date range relevant to your use-case, as this will greatly reduce the change of your datasets hitting rate limit errors. -These settings only work for data sources that allow delta syncs and are applied to all companies. +Please note that these settings may not work for all data types, on all integrations. Please check with Codat Support if you are unsure ## Sync settings @@ -20,13 +20,24 @@ You can configure the following advanced settings: ## Configuration -Use our [Update all sync settings](/platform-api#/operations/update-profile-syncSettings) endpoint to configure advanced sync settings. These settings are configured per data type and apply to all companies. The endpoint does not provide any error messages if the settings are not supported. +To view your Codat Client's 'global' sync settings you can call the following endpoint: -For example, to configure advanced settings for our `invoices` data type, send the following request to the endpoint: +```http title="Get Sync Settings" +GET /profile/syncSettings +``` + +To override the sync settings at a company level you can make the following request + +```http title="Update Company Sync Settings +POST /companies/:companyId/syncSettings +``` + + +For example, to configure advanced settings for our `invoices` data type, for a given company, send the following request to the endpoint: ```json { - "clientId": "367f7975-267b-439b-90c6-a6040ee680f3", + "clientId": "your-codat-client-id", "settings": [ { "dataType": "invoices", From 62ad8f005e871182250571fa74f1506276a5f7ed Mon Sep 17 00:00:00 2001 From: Peter Simpson <40800258+pj-simpson@users.noreply.github.com> Date: Tue, 3 Feb 2026 14:43:47 +0000 Subject: [PATCH 2/4] Fix spelling and enhance sync settings explanation Corrected spelling and improved clarity regarding data synchronization settings. --- docs/knowledge-base/advanced-sync-settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/knowledge-base/advanced-sync-settings.md b/docs/knowledge-base/advanced-sync-settings.md index 776e40db4..d27a64abb 100644 --- a/docs/knowledge-base/advanced-sync-settings.md +++ b/docs/knowledge-base/advanced-sync-settings.md @@ -4,7 +4,7 @@ description: "Review additional settings available to configure the sync of vari displayed_sidebar: "docs" --- -For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. You can apply additional sync settings to change these defaults to help you limit the amount of data synchronized from the source platform. We reccomend that you only pull data from a date range relevant to your use-case, as this will greatly reduce the change of your datasets hitting rate limit errors. +For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. You can apply additional sync settings to change these defaults to help you limit the amount of data synchronized from the source platform. We reccomend that you only pull data from a date range relevant to your use-case, as this is likely to greatly reduce the chance of your datasets hitting rate limit errors. Please note that these settings may not work for all data types, on all integrations. Please check with Codat Support if you are unsure From fddae3a114f6a1d173fb7b604fc539d4ff5d6cab Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Wed, 11 Feb 2026 13:37:29 +0000 Subject: [PATCH 3/4] review edits --- docs/knowledge-base/advanced-sync-settings.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/knowledge-base/advanced-sync-settings.md b/docs/knowledge-base/advanced-sync-settings.md index d27a64abb..f3964c384 100644 --- a/docs/knowledge-base/advanced-sync-settings.md +++ b/docs/knowledge-base/advanced-sync-settings.md @@ -4,9 +4,15 @@ description: "Review additional settings available to configure the sync of vari displayed_sidebar: "docs" --- -For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. You can apply additional sync settings to change these defaults to help you limit the amount of data synchronized from the source platform. We reccomend that you only pull data from a date range relevant to your use-case, as this is likely to greatly reduce the chance of your datasets hitting rate limit errors. +For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. -Please note that these settings may not work for all data types, on all integrations. Please check with Codat Support if you are unsure +You can apply additional sync settings to change these defaults. This helps you to limit the amount of data synchronized from the source platform. We recommend that you only pull data from a date range relevant to your use case to reduce the chance of encountering rate limit errors. + +:::caution Limited coverage + +Changing advanced sync settings may not work for some data types and integration combinations. Check with Codat Support to confirm coverage. + +::: ## Sync settings @@ -20,20 +26,19 @@ You can configure the following advanced settings: ## Configuration -To view your Codat Client's 'global' sync settings you can call the following endpoint: +Use the [Get sync settings](/platform-api#/operations/get-profile-syncSettings) endpoint to view the current sync settings for your Codat client: -```http title="Get Sync Settings" +```http title="Get sync settings" GET /profile/syncSettings ``` -To override the sync settings at a company level you can make the following request +To override client-level sync settings at a company level, use the [Update company sync settings](/platform-api#/operations/get-profile-syncSettings) endpoint: -```http title="Update Company Sync Settings -POST /companies/:companyId/syncSettings +```http title="Update company sync settings" +POST /companies/{companyId}/syncSettings ``` - -For example, to configure advanced settings for our `invoices` data type, for a given company, send the following request to the endpoint: +For example, to configure company-specific settings for the `invoices` data type, send the following request to the endpoint: ```json { @@ -58,8 +63,8 @@ For example, to configure advanced settings for our `invoices` data type, for a - When using advanced sync settings, settle on a uniform approach across your data types (e.g. all data types request 24 months' data). Some data types share requests, and applying different approaches may cause inconsistency. -- Advanced sync settings can be applied to all data types, but we advise you do not set them for reference data, such as customers, suppliers, chart of accounts, tax rates, tracking categories, and items. +- Advanced sync settings can be applied to all data types, but we advise you don't set them for reference data, such as customers, suppliers, chart of accounts, tax rates, tracking categories, and items. -- Both `syncFromWindow` and `syncFromUtc` use `sourceModifiedDate` to select records for syncing. You can [read more about modified dates](/using-the-api/modified-dates). +- Both `syncFromWindow` and `syncFromUtc` use `sourceModifiedDate` to select records for syncing. You can read more about [modified dates](/using-the-api/modified-dates). - When a sync setting is introduced after a successful data sync, the records fetched prior to the new sync setting will be either deleted or updated with a _Void_ or _Archived_ status. From 1d0f6a3bf201831823fdd91e1ab2b1b459eeddcf Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Fri, 13 Feb 2026 15:59:19 +0000 Subject: [PATCH 4/4] addressing comments --- docs/knowledge-base/advanced-sync-settings.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/knowledge-base/advanced-sync-settings.md b/docs/knowledge-base/advanced-sync-settings.md index f3964c384..8aecba49a 100644 --- a/docs/knowledge-base/advanced-sync-settings.md +++ b/docs/knowledge-base/advanced-sync-settings.md @@ -26,13 +26,9 @@ You can configure the following advanced settings: ## Configuration -Use the [Get sync settings](/platform-api#/operations/get-profile-syncSettings) endpoint to view the current sync settings for your Codat client: +Use the [Get sync settings](/platform-api#/operations/get-profile-syncSettings) endpoint to view the current global sync settings for your Codat client or the [Get company sync settings](/platform-api#/operations/get-company-syncSettings) endpoint for company-specific sync settings. -```http title="Get sync settings" -GET /profile/syncSettings -``` - -To override client-level sync settings at a company level, use the [Update company sync settings](/platform-api#/operations/get-profile-syncSettings) endpoint: +To override client-level sync settings at a company level, use the [Set company sync settings](/platform-api#/operations/set-company-syncSettings) endpoint: ```http title="Update company sync settings" POST /companies/{companyId}/syncSettings @@ -42,7 +38,7 @@ For example, to configure company-specific settings for the `invoices` data type ```json { - "clientId": "your-codat-client-id", + "companyId": "your-codat-company-id", "settings": [ { "dataType": "invoices", @@ -51,7 +47,7 @@ For example, to configure company-specific settings for the `invoices` data type "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, - "monthsToSync": 0, + "monthsToSync": 24, "isLocked": true } ], @@ -65,6 +61,6 @@ For example, to configure company-specific settings for the `invoices` data type - Advanced sync settings can be applied to all data types, but we advise you don't set them for reference data, such as customers, suppliers, chart of accounts, tax rates, tracking categories, and items. -- Both `syncFromWindow` and `syncFromUtc` use `sourceModifiedDate` to select records for syncing. You can read more about [modified dates](/using-the-api/modified-dates). +- Both `syncFromWindow` and `syncFromUtc` use `sourceModifiedDate` to select records for syncing. You can read more about [modified dates at Codat](/using-the-api/modified-dates). - When a sync setting is introduced after a successful data sync, the records fetched prior to the new sync setting will be either deleted or updated with a _Void_ or _Archived_ status.