gigstack API
  1. Services
gigstack API
  • Welcome to gigstack API
  • gigstack Connect API Guide
  • Migrar de API v1 a v2 de gigstack
  • Clients
    • Clients API Guide
    • List clients
      GET
    • Get client
      GET
    • Update client
      PUT
    • Create client
      POST
    • Validate client fiscal information
      POST
    • Get client customer portal access token
      POST
    • Stamp pending receipts
      POST
    • Delete client
      DELETE
  • Services
    • Services API Guide
    • List services
      GET
    • Get service
      GET
    • Update service
      PUT
    • Create service
      POST
    • Delete service
      DELETE
  • Invoices
    • Invoices API Guide
    • Income
      • List income invoices
      • Get income invoice
      • Create income invoice
    • Egress
      • List egress invoices
      • Get egress invoice
      • Create egress invoice
    • Get invoice files
      GET
    • Cancel invoice
      DELETE
  • Payments
    • Payments API Guide
    • List payments
      GET
    • Get payment
      GET
    • Request payment
      POST
    • Register payment
      POST
    • Mark payment as paid
      POST
    • Refund payment
      POST
    • Cancel payment
      DELETE
  • Receipts
    • Receipts API Guide
    • List receipts
    • Get receipt
    • Create receipt
    • Stamp receipt
    • Cancel receipt
  • Teams
    • Teams API Guide
    • List teams
    • Get team
    • Get team integrations
    • Get team series
    • Get team onboarding URL
    • Update team
    • Update team series
    • Update team settings
    • Create team
    • Add team member
    • Remove team member
    • Create team series
  • Users
    • Users API Guide
    • List users
    • Get user
    • Update user
    • Create user
    • Reset user password
  • Catalogs
    • Tax Regimes Catalog (Régimen Fiscal)
    • Payment Forms | Formas de pago
    • CFDI Usage Catalog (Uso CFDI)
    • Payment Methods Catalog (Método de Pago)
    • Months and Bimesters Catalog (Meses y Bimestres)
    • Invoice Relationships Catalog (Relación entre Facturas)
  1. Services

Services API Guide

Manage your product and service catalog with SAT compliance codes. The Services API handles product/service definitions, tax configurations, and pricing for use in invoices and payments.

📋 Overview#

Services represent the items you sell or provide. Each service includes SAT product keys, unit keys, pricing, and tax configurations required for Mexican tax compliance.

🔑 Key Features#

SAT Product Keys - Proper classification for CFDI compliance
Tax Configuration - IVA, ISR, IEPS support with rates
SKU Management - Internal product identification
Auto-creation - Create services during invoice/payment flow
Flexible Pricing - Unit prices with currency support

📚 Endpoints#

List Services#

Retrieve a paginated list of services in your catalog.
Query Parameters:
limit (integer, 1-100) - Number of results per page (default: 10)
next (string) - Pagination cursor for next page
team (string) - gigstack Connect: Target team ID
Example Request:
Example Response:
{
    "message": "Services retrieved successfully",
    "data": [
        {
            "id": "service_1234567890",
            "description": "Consulting services",
            "sku": "CONS-001",
            "product_key": "80141503",
            "unit_key": "E48",
            "unit_name": "Servicio",
            "unit_price": 1000.0,
            "taxes": [
                {
                    "type": "IVA",
                    "rate": 0.16,
                    "factor": "Tasa",
                    "withholding": false
                }
            ],
            "team": "team_1234567890",
            "created_at": 1677651234
        }
    ],
    "has_more": false,
    "total_results": 1
}

Create Service#

Create a new service in your catalog.
Request Body:
{
    "description": "Professional consulting services",
    "sku": "CONS-001",
    "product_key": "80141503",
    "unit_key": "E48",
    "unit_name": "Servicio",
    "unit_price": 1500.0,
    "taxes": [
        {
            "type": "IVA",
            "rate": 0.16,
            "factor": "Tasa",
            "base": "01",
            "inclusive": false,
            "withholding": false
        }
    ]
}
Example Request:

Get Service#

Retrieve a specific service by ID.
Example Request:

Update Service#

Update an existing service's information.
Example Request:

Delete Service#

Delete a specific service from your catalog.
Example Request:

🏗️ Service Structure#

Important Fields#

FieldTypeDescriptionExample
descriptionstringService description"Consulting services"
skustringStock Keeping Unit"CONS-001"
product_keystringSAT product key (8 digits)"80141503"
unit_keystringSAT unit key"E48"
unit_namestringUnit display name"Servicio"
unit_pricenumberPrice per unit1000.00
taxesarrayTax configurationSee Tax Configuration

