Cobros

Obtener cobro

Obtener información especifica 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}
Request samples
Response samples
application/json
[
  • {
    }
]

Obtener pagos del cobro

Obtener todos los pagos 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}/payments
Request samples
Response samples
application/json
[
  • {
    }
]

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