Download OpenAPI specification:Download
En esta sección, se presentan nuevas features
que serán gradualmente integradas a la documentación principal de la API. La mayoría de los endpoints descritos en esta sección son versiones extendidas de los endpoints originales,
añadiendo funcionalidades o parámetros adicionales para optimizar su uso. Estos cambios no alterarán el comportamiento original de los endpoints existentes.
Todos los endpoints de esta documentación incluyen el prefijo /features
, el cual permite identificar funcionalidades nuevas y/o recientemente modificadas.
Nota importante: En la fecha de lanzamiento oficial, el prefijo /features
será eliminado de todos los endpoints. Así, los endpoints estarán disponibles en su versión final sin el prefijo, garantizando una mayor estabilidad en el entorno de producción.
Ejemplos:
Obtener estudiantes en producción:
/students
Url completa:
https://URL-ESCUELA/api/v2/students
Obtener estudiantes en versionado:
/features/students
Url completa:
https://URL-ESCUELA/api/v2/features/students
Obtener todos los cobros del estudiante
No error
Bad parameters
Authorization Required
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.00",
- "total_scholarships": "100.00",
- "sub_amount": "3050.00",
- "unit_price": "3500.00",
- "total_discount": "450.00",
- "total_to_pay": "2600.00",
- "balance": "450.00",
- "submit_date": "21/12/2023",
- "last_payment_time": "22/12/2023 09:42:12",
- "last_modification_time": "22/12/2023 09:42:12",
- "has_disable_automatic_payments": false,
- "is_divided": false,
- "has_agreement": false,
- "contpaq": {
- "code": "101-03-000-000",
- "contra_code": "201-03-000-000"
}, - "tax": {
- "amount": "0",
- "percentage": "EXEMPT"
}, - "tax_account": {
- "account": "401-03-000-000",
- "contra_account": "301-03-000-000"
}, - "creator": {
- "id": "ADMIN001",
- "name": "ADMIN"
}, - "period": {
- "id": "OYQP3VET",
- "name": "periodo-col02-rec'"
}, - "bank_data": [
- {
- "id": "VZGDCTLU",
- "name": "bankaccount05",
- "number": "05",
- "code": "1004737",
- "type_code": "STANDARD"
}
], - "item_id": "STATIC",
- "items": {
- "id": "NN1UUASB",
- "concept": "cob-fijo-gral-5-cc",
- "price": "365.25"
}
}
]
Obtener información especifica del cargo
Change Log:
Propiedades nuevas
Nombre | Descripción |
---|---|
total_scholarships | Monto total de las becas |
No error
Bad parameters
Authorization Required
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.00",
- "total_scholarships": "100.00",
- "sub_amount": "3050.00",
- "unit_price": "3500.00",
- "total_discount": "450.00",
- "total_to_pay": "2600.00",
- "balance": "450.00",
- "submit_date": "21/12/2023",
- "last_payment_time": "22/12/2023 09:42:12",
- "last_modification_time": "22/12/2023 09:42:12",
- "has_disable_automatic_payments": false,
- "is_divided": false,
- "has_agreement": false,
- "contpaq": {
- "code": "101-03-000-000",
- "contra_code": "201-03-000-000"
}, - "tax": {
- "amount": "0",
- "percentage": "EXEMPT"
}, - "tax_account": {
- "account": "401-03-000-000",
- "contra_account": "301-03-000-000"
}, - "creator": {
- "id": "ADMIN001",
- "name": "ADMIN"
}, - "period": {
- "id": "OYQP3VET",
- "name": "periodo-col02-rec"
}, - "bank_data": [
- {
- "id": "VZGDCTLU",
- "name": "bankaccount05",
- "number": "05",
- "code": "1004737",
- "type_code": "STANDARD"
}
], - "item_id": "STATIC",
- "items": {
- "id": "NN1UUASB",
- "concept": "cob-fijo-gral-5-cc",
- "price": "365.25"
}
}
]
Obtener todas las becas del cargo
Change Log: Se reestructuro el response
No error
Bad parameters
Authorization Required
[- {
- "id": "YYZZNROQ",
- "amount": "780",
- "reason": {
- "id": "ORNCTXK0",
- "name": "porcentaje"
}, - "note": "s/n",
- "type": "AMOUNT"
}
]
Obtener información del estado de cuenta del estudiante/solicitante.
Change Log:
Valor de propiedades cambiadas
Nombre | Descripción |
---|---|
charges->concept | Muestra el concepto de manera correcta |
No error
Bad parameters
Authorization Required
[- {
- "charges": [
- {
- "code": "TUITION",
- "concept": "Period tuition",
- "discount": { },
- "has_agreement": false,
- "id": "BGTR6E45",
- "is_divided": false,
- "item_id": "",
- "latefee": { },
- "payments": [
- {
- "amount": "4500.00",
- "has_refund": false,
- "id": "Z6OASXRM",
- "is_payed_from_prepay": false,
- "receipt": {
- "id": "FUNO100",
- "number": "100.00"
}, - "returned_amount": "0.00",
- "series": {
- "id": "MY2VQLG3",
- "name": "FUNO"
}, - "submit_date": "19/09/2023"
}
], - "scholarships": [
- {
- "amount": "500.00",
- "base_amount": "5000.00",
- "base_amount_type": "ORIGINAL",
- "discount_amount": "500.00",
- "reason": {
- "description": "beca-expiracion-no-expira-facturar-al-liquidar",
- "id": "ILZYPJP8"
}, - "type": "AMNT"
}
], - "sub_amount": "4500.00",
- "total_amount": "5000.00",
- "total_remaining": "0.00",
- "total_scholarships_discount": "500.00"
}
], - "end_date": "19/10/2023",
- "id": "C5AK6TP7",
- "is_enrollment_period": false,
- "is_overdue": false,
- "is_published": true,
- "name": "periodo-col-beca-no-expira",
- "start_date": "19/09/2023",
- "total_debt": "4500.00",
- "total_discounted": "0.00",
- "total_payed": "4500.00",
- "total_refunded_out": "0.00",
- "subcycle": {
- "id": "ADEFR34E",
- "name": "subciclo01-admn"
}
}
]
Obtener todos los cobros del estudiante
No error
Bad parameters
Authorization Required
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.00",
- "total_scholarships": "100.00",
- "sub_amount": "3050.00",
- "unit_price": "3500.00",
- "total_discount": "450.00",
- "total_to_pay": "2600.00",
- "balance": "450.00",
- "submit_date": "21/12/2023",
- "last_payment_time": "22/12/2023 09:42:12",
- "last_modification_time": "22/12/2023 09:42:12",
- "has_disable_automatic_payments": false,
- "is_divided": false,
- "has_agreement": false,
- "contpaq": {
- "code": "101-03-000-000",
- "contra_code": "201-03-000-000"
}, - "tax": {
- "amount": "0",
- "percentage": "EXEMPT"
}, - "tax_account": {
- "account": "401-03-000-000",
- "contra_account": "301-03-000-000"
}, - "creator": {
- "id": "ADMIN001",
- "name": "ADMIN"
}, - "period": {
- "id": "OYQP3VET",
- "name": "periodo-col02-rec'"
}, - "bank_data": [
- {
- "id": "VZGDCTLU",
- "name": "bankaccount05",
- "number": "05",
- "code": "1004737",
- "type_code": "STANDARD"
}
], - "item_id": "STATIC",
- "items": {
- "id": "NN1UUASB",
- "concept": "cob-fijo-gral-5-cc",
- "price": "365.25"
}
}
]
Obtener información especifica del cargo
Change Log:
Propiedades nuevas
Nombre | Descripción |
---|---|
total_scholarships | Monto total de las becas |
No error
Bad parameters
Authorization Required
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.00",
- "total_scholarships": "100.00",
- "sub_amount": "3050.00",
- "unit_price": "3500.00",
- "total_discount": "450.00",
- "total_to_pay": "2600.00",
- "balance": "450.00",
- "submit_date": "21/12/2023",
- "last_payment_time": "22/12/2023 09:42:12",
- "last_modification_time": "22/12/2023 09:42:12",
- "has_disable_automatic_payments": false,
- "is_divided": false,
- "has_agreement": false,
- "contpaq": {
- "code": "101-03-000-000",
- "contra_code": "201-03-000-000"
}, - "tax": {
- "amount": "0",
- "percentage": "EXEMPT"
}, - "tax_account": {
- "account": "401-03-000-000",
- "contra_account": "301-03-000-000"
}, - "creator": {
- "id": "ADMIN001",
- "name": "ADMIN"
}, - "period": {
- "id": "OYQP3VET",
- "name": "periodo-col02-rec"
}, - "bank_data": [
- {
- "id": "VZGDCTLU",
- "name": "bankaccount05",
- "number": "05",
- "code": "1004737",
- "type_code": "STANDARD"
}
], - "item_id": "STATIC",
- "items": {
- "id": "NN1UUASB",
- "concept": "cob-fijo-gral-5-cc",
- "price": "365.25"
}
}
]
Obtener información del estado de cuenta del estudiante/solicitante.
Change Log:
Valor de propiedades cambiadas
Nombre | Descripción |
---|---|
charges->concept | Muestra el concepto de manera correcta |
No error
Bad parameters
Authorization Required
[- {
- "charges": [
- {
- "code": "TUITION",
- "concept": "Period tuition",
- "discount": { },
- "has_agreement": false,
- "id": "BGTR6E45",
- "is_divided": false,
- "item_id": "",
- "latefee": { },
- "payments": [
- {
- "amount": "4500.00",
- "has_refund": false,
- "id": "Z6OASXRM",
- "is_payed_from_prepay": false,
- "receipt": {
- "id": "FUNO100",
- "number": "100.00"
}, - "returned_amount": "0.00",
- "series": {
- "id": "MY2VQLG3",
- "name": "FUNO"
}, - "submit_date": "19/09/2023"
}
], - "scholarships": [
- {
- "amount": "500.00",
- "base_amount": "5000.00",
- "base_amount_type": "ORIGINAL",
- "discount_amount": "500.00",
- "reason": {
- "description": "beca-expiracion-no-expira-facturar-al-liquidar",
- "id": "ILZYPJP8"
}, - "type": "AMNT"
}
], - "sub_amount": "4500.00",
- "total_amount": "5000.00",
- "total_remaining": "0.00",
- "total_scholarships_discount": "500.00"
}
], - "end_date": "19/10/2023",
- "id": "C5AK6TP7",
- "is_enrollment_period": false,
- "is_overdue": false,
- "is_published": true,
- "name": "periodo-col-beca-no-expira",
- "start_date": "19/09/2023",
- "total_debt": "4500.00",
- "total_discounted": "0.00",
- "total_payed": "4500.00",
- "total_refunded_out": "0.00",
- "subcycle": {
- "id": "ADEFR34E",
- "name": "subciclo01-admn"
}
}
]
Obtener todos los cargos de algebraix
Cada cargo contiene
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 Proceso obtener cargos |
No error
Bad parameters
Authorization Required
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.00",
- "total_scholarships": "100.00",
- "sub_amount": "3050.00",
- "unit_price": "3500.00",
- "total_discount": "450.00",
- "total_to_pay": "2600.00",
- "balance": "450.00",
- "submit_date": "21/12/2023",
- "last_payment_time": "22/12/2023 09:42:12",
- "last_modification_time": "22/12/2023 09:42:12",
- "has_disable_automatic_payments": false,
- "is_divided": false,
- "has_agreement": false,
- "contpaq": {
- "code": "101-03-000-000",
- "contra_code": "201-03-000-000"
}, - "tax": {
- "amount": "0",
- "percentage": "EXEMPT"
}, - "tax_account": {
- "account": "401-03-000-000",
- "contra_account": "301-03-000-000"
}, - "creator": {
- "id": "ADMIN001",
- "name": "ADMIN"
}, - "period": {
- "id": "OYQP3VET",
- "name": "periodo-col02-rec'"
}, - "bank_data": [
- {
- "id": "VZGDCTLU",
- "name": "bankaccount05",
- "number": "05",
- "code": "1004737",
- "type_code": "STANDARD"
}
], - "item_id": "STATIC",
- "items": {
- "id": "NN1UUASB",
- "concept": "cob-fijo-gral-5-cc",
- "price": "365.25"
}
}
]
Crear proceso en segundo plano para obtener los cargos en bulk
No error
Bad parameters
Authorization Required
{- "cycle_id": "1ZB9FWKB",
- "period_id": "4JKD09AZ",
- "student_id": "PQQ0931D",
- "group_id": "8IT24HHY",
- "code": [
- "AGREEMENT",
- "BALANCE",
- "ENROLLMENT",
- "LATEFEE",
- "ONETIME",
- "OTHER",
- "TUITION",
- "STATIC",
- "SELL",
- "PACKAGE"
], - "start_submit_date": "01/01/2024",
- "end_submit_date": "31/12/2024",
- "start_last_payment_time": "01/01/2024",
- "end_last_payment_time": "31/12/2024",
- "start_last_modification_time": "01/01/2024",
- "end_last_modification_time": "31/12/2024"
}
{- "details": [ ],
- "id": "VDFER34S",
- "message": "Process created"
}