Contracting Works Announcements

Updates on model and API changes.

2025-12-29: Switching SystemMessage and IntegrationStatus to use Enum_EntityID instead of TableName

Row state messages are generally handled through SystemMessage and IntegrationStatus. Today, this should only be in use by the CW backend and CW internal integrations, so the update will be deployed once the changes pass internal testing. The purpose of the change is to improve performance and ensure data quality on system messages.

In addition, we are preparing for 3rd party intgrations to be able to use our integration status message system, and we have exposed a cleanup method for use with all integrations (internal and external) to reset old integration status messages. For now, please contact the CW dev team if you wish to use the integration status messages for your integration.

The change will be released to production this week or the first week of 2026.

2025-09-26: Removing Sys_RowState from the write API

The use of Sys_Rowstate has evolved since our first versions of the API, and this field is currently not intended to be set by integrations, or indeed reacted to in any way by integrations. It is used internally in CW to manage showing errors for end-users in the user interface. It can still be read by the GraphQL endpoint, but will no longer be returned after an upsert. Similarly, the field will not be part of webhook events.

The change will be released to production in week 41 (next week).

2025-08-22: Removed unused endpoints

We are removing the GetNotSynced endpoints from most entities in the ClientAPI, as they were not in use by our integrations. We are not aware of any external parties using the endpoints, they will therefore be removed as part of a regular release this month. Please let us know if you rely on the endpoints for anything!

2025-08-15: Stricter write authorization

Upcoming API Change

We are tightening write-authorization checks. After the next release, write operations require explicit permission at the table and column level. Requests that previously succeeded due to permissive checks may now fail.

Impacts of the Change

1. Increased authorization errors for write requests when the authenticated user lacks permission for the target table or any included column.
2. Read operations are unaffected.

Example error:

Write authorization failed for user 'integration-sc@contracting.works' on table 'Storage'

You may also see errors that include a specific column name.

Recommended Action

• Review the permissions/roles of users that perform writes.
• Ensure write permission on every table and column included in your payloads.
• If errors occur, remove unauthorized fields from the payload or request appropriate permissions.
• Contact support and include the failing user, table, and (if applicable) column from the error.

Notes

• Retries will not resolve authorization failures; a permission update or payload change is required.

2024-11-25: Further Model Update to Address

Release Dates

Support for Address.PostalNumber is planned removed:

Environment	Date
Extest	2025-01-05
Prod	2025-01-07

Note: Because we see the PostalNumber field is still in use from time to time, we have postponed this update until january 2025.

Upcoming Model Change:

Address.PostalNumber (string) has been replaced by Address.PostalCode (string). The old field Address.PostalNumber is retained for backwards compatibility, and is currently kept in sync with the new field.

This is temporary, and the old Address.PostalNumber field should no longer be used. Please switch your references from PostalNumber to PostalCode as soon as possible.

This change affects both the Contracting Works GraphQL and REST APIs.

Impacts of the Change:

1. GraphQL API: Queries for postalNumber will result in errors.
2. REST API: Updates to PostalNumber will be ignored, as the field will no longer exist in the model.

Recommended Action:

Update your code to use PostalCode instead of PostalNumber immediately. We would appreciate it if you let us know through Contracting.Works Teams when the change is done.

2024-11-20: Model Update to Address

Release Dates

These are our planned release dates for this model update:

Environment	Date
Extest	2024-11-21
Prod	2024-11-27

Upcoming Model Change:

1. Address.MunicipalityNumber (int) will be replaced by Address.MunicipalityCode (string).

This change affects both the Contracting Works GraphQL and REST APIs.

Impacts of the Change:

1. GraphQL API: Queries for municipalityNumber will result in errors.
2. REST API: Updates to municipalityNumber will be ignored, as the field will no longer exist in the model.

Recommended Action:

Update your code to use municipalityCode instead of municipalityNumber.

Note: The field type is changing from int to string.

We recommend testing your integration thoroughly to ensure compatibility once the change is implemented.