Este endpoint permite obtener las areas y tipos de clientes disponibles, mismos que son utilizados al momento del registro de clientes.
HTTP Request
GET https://bol.erphere.com/api/v1/cliParam__getAll
Parámetros de consulta
Párámetro | Tipo | Descripción |
---|---|---|
type | String | Tipo de parámetro que se desea listar (cliente_area o tipo_cliente) |
name | String | Nombre de parámetro |
offset | Int | Número de elementos que se deben omitir del inicio en la lista de resultados |
limit | Int | Número máximo de resultados que se deben devolver en la respuesta |
orderBy | Array | Criterio mediante el cual se deben ordenar los resultados devueltos. Por defecto: ["id","desc"] - id: Identificador de cliente - desc: Descripción de cliente |
Ejemplo de petición
curl --location --request GET 'https://bol.erphere.com/api/v1/cliParam__getAll' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 133|X5rDrmX4tzNDgWqOkAt9wNlbW1bwErXz1fs20iFv' \
--data '{
"type" : "cliente_area",
"offset" : 0,
"limit" : 3,
"orderBy" : ["id", "desc"]
}'
La petición devuelve un JSON estructurado de la siguiente manera:
{
"success": true,
"code": 200,
"results": [
{
"id": 56,
"name": "BANCA",
"description": "Rubro Financiero"
},
{
"id": 57,
"name": "ENERGIA",
"description": "Generadoras, Distribuidoras, etc."
},
{
"id": 58,
"name": "INDUSTRIA",
"description": "Alimentos, Agricola, Textil, Minera, Construccion"
}
]
}