Becas

Obtener becas

Obtener las becas por estudiante.

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

Identificador único del estudiante

Example: 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/students/{student_id}/finance/scholarships
Request samples
Response samples
application/json
[
  • {
    }
]

Agregar Beca

Agregar beca a estudiante.

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

Identificador único del estudiante

Example: 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.

Request Body schema: application/json
required
reason_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único de razón de beca

Puedes encontrar más información sobre cómo obtenerlo en la documentación de Razones de beca

concept
required
string

Concepto de beca

Enum: "ENROLLMENTS" "TUITION"
type
required
string

Tipo de descuento. AMNT: MONTO y PCNT: PORCENTAJE

Enum: "AMNT" "PCNT"
discount
required
number (number) ^\d+(\.\d{1,2})?$

Monto del descuento o porcentaje del descuento

charge_ids
Array of strings (id)

Cargos para actualizar colegiaturas existentes

Puedes encontrar más información sobre cómo obtenerlo en la documentación de Estado de cuenta

note
string

Nota de beca

show_scholarship
boolean

Mostrar detalles de beca a estudiantes y padres de familia

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/students/{student_id}/finance/scholarships
Request samples
application/json
{
  • "reason_id": "AWEDF34R",
  • "concept": "TUITION",
  • "type": "AMNT",
  • "discount": 200,
  • "charge_ids": [
    ],
  • "note": "",
  • "show_scholarship": true
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "AWSDERF2",
  • "message": "Registered scholarship"
}

Eliminar beca

Eliminar beca del estudiante.

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

Identificador único del estudiante

Example: ASDEFERD
scholarship_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único de la beca

Example: AQWQDFG4
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
optional
charge_ids
Array of strings (id)

Cargos para actualizar colegiaturas existentes

Responses
200

No error

400

Bad parameters

401

Authorization Required

delete/students/{student_id}/finance/scholarships/{scholarship_id}
Request samples
application/json
{
  • "charge_ids": [
    ]
}
Response samples
application/json
{
  • "details": [ ],
  • "message": "Scholarship deleted"
}