Algebraix logo
Powered by Redocly

Finanzas

PagosWebhook

Este webhook se utiliza para notificar eventos relacionados con los pagos realizados en Algebraix. Los eventos incluyen:

  • Pagos nuevos: Cuando se registra un nuevo pago.
  • Pagos actualizados: Cuando un pago existente es modificado.
  • Pagos eliminados: Cuando un pago es eliminado.

El payload enviado en cada evento incluye información detallada del Pago

Este webhook es ideal para mantener sincronizados los datos de pagos en sistemas externos, proporcionando actualizaciones en tiempo real.

Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

Indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-webhook-type
required
string

Indica el tipo de webhook que se está procesando

Example: PAYMENTS
x-algebraix-payment-mean
required
string

Medio de pago

Enum Value Description
ONLINE

Pago por internet

SCHOOL

Pagos por ventanilla

BANK

Pago por entidad bancaria

RECURRING

Pago recurrente con tarjeta

x-algebraix-created-at
required
string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000
x-algebraix-charge-id
required
string

Identificador único del cargo

Example: AEDFERF3
x-algebraix-charge-external-id
string

Identificador externo del cargo asignado por el usuario.

Example: 0001
x-algebraix-bank-account-id
required
string

Identificador único de la cuenta de banco

Example: KADFERF3
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
x-algebraix-student-id
required
string

Identificador único del estudiante

Example: WADFERF3
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
id
string

Identificador único del pago

object

Transacción relacionada con el pago

submit_date
string

Fecha del pago

has_refund
boolean

Indica si tiene reembolso

is_payed_from_prepay
boolean

Indica si se ha pagado desde prepago

amount
string

Monto del pago

object

Series de folios relacionadas con el pago

object

Factura o Recibo relacionado con el pago

object

Información relacionada al estudiante

object

Información referente al IVA

object

Cargo relacionado con el pago

algebraix-operation
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "id": "Z6OASXRM",
  • "transaction": {
    },
  • "submit_date": "19/09/2023",
  • "has_refund": false,
  • "is_payed_from_prepay": false,
  • "amount": "4500.00",
  • "series": {
    },
  • "receipt": {
    },
  • "student": {
    },
  • "tax": {
    },
  • "charge": {
    },
  • "algebraix-operation": "INSERT"
}

CargosWebhook

Este webhook se utiliza para notificar eventos relacionados con los cargos realizados en Algebraix. Los eventos incluyen:

  • Cargos nuevos: Cuando se registra un nuevo cargo.
  • Cargos actualizados: Cuando un cargo existente es modificado.
  • Cargos eliminados: Cuando un cargo es eliminado.
Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

Indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-webhook-type
required
string

Indica el tipo de webhook que se está procesando

Example: CHARGES
x-algebraix-created-at
required
string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000
x-algebraix-student-id
required
string

Identificador único del estudiante

Example: AEDFERF3
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
algebraix-operation
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

id
string

Identificador único del cargo

external_id
string

Identificador externo asignado por el usuario

name
string

Nombre del cargo

concept
string

Concepto del cargo

code
string

Códigos de cargos

total_payed
string

Total pagado

original_amount
string

Monto original

sub_amount
string

Subtotal del cargo

unit_price
string

Precio unitario

total_discount
string

Monto total del descuento

total_to_pay
string

Monto total a pagar

total_scholarships
string

Monto total de las becas

balance
string

Saldo

submit_date
string

Fecha de creación

last_payment_time
string

Última fecha de pago

NOTA: Este valor se actualiza con la fecha y hora en que se crean o modifican folios relacionados con este cobro (no necesariamente coincide con la fecha capturada por los usuarios).

last_modification_time
string

Última fecha de modificación

has_disable_automatic_payments
boolean

Indica si tiene desactivada la opción de "pagos automáticos"

is_divided
boolean

Indica si el cargo está dividido

Array of objects

Si el cargo está dividido, aqui se mostratan los detalles de las divisiones.

NOTA: Dentro del listado se muestra tanto el cobro dividido actual como sus relacionados.

has_agreement
boolean

Si está bajo un convenio

object

Información de Contpaq

object

Información referente al IVA

object

Información referente a las claves de servicio

object

Información del usuario creador

object

Periodo del estudiante

Array of objects

Datos de las cuentas bancarias

object

Información relacionada al estudiante

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "algebraix-operation": "INSERT",
  • "id": "string",
  • "external_id": "string",
  • "name": "string",
  • "concept": "string",
  • "code": "string",
  • "total_payed": "string",
  • "original_amount": "string",
  • "sub_amount": "string",
  • "unit_price": "string",
  • "total_discount": "string",
  • "total_to_pay": "string",
  • "total_scholarships": "string",
  • "balance": "string",
  • "submit_date": "string",
  • "last_payment_time": "string",
  • "last_modification_time": "string",
  • "has_disable_automatic_payments": true,
  • "is_divided": true,
  • "division_details": [
    ],
  • "has_agreement": true,
  • "contpaq": {
    },
  • "tax": {
    },
  • "tax_account": {
    },
  • "creator": {
    },
  • "period": {
    },
  • "bank_data": [
    ],
  • "student": {
    }
}

