GET /api/catalogos/periodo-nomina/{id}/

GET /api/catalogos/periodo-nomina/{id}/

Base de solo lectura para catálogos simples (código + nombre).

operationId: catalogos_periodo_nomina_retrieve

Autenticación

Cualquiera de estas credenciales:

• LlaveApi — Llave de API de una integración. El valor completo es Api-Key <prefijo>.<secreto>, tal como lo imprime manage.py crear_llave_api. La llave alcanza exactamente los mismos emisores que la persona a cuyo nombre se creó.

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	path	integer	sí	Un valor de entero único que identifique este periodo de nómina.

Ejemplo

curl "https://api.rededoc.uk/api/catalogos/periodo-nomina/<id>/" \
  -H "Authorization: <llaveapi>"

Respuestas

Código	Descripción
200
401	Error
404	Error
429	Error

200 — cuerpo

Campo	Tipo	Descripción
id	integer	Solo lectura.
codigo	string
nombre	string
activo	boolean

{
  "id": 1,
  "codigo": "texto",
  "nombre": "texto",
  "activo": true
}

401 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

404 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}

429 — cuerpo

Campo	Tipo	Descripción
detail	string	Mensaje para mostrar a la persona.
errores	array<object>	Nunca vacía. Cada error trae codigo, que es lo que el cliente mapea —los de DRF tal cual (required, invalid, does_not_exist, not_found…) y los propios en español (campo_desconocido, solicitud_invalida…)—, y mensaje, para la persona. Si el error es de un campo, su ruta va delante del mensaje: detalles[0].impuestos[0].tributo: Este campo es obligatorio.

{
  "detail": "texto",
  "errores": [
    {
      "codigo": "texto",
      "mensaje": "texto"
    }
  ]
}