Financial Aid API

This domain is retired

Financial aid is not administered in this system and this API is deliberately unreachable. Migration 144 deleted its permission nodes and grants, so every endpoint below returns 403 — there is no role that can be granted access.

The Go domain, its routes and the financialaid schema all still exist, which is why these endpoints still appear in the route table. The schema and its rows are retained for historical reference.

Documented here for completeness and for whoever eventually removes it. See Financial Aid (retired) for the layer-by-layer picture.

Base URL: /api/v1/financial-aid/

Manage financial aid award types, student awards, FAFSA data, financial estimates, and cost of attendance calculations.

Endpoints Overview

Award Types

Method	Endpoint	Description
GET	`/award-types`	List award types
POST	`/award-types`	Create award type
GET	`/award-types/{awardTypeID}`	Get award type details
PATCH	`/award-types/{awardTypeID}`	Update award type
DELETE	`/award-types/{awardTypeID}`	Delete award type

Awards

Method	Endpoint	Description
GET	`/awards`	List awards
POST	`/awards`	Create award
GET	`/awards/{awardID}`	Get award details
PATCH	`/awards/{awardID}`	Update award
DELETE	`/awards/{awardID}`	Delete award
POST	`/awards/{awardID}/approve`	Approve award

FAFSA

Method	Endpoint	Description
GET	`/fafsa`	List FAFSA records
POST	`/fafsa`	Create FAFSA record
GET	`/fafsa/{fafsaID}`	Get FAFSA details
PATCH	`/fafsa/{fafsaID}`	Update FAFSA record
DELETE	`/fafsa/{fafsaID}`	Delete FAFSA record
POST	`/fafsa/{fafsaID}/verify`	Verify FAFSA

Financial Estimates

Method	Endpoint	Description
GET	`/estimates`	List financial estimates
POST	`/estimates`	Create estimate
GET	`/estimates/{estimateID}`	Get estimate details
PATCH	`/estimates/{estimateID}`	Update estimate
DELETE	`/estimates/{estimateID}`	Delete estimate
POST	`/estimates/{estimateID}/publish`	Publish estimate
POST	`/estimates/{estimateID}/accept`	Accept estimate
POST	`/estimates/{estimateID}/decline`	Decline estimate

Estimate Cost Items

Method	Endpoint	Description
GET	`/estimates/{estimateID}/cost-items`	List cost items
POST	`/estimates/{estimateID}/cost-items`	Create cost item
PATCH	`/cost-items/{costItemID}`	Update cost item
DELETE	`/cost-items/{costItemID}`	Delete cost item

Estimate Awards

Method	Endpoint	Description
GET	`/estimates/{estimateID}/awards`	List estimate awards
POST	`/estimates/{estimateID}/awards`	Link award to estimate
PATCH	`/estimate-awards/{estAwardID}`	Update estimate award
DELETE	`/estimate-awards/{estAwardID}`	Remove award from estimate

Award Types

Award types are template definitions for awards (scholarships, grants, loans, work-study).

List Award Types

GET /api/v1/financial-aid/award-types

Returns all award type definitions.

Example Request

bash

curl -X GET http://localhost:8000/api/v1/financial-aid/award-types \
  -b cookies.txt

Success Response (200 OK)

json

