Clientes

Parámetros en la cabecera HTTP

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

URL base

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

Obtener los clientes

Parámetros

search (caracteres): Campo de búsqueda, puedes buscar por correo, nombre, cif, etc. Opcional.
page (número entero): Página actual. Opcional.
perPage (número entero): Cantidad de registros por página. Opcional.

GET /

{
  "search": "B188888888",
  "page": 1,
  "perPage": 20
}

Respuesta

{
  "success": true,
  "message": "OK",
  "data": {
    "data": [
      {
        "id": 9999,
        "name": "USER CUSTOMER",
        "active": 1,
        "access": {
          "email": "test@example.es"
        },
        "profile": {
          "identificacion": 1,
          "dni": "B188888888",
          "razon_social": "CUSTOMER",
          "codigo_postal": "01005",
          "direccion": "CALLE",
          "country": 724,
          "account": [
            {
              "id": 9999,
              "activa": 1,
              "alias": "CUSTOMER",
              "convenio_colectivo": "60888888888888",
              "cuenta": "28199993333",
              "regimen": "0111",
            }
          ],
          "parameters": {
            "representativeData": {
                "doc": "77056403D",
                "name": "JOSE",
                "surname": "APELLIDO",
                "job_position": "ADMINISTRADOR"
            }
          }
        }
      }
    ],
    "pagination": {
      "page": 1,
      "lastPage": 1,
      "perPage": 50,
      "total": 2
    }
  }
}

Guardar un 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.
not_notify (boolean): NO notificar al cliente de la creación del usuario, posibles valores: 1 = NO notificar al cliente, 0 = Notificar al cliente
profile (objeto) : Datos de perfil del cliente.
- dni (caracteres) : CIF de la empresa
- 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.
  - representativeData (objeto) : Datos del representante de la empresa.
    - doc (caracteres) : Documento Nacional de Identidad.
    - name (caracteres) : Nombre del representante.
    - surname (caracteres) : Apellido del representante.
    - job_position (caracteres) : cargo del representante.

POST /

{
    "name": "NOMBRE DE LA EMPRESA",
    "access": {
        "email": "test@example.es",
        "password": 123456,
        "password_confirmation": 123456
    },
    "not_notify": 1,
    "profile": {
        "dni": "B46469763",
        "razon_social": "NOMBRE DE LA EMPRESA",
        "codigo_postal": "01005",
        "direccion": "calle alava...",
        "account": [
            {
                "activa": 1,
                "alias": "Regimen de madrid",
                "cuenta": "28148369999",
                "regimen": "0111"
            },
            {
                "activa": 0,
                "alias": "Regimen de prueba",
                "anulada": 0,
                "cuenta": "13119940999",
                "regimen": "0112"
            }
        ],
        "parameters": {
            "representativeData": {
                "doc": "77056403D",
                "name": "JOSE",
                "surname": "APELLIDO",
                "job_position": "ADMINISTRADOR"
            }
        }
    }
}

Respuesta

{
  "success": true,
  "message": "OK",
  "data": {
    "id": 9999,
    "name": "NOMBRE DE LA EMPRESA",
    "access": {
        "email": "test@example.es"
    },
    "...": "..."
  }
}

Eliminar un cliente

Parámetros

id (número entero): ID del cliente.

DELETE /{customerID}

customerID

Respuesta

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

Desactivar un cliente

Parámetros

id (número entero): ID del cliente.
active (número entero) : Posibles valores:
- true: Activar
- false: Desactivar

PUT /{customerID}/activate

{
  "active": false,
}

Respuesta

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

Cerrar sesión Obtener los clientes