feat: adding docs for mileate rates related fields in expenses api

reference/admin.yaml

@@ -17911,6 +17911,11 @@ components:
         - rate
         - vehicle_type
         - is_enabled
+        - vehicle_ownership
+        - vehicle_category
+        - fuel_type
+        - engine_capacity
+        - charging_location
       properties:
         id:
           $ref: '#/components/schemas/id_integer'
@@ -20311,6 +20316,58 @@ components:
           example: 10
           nullable: true
           description: Amount (in Home currency) per unit.
+        vehicle_ownership:
+          type: string
+          nullable: true
+          enum:
+            - PERSONAL
+            - COMPANY
+            - null
+          description: Vehicle ownership for advanced mileage rates. `null` for basic mileage rates.
+        vehicle_category:
+          type: string
+          nullable: true
+          enum:
+            - CAR
+            - MOTORCYCLE
+            - BICYCLE
+            - null
+          description: Vehicle category for advanced mileage rates. `null` for basic mileage rates.
+        fuel_type:
+          type: string
+          nullable: true
+          enum:
+            - PETROL
+            - DIESEL
+            - LPG
+            - ELECTRIC
+            - null
+          description: Fuel type for advanced car mileage rates. `null` otherwise.
+        engine_capacity:
+          type: object
+          nullable: true
+          additionalProperties: false
+          description: Engine capacity band for petrol, diesel, and LPG advanced car rates. An empty object for basic mileage rates.
+          properties:
+            from:
+              type: string
+              nullable: true
+              example: '0'
+            to:
+              type: string
+              nullable: true
+              example: '1400'
+            unit:
+              type: string
+              example: cc
+        charging_location:
+          type: string
+          nullable: true
+          enum:
+            - HOME
+            - PUBLIC
+            - null
+          description: Charging location for advanced electric car mileage rates. `null` otherwise.
     expense_custom_field:
       type: object
       description: |
@@ -21322,6 +21379,11 @@ components:
         - distance_unit
         - mileage_calculated_distance
         - mileage_calculated_amount
+        - selected_vehicle_ownership
+        - selected_vehicle_category
+        - passenger_count
+        - passenger_mileage_rate
+        - passenger_amount
         - mileage_rate_id
         - mileage_rate
         - mileage_is_round_trip
@@ -21546,6 +21608,36 @@ components:
           type: number
           nullable: true
           description: Amount computed by Sage Exp Mgmt in mileage expenses.
+        selected_vehicle_ownership:
+          type: string
+          nullable: true
+          enum:
+            - PERSONAL
+            - COMPANY
+            - null
+          description: Selected vehicle ownership for an advanced mileage expense. `null` for a basic mileage expense.
+        selected_vehicle_category:
+          type: string
+          nullable: true
+          enum:
+            - CAR
+            - MOTORCYCLE
+            - BICYCLE
+            - null
+          description: Selected vehicle category for an advanced mileage expense. `null` for a basic mileage expense.
+        passenger_count:
+          type: integer
+          nullable: true
+          description: Number of passengers carried on the mileage journey.
+        passenger_mileage_rate:
+          type: number
+          nullable: true
+          readOnly: true
+          description: Passenger mileage rate snapshot applied to this expense. `null` when passenger mileage does not apply.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: Passenger mileage reimbursement amount for this expense.
         mileage_rate_id:
           allOf:
             - $ref: '#/components/schemas/fk_integer'
@@ -22155,6 +22247,16 @@ components:
           type: number
           nullable: true
           description: Amount computed by Sage Exp Mgmt in mileage expenses.
+        passenger_count:
+          type: integer
+          nullable: true
+          description: |
+            Number of passengers carried on the mileage journey. For advanced CAR mileage when passenger mileage is enabled, this is optional; when provided, it must be between 1 and 6. It must be `0` for MOTORCYCLE or BICYCLE mileage, and `null` for basic mileage or when passenger mileage is disabled.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: |
+            Passenger mileage reimbursement amount for this expense. For advanced CAR mileage when passenger mileage is enabled and `passenger_count` is provided, it must equal `passenger_count * passenger_mileage_rate * distance`, rounded to two decimal places. It must be `null` when `passenger_count` is `null`, for basic mileage, or when passenger mileage is disabled; no passenger reimbursement is applied for MOTORCYCLE or BICYCLE mileage.
         commute_details_id:
           type: integer
           nullable: true
@@ -34810,6 +34912,16 @@ components:
           $ref: '#/components/schemas/distance'
         distance_unit:
           $ref: '#/components/schemas/distance_unit'
+        passenger_count:
+          type: integer
+          nullable: true
+          description: |
+            Number of passengers carried on the mileage journey. For advanced CAR mileage when passenger mileage is enabled, this is optional; when provided, it must be between 1 and 6. It must be `0` for MOTORCYCLE or BICYCLE mileage, and `null` for basic mileage or when passenger mileage is disabled.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: |
+            Passenger mileage reimbursement amount for this expense. For advanced CAR mileage when passenger mileage is enabled and `passenger_count` is provided, it must equal `passenger_count * passenger_mileage_rate * distance`, rounded to two decimal places. It must be `null` when `passenger_count` is `null`, for basic mileage, or when passenger mileage is disabled; no passenger reimbursement is applied for MOTORCYCLE or BICYCLE mileage.
         started_at:
           $ref: '#/components/schemas/timestamptz_pst'
         ended_at:

