Business Resources
The core resource management endpoints: businesses, professionals, categories, services, and week schedules. All the CRUD operations for managing the business domain.
TL;DR
Businesses
A Business is the top-level tenant. Every request is scoped to a business via the ilm-business header. Businesses own professionals, fiscal entities, and contracts.
The business resource supports standard JSON:API operations: list, get, create, update, and delete. Each business has a name, slug, and configuration settings.
Professionals
Professionals are the people who work within a business. Each professional has a name, email, and optional tax information. Professionals are linked to fiscal entities and contracts.
A professional belongs to a business and can have multiple fiscal entities (one per CNPJ/CPF). The is-owned-by-account flag indicates whether the professional is the account owner.
Categories & Services
Business categories define the types of services a business offers. Professional categories link professionals to specific service categories. Professional services are the individual services that professionals provide.
BusinessCategory
Categories available at the business level. Used to classify the business and its offerings.
ProfessionalCategory
Links a professional to a category. Determines which services the professional can offer.
ProfessionalService
Individual services with pricing. Each service belongs to a professional and a category.
Week Schedules
Week schedules define the working hours for a business or professional. Each schedule entry specifies a day of the week, start time, and end time. Schedules are used for appointment booking and availability calculations.
Endpoints
Businesses
| Method | Path | Purpose |
|---|---|---|
| GET | /businesses | List all businesses for the current user. |
| GET | /businesses/{id} | Get a single business. |
| POST | /businesses | Create a new business. |
| PATCH | /businesses/{id} | Update a business. |
| DELETE | /businesses/{id} | Delete a business. |
Professionals
| Method | Path | Purpose |
|---|---|---|
| GET | /professionals | List professionals for the current business. |
| GET | /professionals/{id} | Get a single professional. |
| POST | /professionals | Create a new professional. |
| PATCH | /professionals/{id} | Update a professional. |
| DELETE | /professionals/{id} | Delete a professional. |
Categories & Services
| Method | Path | Purpose |
|---|---|---|
| GET | /business-categories | List business categories. |
| GET | /professional-categories | List professional categories. |
| GET | /professional-services | List professional services. |
| POST | /professional-services | Create a professional service. |
| PATCH | /professional-services/{id} | Update a professional service. |
| DELETE | /professional-services/{id} | Delete a professional service. |
Week Schedules
| Method | Path | Purpose |
|---|---|---|
| GET | /week-schedules | List week schedules for the current business. |
| POST | /week-schedules | Create a week schedule. |
| PATCH | /week-schedules/{id} | Update a week schedule. |
| DELETE | /week-schedules/{id} | Delete a week schedule. |