Algebraix logo
Powered by Redocly

Paquete de cobros

Obtener paquetes de cobros

Obtener los paquetes de cobros

Request
query Parameters
is_active
boolean

Obtener paquetes de cobros activos o inactivos

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/charges/package
Request samples 
Response samples 
application/json
[
  • {
    }
]
Obtener paquetes de cobros por ID
Obtener los paquetes de cobros


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


 
 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.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/finance/charges/package/{package_id}
Request samples 
Response samples 
application/json
{
  • "id": "ASDF1234",
  • "is_active": true,
  • "name": "Cobro de colegiaturas",
  • "description": "Este es un cobro de colegiaturas",
  • "creator": {
    },
  • "subcycle": {
    }
}
Obtener items
Obtener cobros relacionados al paquete de cobros


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


 
 Example:  LA34ERD4
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/charges/package/{package_id}/items
Request samples 
Response samples 
application/json
[
  • {
    }
]
Obtener historial
Obtener historial de procesamiento del paquete de cobros


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


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


 
 Example:  LA34ERD4
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/charges/package/{package_id}/processes
Request samples 
Response samples 
application/json
[
  • {
    }
]
Procesar paquete de cobros
Procesa un paquete de cobros en background y retornara el id del proceso. Para consultar el estado del proceso usar el endpoint /progress/{process_id}.


Es un proceso de tipo PACKAGE


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


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


 
 Example:  LA34ERD4
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
 Array (non-empty)
student_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante/solicitante


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


NOTA: No puedes usar el mismo estudiante en más de un objeto


 
group_id
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


 
charge_ids
Array of strings (id)   non-empty 
Identificador único del cobro


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Cobros relacionados al paquete de cobros


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/finance/charges/package/{package_id}/processes
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Process created"
}
Obtener historial por ID
Obtener historial de procesamiento del paquete de cobros por ID


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


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


 
 Example:  LA34ERD4
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 Historial del paquete de cobros


 
 Example:  MJA34DFQ
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/charges/package/{package_id}/process/{process_id}
Request samples 
Response samples 
application/json
{
  • "id": "ASDF1234",
  • "completed_at": "2024-05-17 15:33:28",
  • "creator": {
    },
  • "charges_count": 5
}
Obtener cobros generados
Obtener información de los cobros generados a partir de un proceso de paquete de cobros


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


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


 
 Example:  LA34ERD4
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 Historial del paquete de cobros


 
 Example:  MJA34DFQ
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/charges/package/{package_id}/process/{process_id}/items
Request samples 
Response samples 
application/json
[
  • {
    }
]
Eliminar cobro procesado
Eliminar cobro procesado


Request 
path Parameters
package_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del paquete de cobro


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


 
 Example:  LA34ERD4
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 Historial del paquete de cobros


 
 Example:  MJA34DFQ
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del cobro


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


 
 Example:  LJA34DFF
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/finance/charges/package/{package_id}/process/{process_id}/items/{item_id}
Request samples 
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Charge deleted"
}
➔ Next to Netsuite