ALalegra
Centros de costos

Listar centros de costos

Endpoint que permite consultar todos los centros de costos registrados en la aplicación

get/cost-centers

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/cost-centers
  • Auth
    HTTP basic

Query parameters

startinteger

Indica a partir de cual centro de costo se desea consultar.

limitinteger

Cantidad de centros de costos a partir del inicio que se desea retornar. Por defecto retorna 30. Si este valor es mayor que 30, la aplicación retorna error.

order_direction'DESC' | 'ASC'

Orden ascendente o descendente en el cual se quieren retornar los centros de costos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_field'id' | 'name' | 'code' | 'status'

Campo por el cual se desea ordenar, las opciones posibles son id, name, code, status.

status'active' | 'inactive'

Indica el estado del centro de costo. Las opciones posibles son: active e inactive

namestring

Permite filtrar por nombre de centro de costo, teniendo en cuenta si el nombre contiene el valor establecido en el parámetro.

metadataboolean

Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los centros de costos. Actualmente la información que se envía en metadata incluye el total de centros de costos que tiene registrada la empresa.

Response

200 OK

idinteger

Identificador único que representa un centro de costo específico.

codestring

Es un código que el usuario puede darle al centro de costo.

namestring

Nombre del centro de costos.

descriptionstring

Descripción del centro de costos.

status'active' | 'inactive'

Estado del centro de costo. Las opciones posibles son:

  • active: indica que el centro de costo esta activo y se puede usar.
  • inactive: indica que el centro de costo se encuentra desactivado. No se puede usar.

Changes

No recorded changes to this operation across all 1 revision of this API.