Algebraix logo
Powered by Redocly

Ingresos

Obtener estadísticas de ingresos

Con esta información puedes obtener ingresos por estudiante, desglose por estudiante y conceptos, desglose por grupo actual y grupo de cobro

Request
query Parameters
process_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del proceso

Puedes encontrar más información sobre cómo obtenerlo en la documentación de Procesos de estadísticas de ingresos

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/finance/charges/income/stats
Request samples 
Response samples 
application/json
[
  • {
    }
]
Crear proceso para estadísticas de ingresos
Crear proceso en segundo plano para obtener las estadísticas de ingresos


Request 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
period_ids
required
Array of strings (id) 
Filtar por identificadores únicos del periodo


 
group_ids
required
Array of strings (id) 
Identificador único del grupo 


Puedes implementar estos Ids para búsqueda de estudiantes dados de baja, solicitantes y gradudados:






Valor
Descripción





SOLICIT0
Solicitante




GRADUATE
Graduado




DEACTIVE
Desactivado





 
start_date
required
string <date>  (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha de inicio


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas


 
end_date
required
string <date>  (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Fecha final


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas


 
exclude_refunds
boolean
No incluir folios con devolución emitida


 
required
Array of objects  non-empty 
Filtro de cobros


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/finance/charges/income/stats
Request samples 
application/json
{
  • "period_ids": [
    ],
  • "group_ids": [
    ],
  • "start_date": "2024-01-01",
  • "end_date": "2024-11-11",
  • "exclude_refunds": true,
  • "charges": [
    ]
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "VDFER34S",
  • "message": "Process created"
}
Obtener ingresos por tipo de cobro
Con esta información puedes obtener desglose de ingresos por tipo de cobro


Request 
query Parameters
process_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del proceso


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Procesos de estadísticas de ingresos


 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/finance/charges/types/income/stats
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Obtener estadísticas de ingresos por familia
Con esta información puedes obtener desglose de familia y periodo


Request 
query Parameters
process_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del proceso


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Procesos de estadísticas de ingresos


 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/finance/charges/income/families/stats
Request samples 
Response samples 
application/json
[
  • {
    }
]
Obtener estadísticas de ingresos por dia
Con esta información puedes obtener desglose por día


Request 
query Parameters
process_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del proceso


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Procesos de estadísticas de ingresos


 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/finance/charges/income/perday/stats
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Adeudos