deprecated

[Upcoming: 2023-04-10] Changes to handling of deleted data

On April 10, 2023, Codat will change the way Accounting data deleted by Company users within their accounting package is handled. To ensure better consistency between successive data syncs, records deleted by a Company between two data syncs 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 package.

Action required

From April 10, 2023, the Codat API will return data that was not previously returned. Therefore, if data pertaining to records deleted between two successive data syncs is not required for your use case, you will need to filter out deleted records. This can be achieved by querying Codat's API with:
?query=metadata.isDeleted=true

Expected impact if no action is taken

If no action is taken, API calls to retrieve Company Accounting data will include records deleted by Companies.

Additional information

Accounting data deleted by a Company between two data syncs 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 Company between successive Codat data syncs. Records that were both created and deleted by a Company before the first Codat sync 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 10, 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 syncs.

๐Ÿ“˜

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 here.