BecasWebhook

Este webhook se utiliza para notificar eventos relacionados con las becas realizadas en Algebraix. Los eventos incluyen:

  • Becas nuevas: Cuando se registra una nueva beca.
  • Becas actualizadas: Cuando una beca existente es modificada.
  • Becas eliminadas: Cuando una beca es eliminada.
Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

Indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-webhook-type
required
string

Indica el tipo de webhook que se está procesando

Example: CHARGE_SCHOLARSHIPS
x-algebraix-created-at
required
string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000
x-algebraix-student-id
required
string

Identificador único del estudiante

Example: AEDFERF3
x-algebraix-charge-id
required
string

Identificador único del cargo

Example: FERD1392
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
id
string

Identificador único de la beca

amount
string <decimal>

Monto total de la beca

object

Razón de beca

note
string

Notas sobre el descuento

type
string

Tipo de descuento

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "id": "string",
  • "amount": "string",
  • "reason": {
    },
  • "note": "string",
  • "type": "AMOUNT"
}

DescuentosWebhook

Este webhook se utiliza para notificar eventos relacionados con los descuentos realizados en Algebraix. Los eventos incluyen:

  • Descuentos nuevos: Cuando se registra un nuevo descuento.
  • Descuentos actualizados: Cuando un descuento existente es modificado.
  • Descuentos eliminados: Cuando un descuento es eliminado.
Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

Indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-webhook-type
required
string

Indica el tipo de webhook que se está procesando

Example: DISCOUNTS
x-algebraix-created-at
required
string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000
x-algebraix-student-id
required
string

Identificador único del estudiante

Example: AEDFERF3
x-algebraix-charge-id
required
string

Identificador único del cargo

Example: FERD1392
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
id
string

Identificador único del descuento

type
string

Tipo de descuento

Enum: "MANUAL" "AUTOMATIC"
amount
string <decimal>

Monto del descuento

note
string

Nota del descuento

algebraix-operation
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "id": "string",
  • "type": "MANUAL",
  • "amount": "string",
  • "note": "string",
  • "algebraix-operation": "INSERT"
}

Notas de créditoWebhook

Este webhook se utiliza para notificar eventos relacionados con las notas de crédito (CFDI tipo E) realizadas en Algebraix. Los eventos incluyen:

  • Notas de crédito nuevas: Cuando se registra una nueva nota de crédito.
  • Notas de crédito actualizadas: Cuando una nota de crédito existente es modificada.
  • Notas de crédito eliminadas: Cuando una nota de crédito es eliminada.

Se envía un evento por cada nota de crédito completa (no uno por cada cargo incluido en ella). El proceso de creación se compone de un INSERT seguido de un UPDATE en la misma transacción (primero se registra, después se timbra ante el SAT), por lo que una sola nota de crédito creada exitosamente entrega este webhook dos veces — INSERT y luego UPDATE — ambas con los mismos datos finales ya timbrados. Esto es un comportamiento esperado (entrega idempotente por id), no una entrega duplicada por error.

Puede crearse desde Crear nota de crédito.

Request
header Parameters
Content-Type
required
string

Tipo de contenido

Example: application/json
Content-Length
required
string

Indica el tamaño del cuerpo de la solicitud HTTP

Example: 655
x-algebraix-webhook-type
required
string

Indica el tipo de webhook que se está procesando

Example: CREDIT_NOTES
x-algebraix-created-at
required
string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000
x-algebraix-transaction-id
required
string

Identificador único de la transacción relacionada

Example: FERD1392
x-algebraix-operation
required
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

Example: INSERT
authorization
string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0
ADDITIONAL-PROPERTIES
string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value
Request Body schema: application/json
algebraix-operation
string

Tipo de operación efectuada en base de datos

Enum Value Description
INSERT

Valor insertado

UPDATE

Valor actualizado

DELETE

Valor eliminado

id
string

Identificador único de la nota de crédito

transaction_id
string

Identificador único de la transacción relacionada

object

Serie fiscal de la nota de crédito

object

Folio de la nota de crédito

date_time
string

Fecha y hora de creación (formato DD/MM/YYYY HH24:MI:SS)

is_active
boolean

Indica si la nota de crédito está activa

uuid
string

UUID fiscal (timbre SAT) de la nota de crédito. Vacío si aún no ha sido timbrada.

amount
string

Monto total de la nota de crédito

payment_method
string

Clave de forma de pago SAT

Array of objects

Cargos incluidos en la nota de crédito

Responses
200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples
application/json
{
  • "algebraix-operation": "INSERT",
  • "id": "string",
  • "transaction_id": "string",
  • "series": {
    },
  • "receipt": {
    },
  • "date_time": "string",
  • "is_active": true,
  • "uuid": "string",
  • "amount": "string",
  • "payment_method": "string",
  • "charges": [
    ]
}
➔ Next to Usuarios