Supplier
Create a supplier claim
Creates a supplier claim from the header and any items in the body, and returns the stored document (201, `Location` header set). Reserves the next internal document number. Requires `Permissions.ClaimSupplier.Create`.
Search supplier claims
Returns one page of supplier claims matching the filter. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.ClaimSupplier.View`.
Get a supplier claim
Returns one supplier claim by `claimId`, with its header, items and item variants. Requires `Permissions.ClaimSupplier.View`.
Get a supplier claim as PDF
Renders the supplier claim with its configured print template and returns `application/pdf` inline. 404 when the document has no printable output. Requires `Permissions.ClaimSupplier.View`.
Delete a supplier claim
Deletes the supplier claim together with its items and item variants. Cannot be undone. Call `GET {documentId}/check-delete` first to find out whether the delete is allowed. Requires `Permissions.ClaimSupplier.Delete`.
Update a supplier claim
Updates the supplier claim header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.ClaimSupplier.Update`.
Check whether a supplier claim can be deleted
Advisory pre-flight for `DELETE {documentId}`. `canBeDeleted` is false when `blockingReasons` holds `HEADER_BLOCKED` or `ITEMS_BLOCKED`. The delete re-checks inside its own transaction, so a positive answer here is an indication rather than a guarantee. Requires `Permissions.ClaimSupplier.Delete`.
Add items to a supplier claim
Appends the items in the body to an existing supplier claim and recalculates the document totals. Requires `Permissions.ClaimSupplier.Create`.
Delete supplier claim items
Deletes the items listed in `itemIds` and recalculates the document totals. Call `GET {documentId}/items/check-delete` first to find out whether the delete is allowed. Requires `Permissions.ClaimSupplier.Delete`.
Check whether supplier claim items can be deleted
Advisory pre-flight for `DELETE {documentId}/items`. `blockingReasons` holds `ITEMS_BLOCKED` when at least one id in `itemIds` is still referenced elsewhere. At most 1000 ids per call. Requires `Permissions.ClaimSupplier.Delete`.
Update a supplier claim item
Replaces one item of the supplier claim, identified by `itemId`, and recalculates the document totals. Requires `Permissions.ClaimSupplier.Update`.
Delete a supplier claim item variant
Deletes one variant row (a size/colour breakdown) of an item and recalculates the document totals. Call the matching `check-delete` endpoint first to find out whether the delete is allowed. Requires `Permissions.ClaimSupplier.Delete`.
Check whether an item variant can be deleted
Advisory pre-flight for `DELETE {documentId}/items/{itemId}/variants/{variantId}`. `blockingReasons` holds `ITEM_VARIANT_BLOCKED` when the variant is still referenced elsewhere. Requires `Permissions.ClaimSupplier.Delete`.
Get the lock state of a supplier claim
Returns whether the supplier claim is locked against concurrent edits and, when it is, the name of the user holding the lock. Requires `Permissions.ClaimSupplier.View`.
Lock a supplier claim
Locks the supplier claim for the calling user so other users cannot edit or process it. Returns 400 when it is already locked. Release it with `DELETE {documentId}/lock`. Requires `Permissions.ClaimSupplier.Update`.
Unlock a supplier claim
Releases the lock on the supplier claim. Returns 400 when the lock belongs to another user. Requires `Permissions.ClaimSupplier.Update`.
Get a internal claim as PDF GET
Renders the internal claim with its configured print template and returns `application/pdf` inline. 404 when the document has no printable output. Requires `Permissions.ClaimInternal.View`.
Create a supplier claim POST
Creates a supplier claim from the header and any items in the body, and returns the stored document (201, `Location` header set). Reserves the next internal document number. Requires `Permissions.ClaimSupplier.Create`.