Flavours API
Drawer

Create Drawer

POST
/api/v2/drawers

Create a new drawer transaction.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

market_id*string

Market ID. The id of an existing record in the markets table.

branch_id*string

Branch ID. The id of an existing record in the branches table.

type*string

Transaction type.

Value in"INCREASE" | "DECREASE" | "OTHER"
amount?|

Amount (required for INCREASE/DECREASE, optional for OTHER). This field is required unless type is in OTHER.

notes?|

Notes (required for OTHER type). This field is required when type is OTHER.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:8000/api/v2/drawers" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "market_id": "uuid",    "branch_id": "uuid",    "type": "INCREASE"  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Drawer created successfully."
  },
  "data": {
    "market_id": "07928d80-350c-46eb-8786-91a40ca509a0",
    "branch_id": "baf2460b-f254-43d5-9d9a-e951fa9aa0f4",
    "type": "INCREASE",
    "amount": 628.53,
    "notes": "Unde suscipit temporibus omnis placeat est.",
    "attendance_id": "1",
    "created_at": 1782824836208,
    "updated_at": 1782824836208,
    "id": 698781025195710
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 422,
    "status": "error",
    "message": "The selected market id is invalid. (and 3 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The selected market is invalid.",
      "field": "market"
    },
    {
      "code": 0,
      "message": "The selected branch is invalid.",
      "field": "branch"
    },
    {
      "code": 0,
      "message": "The selected type is invalid.",
      "field": "type"
    },
    {
      "code": 0,
      "message": "The amount field is required unless type is in OTHER.",
      "field": "amount"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}