Skip to main content

Service Catalog API

Manage services, procedures, and billable catalog items used throughout the hospital management system.

Base Information

  • Base Path: /catalog/
  • Authentication: OAuth2PasswordBearer

Create Catalog Item

Creates a new service catalog item.

Endpoint

POST /catalog/

Request Body

{
"code": "string",
"name": "string",
"default_price": 0,
"discount_percent": 0,
"discount_amount": 0,
"category": "string",
"description": "string"
}

Response (201 Created)

null

Get All Catalog Items

Returns a paginated list of catalog items.

Endpoint

GET /catalog/

Query Parameters

ParameterTypeDefaultDescription
limitinteger100Maximum records to return
offsetinteger0Pagination offset
order_bystringcreated_atSort field
searchstringnullSearch text
tagsarray[]Filter by tags

Response (200 OK)

{
"total": 0,
"offset": 0,
"limit": 0,
"data": []
}

Get Catalog Item By ID

Returns details of a specific catalog item.

Endpoint

GET /catalog/{id}

Path Parameters

ParameterTypeDescription
iduuidCatalog Item ID

Response (200 OK)

null

Update Catalog Item

Updates an existing catalog item.

Endpoint

PUT /catalog/{id}

Path Parameters

ParameterTypeDescription
iduuidCatalog Item ID

Request Body

{
"code": "string",
"name": "string",
"default_price": 0,
"discount_percent": 0,
"discount_amount": 0,
"category": "string",
"description": "string"
}

Response (200 OK)

null