Endpoints

Productos / Servicios

Los items son los productos o servicios que se facturan. Cada item pertenece a un negocio, tiene un tipo (producto vs. servicio) y un impuesto por defecto. Al emitir un comprobante, se referencian por item_id.

GET/items API Key

Lista los productos/servicios de un negocio.

Colección paginada: sin page ni perPage recibes la primera página de 25 registros y el bloque meta. Ver Paginación y filtros.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
pageint No Número de página. Por defecto 1.
perPageint No Tamaño de página. Por defecto 25, máximo 100. Alias: limit.
sortBystring No Campo de ordenamiento. Valores admitidos: id, code, auxCode, name, unitPrice, itemType, tax, createdAt. Por defecto name asc.
sortDirstring No Sentido del ordenamiento: asc o desc.
searchstring No Búsqueda parcial sobre nombre, código y código auxiliar.
itemTypeIdint No Filtra por tipo de producto/servicio.
idsstring No Lista de IDs separados por coma. Devuelve únicamente esos registros.
GET/items/{id} API Key

Obtiene un producto por su ID.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
POST/items API Key

Crea un nuevo producto o servicio.

CampoTipoRequeridoDescripción
businessIdintID del negocio.
itemTypeIdintTipo de item (ver /catalogs/item-types).
taxIdint No ID del impuesto a aplicar por defecto.
namestring(50)Nombre del producto o servicio.
defaultTaxboolSi se debe aplicar el impuesto por defecto al facturar.
codestring(10)Código principal interno del item.
auxCodestring(10)Código auxiliar (puede ser código de barras o similar).
unitPricefloatPrecio unitario sin impuestos.
json
{
  "businessId": 1,
  "itemTypeId": 1,
  "taxId": 1,
  "name": "Servicio de Consultoría",
  "defaultTax": true,
  "code": "SRV001",
  "auxCode": "AUX001",
  "unitPrice": 150.00
}
PUT/items/{id} API Key

Actualiza un producto existente.

json
{
  "name": "Servicio de Auditoría",
  "unitPrice": 200.00
}
DELETE/items/{id} API Key

Elimina (soft-delete) un producto.