Get a supplier claim
Returns one supplier claim by `claimId`, with its header, items and item variants. Requires `Permissions.ClaimSupplier.View`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
claimId*integerint32application/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?|int32branchId?|int32foreignCurrencyId?|int32isConfirmed?boolean|nullreceivingWarehouseId?|int32supplierId?|int32totalForeignPrice?|decimaltotalPurchasePrice?|decimaltotalPurchasePriceWoVat?|decimalwarehouseId?|int32curl -X GET 'https://<your-instance>/api/documents/claims/supplier/0' \ -H 'Authorization: Bearer <access-token>'{ "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, "supplierClaimItemVariantId": 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, "dateOfExchangeRate": "2019-08-24T14:15:22Z", "foreignCurrencyId": 0, "foreignExchangeRate": 0, "foreignPurchasePriceWoVat": 0, "isCancellation": true, "isPartialCancellation": true, "purchasePriceWoVat": 0, "purchasePriceWoVatReceived": 0, "quantityReceived": 0, "stockIntakeItemId": 0, "supplierClaimItemId": 0, "supplierProductCode": "string" } ], "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, "branchId": 0, "foreignCurrencyId": 0, "isConfirmed": true, "receivingWarehouseId": 0, "supplierId": 0, "totalForeignPrice": 0, "totalPurchasePrice": 0, "totalPurchasePriceWoVat": 0, "warehouseId": 0}Search supplier claims POST
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 as PDF GET
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`.