Household employees scheme
Register a household employee

Register a household employee

⚠️

Add test=1 to run tests without real effects. In production, omit this parameter.

Register a new employee under the household employees scheme.

Base URL

https://api.saltra.es/api/v4/seg-social/hogar

Parameters

  • test (number (1)): For testing, add the test=1 parameter. It must be omitted in production.
  • ccc (integer): Contribution account code, 11 digits.
  • datos_trabajador (object): Worker details.
    • DOC (string): National identity document.
    • SEL_IPF_TIPO (integer): Optional. Identification type. Possible values:
      • 1: DNI
      • 2: Passport
      • 6: NIE
    • NSS (integer): Social Security number, 12 digits.
  • datos_alta (object): Registration details.
    • FECHA_INI_ACTIVIDAD (date): Activity start date, format YYYY-MM-DD.
    • TIPO_CONTRATO (integer): Contract type, 3 digits. Possible values:
      • 100: Full-time contract (permanent)
      • 200: Part-time contract (permanent)
      • 300: Permanent seasonal contract
      • 401: Full-time temporary contract (for a specific work or service)
      • 402: Full-time temporary contract (due to production circumstances)
      • 501: Part-time temporary contract (for a specific work or service)
      • 502: Part-time temporary contract (due to production circumstances)
    • RETRIBUCION_MENSUAL (decimal): Monthly pay.
    • PERSONA_DED_CUIDADO_FN (string): Person dedicated to caring for a large family, values: "S" (Yes) or "N" (No).
    • SALARIO_ESPECIE (decimal): Optional. Payment in kind.
    • PACTO_HORAS_PRESENCIA (string): On-call hours agreement, optional, values: "S" (Yes) or "N" (No).
    • NUM_HORAS_PRESENCIA (integer): Number of on-call hours, optional.
    • RET_HORAS_PRES_PACTADAS (decimal): Optional. Pay for agreed on-call hours.
    • PACTO_PERNOCTA (string): Optional. Overnight stay agreement, values: "S" (Yes) or "N" (No).
    • RET_PACTO_PERNOCTA (decimal): Optional. Pay for the overnight stay agreement.

For part-time contracts (200, 300, 501, 502), additional parameters are required:

  • TRABAJADOR_HOR_REG_EXT (string): Hourly worker under the external scheme, values: "S" (Yes) or "N" (No).

  • HORAS_TM (integer): Monthly working hours.

  • MINUTOS_TM (integer): Optional. Monthly working minutes.

  • NUM_HORAS_TRAB_SEMANA (integer): Optional. Working hours per week.

  • SALARIO_HORA (decimal): Hourly wage.

  • datos_bancarios (object): Optional. Bank details.

    • IPF_NOMBRE (string): Name of the account holder.
    • NUMDOCUMENTO (string): Document number.
    • IBAN (string): IBAN number.
POST /hogar/alta
{
  "test": 1,
  "ccc": "12345678901",
  "datos_trabajador": {
    "DOC": "12345678A",
    "SEL_IPF_TIPO": 1,
    "NSS": "123456789012"
  },
  "datos_alta": {
    "FECHA_INI_ACTIVIDAD": "2023-01-01",
    "TIPO_CONTRATO": "100",
    "RETRIBUCION_MENSUAL": 1200,
    "PERSONA_DED_CUIDADO_FN": "N",
    "SALARIO_ESPECIE": 0,
    "PACTO_HORAS_PRESENCIA": "N",
    "PACTO_PERNOCTA": "N"
  },
  "datos_bancarios": {
    "IPF_NOMBRE": "NOMBRE APELLIDO",
    "NUMDOCUMENTO": "12345678A",
    "IBAN": "ES0012345678901234567890"
  }
}

Response

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "file": {
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    }
  }
}