{
  "count": 15,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "PRES_SCHOLAR",
      "name": "Presidential Scholarship",
      "award_type": "scholarship",
      "award_category": "merit",
      "default_amount": "10000.00",
      "min_amount": "5000.00",
      "max_amount": "15000.00",
      "is_renewable": true,
      "requires_fafsa": false,
      "disbursement_schedule": "per_term",
      "eligibility_criteria": "GPA >= 3.8",
      "assigned_by_department": "ADMISSIONS",
      "is_active": true,
      "display_order": 1,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

TypeScript Types

typescript

interface AwardType {
  id: string
  code: string
  name: string
  award_type: 'scholarship' | 'grant' | 'loan' | 'work_study'
  award_category: string | null
  default_amount: string | null
  min_amount: string | null
  max_amount: string | null
  is_renewable: boolean
  requires_fafsa: boolean
  disbursement_schedule: string | null
  eligibility_criteria: string | null
  assigned_by_department: 'ADMISSIONS' | 'STUDENT_FINANCE' | null
  is_active: boolean
  display_order: number
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
}

Create Award Type

POST /api/v1/financial-aid/award-types

Request Body

Field	Type	Required	Description
`code`	string	Yes	Unique code (max 50)
`name`	string	Yes	Display name (max 200)
`award_type`	string	Yes	One of: `scholarship`, `grant`, `loan`, `work_study`
`award_category`	string	No	Category classification
`default_amount`	decimal	No	Default award amount
`min_amount`	decimal	No	Minimum allowed amount
`max_amount`	decimal	No	Maximum allowed amount
`is_renewable`	boolean	No	Whether award is renewable
`requires_fafsa`	boolean	No	Whether FAFSA is required
`disbursement_schedule`	string	No	How award is disbursed
`eligibility_criteria`	string	No	Eligibility description
`assigned_by_department`	string	No	One of: `ADMISSIONS`, `STUDENT_FINANCE`
`is_active`	boolean	No	Active status
`display_order`	integer	No	Display sort order

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/award-types \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "code": "DEAN_SCHOLAR",
    "name": "Dean'\''s Scholarship",
    "award_type": "scholarship",
    "award_category": "merit",
    "default_amount": "5000.00",
    "is_renewable": true,
    "requires_fafsa": false,
    "disbursement_schedule": "per_term"
  }'

Update Award Type

PATCH /api/v1/financial-aid/award-types/{awardTypeID}

All fields are optional. Only provided fields are updated.

Awards

Awards represent financial aid assigned to individual students.

List Awards

GET /api/v1/financial-aid/awards

Query Parameters

Parameter	Type	Description
`person_id`	uuid	Filter by person
`term_id`	integer	Filter by term
`award_type`	string	Filter by type: `scholarship`, `grant`, `loan`, `work_study`
`status`	string	Filter by status
`department`	string	Filter by assigning department
`search`	string	Search awards
`order_by`	string	Sort field
`limit`	integer	Page size
`offset`	integer	Page offset

Example Request

bash

curl -X GET "http://localhost:8000/api/v1/financial-aid/awards?award_type=scholarship&status=approved" \
  -b cookies.txt

Success Response (200 OK)

json

{
  "count": 25,
  "results": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "application_id": 100,
      "term_id": 10,
      "award_type_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "award_type": "scholarship",
      "award_category": "merit",
      "award_name": "Presidential Scholarship",
      "amount": "10000.00",
      "status": "approved",
      "is_renewable": true,
      "requires_fafsa": false,
      "disbursement_schedule": "per_term",
      "renewal_conditions": "Maintain 3.5 GPA",
      "assigned_by_department": "ADMISSIONS",
      "assigned_by": 1,
      "assigned_at": "2024-03-15T10:00:00Z",
      "approved_by": 2,
      "approved_at": "2024-03-20T14:30:00Z",
      "notes": null,
      "created_at": "2024-03-15T10:00:00Z",
      "updated_at": "2024-03-20T14:30:00Z"
    }
  ]
}

TypeScript Types

typescript

interface Award {
  id: string
  person_id: string
  application_id: number | null
  term_id: number | null
  award_type_id: string | null
  award_type: 'scholarship' | 'grant' | 'loan' | 'work_study'
  award_category: string | null
  award_name: string
  amount: string
  status: 'pending' | 'approved' | 'active' | 'disbursed' | 'cancelled' | 'expired'
  is_renewable: boolean
  requires_fafsa: boolean
  disbursement_schedule: string | null
  renewal_conditions: string | null
  assigned_by_department: string | null
  assigned_by: number
  assigned_at: string
  approved_by: number | null
  approved_at: string | null
  notes: string | null
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
  award_type_ref: AwardType | null
}

