Social Security

Social Security

Connect your applications with social security functions.

Parameters in the HTTP header

  • Authorization (characters): API Authorization. Example: Bearer {token}
  • X-Cert-Secret (characters): Secret key associated with the client's certificate.

Base URL

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

Issues

Issues received in the Social Security API or validation errors.

Response parameters

  • success (boolean): Response "true" when everything is okay, and "false" when there are issues.
  • message (characters): The response message.
  • errors (array) : The issues captured in the API, whether from Social Security or validation errors.
    • tgss: Issues related to Social Security.
    • regimen: Validation issues.
  • maintenance (boolean): When Social Security is under maintenance.

Response

Response
{
  "success": false,
  "message": "Página no operativa, inténtelo de nuevo más tarde. StatusCode: 500",
  "status": 500,
  "data": [],
  "errors": {
    "tgss": [
      "Página no operativa, inténtelo de nuevo más tarde. StatusCode: 500"
    ],
    "regimen": ["El campo regimen es obligatorio."]
  },
  "maintenance": true
}

Enroll an employee

Parameters

Note for TEPs (Temporary Employment Companies):

  • cesion_regimen (integer) : Regime, 4 digits. Possible values:
  • cesion_ccc (integer) : Contribution Account, 11 digits.
  • cesion_tipo (integer) : Possible values:
    • 01: Labor Enclave
    • 02: Temporary Employment Agency (TEP)
    • 03: Subcontracting of Works and Services
    • 04: Nautical Management
POST /alta
{
  "test": 1,
  "regimen": "0111",
  "ccc": 12345678901,
  "nss": 123456789012,
  "identificacion": 1,
  "dni": "12345678A",
  "fecha_real": "2023-01-01",
  "grupo_cotizacion": 12,
  "tipo_contrato": 402,
  "cno": 1234,
  "category_professional": 1234567,
  "coeficiente": "500",
  "rlce": 1234,
  "worker_collective": 123,
  "ocupacion": "a",
  "convenio": 12345678901234,
  "modalidad_ctz": 2,
  "fic": "2023-02-01",
  "duplicate": 1
}

Response

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "file": {
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    },
    "idc": {
      // If sent, obtener_idc = 1
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    }
  }
}

Remove an enrollment record

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, maximum 4 digits. Possible values:
  • ccc (integer): Contribution Account, maximum 11 digits.
  • dni (characters): National Identity Document.
  • nss (integer): Social Security Number, maximum 12 digits.
  • fecha_real (date): Registration date, format YYYY-MM-DD.
DELETE /alta
{
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OK"
}

Dismiss an employee

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • identificacion (integer): Identification number, possible values: -1: National ID (DNI) -2: Passport -6: Foreigner Identification (NIE)
  • dni (string): National Identity Document.
  • situacion (integer): Situation code, 2 digits. Possible values:
  • fecha_real (date): Start date, formatted as YYYY-MM-DD.
  • fecha_vacaciones (date): Vacation date, formatted as YYYY-MM-DD. Optional.
  • indicativoSAA (integer): Mandatory field for terminations to report paid vacation, up to 3 digits. Optional.
  • duplicate (integer): Retrieve the PDF in base64 and JSON format in the response, possible values: 1 or null. Optional.
POST /baja
{
  "test": 1,
  "regimen": "0111",
  "ccc": 12345678901,
  "nss": 123456789012,
  "identificacion": 1,
  "dni": "12345678A",
  "situacion": 93,
  "fecha_real": "2023-11-01",
  "fecha_vacaciones": "2024-07-15",
  "indicativoSAA": 123,
  "duplicate": 1
}

Response

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

Remove a termination record

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integers): Regime, maximum 4 digits. Possible values:
  • ccc (integers): Contribution Account, maximum 11 digits.
  • dni (characters): National Identity Document.
  • nss (integers): Social Security Number, maximum 12 digits.
  • fecha_real (date): Date of baja, format YYYY-MM-DD.
DELETE /baja
{
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OK"
}

Duplicate of an enrollment or a termination

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • startDate (date): Date, in the format YYYY-MM-DD.
  • movType (characters): Movement type, possible values:
    • ALTA
    • BAJA
