Repository navigation
Restructure UpdateConnector documentation - #204
Merged
Merged
Conversation
Reorganise the NL and EN UpdateConnector pages around message structure and the three ways to determine the operation (HTTP method, subobject URL, @action). Add guidance on elements without @action and common pitfalls, replace the real AfasToken with a Bearer placeholder, and update the date. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Both language versions contain incorrect connector URLs, schema-invalid payload examples, and conflicting guidance on supported methods and nested-object behavior that could lead readers to send invalid requests.
5 open issues
What changed in this PR
review nodig: ja
labels: 📚 leerzaam
Deze PR herstructureert de Nederlandse en Engelse UpdateConnector-documentatie voor Profit. De stapsgewijze uitleg van berichtopbouw en bewerkingen maakt de pagina leerzaam voor integratieontwikkelaars.
Changes:
- Ordent bewerkingen via HTTP-methoden, subobject-URL’s en
@Actionper element. - Voegt voorbeelden en uitleg toe over sleutelvelden, SOAP en valkuilen bij geneste objecten.
- Vervangt het concrete token door een placeholder en actualiseert de documentatiedatum.
| File | Description |
|---|---|
markdownpages/profit/nl/update-connector.md |
Herstructureert en breidt de Nederlandse uitleg en voorbeelden uit. |
markdownpages/profit/en/update-connector.md |
Voert dezelfde herstructurering en aanvullingen door in het Engels. |
Review effort: Balanced
The connector URL is /connectors/FiEntries; FiEntryPar is its main object in the payload. Clarify that the top-level object name can differ from the connector name. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The OpenAPI specs only document POST for /connectors/{connector}/{subobject}
routes. Point to PUT on the main connector for updates and to the DELETE
route with keys in the URL for deletes.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
AfasFbOrderCompLines has no UnCd or FxQu field in the FbAssembly schema; the unit field is BiUn. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The FbAssembly insert schema requires BaNu, BiUn and QuUn on FbOrderBatchLines. Use the unit and quantity of the parent component line. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Elements outside the URL path get the update operation; whether deeper nested objects are still created differs per connector. Explain when an explicit "@action": "insert" is needed and make both passages consistent. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Eric Zwaal (ezw2000)
approved these changes
Nov 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Restructures the UpdateConnector page (
markdownpages/profit/nl/update-connector.mdandmarkdownpages/profit/en/update-connector.md). The EN page is a translation of the NL page.Element,FieldsandObjects, with a journal entry example. It also notes that the top-level object name can differ from the connector name (connectorFiEntrieshas main objectFiEntryPar).POST,PUT,DELETE), keeping the existing validation, field-clearing and delete contentPOSTon a subobject URL (KnOrganisation/KnBankAccount, plus the existingHrMobilityexample). The OpenAPI specs only documentPOSTfor these routes, so the text points toPUTon the main connector for updates and to theDELETEroute with keys in the URL for deletes.@Actionper element, with a newFbAssemblyexample next to the existing employee example@Actionguidance: how elements without@Actionare handled, and common pitfalls (placement, capitalisation, attribute order, nested levels).Actionattribute onFields).AfasTokenin the POST example is replaced with aBearer {token}placeholder.The endpoints used in the examples (
FiEntries,KnOrganisation/KnBankAccount,HrMobility/HrEmployeeMobilityRegistration) were checked against the OpenAPI specs inOpenApiSpecs/profit/nl.To check
🤖 Generated with Claude Code