reference/approver.yaml

@@ -5596,6 +5596,58 @@ components:
           example: 10
           nullable: true
           description: Amount (in Home currency) per unit.
+        vehicle_ownership:
+          type: string
+          nullable: true
+          enum:
+            - PERSONAL
+            - COMPANY
+            - null
+          description: Vehicle ownership for advanced mileage rates. `null` for basic mileage rates.
+        vehicle_category:
+          type: string
+          nullable: true
+          enum:
+            - CAR
+            - MOTORCYCLE
+            - BICYCLE
+            - null
+          description: Vehicle category for advanced mileage rates. `null` for basic mileage rates.
+        fuel_type:
+          type: string
+          nullable: true
+          enum:
+            - PETROL
+            - DIESEL
+            - LPG
+            - ELECTRIC
+            - null
+          description: Fuel type for advanced car mileage rates. `null` otherwise.
+        engine_capacity:
+          type: object
+          nullable: true
+          additionalProperties: false
+          description: Engine capacity band for petrol, diesel, and LPG advanced car rates. An empty object for basic mileage rates.
+          properties:
+            from:
+              type: string
+              nullable: true
+              example: '0'
+            to:
+              type: string
+              nullable: true
+              example: '1400'
+            unit:
+              type: string
+              example: cc
+        charging_location:
+          type: string
+          nullable: true
+          enum:
+            - HOME
+            - PUBLIC
+            - null
+          description: Charging location for advanced electric car mileage rates. `null` otherwise.
     per_diem_rate_out_embed:
       type: object
       nullable: true
@@ -6638,6 +6690,11 @@ components:
         - distance_unit
         - mileage_calculated_distance
         - mileage_calculated_amount
+        - selected_vehicle_ownership
+        - selected_vehicle_category
+        - passenger_count
+        - passenger_mileage_rate
+        - passenger_amount
         - mileage_rate_id
         - mileage_rate
         - mileage_is_round_trip
@@ -6862,6 +6919,36 @@ components:
           type: number
           nullable: true
           description: Amount computed by Sage Exp Mgmt in mileage expenses.
+        selected_vehicle_ownership:
+          type: string
+          nullable: true
+          enum:
+            - PERSONAL
+            - COMPANY
+            - null
+          description: Selected vehicle ownership for an advanced mileage expense. `null` for a basic mileage expense.
+        selected_vehicle_category:
+          type: string
+          nullable: true
+          enum:
+            - CAR
+            - MOTORCYCLE
+            - BICYCLE
+            - null
+          description: Selected vehicle category for an advanced mileage expense. `null` for a basic mileage expense.
+        passenger_count:
+          type: integer
+          nullable: true
+          description: Number of passengers carried on the mileage journey.
+        passenger_mileage_rate:
+          type: number
+          nullable: true
+          readOnly: true
+          description: Passenger mileage rate snapshot applied to this expense. `null` when passenger mileage does not apply.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: Passenger mileage reimbursement amount for this expense.
         mileage_rate_id:
           allOf:
             - $ref: '#/components/schemas/fk_integer'
@@ -7449,6 +7536,16 @@ components:
           type: number
           nullable: true
           description: Amount computed by Sage Exp Mgmt in mileage expenses.
+        passenger_count:
+          type: integer
+          nullable: true
+          description: |
+            Number of passengers carried on the mileage journey. For advanced CAR mileage when passenger mileage is enabled, this is optional; when provided, it must be between 1 and 6. It must be `0` for MOTORCYCLE or BICYCLE mileage, and `null` for basic mileage or when passenger mileage is disabled.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: |
+            Passenger mileage reimbursement amount for this expense. For advanced CAR mileage when passenger mileage is enabled and `passenger_count` is provided, it must equal `passenger_count * passenger_mileage_rate * distance`, rounded to two decimal places. It must be `null` when `passenger_count` is `null`, for basic mileage, or when passenger mileage is disabled; no passenger reimbursement is applied for MOTORCYCLE or BICYCLE mileage.
         commute_details_id:
           type: integer
           nullable: true
@@ -9594,6 +9691,16 @@ components:
           $ref: '#/components/schemas/distance'
         distance_unit:
           $ref: '#/components/schemas/distance_unit'
+        passenger_count:
+          type: integer
+          nullable: true
+          description: |
+            Number of passengers carried on the mileage journey. For advanced CAR mileage when passenger mileage is enabled, this is optional; when provided, it must be between 1 and 6. It must be `0` for MOTORCYCLE or BICYCLE mileage, and `null` for basic mileage or when passenger mileage is disabled.
+        passenger_amount:
+          type: number
+          nullable: true
+          description: |
+            Passenger mileage reimbursement amount for this expense. For advanced CAR mileage when passenger mileage is enabled and `passenger_count` is provided, it must equal `passenger_count * passenger_mileage_rate * distance`, rounded to two decimal places. It must be `null` when `passenger_count` is `null`, for basic mileage, or when passenger mileage is disabled; no passenger reimbursement is applied for MOTORCYCLE or BICYCLE mileage.
         started_at:
           $ref: '#/components/schemas/timestamptz_pst'
         ended_at: