v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-07-116470172.6 KB

Facturas

Listar Facturas

Permite acceder a la lista de todas las facturas generadas en el sistema.

get/invoices

Query parameters

qstring

Parámetro para realizar búsquedas basadas en key y value de los datos o dentro del metadata usando metadata.key=value. Los criterios de búsqueda disponibles son:

name
date_from
date_to
page
status
external_id
metadata Puedes proporcionar múltiples criterios separados por espacio. Ejemplo: external_id=123456 metadata.student_curp=12345

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Response

Listar Facturas

itemsinteger

Cantidad de registros por pagina

pageinteger

Pagina actual del total

total_pagesinteger

Total de paginas restantes

Example response

{
  "items": 112,
  "page": 1,
  "total_pages": 11,
  "data": [
    {
      "id": "a12a51c4-3f69-464f-93eb-cc8d355f68b2",
      "created_at": "2023-09-01 14:44:17.600161",
      "updated_at": "2023-09-01 14:44:17.600161",
      "invoiceType": "invoice",
      "ledgerId": "f2d93d57-ed03-4c11-87cc-3285c98ae38f",
      "payment_id": "719ec40a-588b-49f9-a216-0d2cdb1dc685",
      "amount": 100.2,
      "status": "successful",
      "emittedDate": "2023-09-01"
    }
  ]
}