Cobros

Obtener cobros de inscripción / cobros únicos

Obtener cobros de inscripción y cobros únicos

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

Identificador único del periodo

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

Identificador único del estudiante

Example: student_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/finance/charges/enrollment
Request samples
Response samples
application/json
{
  • "new_enrollments": [
    ],
  • "enrollments_process": [
    ],
  • "one_time_charges": [
    ],
  • "one_time_packages": [
    ],
  • "reenrollments": [
    ]
}

Obtener cobros fijos

Obtener cobros fijos

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

Identificador único del estudiante

Example: student_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/finance/charges/static
Request samples
Response samples
application/json
{
  • "fixed_charges": [
    ],
  • "specific_fixed_charges": [
    ],
  • "resit_exam_charges": [
    ]
}

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 en bulk

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/bulk
Request samples
Response samples
application/json
[
  • {
    }
]

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/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"
}