Obtener cobro
Obtener información especifica del cobro
path Parameters
header Parameters
No error
Bad parameters
Authorization Required
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
- 200
- 400
- 401
[- {
- "id": "OOAOX5JN",
- "name": "Colegiatura del periodo",
- "concept": "reinscripcion-01",
- "code": "TUITION",
- "total_payed": "3050.00",
- "original_amount": "3050.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 pagos del cobro
Obtener todos los pagos del cobro
path Parameters
header Parameters
No error
Bad parameters
Authorization Required
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
- 200
- 400
- 401
[- {
- "amount": "4500.00",
- "has_refund": false,
- "id": "Z6OASXRM",
- "is_payed_from_prepay": false,
- "receipt": {
- "id": "FUNO100",
- "number": "100"
}, - "series": {
- "id": "MY2VQLG3",
- "name": "FUNO"
}, - "submit_date": "19/09/2023"
}
]Obtener becas del cobro
Obtener todas las becas del cobro
path Parameters
header Parameters
No error
Bad parameters
Authorization Required
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
- 200
- 400
- 401
[- {
- "id": "YYZZNROQ",
- "concept": "nota1",
- "base_amount": "ORIGINAL",
- "contpaq_code": " ",
- "reason": {
- "id": "ORNCTXK0",
- "name": "porcentaje"
}, - "discount": {
- "amount": 15,
- "note": "s/n",
- "type": "PCNT"
}
}
]Eliminar beca del cobro
Eliminar beca de un cobro en especifico del estudiante.
path Parameters
header Parameters
No error
Bad parameters
Authorization Required
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
- 200
- 400
- 401
{- "details": [ ],
- "message": "Scholarship deleted"
}Agregar descuento
Agregar descuento al cobro
path Parameters
header Parameters
Request Body schema: application/jsonrequired
No error
Bad parameters
Authorization Required
- Payload
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
{- "new_total": 100,
- "is_regenerate_bank_codes": true,
- "notes": ""
}- 200
- 400
- 401
{- "details": [ ],
- "id": "AWDSFER4",
- "message": "Discount applied"
}Procesar cobros
Procesar cobros recurrentes al estudiante.
Este es un proceso background que registra en el estado de cuenta todos los cobros recurrentes del estudiante del periodo especificado y retornara el id del progreso. Para consultar el estado del proceso usar el endpoint /progress/{process_id}
path Parameters
header Parameters
Request Body schema: application/jsonrequired
| cycle_id required | string (id) = 8 characters ^[A-Z0-9]{8}$ Identificador único del ciclo Puedes encontrar más información sobre cómo obtenerlo en la documentación de Ciclos |
| group_id required | 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 |
| period_ids required | Array of strings (id) non-empty Identificadores unicos de los periodos Puedes encontrar más información sobre cómo obtenerlo en la documentación de Periodos |
No error
Bad parameters
Authorization Required
- Payload
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
{- "cycle_id": "FGRETFGR",
- "group_id": "BRF45RFU",
- "period_ids": [
- "FGRTHYUI"
]
}- 200
- 400
- 401
{- "details": [ ],
- "id": "AWSDERF2",
- "message": "Student recurring charges processed"
}Eliminar registro de proceso
Eliminar registro de proceso
path Parameters
header Parameters
Request Body schema: application/jsonrequired
Identificadores unicos de los periodos
No error
Bad parameters
Authorization Required
- Payload
- curl
- Node.js
- Python
- C#
- JavaScript
- PHP
- Java
- Go
- Ruby
[- "FGRTHYUI"
]- 200
- 400
- 401
{- "details": [ ],
- "message": "Charge registry deleted"
}