Completed 2023-04-11: Changes to handling of deleted data
On April 11, 2023, Codat will change the way accounting data deleted by companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. users within their accounting software is handled.
To ensure better consistency between successive data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule., records deleted by a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. between two data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. will now continue to be stored by Codat. A flag will be set to indicate that the data has been deleted in the underlying Accounting software.
This was previously scheduled for 2023/04/10. This has been pushed back a day as this fell on a public holiday in the UK.
Action required
From April 11, 2023, the Codat APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. will return data that was not previously returned. Therefore, if data pertaining to records deleted between two successive data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. is not required for your use case, you will need to filter out deleted records. This can be achieved by querying Codat's APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. with:
?query=metadata.isDeleted!=true
Expected impact if no action is taken
If no action is taken, APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. calls to retrieve companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. accounting data will include records deleted by companies.
Additional information
Accounting data deleted by a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. between two data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. can be identified with the isDeleted flag (boolean), present on the metadata object that is now returned on all Accounting data endpoints.
"metadata": {
"isDeleted": true // false by default; true only where previously synced data is deleted by a company
}
Note 1: This change applies to only Accounting data deleted by a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. between successive Codat data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.. Records that were both created and deleted by a companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. before the first Codat syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. will never be included in Codat data.
Note 2: For datatypes with a Status property in Codat's data model, Codat does not currently delete data, but instead updates the status property. The metadata.isDeleted flag will be set to True after April 11, 2023.
Note 3: For pre-existing data, the isDeleted flag may be set to null; this will be set to true/false on future data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule..
You can get ahead of this change by enabling it now in the Portal. Learn how to do that here, or read our change policy.