{
 "openapi": "3.1.0",
 "info": {
  "title": "Student Billing (Student Lifecycle)",
  "version": "20261030b",
  "description": "A term’s charges netted against aid. Issuing raises a real receivable in Accounting. Partially paid: the payer has paid something. Partially credited: only a credit note or refund has reduced it. Paid: closed, with a payment toward it. Credited: closed by credit notes alone."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "student-bills": {
    "type": "object",
    "required": [],
    "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
     },
     "bill_no": {
      "type": "string",
      "description": "Bill no",
      "readOnly": true
     },
     "student_id": {
      "type": "string",
      "format": "uuid",
      "description": "Student id",
      "readOnly": true
     },
     "term_id": {
      "type": "string",
      "format": "uuid",
      "description": "Term id",
      "readOnly": true
     },
     "bill_date": {
      "type": "string",
      "format": "date",
      "description": "Bill date",
      "readOnly": true
     },
     "due_date": {
      "type": "string",
      "format": "date",
      "description": "Due date",
      "readOnly": true
     },
     "gross_charges": {
      "type": "string",
      "format": "decimal",
      "description": "Gross charges",
      "readOnly": true
     },
     "aid_applied": {
      "type": "string",
      "format": "decimal",
      "description": "Aid applied",
      "readOnly": true
     },
     "net_due": {
      "type": "string",
      "format": "decimal",
      "description": "Net due",
      "readOnly": true
     },
     "currency": {
      "type": "string",
      "description": "Currency",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "ar_invoice_id": {
      "type": "string",
      "format": "uuid",
      "description": "Ar invoice id",
      "readOnly": true
     },
     "cost_center_id": {
      "type": "string",
      "format": "uuid",
      "description": "Cost center id",
      "readOnly": true
     },
     "notes": {
      "type": "string",
      "description": "Notes",
      "readOnly": true
     },
     "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
     },
     "amount_settled": {
      "type": "string",
      "format": "decimal",
      "description": "Amount settled",
      "readOnly": true
     },
     "late_fee_for": {
      "type": "string",
      "format": "uuid",
      "description": "Late fee for",
      "readOnly": true
     },
     "late_fee_id": {
      "type": "string",
      "format": "uuid",
      "description": "Late fee id",
      "readOnly": true
     },
     "amount_paid": {
      "type": "string",
      "format": "decimal",
      "description": "Amount paid",
      "readOnly": true
     },
     "amount_credited": {
      "type": "string",
      "format": "decimal",
      "description": "Amount credited",
      "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/student-bills": {
   "get": {
    "summary": "list student-bills",
    "operationId": "list_student_bills_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post student billing",
    "operationId": "action_student_bills_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/student-bills/{id}": {
   "get": {
    "summary": "get student-bills",
    "operationId": "get_student_bills_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put student billing",
    "operationId": "action_student_bills_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete student billing",
    "operationId": "action_student_bills_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/student-bills/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_student_bills_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"
     }
    }
   }
  },
  "/api/slcm/student-bills/{parentId}/lines": {
   "get": {
    "summary": "Lines",
    "operationId": "action_student_bills_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Lines",
    "operationId": "action_student_bills_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/student-bills/{parentId}/lines/{lineId}": {
   "put": {
    "summary": "Lines",
    "operationId": "action_student_bills_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Lines",
    "operationId": "action_student_bills_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/student-bills/{id}/issue": {
   "post": {
    "summary": "Issue",
    "operationId": "action_student_bills_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/slcm/student-bills/{id}/record-payment": {
   "post": {
    "summary": "Record payment",
    "operationId": "action_student_bills_0_6",
    "description": "Body keys: amount, receiptDate, receipt_date, method",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}