Create Award

POST /api/v1/financial-aid/awards

Request Body

Field	Type	Required	Description
`person_id`	uuid	Yes	Person receiving the award
`application_id`	integer	No	Related admission application
`term_id`	integer	No	Term the award applies to
`award_type_id`	uuid	No	Award type template ID
`award_type`	string	Yes	One of: `scholarship`, `grant`, `loan`, `work_study`
`award_category`	string	No	Category classification
`award_name`	string	Yes	Award name (max 200)
`amount`	decimal	Yes	Award amount
`status`	string	No	One of: `pending`, `approved`, `active`, `disbursed`, `cancelled`, `expired`
`is_renewable`	boolean	No	Whether award is renewable
`requires_fafsa`	boolean	No	Whether FAFSA is required
`disbursement_schedule`	string	No	Disbursement schedule
`renewal_conditions`	string	No	Conditions for renewal
`assigned_by_department`	string	No	One of: `ADMISSIONS`, `STUDENT_FINANCE`
`notes`	string	No	Staff notes

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/awards \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "term_id": 10,
    "award_type": "scholarship",
    "award_name": "Presidential Scholarship",
    "amount": "10000.00",
    "assigned_by_department": "ADMISSIONS"
  }'

Approve Award

POST /api/v1/financial-aid/awards/{awardID}/approve

Approve a pending award. Sets status to approved and records the approver.

Request Body

Field	Type	Required	Description
`notes`	string	No	Approval notes

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/awards/b2c3d4e5-f6a7-8901-bcde-f12345678901/approve \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"notes": "Approved per committee review"}'

Success Response (200 OK)

json

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "approved",
  "approved_by": 2,
  "approved_at": "2024-03-20T14:30:00Z"
}

FAFSA

Manage FAFSA (Free Application for Federal Student Aid) data for students.

List FAFSA Records

GET /api/v1/financial-aid/fafsa

Query Parameters

Parameter	Type	Description
`person_id`	uuid	Filter by person
`fafsa_year`	integer	Filter by FAFSA year
`verified`	boolean	Filter by verification status
`search`	string	Search records
`order_by`	string	Sort field
`limit`	integer	Page size
`offset`	integer	Page offset

Example Request

bash

curl -X GET "http://localhost:8000/api/v1/financial-aid/fafsa?fafsa_year=2025" \
  -b cookies.txt

Success Response (200 OK)

json

{
  "count": 10,
  "results": [
    {
      "id": "d4e5f6a7-b8c9-0123-defg-234567890123",
      "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "application_id": 100,
      "fafsa_year": 2025,
      "submission_date": "2024-10-01T00:00:00Z",
      "processed_date": "2024-10-15T00:00:00Z",
      "efc": 5000,
      "sai": -1500,
      "pell_eligible": true,
      "pell_amount": "7395.00",
      "dependency_status": "dependent",
      "income_range": "30000-39999",
      "housing_plan": "on_campus",
      "verification_required": false,
      "verification_completed": false,
      "verified_by": null,
      "verified_at": null,
      "entered_by": 1,
      "entered_at": "2024-10-01T00:00:00Z",
      "notes": null,
      "created_at": "2024-10-01T00:00:00Z",
      "updated_at": "2024-10-15T00:00:00Z"
    }
  ]
}

TypeScript Types

typescript

interface FAFSAData {
  id: string
  person_id: string
  application_id: number | null
  fafsa_year: number
  submission_date: string | null
  processed_date: string | null
  efc: number | null
  sai: number | null
  pell_eligible: boolean | null
  pell_amount: string | null
  dependency_status: 'dependent' | 'independent' | null
  income_range: string | null
  housing_plan: 'on_campus' | 'off_campus_with_parents' | 'off_campus_not_with_parents' | null
  verification_required: boolean
  verification_completed: boolean
  verified_by: number | null
  verified_at: string | null
  entered_by: number
  entered_at: string
  notes: string | null
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
}

