POST
/
api
/
withdrawals
Create a withdrawal
curl --request POST \
  --url http://localhost:3000/api/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "withdrawnBy": "<string>",
  "material": "<string>",
  "quantity": 2,
  "order": "<string>",
  "pane": "<string>",
  "approvedBy": "<string>",
  "withdrawnDimensions": {
    "width": 1,
    "height": 1,
    "thickness": 1
  },
  "notes": "<string>",
  "inventory": "<string>",
  "withdrawnDate": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "withdrawalNumber": "<string>",
    "order": "<string>",
    "pane": "<string>",
    "withdrawnBy": "<string>",
    "material": "<string>",
    "quantity": 2,
    "status": "pending",
    "approvedBy": "<string>",
    "withdrawnDimensions": {
      "width": 1,
      "height": 1,
      "thickness": 1
    },
    "notes": "<string>",
    "inventory": "<string>",
    "withdrawnDate": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
On success, the created withdrawal includes withdrawalNumber, a unique human-readable id in the form WDW-0001, WDW-0002, … assigned by the server. It is not part of the request body. Existing documents without a number can be updated with npm run backfill.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
withdrawnBy
string
required
Minimum string length: 1
​
material
string
required
Minimum string length: 1
​
quantity
integer
required
Required range: x >= 1
​
stockType
enum<string>
required
Available options:
Raw,
Reuse
​
order
string
Minimum string length: 1
​
pane
string
Minimum string length: 1
​
status
enum<string>
Available options:
pending,
approved,
rejected
​
approvedBy
string
Minimum string length: 1
​
withdrawnDimensions
object
​
notes
string
​
inventory
string

Inventory slot ID

Minimum string length: 1
​
withdrawnDate
string<date-time>

Response

Withdrawal created

​
success
boolean
Example:

true

​
message
string
​
data
object