WinShopAPI docs
ReferenceDocumentsExpeditionWrite offs

Get write-off defaults

Returns the instance's configured defaults applied when a write-off is created. Requires `Permissions.WriteOffs.View`.

GET
/api/documents/expedition/write-offs/base-config

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Response Body

application/json
  1. response
customerId?integer
Formatint32
paymentTypeId?integer
Formatint32
showOnlyActiveProducts?boolean
warehouseId?integer
Formatint32
writeOffNeedsConfirmation?boolean
curl -X GET 'https://<your-instance>/api/documents/expedition/write-offs/base-config' \  -H 'Authorization: Bearer <access-token>'
{  "customerId": 0,  "paymentTypeId": 0,  "showOnlyActiveProducts": true,  "warehouseId": 0,  "writeOffNeedsConfirmation": true}

Create a write-off POST

Creates a write-off 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.WriteOffs.Create`.

Get a write-off GET

Returns one write-off by `documentId`, with its header, items and item variants. Requires `Permissions.WriteOffs.View`.