Boiler plate app
Boiler Plate App
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| POST/v1/extensions/activateClientExtension | 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 consume the updated path:/boilerplate/v1/extensions/activateClientExtension |
| POST/v1/extensions/activateExtension | 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 consume the updated path:/boilerplate/v1/extensions/activateExtension |
| POST/v1/extensions/activateTemplateExtension | 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 consume the updated path:/boilerplate/v1/extensions/activateTemplateExtension |
| POST/v1/extensions/addClientExtension | 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 consume the updated path:/boilerplate/v1/extensions/addClientExtension |
| POST/v1/extensions/addExtension | 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 consume the updated path:/boilerplate/v1/extensions/addExtension |
| POST/v1/extensions/addTemplateExtension | 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 consume the updated path:/boilerplate/v1/extensions/addTemplateExtension |
| POST/v1/extensions/clientDocumentDelivery/messages | 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 consume the updated path:/boilerplate/v1/extensions/clientDocumentDelivery/messages |
| POST/v1/extensions/clientDocumentStatus | 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 consume the updated path:/boilerplate/v1/extensions/clientDocumentStatus |
| POST/v1/extensions/configureClientExtension | 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 consume the updated path:/boilerplate/v1/extensions/configureClientExtension |
| POST/v1/extensions/configureExtension | 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 consume the updated path:/boilerplate/v1/extensions/configureExtension |
| POST/v1/extensions/configureTemplateExtension | 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 consume the updated path:/boilerplate/v1/extensions/configureTemplateExtension |
| POST/v1/extensions/deactivateClientExtension | 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 consume the updated path:/boilerplate/v1/extensions/deactivateClientExtension |
| POST/v1/extensions/deactivateExtension | 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 consume the updated path:/boilerplate/v1/extensions/deactivateExtension |
| POST/v1/extensions/deactivateTemplateExtension | 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 consume the updated path:/boilerplate/v1/extensions/deactivateTemplateExtension |
| POST/v1/extensions/deleteClientExtension | 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 consume the updated path:/boilerplate/v1/extensions/deleteClientExtension |
| POST/v1/extensions/deleteExtension | 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 consume the updated path:/boilerplate/v1/extensions/deleteExtension |
| POST/v1/extensions/deleteTemplateExtension | 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 consume the updated path:/boilerplate/v1/extensions/deleteTemplateExtension |
| POST/v1/extensions/documentDelivery/messages | 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 consume the updated path:/boilerplate/v1/extensions/documentDelivery/messages |
| POST/v1/extensions/documentStatus | 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 consume the updated path:/boilerplate/v1/extensions/documentStatus |
NewNew Endpoints
| Method & Endpoint | Core Functionality | Auth/Scopes Required |
|---|---|---|
| POST/boilerplate/v1/extensions/activateClientExtension | Activate client-specific extensions. | None specified |
| POST/boilerplate/v1/extensions/activateExtension | Activate a custom developer extension. | None specified |
| POST/boilerplate/v1/extensions/activateTemplateExtension | Enable specified workspace extension templates. | None specified |
| POST/boilerplate/v1/extensions/addClientExtension | Assign integrations to client instances. | None specified |
| POST/boilerplate/v1/extensions/addExtension | Attach localized integrations onto target spaces. | None specified |
| POST/boilerplate/v1/extensions/addTemplateExtension | Bind master template extensions. | None specified |
| POST/boilerplate/v1/extensions/clientDocumentCallbackExternal | Manage external callbacks for client documents. | None specified |
| POST/boilerplate/v1/extensions/clientDocumentDelivery/messages | Transmit client document payload records. | None specified |
| POST/boilerplate/v1/extensions/clientDocumentStatus | Query status configurations for client billing targets. | None specified |
| POST/boilerplate/v1/extensions/configureClientExtension | Update configuration parameters for client integration nodes. | None specified |
| POST/boilerplate/v1/extensions/configureExtension | Apply configuration updates to developer extensions. | None specified |
| POST/boilerplate/v1/extensions/configureTemplateExtension | Configure dynamic schema behaviors on template elements. | None specified |
| POST/boilerplate/v1/extensions/deactivateClientExtension | Suspend active client-level integrations. | None specified |
| POST/boilerplate/v1/extensions/deactivateExtension | Terminate and deactivate specific active modules. | None specified |
| POST/boilerplate/v1/extensions/deactivateTemplateExtension | Disable master templates across dependent spaces. | None specified |
| POST/boilerplate/v1/extensions/deleteClientExtension | Uninstall extensions cleanly for target clients. | None specified |
| POST/boilerplate/v1/extensions/deleteExtension | Perform full module removals from the active space. | None specified |
| POST/boilerplate/v1/extensions/deleteTemplateExtension | Remove active template configurations. | None specified |
| POST/boilerplate/v1/extensions/documentCallbackExternal | Retrieve webhook updates from external document networks. | None specified |
| POST/boilerplate/v1/extensions/documentDelivery/messages | Stream transactional document components. | None specified |
| POST/boilerplate/v1/extensions/documentStatus | Extract status metrics on outbound document routes. | None specified |
Documents
Documents Core
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| POST/v1/spaces/actions/{namespace}/{name}/initialize | Removed the subject request property. | Client payloads including the subject field will be rejected by the updated schema validation on this endpoint. | Remove the subject parameter from all action initialization request payloads and update client-side schema definitions accordingly. |
| POST/v1/spaces/documents/clone/initialize | Removed the subject request property. | Client payloads including the subject field will be rejected by the updated schema validation on this endpoint. | Remove the subject parameter from clone initialization request payloads and update client-side schema models. |
| POST/v1/spaces/documents/dispute/initialize | Removed the subject request property. | Client payloads including the subject field will be rejected by the updated schema validation on this endpoint. | Remove the subject parameter from dispute initialization request payloads and update client-side schema models. |
| POST/v1/spaces/documents/refuse/initialize | Removed the subject request property. | Client payloads including the subject field will be rejected by the updated schema validation on this endpoint. | Remove the subject parameter from refuse initialization request payloads and update client-side schema models. |
NewNew Endpoints
| Method & Endpoint | Core Functionality | Auth/Scopes Required |
|---|---|---|
| POST/v1/spaces/[spaceId]/documents/[documentId]:refuse | Refuse a document and record the associated refusal justification. | None specified |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| POST/v1/spaces/actions/{namespace}/{name}/execute | Added the optional response property action/items/target under success status 200. | Access the target entity reference directly from custom action execution responses. |
| POST/v1/spaces/documents/accept/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful accept operation executions. |
| POST/v1/spaces/documents/approve/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful approve operation executions. |
| POST/v1/spaces/documents/cancel/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful cancel operation executions. |
| POST/v1/spaces/documents/clone/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target cloned document reference on successful clone operation executions. |
| POST/v1/spaces/documents/convertInvoiceToCreditNote/execute | Added the optional response property action/items/target under success status 200. | Identify the resulting credit note document on invoice conversion completions. |
| POST/v1/spaces/documents/convertQuoteToInvoice/execute | Added the optional response property action/items/target under success status 200. | Identify the resulting invoice document on quote conversion completions. |
| POST/v1/spaces/documents/delete/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful delete operation executions. |
| POST/v1/spaces/documents/deleteVersion/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful version deletion executions. |
| POST/v1/spaces/documents/dispute/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful dispute operation executions. |
| POST/v1/spaces/documents/refuse/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful refuse operation executions. |
| POST/v1/spaces/documents/resolve/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful dispute resolution executions. |
| POST/v1/spaces/documents/send/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful send operation executions. |
| POST/v1/spaces/documents/undoAccept/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful accept reversal executions. |
| POST/v1/spaces/documents/undoRefuse/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful refuse reversal executions. |
| POST/v1/spaces/documents/validate/execute | Added the optional response property action/items/target under success status 200. | Retrieve the target document reference on successful document validation executions. |
| POST/v1/files:convert | Added the new optional request property input/lines/items/productIdentifiers/sellerIdentifier. | Supply a seller-specific product identifier on individual line items during document conversion operations. |
Network
Network Documents
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| POST/v1/spaces/connectors/peppol/documents:add | Added the new optional request property receiverLegalName. | Supply the legal name of the document receiver directly in Peppol document submission payloads for enriched routing metadata. |
Payment accounts
Payments Accounts
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| GET/v1/spaces/[spaceId]/paymentAccounts | Added the new REQUESTED enum value to the paymentAccounts/items/status response property under status 200. | Clients with strict enum validation on payment account status fields will fail to deserialize accounts in the REQUESTED state. | Extend client-side payment account status models to accept and process the new REQUESTED state. |
| POST/v1/spaces/[spaceId]/paymentAccounts | Added the new REQUESTED enum value to the status response property under status 201. | Strictly typed clients processing newly created payment accounts may fail when receiving the REQUESTED status on creation. | Update account creation response handlers to accept the REQUESTED status value in client-side enum definitions. |
| GET/v1/spaces/[spaceId]/paymentAccounts/[paymentAccountId] | Added the new REQUESTED enum value to the status response property under status 200. | Client parsers utilizing strict state validation on individual account lookups will fail when retrieving accounts in the REQUESTED state. | Ensure payment account detail parsers support the new REQUESTED status flag. |
| GET/v1/spaces/[spaceId]/paymentAccounts/[paymentAccountId]/movements/[movementId]:paymentCancellation | Added the new doc_to_doc enum value to the type response property under status 200. | Client applications with hardcoded payment type enums will fail to process cancellation records carrying the doc_to_doc movement type. | Extend the client-side movement type model to accept and handle the new doc_to_doc payment type value. |
Payments Integration
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| GET/v1/spaces/[spaceId]/payments | Added the new doc_to_doc enum value to the paymentDetails/items/type response property under status 200. | Strictly typed client parsers validating payment type enums will fail to deserialize payment list entries carrying the doc_to_doc type. | Extend client-side payment type models to support the new doc_to_doc enum value in version 1 payment list responses. |
| GET/v1/spaces/[spaceId]/payments/[paymentId] | Added the new doc_to_doc enum value to the type response property under status 200. | Strictly typed client routines fetching individual version 1 payments will fail when encountering the newly introduced doc_to_doc payment type. | Incorporate the doc_to_doc value into version 1 single-payment response type models. |
| GET/v2/spaces/[spaceId]/payments | Added the new doc_to_doc enum value to the paymentDetails/items/type response property under status 200. | Version 2 payment list parsers enforcing strict type validation will fail when processing payments of the doc_to_doc type. | Update version 2 payment list type enumerations to include and handle the doc_to_doc payment type. |
| POST/v2/spaces/[spaceId]/payments/bulkGet | Added the new doc_to_doc enum value to the payments/items/type response property under status 200. | Bulk payment query responses returning doc_to_doc records will trigger deserialization failures in strictly typed version 2 clients. | Re-configure bulk lookup type models to support the doc_to_doc enum parameter in version 2 responses. |
| GET/v2/spaces/[spaceId]/payments/[paymentId] | Added the new doc_to_doc enum value to the type response property under status 200. | Individual version 2 payment fetches will fail in strict enum parsers when returning records with the doc_to_doc type. | Update single-payment entity models inside version 2 SDKs to acknowledge doc_to_doc. |
| GET/v3/spaces/[spaceId]/payments | Added the new doc_to_doc enum value to the paymentDetails/items/type response property under status 200. | Version 3 payment list parsers enforcing strict type validation will fail when processing payments of the doc_to_doc type. | Extend version 3 payment list type models to include the doc_to_doc enum value. |
| POST/v3/spaces/[spaceId]/payments/bulkGet | Added the new doc_to_doc enum value to the payments/items/type response property under status 200. | Multi-resource payment queries returning doc_to_doc records in version 3 will trigger deserializer failures in strictly typed clients. | Re-configure version 3 bulk lookup type models to support the new doc_to_doc enum parameter. |
| GET/v3/spaces/[spaceId]/payments/[paymentId] | Added the new doc_to_doc enum value to the type response property under status 200. | Fetching individual version 3 payment records with doc_to_doc type will cause processing failures in strict client parsers. | Update single-payment models in version 3 SDKs to accept and handle the doc_to_doc type. |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| GET/v3/spaces/[spaceId]/payments | Added new optional query parameters: counterpartyName, dateFrom, dateTo, and paymentType. | Filter version 3 payment listings by counterparty name, date ranges, or payment type for more targeted query results. |
Platform
Platform Email
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| POST/v1/emails | Added a new optional request property notificationId. | Bind direct email transmissions to discrete platform notification events to simplify system-wide tracing. |
| POST/v1/feedback/email/mailgun | Added new optional request properties event-data/user-variables/notificationId and event-data/user-variables/traceId. | Pass notification and trace identifier parameters within Mailgun callback metadata for comprehensive email log correlation. |
Platform Extension
NewNew Endpoints
| Method & Endpoint | Core Functionality | Auth/Scopes Required |
|---|---|---|
| POST/v1/applications/[applicationId]/versions/[appVersionId]:restore | Restore a previously published application version to active state. | None specified |
| POST/v1/applications/[applicationId]:restore | Restore an application to its last active configuration. | None specified |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| POST/v1/applications/[applicationId]/versions | API removed with deprecation. | Transition version creation workflows to the current supported endpoint patterns and remove references to this deprecated path. |
| PATCH/v1/applications/[applicationId]/versions/[appVersionId] | API removed with deprecation. | Transition version update workflows to the current supported endpoint patterns and remove references to this deprecated path. |
| PATCH/v2/applications/[applicationId] | Added the new optional request property publisherName. | Update the display name of the application publisher directly via standard PATCH on version 2 application profiles. |
Payments Reconciliation
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| GET/transaction-radar/v1/spaces/[spaceId]/payments/aggregations | Added the new PAYMENT enum value to the paymentAggregations/items/aggregations/items/payableType response property under statuses 200 and 400. | Client parsers with strict enum enforcement on payableType will fail when processing aggregations containing the PAYMENT payable type. | Extend client-side payable type enumerations to support and process the new PAYMENT value in aggregation responses. |
| GET/transaction-radar/v1/spaces/[spaceId]/payments/[paymentId]/aggregations | Added the new PAYMENT enum value to the paymentAggregations/items/aggregations/items/payableType response property under statuses 200 and 400. | Client parsers with strict enum enforcement on payableType will fail when processing payment-specific aggregations carrying the PAYMENT type. | Update per-payment aggregation parsers to handle the new PAYMENT payable type value. |
| GET/v1/transaction-radar/spaces/[spaceId]/payments/aggregations | Added the new PAYMENT enum value to the paymentAggregations/items/aggregations/items/payableType response property under statuses 200 and 400. | Strictly typed clients using the alternate path prefix will fail to process aggregation responses containing PAYMENT payable entries. | Extend payable type handling in alternate-path aggregation queries to include the PAYMENT enum value. |
| GET/v1/transaction-radar/spaces/[spaceId]/payments/[paymentId]/aggregations | Added the new PAYMENT enum value to the paymentAggregations/items/aggregations/items/payableType response property under statuses 200 and 400. | Strictly typed clients using the alternate path prefix will fail to process payment-specific aggregation responses containing PAYMENT payable entries. | Update per-payment aggregation parsers on the alternate path to handle the PAYMENT payable type value. |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| POST/transaction-radar/v1/spaces/[spaceId]/payments/[paymentId]:matchDocuments | Added the new PAYMENT enum value to the updatedSelection/items/payableType request property. | Match payment-type payables directly when updating document reconciliation selections. |
| POST/v1/transaction-radar/spaces/[spaceId]/payments/[paymentId]:matchDocuments | Added the new PAYMENT enum value to the updatedSelection/items/payableType request property. | Match payment-type payables directly when updating document reconciliation selections on the alternate path. |
Tax
Tax Configuration
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| POST/v1/engineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent request property. | Clients submitting NON_EXISTENT_TERRITORY_TAX_TYPE as the taxServiceEvent value will receive schema validation failures. | Remove usage of NON_EXISTENT_TERRITORY_TAX_TYPE from all taxServiceEvent request fields and implement appropriate fallback logic. |
| PATCH/v1/engineNotes/[engineNoteId] | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent request property. | Clients submitting NON_EXISTENT_TERRITORY_TAX_TYPE as the taxServiceEvent value on engine note updates will receive schema validation failures. | Remove NON_EXISTENT_TERRITORY_TAX_TYPE from PATCH request payloads targeting engine notes. |
| POST/v1/spaces/[spaceId]/customEngineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent request property. | Clients submitting NON_EXISTENT_TERRITORY_TAX_TYPE as the taxServiceEvent value on custom engine note creation will encounter validation rejections. | Remove NON_EXISTENT_TERRITORY_TAX_TYPE from custom engine note creation request payloads. |
| PATCH/v1/spaces/[spaceId]/customEngineNotes/[engineNoteId] | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent request property. | Clients submitting NON_EXISTENT_TERRITORY_TAX_TYPE as the taxServiceEvent value on custom engine note updates will encounter validation rejections. | Remove NON_EXISTENT_TERRITORY_TAX_TYPE from custom engine note update request payloads. |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| GET/v1/engineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the engineNotes/items/taxServiceEvent response property under status 200. | Simplify client-side tax event type mapping by removing handling for the deprecated NON_EXISTENT_TERRITORY_TAX_TYPE value. |
| POST/v1/engineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent response property under status 200. | Clean up engine note creation response parsers by removing the deprecated NON_EXISTENT_TERRITORY_TAX_TYPE state. |
| PATCH/v1/engineNotes/[engineNoteId] | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent response property under status 200. | Streamline engine note update response models by eliminating the deprecated NON_EXISTENT_TERRITORY_TAX_TYPE tax event type. |
| GET/v1/spaces/[spaceId]/customEngineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the engineNotes/items/taxServiceEvent response property under status 200. | Simplify custom engine note list parsers by removing support for the deprecated NON_EXISTENT_TERRITORY_TAX_TYPE value. |
| POST/v1/spaces/[spaceId]/customEngineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent response property under status 200. | Streamline custom engine note creation response handling by eliminating the deprecated tax event type. |
| PATCH/v1/spaces/[spaceId]/customEngineNotes/[engineNoteId] | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the taxServiceEvent response property under status 200. | Streamline custom engine note update response handling by eliminating the deprecated tax event type. |
| GET/v1/spaces/[spaceId]/engineNotes | Removed the NON_EXISTENT_TERRITORY_TAX_TYPE enum value from the engineNotes/items/taxServiceEvent response property under status 200. | Simplify space-level engine note list parsers by removing support for the deprecated NON_EXISTENT_TERRITORY_TAX_TYPE value. |
Trust
Trust Entity
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| GET/v1/directory/entities/[entityId]/spaces/[spaceId] | Added the optional response property globalIdentifiers under success status 200. | Access global identifier records directly from version 1 directory entity-space lookups. |
| GET/v1/directory/spaces | Added the optional response property spaces/items/globalIdentifiers under success status 200. | Retrieve global identifier sets for each space in version 1 directory space listings. |
| GET/v1/entities/[entityId]/spaces | Added the optional response property spaces/items/status under success status 200. | Inspect the active status of each space in version 1 entity-space association listings. |
| POST/v1/entities/[entityId]/spaces | Added the optional response property status under success status 201. | Retrieve the initial status of the newly associated space on version 1 entity-space creation. |
| GET/v2/directory/entities/[entityId]/spaces/[spaceId] | Added the optional response property globalIdentifiers under success status 200. | Access global identifier records directly from version 2 directory entity-space lookups. |
| GET/v2/directory/spaces | Added the optional response property spaces/items/globalIdentifiers under success status 200. | Retrieve global identifier sets for each space in version 2 directory space listings. |
| POST/v2/entities/[entityId]/spaces | Added the optional response property status under success status 201. | Retrieve the initial status of the newly associated space on version 2 entity-space creation. |
Workspace
Workspace Partner
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| POST/api/v1/spaces/[spaceId]/clientPeppolExtension:backgroundActivate | The clientIds/items/ request property type/format changed from string/uuid to string/'', and the sessionId request property type/format changed from string/uuid to string/''. | Client applications enforcing UUID format validation on clientIds/items/ or sessionId will fail schema checks when non-UUID values are submitted. | Update client-side validation logic to accept plain string values without UUID format enforcement for both clientIds/items/ and sessionId fields. |
| DELETE/v1/spaces/[spaceId]/clients:delete | Removed the required response property clientDeleteResponses/items/ordinalNumber from the 200 status response and removed the bulkDeleteClients/items/ordinalNumber request property. | Clients relying on ordinalNumber in bulk delete request payloads or expecting it in clientDeleteResponses will encounter missing-field errors at runtime. | Remove ordinalNumber from bulk delete request payloads and update response parsing logic to no longer reference ordinalNumber in deletion confirmation records. |
NewNew Endpoints
| Method & Endpoint | Core Functionality | Auth/Scopes Required |
|---|---|---|
| GET/v1/spaces/[partnerSpaceId]/clients/[clientId]/extensionConfigs | Retrieve the extension configuration profiles assigned to a specific partner client. | None specified |
| POST/api/v1/insights/[partnerSpaceId]/authorization | Create authorization tokens for partner insights access. | None specified |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| GET/v1/spaces/[partnerSpaceId]/clients/[clientId]/clientSpace | Added the optional response property status under success status 200. | Inspect the active status of the client workspace directly from version 1 client space lookups. |
| PATCH/v1/spaces/[partnerSpaceId]/clients/[clientId]/clientSpace | Added the optional response property status under success status 200. | Confirm the resulting workspace status after applying partial updates to client space configurations. |
| GET/v1/spaces/[partnerSpaceId]/clients/[clientId]/extensions | Added the optional response property extensions/items/activationTime under success status 200. | Retrieve the activation timestamp for each extension assigned to a client workspace. |
| GET/v1/spaces/[partnerSpaceId]/clients/[clientId]/[subjectType] | Added the optional response property users/items/lastSyncedAt under success status 200. | Inspect the last synchronization timestamp for each user returned in client subject-type listings. |
| GET/v2/spaces/[partnerSpaceId]/clients/[clientId]/clientSpace | Added the security scope space_client_manage to the endpoint's security scheme partner_store and added the optional response property status under success status 200. | Expand authorized access patterns for client space reads and inspect the workspace status in version 2 lookups. |
| POST/api/v1/spaces/[spaceId]/clientPeppolExtension:backgroundActivate | Added the new optional request property ql. The clientIds and clientIds/items/ request properties became nullable. Removed the UUID format pattern from the sessionId request property. | Use query language expressions for flexible client targeting and pass nullable client ID arrays on Peppol extension background activations. |
| POST/api/v1/spaces/[spaceId]/clients:bulkInvite | Added the new optional request property ql. The clientIds and clientIds/items/ request properties became nullable and optional. | Use query language expressions or nullable client ID arrays for flexible bulk invitation targeting. |
| DELETE/v1/spaces/[spaceId]/clients:delete | Added the new optional request property ql. The bulkDeleteClients and bulkDeleteClients/items/ request properties became nullable and optional. Added the required response property clientDeleteResponses/items/clientId under status 200. | Use query language expressions for flexible targeting in bulk client deletions and retrieve confirmed client IDs directly from deletion response records. |
Workspace Space
BreakingBreaking Changes
| Method & Endpoint | The Change | Breaking Behavior | Migration Path |
|---|---|---|---|
| POST/v1/spaces/[spaceId]/groups/[groupId]:assignUsers | 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 consume the updated path:/v1/spaces/[spaceId]/groups/[groupId]:assign |
| POST/v1/spaces/[spaceId]/groups/[groupId]:unassignUsers | 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 consume the updated path:/v1/spaces/[spaceId]/groups/[groupId]:unassign |
| GET/v2/spaces/[spaceId]/permissionTree | Removed the optional response properties lastSyncedAt, status, and subjectType from the 200 status response. | Client applications reading lastSyncedAt, status, or subjectType from version 2 permission tree responses will encounter null reference errors. | Remove dependencies on lastSyncedAt, status, and subjectType from permission tree response processing logic and update client-side data models accordingly. |
NewNew Endpoints
| Method & Endpoint | Core Functionality | Auth/Scopes Required |
|---|---|---|
| POST/v1/spaces/[spaceId]/groups/[groupId]:assign | Assign users or subjects to a workspace group. | None specified |
| POST/v1/spaces/[spaceId]/groups/[groupId]:unassign | Unassign users or subjects from a workspace group. | None specified |
| PUT/v1/spaces/[spaceId]:updateStatus | Update the status of a workspace space directly. | None specified |
InfoImprovements (Non-Breaking)
| Method & Endpoint | Enhancement Details | Developer Opportunity |
|---|---|---|
| GET/v1/entities/[entityId]/groups | Added optional response properties groups/items/createdAt, groups/items/resourceId, groups/items/resourceType, and groups/items/updatedAt under success status 200. | Retrieve creation timestamps, resource identifiers, resource types, and modification timestamps directly from entity group listings. |
| GET/v1/entities/[entityId]/groups/[groupId] | Added optional response properties createdAt, resourceId, resourceType, and updatedAt under success status 200. | Inspect full lifecycle metadata on individual entity group lookups. |
| GET/v1/spaces | Added the optional response property spaces/items/status under success status 200. | Inspect the active status of each space in version 1 space listings. |
| GET/v1/spaces/[spaceId] | Added the optional response property status under success status 200. | Access the current status of a specific workspace directly from version 1 space detail responses. |
| PATCH/v1/spaces/[spaceId] | Added the optional response property status under success status 200. | Confirm the resulting space status after applying partial configuration updates. |
| GET/v1/spaces/[spaceId]/extensions | Added the optional response property extensions/items/activationTime under success status 200. | Retrieve the activation timestamp for each extension in space extension listings. |
| POST/v1/spaces/[spaceId]/extensions | Added the optional response property activationTime under success status 201. | Access the activation timestamp of a newly added extension on creation. |
| GET/v1/spaces/[spaceId]/extensions/[extensionId] | Added the optional response property activationTime under success status 200. | Retrieve the activation timestamp for a specific extension on individual lookup. |
| PUT/v1/spaces/[spaceId]/extensions/[extensionId] | Added the optional response property activationTime under success status 200. | Confirm the activation timestamp after replacing extension configurations via PUT. |
| PUT/v1/spaces/[spaceId]/extensions/[extensionId]:updateStatus | Added the new optional request property activationTime and the optional response property activationTime under success status 200. | Set and verify the activation timestamp when updating extension status configurations. |
| GET/v1/spaces/[spaceId]/groups | Added optional response properties groups/items/createdAt, groups/items/resourceId, groups/items/resourceType, and groups/items/updatedAt under success status 200. | Retrieve full lifecycle metadata for each group in workspace group listings. |
| POST/v1/spaces/[spaceId]/groups | Added optional response properties createdAt, resourceId, resourceType, and updatedAt under success status 201. | Access creation timestamps and resource identifiers directly on new group creation responses. |
| GET/v1/spaces/[spaceId]/groups/[groupId] | Added optional response properties createdAt, resourceId, resourceType, and updatedAt under success status 200. | Inspect full lifecycle metadata on individual workspace group lookups. |
| PATCH/v1/spaces/[spaceId]/groups/[groupId] | Added optional response properties createdAt, resourceId, resourceType, and updatedAt under success status 200. | Confirm updated resource metadata directly from workspace group PATCH responses. |
| GET/v1/spaces/[spaceId]/groups/[groupId]/users | Added the optional response property users/items/lastSyncedAt under success status 200. | Retrieve the last synchronization timestamp for each user in workspace group member listings. |
| GET/v1/spaces/[spaceId]/spaceContext | Added the optional response property status under success status 200. | Inspect the current status of the space within the full space context response. |
| GET/v1/spaces/[spaceId]/subscriptions | Added the new optional query parameter include and the optional response property subscriptions/items/extensions under success status 200. | Use the include parameter to request extension details inline within subscription listing responses. |
| POST/v1/spaces/[spaceId]/subscriptions | Added the optional response property extensions under success status 201. | Access the extension list bound to a newly created subscription directly on the creation response. |
| GET/v1/spaces/[spaceId]/[subjectType] | Added the new optional query parameter ql and the optional response property users/items/lastSyncedAt under success status 200. | Use query language expressions for flexible subject filtering and retrieve synchronization timestamps for each user returned. |
| POST/v1/spaces/[spaceId]/[subjectType] | Added the optional response property lastSyncedAt under success status 201. | Retrieve the initial synchronization timestamp for newly added space subjects on creation. |
| GET/v1/spaces/[spaceId]/[subjectType]/[subject] | Added the optional response property lastSyncedAt under success status 200. | Inspect the synchronization timestamp for a specific space subject on individual lookup. |
| PATCH/v1/spaces/[spaceId]/[subjectType]/[subject] | Added the optional response property lastSyncedAt under success status 200. | Confirm the synchronization timestamp after applying partial updates to space subjects. |
| GET/v1/spaces/[spaceId]/[subjectType]/[subject]/groups | Added optional response properties groups/items/createdAt, groups/items/resourceId, groups/items/resourceType, and groups/items/updatedAt under success status 200. | Retrieve full lifecycle metadata for each group associated with a space subject. |
| POST/v1/spaces/[spaceId]/[subjectType]/[subject]:activate | Added the optional response property lastSyncedAt under success status 200. | Confirm the synchronization timestamp on successful space subject activation. |
| POST/v1/spaces/[spaceId]/[subjectType]/[subject]:deactivate | Added the optional response property lastSyncedAt under success status 200. | Confirm the synchronization timestamp on successful space subject deactivation. |
| GET/v1/[subjectType]/[subject]/spaces | Added the optional response property spaces/items/status under success status 200. | Inspect the active status of each space in subject-centric space listings. |
| GET/v2/spaces | Added the optional response property spaces/items/status under success status 200. | Inspect the status of each space in version 2 space listings. |
| GET/v2/spaces/[spaceId] | Added the optional response property status under success status 200. | Access the current status of a specific workspace directly from version 2 space detail responses. |
| PATCH/v2/spaces/[spaceId] | Added the optional response property status under success status 200. | Confirm the resulting space status after applying partial configuration updates in version 2. |
| PATCH/v2/spaces/[spaceId]:jsonpatch | Added the optional response property status under success status 200. | Confirm the resulting space status after issuing version 2 JSON patch updates. |