📊 Tax Configuration#

Tax Object Structure#

{
    "type": "IVA", // Tax type: IVA, ISR, IEPS
    "rate": 0.16, // Tax rate (0.16 = 16%)
    "factor": "Tasa", // SAT factor type
    "base": "01", // Tax base code
    "inclusive": false, // If tax is included in price
    "withholding": false // If this is a withholding tax
}

Common Tax Configurations#

Standard 16% IVA#

{
    "type": "IVA",
    "rate": 0.16,
    "factor": "Tasa",
    "withholding": false
}

10% ISR Withholding#

{
    "type": "ISR",
    "rate": 0.1,
    "factor": "Tasa",
    "withholding": true
}

Zero IVA (Exempt)#

{
    "type": "IVA",
    "rate": 0.0,
    "factor": "Exento",
    "withholding": false
}

🗂️ Common SAT Product Keys#

CategoryProduct KeyDescription
Consulting80141503Business consulting
Software81111500Software development
Web Services81112100Web hosting services
Training86101604Training services
Design82121500Graphic design
Marketing80141600Marketing services
Legal84111500Legal services
Accounting84111600Accounting services
Medical85121600Medical services
Construction72121400Construction services

📏 Common SAT Unit Keys#

Unit KeyDescriptionUse Case
E48ServicioServices
H87PiezaIndividual pieces
EAElementoElements/Items
ACTActividadActivities
MONMesMonthly services
ANNAñoAnnual services
HURHoraHourly services
DAYDíaDaily services
KGMKilogramoWeight-based
MTRMetroLength-based

🔍 Search and Auto-Creation#

When creating invoices or payments, you can search for existing services or auto-create them:
{
    "items": [
        {
            "search": {
                "on_key": "sku",
                "on_value": "CONS-001",
                "auto_create": true
            },
            "description": "Consulting services",
            "sku": "CONS-001",
            "product_key": "80141503",
            "unit_key": "E48",
            "unit_price": 1000.0,
            "quantity": 2,
            "taxes": [
                {
                    "type": "IVA",
                    "rate": 0.16
                }
            ]
        }
    ]
}

🎯 Use Cases#

1. Professional Services Company#

{
    "description": "Legal consultation - 1 hour",
    "sku": "LEGAL-HR",
    "product_key": "84111500",
    "unit_key": "HUR",
    "unit_name": "Hora",
    "unit_price": 3000.0,
    "taxes": [
        {
            "type": "IVA",
            "rate": 0.16,
            "withholding": false
        },
        {
            "type": "ISR",
            "rate": 0.1,
            "withholding": true
        }
    ]
}

2. E-commerce Product#

{
    "description": "Laptop Computer",
    "sku": "LAPTOP-001",
    "product_key": "43211500",
    "unit_key": "H87",
    "unit_name": "Pieza",
    "unit_price": 15000.0,
    "taxes": [
        {
            "type": "IVA",
            "rate": 0.16,
            "withholding": false
        }
    ]
}

3. Subscription Service#

{
    "description": "Software subscription - Monthly",
    "sku": "SAAS-MONTHLY",
    "product_key": "81111500",
    "unit_key": "MON",
    "unit_name": "Mes",
    "unit_price": 500.0,
    "taxes": [
        {
            "type": "IVA",
            "rate": 0.16,
            "withholding": false
        }
    ]
}

💡 Best Practices#

1.
Always use correct SAT codes - Ensure product_key and unit_key match SAT catalogs
2.
Configure taxes properly - Include all applicable taxes (IVA, ISR, IEPS)
3.
Use meaningful SKUs - Create a consistent SKU system for internal tracking
4.
Include detailed descriptions - Help clients understand what they're paying for
5.
Set up common services - Pre-create frequently used services
6.
Update prices regularly - Keep pricing current with market conditions

🔗 Related Resources#

Invoices API - Use services in invoices
Payments API - Include services in payment requests
Teams API - Configure default tax settings

🚨 Error Handling#

Invalid Product Key#

{
    "message": "Invalid product_key",
    "error": "Product key must be 8 digits from SAT catalog"
}

Invalid Tax Configuration#

{
    "message": "Invalid tax configuration",
    "error": "Tax rate must be between 0 and 1"
}

Service Not Found#

{
    "message": "Service not found",
    "error": "The specified service does not exist"
}

Need help with service configuration? Check our support documentation or contact support@gigstack.io
Modified at 2025-08-26 16:41:41
Previous
Delete client
Next
List services
Built with