Algebraix logo
Powered by Redocly

Transacciones

Obtener transacciones

Obtener transacciones resultado del proceso

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 Procesos de transacciones

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


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 Procesos de transacciones


 
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/transactions/returns
Request samples 
Response samples 
application/json
[
  • {
    }
]
Crear proceso para obtener transacciones
Crear proceso en segundo plano para obtener las transacciones


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
required
Filtros


filter_type
string
 Default:  "TRANSACTIONS"
Tipo de filtro para búsqueda de transacciones.






Valor
Descripción





TRANSACTIONS
Folios públicos de cobranza   (Obtener transacciones)




RETURNS
Devoluciones (Obtener devoluciones)





 
serie_id
string
Filtrar por serie de folio


 
start_receipt
integer  >= 1 
Filtrar por número inicial del folio


Nota importante:
Para poder usar de manera correcta la busqueda por folios, debes enviar ambos folios (start_receipt y end_receipt), opcional el id de la serie (series_id)


 
end_receipt
integer  >= 1 
Filtrar por número final del folio


  Nota importante:
  Para poder usar de manera correcta la busqueda por folios, debes enviar ambos folios (start_receipt y end_receipt), opcional el id de la serie (series_id)


 
start_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de ingreso inicial


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas


 
end_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de ingreso final


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_date y end_date), esta búsqueda se basa en el rango de las dos fechas


 
start_invoice_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de factura incial


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_invoice_date y end_invoice_date), esta búsqueda se basa en el rango de las dos fechas


 
end_invoice_date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
Filtrar por fecha de factura final


Nota importante:
Para poder usar de manera correcta la búsqueda, se deben enviar ambas fechas (start_invoice_date y end_invoice_date), esta búsqueda se basa en el rango de las dos fechas


 
start_creation_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_creation_date y end_creation_date), esta búsqueda se basa en el rango de las dos fechas


 
end_creation_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_creation_date y end_creation_date), esta búsqueda se basa en el rango de las dos fechas


 
payment_mean
required
Array of strings (payment_mean) 
Filtrar por medio de pago


Items Enum Value Description
ONLINE
Pago por internet


SCHOOL
Pagos por ventanilla


BANK
Pago por entidad bancaria


RECURRING
Pago recurrente con tarjeta


 
receipt_type
required
Array of strings
Filtrar por el tipo de recibo


Items Enum Value Description
PUBLIC
Folios publicos de cobranza


PRIVATE
Folios privados


CANCELLED
Folios canceados


RETURNS
Devoluciones


CREDIT_NOTES
Notas de crédito


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/finance/transactions/process
Request samples 
application/json
{
  • "filter_type": "TRANSACTIONS",
  • "serie_id": "SDFVRED3",
  • "start_receipt": 1,
  • "end_receipt": 10,
  • "payment_mean": [
    ],
  • "receipt_type": [
    ]
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "VDFER34S",
  • "message": "Process created"
}
Obtener transacción por ID
Obtener información de la transacción


Request 
path Parameters
transaction_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único de la transacción


 
 Example:  FGREDR45
query Parameters
document_type
string
 Default:  "INVOICE"
Tipo de documento


 Enum Value Description
RECEIPT
Folio temporal o serial


INVOICE
Factura PUE o PPD


PAYMENT
Factura tipo de pago


PRIVATE
Factura PUE o PPD privada


PRIVATE_GLOBAL
Factura privada global


PRIVATE_REFUND
Nota de crédito privada


PRIVATE_PAYMENT
Factura privada de pago


PRIVATE_DONATIVE
Factura privada de donativo


REFUND
Nota de crédito


 
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/transactions/{transaction_id}
Request samples 
Response samples 
application/json
{
  • "id": "ASDE1234",
  • "is_active": false,
  • "document_type": "RECEIPT",
  • "notes": "nota de folio",
  • "date_time": "19/03/2024 11:07:03",
  • "total": "12,600.00",
  • "subtotal": "12,600.00",
  • "payment_method": "Tarjeta de creito - Recibido por internet",
  • "creator": {
    },
  • "series": {
    },
  • "receipt": {
    },
  • "taxes": [
    ],
  • "payment_mean": "SCHOOL",
  • "customer": {
    },
  • "students": [
    ],
  • "returns": [
    ],
  • "cancellation": {
    }
}
➔ Next to Correo de bienvenida