Services
Services
Overview
Endpoints
POST /v2/services
Request Body
{
"name": "Web Development",
"description": "Custom web application development services",
"category": "Development",
"price": 1500.0,
"currency": "MXN",
"unit": "hour",
"taxRate": 16.0,
"isActive": true,
"metadata": {
"skillLevel": "Senior",
"estimatedHours": "40-80",
"deliveryTime": "2-4 weeks"
}
}Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Service name |
description | string | No | Service description |
category | string | No | Service category |
price | number | No | Default service price |
currency | string | No | Currency code (default: MXN) |
unit | string | No | Pricing unit (hour, project, etc.) |
taxRate | number | No | Tax rate percentage |
isActive | boolean | No | Service availability status |
metadata | object | No | Additional service information |
Response
{
"data": {
"id": "service_789",
"name": "Web Development",
"description": "Custom web application development services",
"category": "Development",
"price": 1500.0,
"currency": "MXN",
"unit": "hour",
"taxRate": 16.0,
"isActive": true,
"metadata": {
"skillLevel": "Senior",
"estimatedHours": "40-80",
"deliveryTime": "2-4 weeks"
},
"timestamp": "2024-01-15T10:30:00.000Z"
},
"message": "Service created successfully"
}GET /v2/services
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | number | Number of results to return (default: 20, max: 100) |
offset | number | Number of results to skip |
name | string | Filter by service name (partial match) |
category | string | Filter by service category |
isActive | boolean | Filter by active status |
minPrice | number | Filter by minimum price |
maxPrice | number | Filter by maximum price |
Response
{
"data": [
{
"id": "service_789",
"name": "Web Development",
"description": "Custom web application development services",
"category": "Development",
"price": 1500.0,
"currency": "MXN",
"unit": "hour",
"isActive": true,
"timestamp": "2024-01-15T10:30:00.000Z"
}
],
"message": "Services retrieved successfully",
"totalResults": 1,
"hasMore": false,
"next": null
}GET /v2/services/{serviceId}
Response
{
"data": {
"id": "service_789",
"name": "Web Development",
"description": "Custom web application development services",
"category": "Development",
"price": 1500.0,
"currency": "MXN",
"unit": "hour",
"taxRate": 16.0,
"isActive": true,
"metadata": {
"skillLevel": "Senior",
"estimatedHours": "40-80",
"deliveryTime": "2-4 weeks"
},
"timestamp": "2024-01-15T10:30:00.000Z"
},
"message": "Service retrieved successfully"
}PUT /v2/services/{serviceId}
Request Body
{
"price": 1800.0,
"description": "Premium web application development services",
"isActive": true
}DELETE /v2/services/{serviceId}
Service Categories
| Category | Description |
|---|---|
| Development | Software and web development |
| Design | UI/UX and graphic design |
| Consulting | Business and technical consulting |
| Marketing | Digital marketing services |
| Support | Technical support and maintenance |
| Training | Educational and training services |
Code Examples
Create a Service
List and Filter Services
Integration with Invoices
Error Handling
Common Error Responses
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": {
"name": "Service name is required",
"price": "Price must be greater than 0",
"taxRate": "Tax rate must be between 0 and 100"
}
},
"message": "Request validation failed"
}{
"error": {
"code": "DUPLICATE_SERVICE",
"message": "A service with this name already exists in this category"
},
"message": "Service name must be unique within category"
}Best Practices
1.
2.
3.
4.
5.
6.
Service Templates
Next Steps
Modified at 2025-06-11 04:58:15