Sign in

v1

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

Actualizar Complemento

Actualización de datos de un Complemento

put/complements/{complementID}

Path parameters

complementIDstring required

ID del complemento que se desea trabajar.

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Request body

namestring
program_idstring required
amountinteger
periodicity'weekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual'
frecuency'unique' | 'recurrent'
pay_datestring
start_datestring
end_datestring
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example request

{
  "name": "Curso de natación",
  "program_id": "prm_69dc9120-03cc-4737-99b3-88d018804a29",
  "amount": 1000,
  "periodicity": "monthly",
  "frecuency": "recurrent",
  "pay_date": "2023-11-10",
  "start_date": "2023-11-10",
  "end_date": "2023-11-10",
  "external_id": "a2745b9f-64eb-419e-8f18-7913d08d102f",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Response

Actualizar Complemento

idstring
program_idstring
namestring
amountinteger
frecuency'unique' | 'recurrent'
periodicity'weekly' | 'monthly' | 'bimonthly' | 'quarterly' | 'semiannual' | 'annual'
start_datestring
end_datestring
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example response

{
  "id": "cpt_96adb1f0-0874-4b8d-be9e-4f8772388d33",
  "program_id": "prm_0cb0b357-b55c-4daa-938e-47733305a4fc",
  "name": "Complemento curso natación",
  "amount": 1000,
  "frecuency": "unique",
  "periodicity": "monthly",
  "start_date": "2024-01-01",
  "end_date": "2024-06-30",
  "external_id": "a2745b9f-64eb-419e-8f18-7913d08d102f",
  "metadata": {
    "id_alumno": "123abc"
  },
  "items": [
    {
      "pay_date": "2024-01-10"
    }
  ]
}