Ir al contenido

Referencia · Catálogos

Crear o editar un rubro

POST/serviciosRubrosAgregarEditar

Crea o edita un rubro de servicios.

La guía correspondiente está en Listar rubros.

La ruta POST /serviciosRubrosAgregarEditar se agrega a la URL base del ambiente.

Enviá los headers x-api-key y x-api-secret. Cómo obtenerlos está en Credenciales.

El cuerpo es JSON (Content-Type: application/json).

Si falta un campo obligatorio, la API rechaza la solicitud.

Campo Tipo Obligatorio Descripción Ejemplo
rubro objeto Sí Ver rubro. —
accion string Sí “agregar” crea un rubro nuevo; “editar” actualiza uno existente. agregar

Rubro a crear o modificar.

Campo Tipo Obligatorio Descripción Ejemplo
version number Sí Versión interna del registro. —
id string Sí Identificador del rubro. Hace falta para editarlo. —
codigo string Sí Código corto del rubro. —
nombre string Sí Nombre del rubro. —
padreId string | null Sí Identificador del rubro padre. null si es un rubro raíz. —
nombreCompleto string Sí Nombre incluyendo la jerarquía. —
activo boolean Sí El listado solo incluye rubros activos. —
esHoja boolean Sí true si el rubro no tiene hijos. —
ultimaEdicion number Sí Marca de tiempo de la última edición, en milisegundos. —

Rubro creado o editado correctamente

Si la operación sale bien, codigoError es "0".

Campo Tipo Obligatorio Descripción Ejemplo
descripcion string Sí — —
codigoError string Sí — —
rubro objeto | null Sí Ver rubro. —
Campo Tipo Obligatorio Descripción Ejemplo
version number Sí Versión interna del registro. —
id string Sí Identificador del rubro. Hace falta para editarlo. —
codigo string Sí Código corto del rubro. —
nombre string Sí Nombre del rubro. —
padreId string | null Sí Identificador del rubro padre. null si es un rubro raíz. —
nombreCompleto string Sí Nombre incluyendo la jerarquía. —
activo boolean Sí El listado solo incluye rubros activos. —
esHoja boolean Sí true si el rubro no tiene hijos. —
ultimaEdicion number Sí Marca de tiempo de la última edición, en milisegundos. —

Una respuesta de error trae codigoError y descripcion. El mismo código puede significar cosas distintas según el endpoint. El índice completo está en Códigos de error.

Si fallan las credenciales o el formato del body, aplican los códigos comunes: A01 a A06, V01 y V02.

Código Significado
E01 accion inválida (debe ser "agregar" o "editar")
E02 Empresa no encontrada

Error de validación

{
"descripcion": "Acción no es correcta, debe ser agregar o editar",
"codigoError": "E01",
"rubro": null
}
{
"accion": "agregar",
"rubro": {
"version": 1,
"id": "",
"codigo": "PAN",
"nombre": "Panadería",
"padreId": null,
"nombreCompleto": "Panadería",
"activo": true,
"esHoja": true,
"ultimaEdicion": 0
}
}

Usá el id del rubro obtenido desde /serviciosRubrosListado.

{
"accion": "editar",
"rubro": {
"version": 1,
"id": "REEMPLAZAR_CON_ID_RUBRO",
"codigo": "PAN",
"nombre": "Panadería y confitería",
"padreId": null,
"nombreCompleto": "Panadería y confitería",
"activo": true,
"esHoja": true,
"ultimaEdicion": 0
}
}