2024-01-10: Deprecation of `data` object returned when creating or updating records
On January 10, 2024, we will deprecate the data field that is currently returned in the response and /push endpoints when creating or updating entities.
Written data will also no longer be stored within Codat, and a refresh of data will be required for Codat to reflect new or updated records.
You can see a before and after examples of responses below:
1 | { | 1 | { | ||
2 | "changes": [ | 2 | "changes": [ | ||
3 | { | 3 | { | ||
4 | "type": "Unknown", | 4 | "type": "Unknown", | ||
5 | "recordRef": { | 5 | "recordRef": { | ||
6 | "id": "string", | 6 | "id": "string", | ||
7 | "dataType": "string" | 7 | "dataType": "string" | ||
8 | }, | 8 | }, | ||
9 | "attachmentId": "string" | 9 | "attachmentId": "string" | ||
10 | } | 10 | } | ||
11 | ], | 11 | ], | ||
12 | - | "data": { | |||
13 | - | // object created or updated | |||
14 | - | ... | |||
15 | - | }, | |||
16 | "dataType": "string", | 12 | "dataType": "string", | ||
17 | "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | 13 | "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
18 | "pushOperationKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | 14 | "pushOperationKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
19 | "dataConnectionKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | 15 | "dataConnectionKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6", | ||
20 | "requestedOnUtc": "2023-06-26T07:48:36.066Z", | 16 | "requestedOnUtc": "2023-06-26T07:48:36.066Z", | ||
21 | "completedOnUtc": "2023-06-26T07:48:36.066Z", | 17 | "completedOnUtc": "2023-06-26T07:48:36.066Z", | ||
22 | "timeoutInMinutes": 0, | 18 | "timeoutInMinutes": 0, | ||
23 | "status": "string", | 19 | "status": "string", | ||
24 | "errorMessage": "string", | 20 | "errorMessage": "string", | ||
25 | "validation": { | 21 | "validation": { | ||
26 | "errors": [ | 22 | "errors": [ | ||
27 | { | 23 | { | ||
28 | "itemId": "string", | 24 | "itemId": "string", | ||
29 | "message": "string", | 25 | "message": "string", | ||
30 | "validatorName": "string" | 26 | "validatorName": "string" | ||
31 | } | 27 | } | ||
32 | ], | 28 | ], | ||
33 | "warnings": [ | 29 | "warnings": [ | ||
34 | { | 30 | { | ||
35 | "itemId": "string", | 31 | "itemId": "string", | ||
36 | "message": "string", | 32 | "message": "string", | ||
37 | "validatorName": "string" | 33 | "validatorName": "string" | ||
38 | } | 34 | } | ||
39 | ] | 35 | ] | ||
40 | }, | 36 | }, | ||
41 | "statusCode": 0 | 37 | "statusCode": 0 | ||
42 | } | 38 | } |
Action required
If you currently make use of any properties in the data object of the write operation response, you will need to use the changes.recordRef object instead.
- Use
changes.recordRefto retrieve the recorddatatypeandid. - Initiate a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. for the given data type or wait until the next scheduled syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule..
- After the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. is complete, make a
GETcall to the relevant endpoint to retrieve the full record if needed.
Expected impact if no action is taken
As of January 10, 2024, you will no longer be able to use the data object on the write operation responses or /push endpoints.
You will not be able to use the returned id to access the records you have written within Codat until you've (refreshed that companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.'s data](/using-the-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./queueing-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.) for the given data type.