NominexDocs
Referencia de la APIContratos

Listar

Descripcion general

Este endpoint permite obtener un listado paginado de los contratos pertenecientes a tu organización. Los resultados se devuelven en formato JSON e incluyen metadatos de paginación. Cada contrato es propiedad de la organización y se comparte entre varias razones sociales mediante un puente (relación M:N), por lo que expone el arreglo legal_entity_numbers con las RS vinculadas y el arreglo concept_numbers con los conceptos de nómina extralegales que adjunta. El campo contract_type corresponde a un código SAT c_TipoContrato (p. ej. "01" para indeterminado). Los contratos eliminados se excluyen automáticamente.

Endpoint

GEThttps://app.integranom.com/api/v1/contracts

Consulta multiples contratos


Query params

ParametroTipoRequeridoDefaultDescripcion
pageinteger ≥ 1No1Página solicitada. El tamaño de página es fijo en 20.
active"true" | "false"No-Filtra por el flag is_active.

Consulta contratos filtrados


Se pueden acotar los resultados por número de contrato, por tipo de contrato SAT o por razón social. Todos los filtros hacen coincidencia exacta y se pueden combinar; legal_entity_number devuelve los contratos vinculados a esa RS.

Query params

ParametroTipoRequeridoDefaultDescripcion
contract_numberintegerNo-Filtra por número de contrato exacto.
contract_typestringNo-Filtra por código SAT c_TipoContrato (coincidencia exacta).
legal_entity_numberintegerNo-Devuelve los contratos vinculados a esa razón social.

Cada contrato de la respuesta incluye además template_key, is_legal_default, concept_calculations, concept_values (los montos fijos y las fórmulas de fracción del salario, en el formato anterior) y todas las prestaciones, más year_end_bonus_discounts_absences y year_end_bonus_days, que es null cuando la tabla de aguinaldo cambia con la antigüedad.

Errores

StatusCausa
400Valor inválido en alguno de los filtros (page, contract_number, contract_type, legal_entity_number o active).
401API key ausente o inválida.
Abrir Nominex