GET /duplicate-ta
{
  "regimen": "0111",
  "ccc": "12345678901",
  "nss": "123456789011",
  "startDate": "2023-01-01",
  "movType": "ALTA"
}

Response

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

Life work report of an affiliate

Parameters

GET /life-affiliate
{
  "regimen": "0111",
  "ccc": "12345678901",
  "nss": "123456789011"
}

Response

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

Contribution data report (IDC)

Parameters

  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • startDate (date): Date, format YYYY-MM-DD.
GET /duplicate-idc
{
  "regimen": "0111",
  "ccc": "12345678901",
  "nss": "123456789011",
  "startDate": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OK",
  "data": {
    "date": "2022-01-01", // fecha de IDC
    "file": {
      "contentType": "application/pdf",
      "name": "document.pdf",
      "content": "base64"
    }
  }
}

Update occupation

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • dni (string): National ID document.
  • fecha_real (date): Enrollment date, formatted as YYYY-MM-DD.
  • ocupacion (string): Employee occupation, optional. Possible values:
  • duplicate (integer): Retrieve the PDF in base64 and JSON format in the response, possible values are 1 or null. Optional.
PUT /occupation
{
  "test": 1,
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01",
  "ocupacion": "a",
  "duplicate": 1
}

Response

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

Update contribution group

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • dni (string): National ID document.
  • fecha_real (date): Date of registration, format YYYY-MM-DD.
  • grupo_cotizacion (integer): Contribution group, 2 digits. Possible values:
  • duplicate (integer): Get the PDF in base64 and in JSON format in the response, possible values are 1 or null. Optional.
PUT /quote-group
{
  "test": 1,
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01",
  "grupo_cotizacion": "01",
  "duplicate": 1
}

Response

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

Update professional category

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • dni (characters): National ID document.
  • fecha_real (date): Date of registration, format YYYY-MM-DD.
  • category_professional (integer): Professional category, 7 digits. Possible values:
  • duplicate (integer): Get the PDF in base64 and in JSON format in the response, possible values are 1 or null. Optional.
PUT /category-professional
{
  "test": 1,
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01",
  "category_professional": "6100305",
  "duplicate": 1
}

Response

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

Update National Classification of Occupations (CNO)

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • dni (characters): National ID document.
  • fecha_real (date): Date of registration, format YYYY-MM-DD.
  • cno (integer): National Classification of Occupations, 4 digits. Possible values:
  • duplicate (integer): Get the PDF in base64 and in JSON format in the response, possible values are 1 or null. Optional.
PUT /cno
{
  "test": 1,
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "fecha_real": "2023-01-01",
  "cno": "1212",
  "duplicate": 1
}

Response

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

Update employment contract or rate

Parámetros

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • nss (integer): Social Security Number, 12 digits.
  • dni (characters): National Identity Document.
  • startDate (date): Date of change, formatted as YYYY-MM-DD.
  • contractType (integer): Contract type, 3 digits.
  • coeficiente (integer): Partial coefficient for part-time work, up to 3 digits, optional.
  • worker_collective (integer): Worker's collective; required for contract types (402, 502, 407, 507), up to 3 digits, optional. Possible values:
PUT /contract-coeficiente
{
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "startDate": "2023-01-01",
  "contractType": "100",
  "coeficiente": "500",
  "worker_collective": "967"
}

Response

Response
{
  "success": true,
  "message": "OK"
}

Query affiliation number by DNI/NIF/NIE

Parameters

  • dni (characters): National ID document.
  • apellido1 (characters): First surname.
  • apellido2 (characters): Second surname. Optional.
GET /nss-by-ipf
{
  "dni": "12345678B",
  "apellido1": "apellido1",
  "apellido2": "apellido2"
}

Response

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "name": "NOMBRE",
    "nss": "123456789012",
    "dni": "012323132X",
    "identificacion": "1"
  }
}

Query DNI/NIF/NIE by affiliation number

Parameters

  • nss (characters): Social Security Number, maximum 12 digits.
GET /ipf-by-nss
{
  "nss": "123456789011"
}

Response

