Algebraix logo
Powered by Redocly

Cobros

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

external_id
string <= 32 characters

Filtrar por el identificador externo asignado por el usuario

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
Request samples 
Response samples 
application/json
[
  • {
    }
]
Crear colegiatura
Crear colegiatura al 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
amount
required
number  >= 0.01 
Monto de la colegiatura (requerido, mayor a 0). Puede enviarse como número JSON o como cadena numérica.


 
tax_percentage
string
 Default:  "EXEMPT"
Porcentaje de IVA. EXEMPT: Exento, 16: 16%, 8: 8%.


El monto del IVA se calcula en base al amount y se suma al monto.


 Enum: "EXEMPT" "16" "8"  
group_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del grupo. Si el campo no se incluye, el sistema lo tomará del grupo actual del estudiante.


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


 
period_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del periodo.


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


 
object
Información del SAT. Si no se incluye concept_id y/o unit_id, el sistema tomará los valores configurados en el grado asociado al group_id.


Puedes encontrar más información sobre los grados en la documentación de Grados


 
notes
string
Notas


 
external_id
string  <= 32 characters 
Identificador auxiliar único que puede ser utilizado para identificar el cargo bajo otro id


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/students/{student_id}/finance/charges/tuition
Request samples 
application/json
{
  • "amount": 3500,
  • "tax_percentage": "EXEMPT",
  • "period_id": "OYQP3VET",
  • "sat": {
    },
  • "notes": "Colegiatura periodo enero 2024",
  • "external_id": "0001"
}
Response samples 
application/json
{
  • "id": "OOAOX5JN",
  • "message": "Tuition charge created",
  • "details": [
    ]
}
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 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}
Request samples 
Response samples 
application/json
[
  • {
    }
]
Eliminar cargo
Eliminar un cobro del estudiante.


Este proceso es irreversible. El cobro se eliminará completamente junto con todos sus registros relacionados (recargos, descuentos, becas, etc.).


No se puede eliminar si:


    

  • El cobro tiene pagos registrados
    • 

  • El cobro está asociado a una factura
    • 

  • El cobro forma parte de un convenio de pago
    • 

  • La configuración de periodos no permite eliminar cargos en periodos expirados
    • 

  • El cobro está siendo procesado en un proceso de pagos recurrentes
    • 

  • Es un recargo y el colegio tiene habilitado esquema de factoraje
    • 



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
Cobro eliminado exitosamente


400
Error de validación


401
Authorization Required


delete/students/{student_id}/finance/charges/{charge_id}
Request samples 
Response samples 
application/json
{
  • "message": "Charge deleted",
  • "details": [ ],
  • "id": "AEDFERF3"
}
Dividir cobro
Divide un cobro en parcialidades.


Estrategia A - División automática: Divide el cobro de manera proporcional.
Requiere especificar strategy: "AUTOMATIC" y el array charges solo con period_id.
Los montos se calculan automáticamente dividiendo el monto original entre el número de elementos.


Estrategia B - División manual: Divide el cobro con montos específicos.
Requiere especificar strategy: "MANUAL" y el array charges con period_id y amount.
La suma de todos los montos debe ser exactamente igual al monto original del 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
strategy
string
 Default:  "AUTOMATIC"
Estrategia de división del cobro






Valor
Descripción





AUTOMATIC
Divide equitativamente (montos calculados automáticamente)




MANUAL
Montos específicos para cada cobro





 
required
Array of objects  [ 2 .. 20 ] items 
Array de periodos para los nuevos cobros.


Los montos se calcularán automáticamente dividiendo el monto original entre el número de elementos.


 
Responses 
200
Operación exitosa


400
Error de validación


401
Authorization Required


post/students/{student_id}/finance/charges/{charge_id}/divide
Request samples 
application/json
{
  • "strategy": "AUTOMATIC",
  • "charges": [
    ]
}
Response samples 
application/json
{
  • "details": [
    ],
  • "id": "AEDFERF3",
  • "message": "Charge divided successfully"
}
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
{
  • "id": "Z6OASXRM",
  • "transaction": {
    },
  • "submit_date": "19/09/2023",
  • "has_refund": false,
  • "is_payed_from_prepay": false,
  • "amount": "4500.00",
  • "series": {
    },
  • "receipt": {
    }
}
Obtener becas del cargo
Obtener todas las becas del cargo


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"
}
Obtener recargos del cargo
Obtener recargos 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}/latefees
Request samples 
Response samples 
application/json
[
  • {
    }
]
Obtener descuento del cobro
Obtener descuento del 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.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/students/{student_id}/finance/charges/{charge_id}/discounts
Request samples 
Response samples 
application/json
{
  • "id": "Z6OASXRM",
  • "type": "AUTOMATIC",
  • "amount": "4500.00",
  • "note": "Descuento de colegiatura"
}
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"
}
Eliminar descuento del cobro
Eliminar descuento 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
discount_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del descuento


 
 Example:  FTZYMSG7
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}/discounts/{discount_id}
Request samples 
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Discount deleted"
}
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"
}
➔ Next to Becas