Products

Update a product partially

Updates only the fields present in the body, leaving every other field of the product as it is — in particular main_tax, irpf_rate and equivalence_surcharge_rate, which PUT resets.

  • Null vs omitted: a field sent as null is cleared, which is different from omitting it (see PatchProductRequest). The result goes through the same validation as PUT.
  • Deprecated: use PATCH /v1/companies/{company_id}/products/{product_id}, which behaves identically.

Retires on 9 December 2026. See the migration guide for what moved where and what changes when you switch.

patch/v1/products/{product_id}

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/products/{product_id}
  • Auth: HTTP bearer

Request body

codestring nullable

Unique alphanumeric product code. Send null to clear it.

namestring

Product/service name. Cannot be cleared.

descriptionstring nullable

Detailed description. Send null to clear it.

category'PRODUCT' | 'SERVICE' | 'CONSULTING' | 'SOFTWARE' | 'TRAINING' | 'OTHER'

Product/service category:

  • PRODUCT - Physical, tangible products
  • SERVICE - General services
  • CONSULTING - Consulting and advisory services
  • SOFTWARE - Development, licenses, SaaS
  • TRAINING - Courses, workshops, training
  • OTHER - Other unclassified types
default_pricenumber nullable

Suggested default price. Send null to clear it.

unitstring nullable

Unit of measure. Send null to clear it.

equivalence_surcharge_ratenumber nullable

Equivalence surcharge percentage. Send null to state that none applies (equivalent to 0).

The merged result must be coherent with the regime key: if this PATCH does not send main_tax.regime_key, the stored regime is adjusted automatically (18 when the merged surcharge is > 0, 01 when it is not). With an explicit regime_key in this PATCH, an incoherent combination is rejected with a 422 (SURCHARGE_REQUIRES_REGIME / REGIME_REQUIRES_SURCHARGE).

irpf_ratenumber nullable

IRPF withholding percentage. Send null to state that none applies (equivalent to 0).

The rate must be one of IrpfPercentage (INVALID_IRPF otherwise) and one the company can bear, the same check as an invoice line (see WithholdingOptions in the tax configuration): an entity gets the rates of individuals rejected with IRPF_RATE_NOT_FOR_CORPORATE_ISSUER, and an individual gets 9.5 rejected with IRPF_RATE_ONLY_FOR_CORPORATE_ISSUER.

activeboolean

Indicates whether the product is active.

Example request

{
  "code": "SERV-001",
  "name": "Technical consulting",
  "description": "Specialized technical consulting services",
  "category": "CONSULTING",
  "default_price": 85.5,
  "unit": "hours",
  "main_tax": {
    "type": "IVA",
    "percentage": 21,
    "regime_key": "01"
  },
  "equivalence_surcharge_rate": 5.2,
  "irpf_rate": 15,
  "active": true
}

Response

Product updated successfully

successboolean required

Example response

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "code": "SERV-001",
    "name": "Technical consulting",
    "description": "Specialized technical consulting services in web development",
    "category": "CONSULTING",
    "default_price": 85.5,
    "unit": "hours",
    "main_tax": {
      "type": "IVA",
      "percentage": 21,
      "regime_key": "01"
    },
    "equivalence_surcharge_rate": 5.2,
    "irpf_rate": 15,
    "active": true,
    "created_at": "2025-01-18T10:30:00Z",
    "updated_at": "2025-01-18T15:45:30Z"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.