Create FAFSA Record

POST /api/v1/financial-aid/fafsa

Request Body

Field	Type	Required	Description
`person_id`	uuid	Yes	Person ID
`application_id`	integer	No	Related admission application
`fafsa_year`	integer	Yes	FAFSA award year
`submission_date`	datetime	No	Date submitted
`processed_date`	datetime	No	Date processed
`efc`	integer	No	Expected Family Contribution (legacy)
`sai`	integer	No	Student Aid Index (new formula)
`pell_eligible`	boolean	No	Pell Grant eligibility
`pell_amount`	decimal	No	Pell Grant amount
`dependency_status`	string	No	One of: `dependent`, `independent`
`income_range`	string	No	Income range bracket
`housing_plan`	string	No	One of: `on_campus`, `off_campus_with_parents`, `off_campus_not_with_parents`
`verification_required`	boolean	No	Whether verification is needed
`notes`	string	No	Staff notes

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/fafsa \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "fafsa_year": 2025,
    "submission_date": "2024-10-01T00:00:00Z",
    "efc": 5000,
    "sai": -1500,
    "pell_eligible": true,
    "dependency_status": "dependent",
    "housing_plan": "on_campus"
  }'

Verify FAFSA

POST /api/v1/financial-aid/fafsa/{fafsaID}/verify

Mark a FAFSA record as verified. Sets verification_completed to true and records the verifier.

Request Body

Field	Type	Required	Description
`notes`	string	No	Verification notes

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/fafsa/d4e5f6a7-b8c9-0123-defg-234567890123/verify \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{"notes": "Documents reviewed and verified"}'

Financial Estimates

Financial estimates represent cost of attendance projections for prospective or current students.

List Estimates

GET /api/v1/financial-aid/estimates

Query Parameters

Parameter	Type	Description
`person_id`	uuid	Filter by person
`application_id`	integer	Filter by application
`term_id`	integer	Filter by term
`status`	string	Filter by status
`department`	string	Filter by requesting department
`search`	string	Search estimates
`order_by`	string	Sort field
`limit`	integer	Page size
`offset`	integer	Page offset

Example Request

bash

curl -X GET "http://localhost:8000/api/v1/financial-aid/estimates?status=published" \
  -b cookies.txt

Success Response (200 OK)

json

{
  "count": 5,
  "results": [
    {
      "id": "e5f6a7b8-c9d0-1234-efgh-345678901234",
      "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "application_id": 100,
      "term_id": 10,
      "degree_id": 5,
      "fafsa_data_id": "d4e5f6a7-b8c9-0123-defg-234567890123",
      "estimate_name": "Fall 2025 Financial Estimate",
      "estimate_type": "single_term",
      "academic_year": "2025-2026",
      "enrollment_status": "full_time",
      "housing_type": "on_campus",
      "credits_per_term": 15,
      "version": 1,
      "previous_estimate_id": null,
      "tuition_fees_total": "12000.00",
      "housing_costs_total": "5000.00",
      "meal_plan_total": "3000.00",
      "books_supplies_total": "1200.00",
      "other_costs_total": "500.00",
      "total_costs": "21700.00",
      "scholarships_grants_total": "10000.00",
      "loans_total": "5500.00",
      "work_study_total": "2000.00",
      "total_aid": "17500.00",
      "net_cost": "4200.00",
      "fafsa_required": true,
      "fafsa_received": true,
      "status": "published",
      "requested_by_department": "ADMISSIONS",
      "published_at": "2024-11-01T00:00:00Z",
      "expires_at": "2025-05-01T00:00:00Z",
      "created_at": "2024-10-15T00:00:00Z",
      "updated_at": "2024-11-01T00:00:00Z"
    }
  ]
}

