Clients

Parameters in the HTTP header

Authorization (characters): API Authorization. Example: Bearer {token}

Base URL

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

Get clients

Parameters

search (characters): Search field. Optional.
page (integer): Current page. Optional.
perPage (integer): Number of records per page. Optional.

GET /

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

Response

{
  "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
    }
  }
}

Save a client

Parameters

name (characters) : Client name.
access (object) : Access data.
- email (characters) : Email.
- password (characters) : Password.
- password_confirmation (characters) : Password confirmation.
profile (object) : Client profile data.
- dni (characters) : CIF
- razon_social (characters) : Business name, company name.
- account (array) : Contribution accounts, at least one account is required.
  - regimen (characters) : Account regime.
  - cuenta (characters) : Contribution account.
  - alias (characters) : Account alias.
  - convenio_colectivo (characters) : Collective agreement. Optional.
- parameters (array) : Client parameters. Optional.
  - educational_levels (array) : Educational level parameters. Optional.
  - categories_professional (array) : Professional category parameters. Optional.
  - quote_group (array) : Contribution group parameters. Optional.
  - contracts (array) : Contract parameters. Optional.
  - cnos (array) : National Classification of Occupations (CNO) parameters. Optional.

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"]
    }
  }
}

Response

{
  "success": true,
  "message": "OK",
  "data": {
    "id": 9999,
    "...": "..."
  }
}

Delete a client

Parameters

id (integer): Client ID.

DELETE /{customerID}

customerID

Response

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

Sign out Get clients