Response
{
  "success": true,
  "message": "OK",
  "data": {
    "nombres": "NOMBRE",
    "apellidos": "APELLIDOS",
    "nss": "123456789012",
    "dni": "012323132X",
    "identificacion": "1"
  }
}

Query employee's situation in the company

Parameters

  • regimen (integer) : Regime, 4 digits. Possible values:
  • ccc (integer) : Contribution Account, 11 digits.
  • dni (characters) : National Identity Document.
  • startDate (date) : Enrollment date, formatted as YYYY-MM-DD. (Optional)
  • ces (bool) : For temporary employment agencies only, indicating the company to which the worker is seconded. (Optional)
GET /employee-situations
{
  "regimen": "0111",
  "ccc": "12345678901",
  "dni": "12345678B",
  "startDate": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OK",
  "data": [
    {
      "nss": "999999999999",
      "identificacion": "1",
      "dni": "012323132X",
      "fnacimiento": "1999-12-31",
      "sexo": "M",
      "nombres": "NOMBRE",
      "apellidos": "APELLIDOS",
      "tlf": "699999999",
      "regimen": "0111",
      "ccc": "28199999999",
      "situacion": "01",
      "situacion_text": "ALTA NORMAL",
      "grupo_cotizacion": "04",
      "grupo_cotizacion_text": "AYUDANTES NO TITULA",
      "tipo_contrato": "300",
      "coef": "075",
      "fecha_alta": "2023-12-31",
      "fecha_baja": "2023-12-31"
    }
  ]
}

Average number of active employees

Parameters

  • regimen (integer): Regime, maximum 4 digits. Possible values:
  • ccc (integer): Contribution Account, maximum 11 digits.
  • endDate (date): End date, format YYYY-MM-DD.
  • startDate (date): Start date, format YYYY-MM-DD.
GET /plantilla-media
{
  "regimen": "0111",
  "ccc": "12345678901",
  "startDate": "2023-01-01",
  "endDate": "2023-01-01"
}

Response

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

Certificate of Social Security Compliance

Parameters

  • regimen (integer) : Regimen, 4 digits. Possible values:
  • ccc (integer) : Contribution Account Code (CCC), 11 digits.
  • options (number) : posibles valores:
    • 1: General
    • 3: Subvenciones
    • 7: Sin deuda a una fecha
GET /cert-corriente-tgss
{
  "regimen": "0111",
  "ccc": "12345678901",
  "options": 1
}

Response

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

Employment history report of a Contribution Account (C.C.C.)

Parameters

  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution Account, 11 digits.
  • startDate (date): Start date, format YYYY-MM-DD.
  • endDate (date): End date, format YYYY-MM-DD.
GET /life-ccc
{
  "regimen": "0111",
  "ccc": "12345678901",
  "startDate": "2023-01-01",
  "endDate": "2023-01-01"
}

Response

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

Contribution Data and Settlement period report (C.C.C.)

Parameters

  • regimen (integer) : Regime, 4 digits. Possible values:
  • ccc (integer) : Contribution Account, 11 digits.
  • startDate (date) : Start date, formatted as YYYY-MM-DD.
GET /idc-ccc
{
  "regimen": "0111",
  "ccc": "12345678901",
  "startDate": "2023-01-01"
}

Response

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

Active employees of a Contribution Account Code (C.C.C.)

Parameters

  • regimen (integer): Regime, 4 digits. Possible values:
  • ccc (integer): Contribution account, 11 digits.
  • options (number): - options (number): Possible values:
    • 1: Consolidated registrations
    • 2: Scheduled registrations
    • 3: Both
GET /employees-in-enterprise
{
  "regimen": "0111",
  "ccc": "12345678901",
  "options": 3
}

Response

Response
{
  "success": true,
  "message": "OK",
  "data": {
    "enterprise": {
      "cuenta_cotizacion": "01999999999",
      "nombre_empresa": "NOMBRE DE LA EMPRESA"
    },
    "employees": [
      {
        "nss": "289999999999",
        "identificacion": "1",
        "ipf": "09999999Q",
        "fecha_real": "31-12-2023",
        "nombres": "NOMBRE EMPLEADO",
        "situacion": "AL"
      },
      {
        "nss": "019999999990",
        "identificacion": "6",
        "ipf": "Y9999999Q",
        "fecha_real": "31-12-2023",
        "nombres": "NOMBRE EMPLEADO 3",
        "situacion": "BJ"
      },
      {
        "nss": "019999999990",
        "identificacion": "1",
        "ipf": "07777777Q",
        "fecha_real": "31-12-2023",
        "nombres": "NOMBRE EMPLEADO 2",
        "situacion": "AL"
      }
    ]
  }
}