TypeScript Types

typescript

interface FinancialEstimate {
  id: string
  person_id: string
  application_id: number | null
  term_id: number | null
  degree_id: number | null
  fafsa_data_id: string | null
  estimate_name: string
  estimate_type: 'full_year' | 'single_term'
  academic_year: string | null
  enrollment_status: 'full_time' | 'part_time' | 'half_time' | null
  housing_type: string | null
  credits_per_term: number | null
  version: number
  previous_estimate_id: string | null
  tuition_fees_total: string
  housing_costs_total: string
  meal_plan_total: string
  books_supplies_total: string
  other_costs_total: string
  total_costs: string
  scholarships_grants_total: string
  loans_total: string
  work_study_total: string
  total_aid: string
  net_cost: string
  fafsa_required: boolean
  fafsa_received: boolean
  status: 'draft' | 'pending_review' | 'published' | 'accepted' | 'declined' | 'expired' | 'superseded'
  requested_by_department: string | null
  requested_by: number | null
  requested_at: string | null
  published_at: string | null
  published_by: number | null
  accepted_at: string | null
  declined_at: string | null
  expires_at: string | null
  staff_notes: string | null
  student_notes: string | null
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
  cost_items: EstimateCostItem[]
  awards: EstimateAward[]
}

Create Estimate

POST /api/v1/financial-aid/estimates

Request Body

Field	Type	Required	Description
`person_id`	uuid	Yes	Person ID
`application_id`	integer	No	Related admission application
`term_id`	integer	No	Term ID
`degree_id`	integer	No	Degree program ID
`fafsa_data_id`	uuid	No	Linked FAFSA record
`estimate_name`	string	Yes	Estimate name
`estimate_type`	string	No	One of: `full_year`, `single_term`
`academic_year`	string	No	Academic year (e.g., "2025-2026")
`enrollment_status`	string	No	One of: `full_time`, `part_time`, `half_time`
`housing_type`	string	No	Housing type
`credits_per_term`	integer	No	Expected credits per term
`tuition_fees_total`	decimal	No	Tuition and fees total
`housing_costs_total`	decimal	No	Housing costs total
`meal_plan_total`	decimal	No	Meal plan total
`books_supplies_total`	decimal	No	Books and supplies total
`other_costs_total`	decimal	No	Other costs total
`scholarships_grants_total`	decimal	No	Scholarships/grants total
`loans_total`	decimal	No	Loans total
`work_study_total`	decimal	No	Work-study total
`fafsa_required`	boolean	No	Whether FAFSA is required
`fafsa_received`	boolean	No	Whether FAFSA has been received
`staff_notes`	string	No	Internal staff notes
`student_notes`	string	No	Notes visible to student
`requested_by_department`	string	No	One of: `ADMISSIONS`, `STUDENT_FINANCE`

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "person_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "term_id": 10,
    "estimate_name": "Fall 2025 Financial Estimate",
    "estimate_type": "single_term",
    "enrollment_status": "full_time",
    "housing_type": "on_campus",
    "credits_per_term": 15,
    "requested_by_department": "ADMISSIONS"
  }'

Estimate Workflow Actions

Publish Estimate

POST /api/v1/financial-aid/estimates/{estimateID}/publish

Publish an estimate, making it visible to the student. Changes status from draft or pending_review to published.

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/publish \
  -b cookies.txt

Accept Estimate

POST /api/v1/financial-aid/estimates/{estimateID}/accept

Student accepts the published estimate. Changes status to accepted.

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/accept \
  -b cookies.txt

Decline Estimate

POST /api/v1/financial-aid/estimates/{estimateID}/decline

Student declines the published estimate. Changes status to declined.

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/decline \
  -b cookies.txt

Estimate Cost Items

Itemized cost breakdowns within a financial estimate.

List Cost Items

