{
 "openapi": "3.1.0",
 "info": {
  "title": "Aid Applications (Student Lifecycle)",
  "version": "20261030b",
  "description": "One per student per award year, from the ISIR: SAI, cost of attendance, need, verification and C-code status. Propose a package, offer it, and the student answers in the portal."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "aid-applications": {
    "type": "object",
    "required": [
     "student_id",
     "award_year"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "application_no": {
      "type": "string",
      "description": "Application no",
      "readOnly": true
     },
     "student_id": {
      "type": "string",
      "format": "uuid",
      "description": "Student"
     },
     "award_year": {
      "type": "string",
      "description": "Award year"
     },
     "current_isir_id": {
      "type": "string",
      "format": "uuid",
      "description": "Current isir id",
      "readOnly": true
     },
     "transaction_number": {
      "type": "integer",
      "description": "Transaction number",
      "readOnly": true
     },
     "sai": {
      "type": "integer",
      "description": "Sai",
      "readOnly": true
     },
     "dependency_status": {
      "type": "string",
      "description": "Dependency status",
      "readOnly": true
     },
     "pell_eligible": {
      "type": "boolean",
      "description": "Pell eligible",
      "readOnly": true
     },
     "verification_status": {
      "type": "string",
      "description": "Verification status",
      "readOnly": true
     },
     "verification_group": {
      "type": "string",
      "description": "Verification group",
      "readOnly": true
     },
     "c_code_status": {
      "type": "string",
      "description": "C code status",
      "readOnly": true
     },
     "intensity": {
      "type": "string",
      "description": "Enrolment intensity",
      "enum": [
       "full_time",
       "three_quarter",
       "half_time",
       "less_than_half"
      ]
     },
     "housing": {
      "type": "string",
      "description": "Housing",
      "enum": [
       "on_campus",
       "off_campus",
       "with_parents"
      ]
     },
     "grade_level": {
      "type": "integer",
      "description": "Grade level"
     },
     "coa_budget_id": {
      "type": "string",
      "format": "uuid",
      "description": "Coa budget id",
      "readOnly": true
     },
     "coa_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Coa amount",
      "readOnly": true
     },
     "other_aid": {
      "type": "string",
      "format": "decimal",
      "description": "Other resources"
     },
     "need": {
      "type": "string",
      "format": "decimal",
      "description": "Need",
      "readOnly": true
     },
     "proposed_package": {
      "type": "object",
      "description": "Proposed package",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "offered_at": {
      "type": "string",
      "format": "date-time",
      "description": "Offered at",
      "readOnly": true
     },
     "responded_at": {
      "type": "string",
      "format": "date-time",
      "description": "Responded at",
      "readOnly": true
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/slcm/aid-applications": {
   "get": {
    "summary": "list aid-applications",
    "operationId": "list_aid_applications_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create aid-applications",
    "operationId": "create_aid_applications_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}": {
   "get": {
    "summary": "get aid-applications",
    "operationId": "get_aid_applications_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change aid-applications",
    "operationId": "change_aid_applications_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete aid-applications",
    "operationId": "delete_aid_applications_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}/assign-coa": {
   "post": {
    "summary": "Assign coa",
    "operationId": "action_aid_applications_0_6",
    "description": "Body keys: budget_id",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}/package": {
   "post": {
    "summary": "Package",
    "operationId": "action_aid_applications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}/offer": {
   "post": {
    "summary": "Offer",
    "operationId": "action_aid_applications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}/award-letter": {
   "get": {
    "summary": "Award letter",
    "operationId": "action_aid_applications_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/aid-applications/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_aid_applications_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}