NominexDocs
Referencia de la APIRazón Social

Editar

Actualiza parcialmente una razón social existente.

Descripcion general

Este endpoint permite actualizar parcialmente una razón social. Todos los campos del cuerpo son opcionales: si omites una clave, ese campo no se toca. El identificador en la URL es el legal_entity_number dentro de tu organización. Una solicitud exitosa devuelve 200 con la forma completa de la razón social actualizada.

Las razones sociales eliminadas se tratan como no encontradas (404).

is_active no elimina la razón social: solo la marca como inactiva, y sigue apareciendo en GET (salvo que filtres con active=false). Desactivarla (is_active: false) se rechaza con 409 si algún empleo (de cualquier estatus) la referencia — reasigna esos empleos primero. Para hacer un borrado real, usa DELETE.

Endpoint

PATCHhttps://app.integranom.com/api/v1/legal-entities/{legal_entity_number}

Path param: legal_entity_number — entero positivo. Cualquier otro valor responde con 400.

Renombrar


Envía solo los campos que quieras cambiar. El resto de la razón social queda intacta.

{ "name": "Acme Holdings S.A. de C.V." }

Marcar como inactiva


Cambiar is_active a false marca la razón social como inactiva, pero no la elimina: sigue apareciendo en GET /api/v1/legal-entities (salvo que filtres por active=true) y puede reactivarse después. La desactivación se rechaza con 409 si algún empleo (cualquier estatus, incluidos los dados de baja) referencia la razón social — primero reasígnalos. Para retirarla por completo, usa DELETE.

{ "is_active": false }

Campos del cuerpo

CampoTipoNotas
namestringNo vacío tras recortar cuando se envía.
is_activebooleanAlternar este flag no elimina la razón social: solo la marca como inactiva. Ponerlo en false se rechaza con 409 si algún empleo referencia la razón social. Para borrarla, usa DELETE.

Forma de la respuesta

200 OK — misma forma que la respuesta de crear en modo single.

Errores

StatusCausa
400legal_entity_number inválido en la URL (no es entero positivo); cuerpo JSON inválido; falla de validación de esquema.
404La razón social no existe (o fue eliminada) en esta organización. Cuerpo: { "message": "Legal entity not found." }.
409Intento de desactivar (is_active: false) una razón social referenciada por uno o más empleos. Cuerpo: { "message": "This legal entity is still referenced by one or more employments. Reassign them before deactivating it." }.
500Error no manejado. Cuerpo: { "message": "Internal Server Error" }.
Abrir Nominex