GET /api/v1/financial-aid/estimates/{estimateID}/cost-items

Example Request

bash

curl -X GET http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/cost-items \
  -b cookies.txt

Success Response (200 OK)

json

[
  {
    "id": "f6a7b8c9-d0e1-2345-fghi-456789012345",
    "estimate_id": "e5f6a7b8-c9d0-1234-efgh-345678901234",
    "category": "tuition",
    "item_name": "Undergraduate Tuition",
    "description": "15 credits at $800/credit",
    "unit_cost": "800.00",
    "quantity": 15,
    "total_cost": "12000.00",
    "frequency": "per_term",
    "is_required": true,
    "display_order": 1,
    "created_at": "2024-10-15T00:00:00Z",
    "updated_at": "2024-10-15T00:00:00Z"
  }
]

TypeScript Types

typescript

interface EstimateCostItem {
  id: string
  estimate_id: string
  category: 'tuition' | 'fees' | 'housing' | 'meals' | 'books' | 'supplies' | 'transportation' | 'personal' | 'technology' | 'health_insurance' | 'other'
  item_name: string
  description: string | null
  unit_cost: string
  quantity: number
  total_cost: string
  frequency: 'per_term' | 'per_year' | 'per_credit' | 'one_time'
  is_required: boolean
  display_order: number
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
}

Create Cost Item

POST /api/v1/financial-aid/estimates/{estimateID}/cost-items

Request Body

Field	Type	Required	Description
`estimate_id`	uuid	Yes	Parent estimate ID
`category`	string	Yes	One of: `tuition`, `fees`, `housing`, `meals`, `books`, `supplies`, `transportation`, `personal`, `technology`, `health_insurance`, `other`
`item_name`	string	Yes	Item name
`description`	string	No	Item description
`unit_cost`	decimal	Yes	Cost per unit
`quantity`	integer	Yes	Quantity (>= 1)
`frequency`	string	Yes	One of: `per_term`, `per_year`, `per_credit`, `one_time`
`is_required`	boolean	No	Whether item is required
`display_order`	integer	No	Display sort order

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/cost-items \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "estimate_id": "e5f6a7b8-c9d0-1234-efgh-345678901234",
    "category": "tuition",
    "item_name": "Undergraduate Tuition",
    "unit_cost": "800.00",
    "quantity": 15,
    "frequency": "per_term",
    "is_required": true
  }'

Update Cost Item

PATCH /api/v1/financial-aid/cost-items/{costItemID}

All fields are optional. Only provided fields are updated.

Delete Cost Item

DELETE /api/v1/financial-aid/cost-items/{costItemID}

Estimate Awards

Link awards to financial estimates to show projected aid.

List Estimate Awards

GET /api/v1/financial-aid/estimates/{estimateID}/awards

Example Request

bash

curl -X GET http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/awards \
  -b cookies.txt

Success Response (200 OK)

json

[
  {
    "id": "a7b8c9d0-e1f2-3456-ghij-567890123456",
    "estimate_id": "e5f6a7b8-c9d0-1234-efgh-345678901234",
    "award_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "estimated_amount": "10000.00",
    "display_order": 1,
    "notes": null,
    "created_at": "2024-10-15T00:00:00Z",
    "updated_at": "2024-10-15T00:00:00Z"
  }
]

TypeScript Types

typescript

interface EstimateAward {
  id: string
  estimate_id: string
  award_id: string
  estimated_amount: string
  display_order: number
  notes: string | null
  created_at: string
  created_by: string | null
  updated_at: string
  updated_by: string | null
  award: Award | null
}

Create Estimate Award

POST /api/v1/financial-aid/estimates/{estimateID}/awards

Request Body

Field	Type	Required	Description
`estimate_id`	uuid	Yes	Parent estimate ID
`award_id`	uuid	Yes	Award to link
`estimated_amount`	decimal	Yes	Estimated amount for this estimate
`display_order`	integer	No	Display sort order
`notes`	string	No	Notes about this award in context

