{
 "openapi": "3.1.0",
 "info": {
  "title": "Referrals (CRM)",
  "version": "20261030b",
  "description": "Who was referred, by whom, what became of it and what the referrer is owed."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "referrals": {
    "type": "object",
    "required": [
     "referred_name"
    ],
    "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
     },
     "referral_no": {
      "type": "string",
      "description": "Referral no",
      "readOnly": true
     },
     "referrer_type": {
      "type": "string",
      "description": "Referrer type",
      "enum": [
       "student",
       "alumni",
       "contact",
       "account",
       "staff",
       "partner",
       "other"
      ]
     },
     "referrer_id": {
      "type": "string",
      "format": "uuid",
      "description": "Referring student"
     },
     "referrer_name": {
      "type": "string",
      "description": "Referrer name"
     },
     "referrer_email": {
      "type": "string",
      "description": "Referrer email"
     },
     "referred_name": {
      "type": "string",
      "description": "Referred name"
     },
     "referred_email": {
      "type": "string",
      "description": "Referred email"
     },
     "referred_phone": {
      "type": "string",
      "description": "Referred phone"
     },
     "prospect_id": {
      "type": "string",
      "format": "uuid",
      "description": "Prospect id"
     },
     "program_id": {
      "type": "string",
      "format": "uuid",
      "description": "Program"
     },
     "campaign_id": {
      "type": "string",
      "format": "uuid",
      "description": "Campaign"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "submitted",
       "contacted",
       "qualified",
       "converted",
       "declined",
       "expired",
       "duplicate"
      ]
     },
     "submitted_at": {
      "type": "string",
      "format": "date-time",
      "description": "Submitted at",
      "readOnly": true
     },
     "converted_at": {
      "type": "string",
      "format": "date-time",
      "description": "Converted at",
      "readOnly": true
     },
     "reward_type": {
      "type": "string",
      "description": "Reward"
     },
     "reward_amount": {
      "type": "string",
      "format": "decimal",
      "description": "Reward amount"
     },
     "reward_status": {
      "type": "string",
      "description": "Reward status",
      "enum": [
       "pending",
       "approved",
       "paid",
       "declined",
       "not_applicable"
      ]
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "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
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/crm/referrals": {
   "get": {
    "summary": "list referrals",
    "operationId": "list_referrals_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create referrals",
    "operationId": "create_referrals_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/referrals/{id}": {
   "get": {
    "summary": "get referrals",
    "operationId": "get_referrals_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change referrals",
    "operationId": "change_referrals_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete referrals",
    "operationId": "delete_referrals_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/crm/referrals/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_referrals_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/crm/referrals/{id}/convert-to-prospect": {
   "post": {
    "summary": "Convert to prospect",
    "operationId": "action_referrals_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}