Update a customer claim
Updates the customer claim header and the items sent in the body. Pass `removeItemsNotInRequest=true` to also delete the items the body leaves out. Requires `Permissions.ClaimCustomer.Update`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
documentId*integerint32removeItemsNotInRequest?boolean|nullapplication/json- body
id?|Row id of the document. Read-only; the server assigns it.
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
int32items?array<>|The document's items. Null when the document was loaded without them.
createdAt?|date-timedateOfCreation?|date-timedateOfProcessing?|date-timedeliveryDate?|date-timedocumentStateId?|int32documentStateUserId?|int32foreignExchangeRate?|decimalformNumber?|length <= 150isCancellation?boolean|nullisLocked?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullpaymentTypeId?|int32totalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPrice?|decimaltotalStockPriceWoVat?|decimaluserId?|int32address?|length <= 80bank?|length <= 50bankAccountNumber?|length <= 50bankCode?|length <= 50branchId?|int32currencyId?|int32customerId?|int32deliveryAddressId?|int32email?|length <= 80ibanCode?|length <= 35isConfirmed?boolean|nullname?|length <= 80phone?|length <= 20receivingWarehouseId?|int32soldDate?|date-timesolutionMethodId?|int32swiftCode?|length <= 20transportDriverId?|int32warehouseId?|int32application/json- response
id?|Row id of the document. Read-only; the server assigns it.
int32internalNumber?|Internal document number, unique within the document type and reserved when the document is created. Read-only.
int32items?array<>|The document's items. Null when the document was loaded without them.
createdAt?|date-timedateOfCreation?|date-timedateOfProcessing?|date-timedeliveryDate?|date-timedocumentStateId?|int32documentStateUserId?|int32foreignExchangeRate?|decimalformNumber?|length <= 150isCancellation?boolean|nullisLocked?boolean|nullisPrinted?boolean|nullisProcessed?boolean|nulllastModify?|date-timelockOwner?|length <= 80note?string|nullpaymentTypeId?|int32totalNumberOfItems?|int32totalNumberOfPieces?|decimaltotalPrice?|decimaltotalPriceWoVat?|decimaltotalStockPrice?|decimaltotalStockPriceWoVat?|decimaluserId?|int32address?|length <= 80bank?|length <= 50bankAccountNumber?|length <= 50bankCode?|length <= 50branchId?|int32currencyId?|int32customerId?|int32deliveryAddressId?|int32email?|length <= 80ibanCode?|length <= 35isConfirmed?boolean|nullname?|length <= 80phone?|length <= 20receivingWarehouseId?|int32soldDate?|date-timesolutionMethodId?|int32swiftCode?|length <= 20transportDriverId?|int32warehouseId?|int32curl -X PUT 'https://<your-instance>/api/documents/claims/customer/0' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": 0, "internalNumber": 0, "items": [ { "id": 0, "internalNumber": 0, "item": 0, "productId": 0, "variants": [ { "colorId": 0, "dimensionId": 0, "id": 0, "itemId": 0, "lengthId": 0, "quantity": 0, "sizeId": 0, "price": 0, "priceWoVat": 0 } ], "barcode": "string", "batchId": 0, "claimReason": 0, "createdAt": "2019-08-24T14:15:22Z", "faultDescription": "string", "faultTypId": 0, "lastModify": "2019-08-24T14:15:22Z", "note": "string", "packagePrice": 0, "quantity": 0, "quantityCoefficient": 0, "recyclingFee": 0, "recyclingFeeId": 0, "royalty": 0, "royaltyId": 0, "serviceId": 0, "solutionDescription": "string", "solutionTypeId": 0, "statusId": 0, "stockPrice": 0, "unitId": 0, "userId": 0, "variantId": 0, "vatRate": 0, "claimPrice": 0, "commissionStockIntakeInternalNumber": 0, "deliveryNoteItemId": 0, "headerInternalId": 0, "isCancellation": true, "isPartialCancellation": true, "orderItemId": 0, "originalInvoiceInternalNumber": 0, "posId": 0, "price": 0, "priceWoVat": 0, "priceWoVatIssued": 0, "quantityIssued": 0, "stockIntakeInternalNumber": 0, "unitIdIssued": 0 } ], "createdAt": "2019-08-24T14:15:22Z", "dateOfCreation": "2019-08-24T14:15:22Z", "dateOfProcessing": "2019-08-24T14:15:22Z", "deliveryDate": "2019-08-24T14:15:22Z", "documentStateId": 0, "documentStateUserId": 0, "foreignExchangeRate": 0, "formNumber": "string", "isCancellation": true, "isLocked": true, "isPrinted": true, "isProcessed": true, "lastModify": "2019-08-24T14:15:22Z", "lockOwner": "string", "note": "string", "paymentTypeId": 0, "totalNumberOfItems": 0, "totalNumberOfPieces": 0, "totalPrice": 0, "totalPriceWoVat": 0, "totalStockPrice": 0, "totalStockPriceWoVat": 0, "userId": 0, "address": "string", "bank": "string", "bankAccountNumber": "string", "bankCode": "string", "branchId": 0, "currencyId": 0, "customerId": 0, "deliveryAddressId": 0, "email": "string", "ibanCode": "string", "isConfirmed": true, "name": "string", "phone": "string", "receivingWarehouseId": 0, "soldDate": "2019-08-24T14:15:22Z", "solutionMethodId": 0, "swiftCode": "string", "transportDriverId": 0, "warehouseId": 0}Delete a customer claim DELETE
Deletes the customer 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.ClaimCustomer.Delete`.
Check whether a customer claim can be deleted GET
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.ClaimCustomer.Delete`.