Update advanced sync settings documentation #1756
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarified sync settings details and added examples for retrieving and updating sync settings.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Corrected spelling and improved clarity regarding data synchronization settings.
| --- | ||
|
|
||
| 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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| - 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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be applied').
pzaichkina
reviewed
Feb 11, 2026
| 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: |
Collaborator
There was a problem hiding this comment.
@pj-simpson as discussed, URL needs to be amended once the endpoint is back in the OAS
pzaichkina
reviewed
Feb 11, 2026
| ``` | ||
|
|
||
| For example, to configure advanced settings for our `invoices` data type, 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: |
Collaborator
There was a problem hiding this comment.
@pj-simpson the example code needs to change to be company-specific
|
Link check results for preview deployment (https://codat-docs-git-advanced-sync-settings-codat.vercel.app): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In support we are often sending the 'Advanced Sync Settings' article, however it explicitly referenced 'Delta/ Full syncs' which are an implementation detail that we do not wish t expose to our consumers going forward.
The article also contained a link to dead API docs.
When necessary, when advising our clients about Advanced Sync Settings, we want to be able to provide them with a 'one shot' article which they can read and go away with clear next steps in mind.
Have added
httpexamples to the markdown code.