API release notes September 2026
This changelog lists all API changes released in September 2026, grouped by product area. Each section can be expanded to view breaking changes, new endpoints, and other updates for that area. Review the Breaking Changes entries carefully, as these may require updates to your integration.
Documents
Documents Core
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| GET/documents/core/transaction/v1/spaces/[spaceId]/documents | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/documents:count | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/files | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Modified the strict schema constraint value at examples/Create Child File Request in the request payload. | Payloads violating the updated value validation rule will be rejected. | Update client-side schema definitions to respect the new value constraint. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Modified the strict schema constraint value at examples/Create File Request in the request payload. | Payloads violating the updated value validation rule will be rejected. | Update client-side schema definitions to respect the new value constraint. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Modified the strict schema constraint value at examples/Child File Result in the response payload under status 201. | Payloads violating the updated value validation rule will be rejected. | Update client-side schema definitions to respect the new value constraint. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Modified the strict schema constraint value at examples/Top-Level File Result in the response payload under status 201. | Payloads violating the updated value validation rule will be rejected. | Update client-side schema definitions to respect the new value constraint. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents:count | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/[folder]/content | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/[folder]/directories/[directoryId]/content | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| GET/documents/core/transaction/v1/spaces/[spaceId]/documents | Updated the schema metadata description at documents/category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/documents | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/documents | Updated the schema metadata description at category in the response payload under status 201. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/documents/[documentId] | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/documents/[documentId]/files | Added the new optional response property under status 200 files/md5Hash. | Supply or consume files/md5Hash for enriched functionality. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/documents/[documentId]:jsonpatch | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/files | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/files | Added the new optional response property under status 200 files/md5Hash. | Supply or consume files/md5Hash for enriched functionality. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Added the new optional request property md5Hash. | Supply or consume md5Hash for enriched functionality. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/files | Added the new optional response property under status 201 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/files/[fileId] | Added the new optional response property under status 200 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/files/[fileId] | Updated the schema metadata example in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/files/[fileId] | Added the new optional response property under status 200 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/files/[fileId] | Updated the schema metadata example in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents | Updated the schema metadata description at documents/category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| POST/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents | Updated the schema metadata description at category in the response payload under status 201. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents/[documentId] | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v1/spaces/[spaceId]/[folder]/documents/[documentId]:jsonpatch | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents | Added the new optional response property under status 200 documents/externalKey. | Supply or consume documents/externalKey for enriched functionality. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents | Updated the schema metadata description at documents/category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents | Added the new optional response property under status 201 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents | Updated the schema metadata description at category in the response payload under status 201. | Provides clearer guidance when using this property. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| GET/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:assignConnection | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:assignConnection | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:jsonpatch | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:jsonpatch | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:move | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:move | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:unassignConnection | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/documents/core/transaction/v2/spaces/[spaceId]/documents/[documentId]:unassignConnection | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/documents/core/v1/files:convert | Added the new optional request property input/metadata/customer/globalIdentifiers/global:company_number. | Supply or consume input/metadata/customer/globalIdentifiers/global:company_number for enriched functionality. |
| POST/documents/core/v1/files:convert | Added the new optional request property input/metadata/supplier/globalIdentifiers/global:company_number. | Supply or consume input/metadata/supplier/globalIdentifiers/global:company_number for enriched functionality. |
| POST/documents/core/v1/spaces/files:process | Added the new optional request property files/md5Hash. | Supply or consume files/md5Hash for enriched functionality. |
Documents Network
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| GET/documents/network/transaction/v1/spaces/[spaceId]/documents/[documentId]/relations | Added the new TEMPLATE enum value to the documentRelations/children/document/category response property under status 200. | Strict parsers will fail to deserialize when returning records with the TEMPLATE type. | Update models to accept and handle the TEMPLATE type. |
| GET/documents/network/transaction/v1/spaces/[spaceId]/documents/[documentId]/relations | Added the new TEMPLATE enum value to the documentRelations/parents/document/category response property under status 200. | Strict parsers will fail to deserialize when returning records with the TEMPLATE type. | Update models to accept and handle the TEMPLATE type. |
Documents Payment
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| POST/documents/payment/transaction/v1/spaces/[spaceId]/documents:paydetails | Added the new TEMPLATE enum value to the documents/category response property under status 200. | Strict parsers will fail to deserialize when returning records with the TEMPLATE type. | Update models to accept and handle the TEMPLATE type. |
| POST/documents/payment/transaction/v2/spaces/[spaceId]/documents:paydetails | Added the new TEMPLATE enum value to the documents/category response property under status 200. | Strict parsers will fail to deserialize when returning records with the TEMPLATE type. | Update models to accept and handle the TEMPLATE type. |
NewNew Endpoints
| Endpoint | Description |
|---|---|
| POST/documents/payment/business/v3/spaces/[spaceId]/payments/documents:execute | Adds a new operation for this resource. |
| POST/documents/payment/business/v3/spaces/[spaceId]/payments/documents:validate | Adds a new operation for this resource. |
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| POST/documents/payment/business/v1/spaces/[spaceId]/payments/documents:execute | Modified specification properties: operationID. | No developer action required; specification-only change. |
| POST/documents/payment/business/v2/spaces/[spaceId]/payments/documents:execute | Modified specification properties: operationID. | No developer action required; specification-only change. |
| POST/documents/payment/business/v2/spaces/[spaceId]/payments/documents:validate | Modified specification properties: operationID. | No developer action required; specification-only change. |
Network
Network Core
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| GET/network/core/transaction/v2/spaces/[spaceId]/connections | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/network/core/transaction/v3/spaces/[spaceId]/connections | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| GET/network/core/transaction/v2/spaces/[spaceId]/connections | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/network/core/transaction/v2/spaces/[spaceId]/connections | Added the new optional response property under status 200 connections/externalKey. | Supply or consume connections/externalKey for enriched functionality. |
| POST/network/core/transaction/v2/spaces/[spaceId]/connections | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/network/core/transaction/v2/spaces/[spaceId]/connections | Added the new optional response property under status 201 externalKey. | Supply or consume externalKey for enriched functionality. |
| GET/network/core/transaction/v2/spaces/[spaceId]/connections/[connectionId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/network/core/transaction/v2/spaces/[spaceId]/connections/[connectionId] | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/network/core/transaction/v2/spaces/[spaceId]/connections/[connectionId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/network/core/transaction/v2/spaces/[spaceId]/connections/[connectionId]:jsonpatch | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| GET/network/core/transaction/v3/spaces/[spaceId]/connections | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/network/core/transaction/v3/spaces/[spaceId]/connections | Added the new optional response property under status 200 connections/externalKey. | Supply or consume connections/externalKey for enriched functionality. |
| POST/network/core/transaction/v3/spaces/[spaceId]/connections | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/network/core/transaction/v3/spaces/[spaceId]/connections | Added the new optional response property under status 201 externalKey. | Supply or consume externalKey for enriched functionality. |
| GET/network/core/transaction/v3/spaces/[spaceId]/connections/[connectionId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/network/core/transaction/v3/spaces/[spaceId]/connections/[connectionId] | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/network/core/transaction/v3/spaces/[spaceId]/connections/[connectionId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
Payments
Payments Integration
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| GET/payments/integration/v1/spaces/[spaceId]/payments/collect/consents/[consentId] | API path removed without deprecation. | Invocations targeting this endpoint will fail immediately with an HTTP 404 Not Found routing error. | Re-route client integrations to current supported paths. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/[paymentId]:cancel | API path removed without deprecation. | Invocations targeting this endpoint will fail immediately with an HTTP 404 Not Found routing error. | Re-route client integrations to current supported paths. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/collect/consents | API path removed without deprecation. | Invocations targeting this endpoint will fail immediately with an HTTP 404 Not Found routing error. | Re-route client integrations to current supported paths. |
| GET/payments/integration/v1/spaces/[spaceId]/payments | The GET method was removed from this endpoint. | Invocations using this method will fail with an HTTP 405 Method Not Allowed. | Migrate client calls to alternative methods or endpoints. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Removed the changeNotificationUrl request property. | Client payloads including the changeNotificationUrl field will be rejected. | Remove the changeNotificationUrl parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint min at payments/amount/value in the request payload. | Payloads violating the updated min validation rule will be rejected. | Update client-side schema definitions to respect the new min constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint max at payments/amount/value in the request payload. | Payloads violating the updated max validation rule will be rejected. | Update client-side schema definitions to respect the new max constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Removed the payments/creditor/address request property. | Client payloads including the payments/creditor/address field will be rejected. | Remove the payments/creditor/address parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Removed the payments/creditor/verificationId request property. | Client payloads including the payments/creditor/verificationId field will be rejected. | Remove the payments/creditor/verificationId parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Removed the payments/creditor/account/parent request property. | Client payloads including the payments/creditor/account/parent field will be rejected. | Remove the payments/creditor/account/parent parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint minLength at payments/creditor/account/bank/identifier in the request payload. | Payloads violating the updated minLength validation rule will be rejected. | Update client-side schema definitions to respect the new minLength constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Removed the THIRD_PARTY enum value from the payments/creditor/account/bank/scheme request property. | Submitting THIRD_PARTY will result in schema validation failures. | Remove usage of THIRD_PARTY and implement fallback logic. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint minLength at payments/creditor/account/identifier in the request payload. | Payloads violating the updated minLength validation rule will be rejected. | Update client-side schema definitions to respect the new minLength constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint minLength at payments/reference/value in the request payload. | Payloads violating the updated minLength validation rule will be rejected. | Update client-side schema definitions to respect the new minLength constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Modified the strict schema constraint minItems at payments in the request payload. | Payloads violating the updated minItems validation rule will be rejected. | Update client-side schema definitions to respect the new minItems constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Removed the changeNotificationUrl request property. | Client payloads including the changeNotificationUrl field will be rejected. | Remove the changeNotificationUrl parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Modified the strict schema constraint min at payment/amount/value in the request payload. | Payloads violating the updated min validation rule will be rejected. | Update client-side schema definitions to respect the new min constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Modified the strict schema constraint max at payment/amount/value in the request payload. | Payloads violating the updated max validation rule will be rejected. | Update client-side schema definitions to respect the new max constraint. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Removed the payment/creditor/verificationId request property. | Client payloads including the payment/creditor/verificationId field will be rejected. | Remove the payment/creditor/verificationId parameter from request payload models. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Modified the strict schema constraint minLength at payment/reference/value in the request payload. | Payloads violating the updated minLength validation rule will be rejected. | Update client-side schema definitions to respect the new minLength constraint. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the availableOperations response property under status 200. | Client payloads including the availableOperations field will be rejected. | Remove the availableOperations parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the counterParty response property under status 200. | Client payloads including the counterParty field will be rejected. | Remove the counterParty parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the createdAt response property under status 200. | Client payloads including the createdAt field will be rejected. | Remove the createdAt parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the originatingAccount response property under status 200. | Client payloads including the originatingAccount field will be rejected. | Remove the originatingAccount parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the endToEndId response property under status 200. | Client payloads including the endToEndId field will be rejected. | Remove the endToEndId parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the reference response property under status 200. | Client payloads including the reference field will be rejected. | Remove the reference parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Removed the type response property under status 200. | Client payloads including the type field will be rejected. | Remove the type parameter from response payload under status 200 models. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Modified the strict schema constraint min at amount/value in the response payload under status 200. | Payloads violating the updated min validation rule will be rejected. | Update client-side schema definitions to respect the new min constraint. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Modified the strict schema constraint max at amount/value in the response payload under status 200. | Payloads violating the updated max validation rule will be rejected. | Update client-side schema definitions to respect the new max constraint. |
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| POST/payments/integration/v1/spaces/[spaceId]/payments | Updated the schema metadata description at locale in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Updated the schema metadata example at locale in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Updated the schema metadata description at payments/amount/value in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Added the new IBAN enum value to the payments/creditor/account/scheme request property. | You can now use this new enum value in requests. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Added the new BBAN enum value to the payments/creditor/account/scheme request property. | You can now use this new enum value in requests. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Added the new ANB enum value to the payments/creditor/account/scheme request property. | You can now use this new enum value in requests. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Added the new SE_BANKGIRO enum value to the payments/creditor/account/scheme request property. | You can now use this new enum value in requests. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Added the new SE_PLUSGIRO enum value to the payments/creditor/account/scheme request property. | You can now use this new enum value in requests. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Updated the schema metadata description at payments/creditor/account in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments | Updated the schema metadata description at payments/creditor/name in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Updated the schema metadata description at locale in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Updated the schema metadata example at locale in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | Updated the schema metadata description at payment/amount/value in the request payload. | Provides clearer guidance when using this property. |
| POST/payments/integration/v1/spaces/[spaceId]/payments/transfers | The locale property is no longer required in the request payload. | Clients can omit this property. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Updated the schema metadata description at amount/value in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | The availableOperations property is no longer required in the response payload under status 200. | Clients can omit this property. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | The type property is no longer required in the response payload under status 200. | Clients can omit this property. |
| GET/payments/integration/v1/spaces/[spaceId]/payments/[paymentId] | Updated the schema metadata description in the response payload under status 200. | Provides clearer guidance when using this property. |
Payment Accounts
NewNew Endpoints
| Endpoint | Description |
|---|---|
| GET/payments/paymentaccounts/v2/spaces/[spaceId]/paymentAccounts | Adds a new operation for this resource. |
DeprecatedDeprecated Endpoints
| Endpoint | Details | Impact |
|---|---|---|
| GET/payments/paymentaccounts/v1/spaces/[spaceId]/paymentAccounts | Marked the endpoint as deprecated. | This endpoint will be removed in a future release. |
Platform
Platform Todo
NewNew Endpoints
| Endpoint | Description |
|---|---|
| GET/platform/todo/v1/spaces/[spaceId]/settings/personal/preferences/notifications/digest | Adds a new operation for this resource. |
| PUT/platform/todo/v1/spaces/[spaceId]/settings/personal/preferences/notifications/digest | Adds a new operation for this resource. |
Trust
Trust Entity
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| GET/trust/entity/v2/directory/spaces | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
Workspace
Workspace Partner
BreakingBreaking Changes
| Endpoint | Change | Impact | Migration |
|---|---|---|---|
| PATCH/workspace/partner/api/v1/spaces/[spaceId]/clients/settings/template | The value/accountingIntegrations request property format changed from `` to uuid. | Format mismatch will fail validation when non-compliant values are submitted. | Update logic to accept plain values without `` enforcement. |
| PATCH/workspace/partner/api/v1/spaces/[spaceId]/clients/settings/template | The value/accountingIntegrations response property under status 200 format changed from `` to uuid. | Format mismatch will fail validation when non-compliant values are submitted. | Update logic to accept plain values without `` enforcement. |
| POST/workspace/partner/api/v1/spaces/[spaceId]/clients/settings:addTemplate | The value/accountingIntegrations request property format changed from `` to uuid. | Format mismatch will fail validation when non-compliant values are submitted. | Update logic to accept plain values without `` enforcement. |
| POST/workspace/partner/api/v1/spaces/[spaceId]/clients/settings:addTemplate | The value/accountingIntegrations response property under status 200 format changed from `` to uuid. | Format mismatch will fail validation when non-compliant values are submitted. | Update logic to accept plain values without `` enforcement. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/permissions | Removed the path request property. | Client payloads including the path field will be rejected by the updated schema validation on this endpoint. | Remove the path parameter from request payloads and update client-side schema models. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/permissions | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/permissions | Removed the 404 response status code. | Clients expecting this exact status will encounter errors. | Update error handlers. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/[folder]/content | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/[folder]/directories/[directoryId]/content | Removed the query request property. | Client payloads including the query field will be rejected by the updated schema validation on this endpoint. | Remove the query parameter from request payloads and update client-side schema models. |
NewNew Endpoints
| Endpoint | Impact |
|---|---|
| POST/workspace/partner/api/v1/spaces/[spaceId]/clients:bulkArchive | Adds a new operation for this resource. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/permissions | Adds a new operation for this resource. |
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| POST/workspace/partner/api/v1/spaces/[spaceId]/clientPeppolExtension:backgroundActivate | Added the new optional request property pdpEnabled. | Supply or consume pdpEnabled for enriched functionality. |
| PATCH/workspace/partner/api/v1/spaces/[spaceId]/clients/settings/template | Updated the schema metadata example at value/accountingIntegrations in the request payload. | Provides clearer guidance when using this property. |
| PATCH/workspace/partner/api/v1/spaces/[spaceId]/clients/settings/template | Updated the schema metadata example at value/accountingIntegrations in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/workspace/partner/api/v1/spaces/[spaceId]/clients/settings:addTemplate | Updated the schema metadata example at value/accountingIntegrations in the request payload. | Provides clearer guidance when using this property. |
| POST/workspace/partner/api/v1/spaces/[spaceId]/clients/settings:addTemplate | Updated the schema metadata example at value/accountingIntegrations in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Added the new optional response property under status 200 files/md5Hash. | Supply or consume files/md5Hash for enriched functionality. |
| POST/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Added the new optional request property md5Hash. | Supply or consume md5Hash for enriched functionality. |
| POST/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Updated the schema metadata example in the request payload. | Provides clearer guidance when using this property. |
| POST/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Added the new optional response property under status 201 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| POST/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files | Updated the schema metadata example in the response payload under status 201. | Provides clearer guidance when using this property. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files/[fileId] | Added the new optional response property under status 200 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files/[fileId] | Updated the schema metadata example in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files/[fileId] | Added the new optional response property under status 200 md5Hash. | Supply or consume md5Hash for enriched functionality. |
| PATCH/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/files/[fileId] | Updated the schema metadata example in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/workspace/partner/v1/spaces/[partnerSpaceId]/clients/[clientId]/permissions | Updated the schema metadata example in the response payload under status 200. | Provides clearer guidance when using this property. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Added the new optional request property query. | Filter or enhance queries by utilizing the query parameter for more targeted results. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Added the new optional response property under status 200 documents/externalKey. | Supply or consume documents/externalKey for enriched functionality. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Updated the schema metadata description at documents/category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Added the new optional response property under status 201 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents | Updated the schema metadata description at category in the response payload under status 201. | Provides clearer guidance when using this property. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| GET/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Added the new optional request property externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Added the new TEMPLATE enum value to the category request property. | You can now use this new enum value in requests. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId] | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId]:jsonpatch | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| PATCH/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId]:jsonpatch | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId]:move | Added the new optional response property under status 200 externalKey. | Supply or consume externalKey for enriched functionality. |
| POST/workspace/partner/v2/spaces/[partnerSpaceId]/clients/[clientId]/documents/[documentId]:move | Updated the schema metadata description at category in the response payload under status 200. | Provides clearer guidance when using this property. |
Workspace Space
InfoImprovements (Non-Breaking)
| Endpoint | Details | Impact |
|---|---|---|
| POST/workspace/space/v2/spaces/[spaceId]/permissionTree/[subject]/permissions:bulkGet | Updated the schema metadata description at permissions in the request payload. | Provides clearer guidance when using this property. |
| POST/workspace/space/v2/spaces/[spaceId]/permissionTree/[subject]/permissions:bulkGet | Updated the schema metadata description at permissions in the request payload. | Provides clearer guidance when using this property. |