Clientes

Clientes

Parámetros en el HEADERS

  • Authorization(caracteres): Autorización de la API. Ejemplo: Bearer {token}

URL BASE:

https://api.saltra.es/api/web/v3/customer

Obtener Clientes

Parámetros

  • search(caracteres): Campo de búsqueda. Opcional.
  • page(número entero): Página actual. Opcional.
  • perPage(número entero): Cantidad de registros por página. Opcional.
GET /
search
page
perPage
Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "data": [
      {
        "id": 9999,
        "name": "USER CUSTOMER",
        "active": 1,
        "access": {
          "email": "customer@email.es"
        },
        "profile": {
          "identificacion": 1,
          "dni": "B188888888",
          "razon_social": "CUSTOMER",
          "tlf": null,
          "provincia_id": 1,
          "municipio_id": 1,
          "codigo_postal": "01005",
          "hora_convenio": "8.00",
          "direccion": "CALLE",
          "codigo_empresa": null,
          "country": 724,
          "account": [
            {
              "id": 9999,
              "activa": 1,
              "alias": "CUSTOMER",
              "anulada": 0,
              "convenio_colectivo": "60888888888888",
              "cuenta": "28199993333",
              "regimen": "0111",
              "cif": null
            }
          ],
          "parameters": {
            "quote_group": ["06", "07"],
            "contracts": ["100", "109"],
            "cnos": ["5110", "9310"],
            "categories_professional": ["6000101", "6000102"],
            "educational_levels": ["32", "33"]
          }
        }
      }
    ],
    "pagination": {
      "page": 1,
      "lastPage": 1,
      "perPage": 50,
      "total": 2
    }
  }
}

Guardar Cliente

Parámetros

  • name (caracteres) : Nombre del cliente.
  • access (objeto) : Datos de acceso.
    • email (caracteres) : Correo electrónico.
    • password (caracteres) : Contrasaseña.
    • password_confirmation (caracteres) : Confirmación de contraseña.
  • profile (objeto) : Datos de perfil del cliente.
    • dni (caracteres) : CIF
    • razon_social (caracteres) : Razón social, nombre de la empresa.
    • account (array) : Cuentas de cotización, se requiere al menos una cuenta.
      • regimen (caracteres) : Regimen de la cuenta.
      • cuenta (caracteres) : Cuenta de cotización.
      • alias (caracteres) : Alias de la cuenta.
      • convenio_colectivo (caracteres) : Convenio colectivo. Opcional.
    • parameters (array) : Parametros del cliente. Opcional.
      • educational_levels (array) : Parametros para el Nivel formativo. Opcional.
      • categories_professional (array) : Parametros para la categoría profesional. Opcional.
      • quote_group (array) : Parametros para el grupo de cotización. Opcional.
      • contracts (array) : Parametros para los contratos. Opcional.
      • cnos (array) : Parametros para los Clasificación Nacional de Ocupaciones(CNO). Opcional.
Post /
{
  "name": "USER CUSTOMER",
  "access": {
    "email": "customer@email.es",
    "password": "123456",
    "password_confirmation": "123456"
  },
  "profile": {
    "dni": "B188888888",
    "razon_social": "CUSTOMER",
    "account": [
      {
        "regimen": "0111",
        "cuenta": "28199993333",
        "alias": "CUSTOMER",
        "convenio_colectivo": "60888888888888"
      }
    ],
    "parameters": {
      "quote_group": ["06", "07"],
      "contracts": ["100", "109"],
      "cnos": ["5110", "9310"],
      "categories_professional": ["6000101", "6000102"],
      "educational_levels": ["32", "33"]
    }
  }
}
Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "id": 9999,
    "...": "..."
  }
}

Eliminar Cliente

Parámetros

  • id(número entero): ID del cliente.
DELETE /{customerID}
id
Respuesta
{
  "success": true,
  "message": "OK"
}
UsuariosCertificados