NominexDocs
Referencia de la APIRazón Social

Listar

Descripcion general

Este endpoint permite obtener un listado paginado de las razones sociales pertenecientes a tu organización. Una razón social (legal entity) agrupa empleados y registros patronales bajo un mismo nombre fiscal. Las razones sociales eliminadas se excluyen automáticamente. El tamaño de página es fijo en 20 resultados.

legal_entity_number es un identificador secuencial por organización, estable y reutilizado como segmento de URL en PATCH y DELETE. Los números de razones sociales eliminadas no se reasignan a registros futuros. updated_at es null mientras la razón social no haya sido modificada desde su creación.

Endpoint

GEThttps://app.integranom.com/api/v1/legal-entities

Consulta multiples razones sociales


Query params

ParametroTipoRequeridoDefaultDescripcion
pageinteger ≥ 1No1Página solicitada. Valores fuera de rango o no numéricos caen a 1. El tamaño de página es fijo en 20.
active"true" | "false"No-Filtra por el flag is_active. Cualquier otro valor responde con 400.

Consulta una razon social especifica


Se puede buscar una razón social particular por su número (org-scoped) o por nombre exacto (recortado). Los nombres no son únicos dentro de la organización.

Query params

ParametroTipoRequeridoDefaultDescripcion
legal_entity_numberinteger positivoNo-Filtra por número exacto. Debe ser entero positivo; cualquier otro valor responde con 400.
namestringNo-Filtra por nombre exacto (recortado).

Forma del recurso

Cada elemento de results[] (y cada respuesta de POST/PATCH single) tiene la siguiente forma:

CampoTipoNotas
legal_entity_numberintegerIdentificador secuencial por organización. Estable, reutilizado como segmento de URL. Los números de razones sociales eliminadas no se reasignan.
namestringRazón social. No es necesario que sea única dentro de la organización.
is_activebooleanControlado por el usuario. Independiente del borrado — una razón social inactiva sigue apareciendo en GET (salvo que filtres con active=false).
created_attimestamp ISO 8601 (UTC)
updated_attimestamp ISO 8601 (UTC) | nullnull mientras la razón social no haya sido modificada desde su creación.

Errores

StatusCausa
400legal_entity_number no es entero positivo; o active no es "true"/"false".
401API key ausente o inválida.
403API key no vinculada a una organización, o no autorizada para esta operación.
500Error no manejado. Cuerpo: { "message": "Internal Server Error" }.
Abrir Nominex