Example Request

bash

curl -X POST http://localhost:8000/api/v1/financial-aid/estimates/e5f6a7b8-c9d0-1234-efgh-345678901234/awards \
  -b cookies.txt \
  -H "Content-Type: application/json" \
  -d '{
    "estimate_id": "e5f6a7b8-c9d0-1234-efgh-345678901234",
    "award_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "estimated_amount": "10000.00",
    "display_order": 1
  }'

Update Estimate Award

PATCH /api/v1/financial-aid/estimate-awards/{estAwardID}

Request Body

Field	Type	Required	Description
`estimated_amount`	decimal	No	Updated amount
`display_order`	integer	No	Updated sort order
`notes`	string	No	Updated notes

Delete Estimate Award

DELETE /api/v1/financial-aid/estimate-awards/{estAwardID}

Complete endpoint reference

Every route this domain registers, with the permission node that gates it. Generated from the route table, so it is complete by construction — the sections above explain behaviour, this one guarantees nothing is missing.

Paths are relative to /api/v1/financial-aid. A node in italics is an exemption rather than a grant: selfservice acts only on the caller's own record, public needs no session at all, and custom carries its own wrapper.

Method	Endpoint	Permission node	Description
GET	`/award-types`	`FINANCIALAID.AWARD_TYPES`	List award types
POST	`/award-types`	`FINANCIALAID.AWARD_TYPES`	Create a award type
DELETE	`/award-types/{awardTypeID}`	`FINANCIALAID.AWARD_TYPES`	Delete a award type
GET	`/award-types/{awardTypeID}`	`FINANCIALAID.AWARD_TYPES`	Get one award type
PATCH	`/award-types/{awardTypeID}`	`FINANCIALAID.AWARD_TYPES`	Update a award type
GET	`/awards`	`FINANCIALAID.AWARDS`	List awards
POST	`/awards`	`FINANCIALAID.AWARDS`	Create a award
DELETE	`/awards/{awardID}`	`FINANCIALAID.AWARDS`	Delete a award
GET	`/awards/{awardID}`	`FINANCIALAID.AWARDS`	Get one award
PATCH	`/awards/{awardID}`	`FINANCIALAID.AWARDS`	Update a award
POST	`/awards/{awardID}/approve`	`FINANCIALAID.AWARDS`	Approve for a award
DELETE	`/cost-items/{costItemID}`	`FINANCIALAID.ESTIMATES`	Delete a cost item
PATCH	`/cost-items/{costItemID}`	`FINANCIALAID.ESTIMATES`	Update a cost item
DELETE	`/estimate-awards/{estAwardID}`	`FINANCIALAID.ESTIMATES`	Delete a estimate award
PATCH	`/estimate-awards/{estAwardID}`	`FINANCIALAID.ESTIMATES`	Update a estimate award
GET	`/estimates`	`FINANCIALAID.ESTIMATES`	List estimates
POST	`/estimates`	`FINANCIALAID.ESTIMATES`	Create a estimate
DELETE	`/estimates/{estimateID}`	`FINANCIALAID.ESTIMATES`	Delete a estimate
GET	`/estimates/{estimateID}`	`FINANCIALAID.ESTIMATES`	Get one estimate
PATCH	`/estimates/{estimateID}`	`FINANCIALAID.ESTIMATES`	Update a estimate
POST	`/estimates/{estimateID}/accept`	`FINANCIALAID.ESTIMATES`	Accept for a estimate
GET	`/estimates/{estimateID}/awards`	`FINANCIALAID.ESTIMATES`	List the estimate's awards
POST	`/estimates/{estimateID}/awards`	`FINANCIALAID.ESTIMATES`	Add awards to a estimate
GET	`/estimates/{estimateID}/cost-items`	`FINANCIALAID.ESTIMATES`	List the estimate's cost items
POST	`/estimates/{estimateID}/cost-items`	`FINANCIALAID.ESTIMATES`	Add cost items to a estimate
POST	`/estimates/{estimateID}/decline`	`FINANCIALAID.ESTIMATES`	Decline for a estimate
POST	`/estimates/{estimateID}/publish`	`FINANCIALAID.ESTIMATES`	Publish for a estimate
GET	`/fafsa`	`FINANCIALAID.FAFSA`	Get FAFSA
POST	`/fafsa`	`FINANCIALAID.FAFSA`	Create FAFSA
DELETE	`/fafsa/{fafsaID}`	`FINANCIALAID.FAFSA`	Delete a FAFSA
GET	`/fafsa/{fafsaID}`	`FINANCIALAID.FAFSA`	Get one FAFSA
PATCH	`/fafsa/{fafsaID}`	`FINANCIALAID.FAFSA`	Update a FAFSA
POST	`/fafsa/{fafsaID}/verify`	`FINANCIALAID.FAFSA`	Verify for a FAFSA