Report of active employees in a Contribution Account (C.C.C.) (ITA)

Parameters

GET /informe-ita
{
  "regimen": "0111",
  "ccc": "12345678901"
}

Response

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

Report of employees with scheduled hires in a Contribution Account (C.C.C.)

Parameters

GET /employees-with-movement-previous
{
  "regimen": "0111",
  "ccc": "12345678901"
}

Response

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

Record of days for unpaid internships

Parameters

  • regimen (integer) : Regimen, 4 digits. Possible values:
  • ccc (integer) : Contribution Account, 11 digits.
  • nss (integer) : Social Security Number, 12 digits.
  • identificacion (integer) : Identification number, possible values: -1: National ID (DNI) -2: Passport -6: Foreigner Identification (NIE)
  • dni (string) : National Identity Document.
  • startDate (date) : Date, format YYYY-MM-DD. The day will always be 01.
  • dia_efectivo (integer) : Effective internship days. Optional.
  • dia_previsto_itat (integer) : Scheduled ITAT internship days (ITAT: Temporary Disability due to a work accident). Optional.
  • dia_previsto (integer) : Scheduled Direct Payment Internship Days. Optional.
  • indicativo_practica (string) : Internship Indicator (N = No Internship), optional. Possible values:
    • N = No Internship.
  • no_remunerada (number (1)) : 1 = Unpaid internship, if not unpaid, do not send any value. Optional
POST /pract-no-remun
{
  "regimen": "0111",
  "ccc": 12345678901,
  "nss": 123456789012,
  "identificacion": 1,
  "dni": "12345678A",
  "startDate": "2023-01-01",
  "no_remunerada": 1,
  "dia_efectivo": 1,
  "dia_previsto_itat": 2,
  "dia_previsto": 3
}

Response

Response
{
  "success": true,
  "message": "OPERACION REALIZADA CORRECTAMENTE"
}

Delete record of days for unpaid internships

Parameters

  • regimen (integer) : Regimen, 4 digits. Possible values:
  • ccc (integer) : Contribution Account, 11 digits.
  • nss (integer) : Social Security Number, 12 digits.
  • identificacion (integer) : Identification number, possible values: -1: National ID (DNI) -2: Passport -6: Foreigner Identification (NIE)
  • dni (string) : National Identity Document.
  • startDate (date) : Date, format YYYY-MM-DD. The day will always be 01.
DELETE /pract-no-remun
{
  "regimen": "0111",
  "ccc": 12345678901,
  "nss": 123456789012,
  "identificacion": 1,
  "dni": "12345678A",
  "startDate": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OPERACION REALIZADA CORRECTAMENTE"
}

Delete transfer type for Temporary Employment Agencies

Parameters

  • test (number (1)) : For testing, add the parameter test=1. For production, this must be omitted.
  • regimen (integer) : Regimen, 4 digits. Possible values:
  • ccc (integer) : Contribution Account, 11 digits.
  • cesion_regimen (integer) : Regimen, 4 digits.
  • cesion_ccc (integer) : Contribution Account, 11 digits.
  • identificacion (integer) : Identification number, possible values: -1: National ID (DNI) -2: Passport -6: Foreigner Identification (NIE)
  • dni (string) : National Identity Document.
  • nss (integer) : Social Security Number, 12 digits.
  • startDate (date) : Registration date, format YYYY-MM-DD.
DELETE /alta
{
  "regimen": "0111",
  "ccc": "12345678901",
  "cesion_regimen": "0111",
  "cesion_ccc": "12345678901",
  "dni": "12345678B",
  "nss": "123456789011",
  "startDate": "2023-01-01"
}

Response

Response
{
  "success": true,
  "message": "OK"
}

