Algebraix logo
Powered by Redocly

Algebraix's REST Apis (2.0)

Download OpenAPI specification:Download

License: Algebraix

En esta sección, se presentan nuevas features que serán gradualmente integradas a la documentación principal de la API. La mayoría de los endpoints descritos en esta sección son versiones extendidas de los endpoints originales, añadiendo funcionalidades o parámetros adicionales para optimizar su uso. Estos cambios no alterarán el comportamiento original de los endpoints existentes.

Versionado

Todos los endpoints de esta documentación incluyen el prefijo /features, el cual permite identificar funcionalidades nuevas y/o recientemente modificadas.

Nota importante: En la fecha de lanzamiento oficial, el prefijo /features será eliminado de todos los endpoints. Así, los endpoints estarán disponibles en su versión final sin el prefijo, garantizando una mayor estabilidad en el entorno de producción.

Ejemplos:

Obtener estudiantes en producción:
/students

Url completa:
https://URL-ESCUELA/api/v2/students

Obtener estudiantes en versionado:
/features/students

Url completa:
https://URL-ESCUELA/api/v2/features/students

Cobros

*New* Obtener cargos

Obtener todos los cobros del estudiante

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

Identificador único del estudiante

Example: WADFERF3
query Parameters
cycle_id
string (id) = 8 characters ^[A-Z0-9]{8}$

Obtener cobros de un ciclo determinado

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/features/students/{student_id}/finance/charges
Request samples 
Response samples 
application/json
[
  • {
    }
]
*Updated* Obtener cargo
Obtener información especifica del cargo


Change Log: 


  Propiedades nuevas






Nombre
Descripción





total_scholarships
Monto total de las becas





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


 
 Example:  WADFERF3
charge_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del cobro


 
 Example:  AEDFERF3
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/features/students/{student_id}/finance/charges/{charge_id}
Request samples 
Response samples 
application/json
[
  • {
    }
]
*Updated* Obtener becas del cargo
Obtener todas las becas del cargo


Change Log: Se reestructuro el response


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


 
 Example:  FGREDFE3
charge_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del cobro


 
 Example:  AEDFERF3
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/features/students/{student_id}/finance/charges/{charge_id}/scholarships
Request samples 
Response samples 
application/json
[
  • {
    }
]
Estado de cuenta
*Updated* Obtener estado de cuenta
Obtener información del estado de cuenta del estudiante/solicitante.


Change Log:


 Valor de propiedades cambiadas






Nombre
Descripción





charges->concept
Muestra el concepto de manera correcta





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


 
 Example:  WADFERF3
query Parameters
cycle_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del ciclo


 
 Example:  cycle_id=WADFERF3
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/features/students/{student_id}/statement
Request samples 
Response samples 
application/json
[
  • {
    }
]
Cobros
*New* Obtener cargos
Obtener todos los cobros del estudiante


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


 
 Example:  WADFERF3
query Parameters
cycle_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Obtener cobros de un ciclo determinado


 
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/features/students/{student_id}/finance/charges
Request samples 
Response samples 
application/json
[
  • {
    }
]
*Updated* Obtener cargo
Obtener información especifica del cargo


Change Log: 


  Propiedades nuevas






Nombre
Descripción





total_scholarships
Monto total de las becas





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


 
 Example:  WADFERF3
charge_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del cobro


 
 Example:  AEDFERF3
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/features/students/{student_id}/finance/charges/{charge_id}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Estado de cuenta
*Updated* Obtener estado de cuenta
Obtener información del estado de cuenta del estudiante/solicitante.


Change Log:


 Valor de propiedades cambiadas






Nombre
Descripción





charges->concept
Muestra el concepto de manera correcta





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


 
 Example:  WADFERF3
query Parameters
cycle_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del ciclo


 
 Example:  cycle_id=WADFERF3
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/features/students/{student_id}/statement
Request samples 
Response samples 
application/json
[
  • {
    }
]
Cobros
*New* Obtener cargos en bulk
Obtener todos los cargos de algebraix


Cada cargo contiene


    

  • Estudiante relacionado
    • 

  • Transacciones relacionadas
    • 

  • Pagos aplicados
    • 

  • Becas aplicadas
    • 

  • Descuento aplicado
    • 



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 Proceso obtener cargos


 
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/features/finance/charges/bulk
Request samples 
Response samples 
application/json
[
  • {
    }
]
*New* Crear proceso para obtener los cargos en bulk
Crear proceso en segundo plano para obtener los cargos en bulk


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
cycle_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Filtrar por identificador único del ciclo


 
period_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Filtrar por identificador único del periodo


 
group_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Filtrar por identificador único del grupo


 
student_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Filtrar por identificador único del estudiante


 
code
Array of strings
Filtrar por código del cargo


Items Enum Value Description
PUBLIC
Folios publicos de cobranza


PRIVATE
Folios privados


CANCELLED
Folios canceados


RETURNS
Devoluciones


CREDIT_NOTES
Notas de crédito


 
start_submit_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de creación inicial


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


 
end_submit_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de creación final


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


 
start_last_payment_time
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por última fecha de pago inicial


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


 
end_last_payment_time
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por última fecha de pago final


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


 
start_last_modification_time
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por última fecha de modificación del cargo inicial


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


 
end_last_modification_time
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por última fecha de modificación del cargo final


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


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/features/finance/charges/bulk
Request samples 
application/json
{
  • "cycle_id": "1ZB9FWKB",
  • "period_id": "4JKD09AZ",
  • "student_id": "PQQ0931D",
  • "group_id": "8IT24HHY",
  • "code": [
    ],
  • "start_submit_date": "01/01/2024",
  • "end_submit_date": "31/12/2024",
  • "start_last_payment_time": "01/01/2024",
  • "end_last_payment_time": "31/12/2024",
  • "start_last_modification_time": "01/01/2024",
  • "end_last_modification_time": "31/12/2024"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "VDFER34S",
  • "message": "Process created"
}