Financial Aid API ​

Endpoints Overview ​

Award Types ​

Awards ​

FAFSA ​

Financial Estimates ​

Estimate Cost Items ​

Estimate Awards ​

Award Types ​

List Award Types ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create Award Type ​

Request Body ​

Example Request ​

Update Award Type ​

Awards ​

List Awards ​

Query Parameters ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create Award ​

Request Body ​

Example Request ​

Approve Award ​

Request Body ​

Example Request ​

Success Response (200 OK) ​

FAFSA ​

List FAFSA Records ​

Query Parameters ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create FAFSA Record ​

Request Body ​

Example Request ​

Verify FAFSA ​

Request Body ​

Example Request ​

Financial Estimates ​

List Estimates ​

Query Parameters ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create Estimate ​

Request Body ​

Example Request ​

Estimate Workflow Actions ​

Publish Estimate ​

Example Request ​

Accept Estimate ​

Example Request ​

Decline Estimate ​

Example Request ​

Estimate Cost Items ​

List Cost Items ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create Cost Item ​

Request Body ​

Example Request ​

Update Cost Item ​

Delete Cost Item ​

Estimate Awards ​

List Estimate Awards ​

Example Request ​

Success Response (200 OK) ​

TypeScript Types ​

Create Estimate Award ​

Request Body ​

Example Request ​

Update Estimate Award ​

Request Body ​

Delete Estimate Award ​

Complete endpoint reference ​

Financial Aid API

Endpoints Overview

Award Types

Awards

FAFSA

Financial Estimates

Estimate Cost Items

Estimate Awards

Award Types

List Award Types

Example Request

Success Response (200 OK)

TypeScript Types

Create Award Type

Request Body

Example Request

Update Award Type

Awards

List Awards

Query Parameters

Example Request

Success Response (200 OK)

TypeScript Types

Create Award

Request Body

Example Request

Approve Award

Request Body

Example Request

Success Response (200 OK)

FAFSA

List FAFSA Records

Query Parameters

Example Request

Success Response (200 OK)

TypeScript Types

Create FAFSA Record

Request Body

Example Request

Verify FAFSA

Request Body

Example Request

Financial Estimates

List Estimates

Query Parameters

Example Request

Success Response (200 OK)

TypeScript Types

Create Estimate

Request Body

Example Request

Estimate Workflow Actions

Publish Estimate

Example Request

Accept Estimate

Example Request

Decline Estimate

Example Request

Estimate Cost Items

List Cost Items

Example Request

Success Response (200 OK)

TypeScript Types

Create Cost Item

Request Body

Example Request

Update Cost Item

Delete Cost Item

Estimate Awards

List Estimate Awards

Example Request

Success Response (200 OK)

TypeScript Types

Create Estimate Award

Request Body

Example Request

Update Estimate Award

Request Body

Delete Estimate Award

Complete endpoint reference