Get purchase order

GET

/api/purchase-orders/{id}

curl --request GET \
  --url http://localhost:3000/api/purchase-orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

• Local development
• Dedicated / self-hosted instance

Includes the items array with joined category/manufacturer names.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Success

Media type application/json

object

data

object

id

required

string format: uuid

poNumber

required

string

supplierName

string

nullable

status

required

string

Allowed values: draft ordered partially_received received cancelled

orderDate

string format: date-time

nullable

expectedDelivery

string format: date-time

nullable

receivedDate

string format: date-time

nullable

totalValue

Numeric(12,2) serialised as string — recalculated server-side from items

string

nullable

notes

string

nullable

createdBy

string format: uuid

nullable

itemCount

List endpoint only

integer

items

Detail endpoint only

Array<object>

object

id

required

string format: uuid

poId

required

string format: uuid

description

required

string

categoryId

string format: uuid

nullable

categoryName

string

nullable

manufacturerId

string format: uuid

nullable

manufacturerName

string

nullable

quantityOrdered

required

integer

quantityReceived

required

integer

unitCost

Numeric(12,2) serialised as string

string

nullable

totalCost

Numeric(12,2) serialised as string

string

nullable

notes

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "status": "draft"
  }
}

401

Not authenticated

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

403

Insufficient role

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

Purchase order not found

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}