Informe de Situación de un C.C.C.

Parámetros

GET /report-situation-ccc
{
  "regimen": "0111",
  "ccc": "12345678901"
}

Respuesta

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

Duplicado de documentos de empresarios

Parámetros

GET /report-duplicate-businessmen
{
  "regimen": "0111",
  "ccc": "12345678901"
}

Respuesta

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

Consulta certificados e informes de deuda

Parámetros

GET /report-certificates-debt
{
  "regimen": "0111",
  "ccc": "12345678901"
}

Respuesta

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

Household Regime (Régimen del Hogar)

Operations for managing household employees in the Social Security system.

Base URL

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

Register a household employee

Register a new employee in the household regime.

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • ccc (integer): Contribution Account, 11 digits.
  • datos_trabajador (object): Worker's information.
    • DOC (characters): National Identity Document.
    • SEL_IPF_TIPO (integer): Identification type, optional. Possible values:
      • 1: National ID (DNI)
      • 2: Passport
      • 6: Foreigner Identification (NIE)
    • NSS (integer): Social Security Number, 12 digits.
  • datos_alta (object): Registration information.
    • FECHA_INI_ACTIVIDAD (date): Start date of activity, format YYYY-MM-DD.
    • TIPO_CONTRATO (integer): Contract type, 3 digits. Possible values:
      • 100: Full-time contract (indefinite)
      • 200: Part-time contract (indefinite)
      • 300: Discontinuous fixed contract
      • 401: Temporary full-time contract (for specific work/service)
      • 402: Temporary full-time contract (for production circumstances)
      • 501: Temporary part-time contract (for specific work/service)
      • 502: Temporary part-time contract (for production circumstances)
    • RETRIBUCION_MENSUAL (float): Monthly salary.
    • PERSONA_DED_CUIDADO_FN (characters): Person dedicated to the care of a large family, values: "S" (Yes) or "N" (No).
    • SALARIO_ESPECIE (float): Salary in kind, optional.
    • PACTO_HORAS_PRESENCIA (characters): Agreement for presence hours, optional, values: "S" (Yes) or "N" (No).
    • NUM_HORAS_PRESENCIA (integer): Number of presence hours, optional.
    • RET_HORAS_PRES_PACTADAS (float): Remuneration for agreed presence hours, optional.
    • PACTO_PERNOCTA (characters): Overnight stay agreement, optional, values: "S" (Yes) or "N" (No).
    • RET_PACTO_PERNOCTA (float): Remuneration for overnight stay, optional.

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

  • TRABAJADOR_HOR_REG_EXT (characters): Worker by hours external regime, values: "S" (Yes) or "N" (No).

  • HORAS_TM (integer): Monthly working hours.

  • MINUTOS_TM (integer): Monthly working minutes, optional.

  • NUM_HORAS_TRAB_SEMANA (integer): Weekly working hours, optional.

  • SALARIO_HORA (float): Hourly wage.

  • datos_bancarios (object): Banking information, optional.

    • IPF_NOMBRE (characters): Account holder's name.
    • NUMDOCUMENTO (characters): Document number.
    • IBAN (characters): 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

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

Dismiss a household employee

Register the termination of a household employee.

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • ccc (integer): Contribution Account, 11 digits.
  • datos_trabajador (object): Worker's information.
    • DOC (characters): National Identity Document.
    • SEL_IPF_TIPO (integer): Identification type, optional. Possible values:
      • 1: National ID (DNI)
      • 2: Passport
      • 6: Foreigner Identification (NIE)
    • NSS (integer): Social Security Number, 12 digits.
  • datos_baja (object): Termination information.
    • FECHA_CESE (date): Termination date, format YYYY-MM-DD.
    • SEL_SELEC_CAUSA (integer): Cause of termination, 2 digits. Common values:
      • 51: Voluntary resignation
      • 54: Contract termination
      • 56: Contract expiration
      • 65: Dismissal
    • DIAS_VACACIONES (integer): Vacation days, optional.
