Cobros

Obtener cargo

Obtener información especifica del cargo

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 cargo

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

Obtener pagos del cargo

Obtener todos los pagos del cargo

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 pago

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/students/{student_id}/finance/charges/{charge_id}/payments
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener pago del cargo por ID

Obtener información especifica del pago del cargo

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 cargo

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

Identificador único del pago

Example: DGLC4690
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/charges/{charge_id}/payments/{payment_id}
Request samples
Response samples
application/json
{
  • "amount": "4500.00",
  • "has_refund": false,
  • "id": "Z6OASXRM",
  • "is_payed_from_prepay": false,
  • "receipt": {
    },
  • "series": {
    },
  • "submit_date": "19/09/2023"
}

Obtener becas del cobro

Obtener todas las becas del cobro

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

Eliminar beca del cobro

Eliminar beca de un cobro en especifico del estudiante.

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

Identificador único del estudiante

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

Identificador único del cobro

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

Responses
200

No error

400

Bad parameters

401

Authorization Required

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

Agregar descuento

Agregar descuento al cobro

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.

Request Body schema: application/json
required
new_total
required
number (number) ^\d+(\.\d{1,2})?$

Nuevo total

Si incluye IVA se tiene que sumar al total.

contpaq_code
string <= 50 characters

Clave de servicio

is_regenerate_bank_codes
boolean
Default: false

Regenerar referencias bancarias

notes
string

Notas

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/students/{student_id}/finance/charges/{charge_id}/discounts
Request samples
application/json
{
  • "new_total": 100,
  • "is_regenerate_bank_codes": true,
  • "notes": ""
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Discount applied"
}

Procesar cobros

Procesar cobros recurrentes al estudiante.

Este es un proceso background que registra en el estado de cuenta todos los cobros recurrentes del estudiante del periodo especificado y retornara el id del progreso. Para consultar el estado del proceso usar el endpoint /progress/{process_id}

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
cycle_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del ciclo

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

group_id
required
string (id) = 8 characters ^[A-Z0-9]{8}$

Identificador único del grupo

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

period_ids
required
Array of strings (id) non-empty

Identificadores unicos de los periodos

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

Responses
200

No error

400

Bad parameters

401

Authorization Required

post/students/{student_id}/finance/charges/process
Request samples
application/json
{
  • "cycle_id": "FGRETFGR",
  • "group_id": "BRF45RFU",
  • "period_ids": [
    ]
}
Response samples
application/json
{
  • "details": [ ],
  • "id": "AWSDERF2",
  • "message": "Student recurring charges processed"
}

Eliminar registro de proceso

Eliminar registro de proceso

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

Identificadores unicos de los periodos

Array (non-empty)
string (id) = 8 characters ^[A-Z0-9]{8}$
Responses
200

No error

400

Bad parameters

401

Authorization Required

delete/students/{student_id}/finance/charges/process
Request samples
application/json
[
  • "FGRTHYUI"
]
Response samples
application/json
{
  • "details": [ ],
  • "message": "Charge registry deleted"
}