POST /hogar/baja
{
  "test": 1,
  "ccc": "12345678901",
  "datos_trabajador": {
    "DOC": "12345678A",
    "SEL_IPF_TIPO": 1,
    "NSS": "123456789012"
  },
  "datos_baja": {
    "FECHA_CESE": "2023-01-31",
    "SEL_SELEC_CAUSA": "51",
    "DIAS_VACACIONES": 0
  }
}

Response

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

Remove a household employee registration

Remove a previously submitted registration for a household employee.

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • ccc (integer): Contribution Account, 11 digits.
  • datos_trabajador (object): Worker's information.
    • DOC (characters): National Identity Document.
    • SEL_IPF_TIPO (integer): Identification type, optional. Possible values:
      • 1: National ID (DNI)
      • 2: Passport
      • 6: Foreigner Identification (NIE)
    • NSS (integer): Social Security Number, 12 digits.
  • datos_alta (object): Registration information.
    • FECHA_INI_ACTIVIDAD (date): Start date of activity to remove, format YYYY-MM-DD.
DELETE /hogar/alta
{
  "test": 1,
  "ccc": "12345678901",
  "datos_trabajador": {
    "DOC": "12345678A",
    "SEL_IPF_TIPO": 1,
    "NSS": "123456789012"
  },
  "datos_alta": {
    "FECHA_INI_ACTIVIDAD": "2023-01-01"
  }
}

Response

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

Update a household employee registration

Update the information of a previously registered household employee.

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • ccc (integer): Contribution Account, 11 digits.
  • datos_trabajador (object): Worker's information.
    • DOC (characters): National Identity Document.
    • SEL_IPF_TIPO (integer): Identification type, optional. Possible values:
      • 1: National ID (DNI)
      • 2: Passport
      • 6: Foreigner Identification (NIE)
    • NSS (integer): Social Security Number, 12 digits.
  • datos_alta (object): Registration information.
    • FECHA_ANTERIOR_ACTIVIDAD (date): Previous start date of activity, format YYYY-MM-DD.
    • FECHA_INICIO_ACTIVIDAD (date): New start date of activity, format YYYY-MM-DD.
    • TIPO_CONTRATO (integer): Contract type, 3 digits. Same values as in registration.
    • RETRIBUCION_MENSUAL (float): Monthly salary.
    • PERSONA_DED_CUIDADO_FN (characters): Person dedicated to the care of a large family, values: "S" (Yes) or "N" (No).
    • Other optional parameters as in registration.
PUT /hogar/alta
{
  "test": 1,
  "ccc": "12345678901",
  "datos_trabajador": {
    "DOC": "12345678A",
    "SEL_IPF_TIPO": 1,
    "NSS": "123456789012"
  },
  "datos_alta": {
    "FECHA_ANTERIOR_ACTIVIDAD": "2023-01-01",
    "FECHA_INICIO_ACTIVIDAD": "2023-01-15",
    "TIPO_CONTRATO": "100",
    "RETRIBUCION_MENSUAL": 1300,
    "PERSONA_DED_CUIDADO_FN": "N"
  }
}

Response

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

Get household employee report (duplicate)

Get a report of a household employee's registration or termination.

Parameters

  • test (number (1)): For testing, add the parameter test=1. For production, it must be omitted.
  • ccc (integer): Contribution Account, 11 digits.
  • datos_trabajador (object): Worker's information.
    • DOC (characters): National Identity Document.
    • SEL_IPF_TIPO (integer): Identification type, optional. Possible values:
      • 1: National ID (DNI)
      • 2: Passport
      • 6: Foreigner Identification (NIE)
    • NSS (integer): Social Security Number, 12 digits.
  • TIPO_RESOLUCION (characters): Resolution type, values: "A" (Registration) or "B" (Termination).
  • datos_alta (object): Registration information, optional.
    • FECHA_INI_ACTIVIDAD (date): Start date of activity, format YYYY-MM-DD, optional.
POST /hogar/report
{
  "test": 1,
  "ccc": "12345678901",
  "datos_trabajador": {
    "DOC": "12345678A",
    "SEL_IPF_TIPO": 1,
    "NSS": "123456789012"
  },
  "TIPO_RESOLUCION": "A",
  "datos_alta": {
    "FECHA_INI_ACTIVIDAD": "2023-01-01"
  }
}

Response

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