AssetLab Asset Betterments API

openapi: 3.2.0
info:
  title: Assetlab Ca Asset Betterments API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Asset Betterments across 2 of this provider''s published API definitions: assetlab-ca-openapi.yaml, assetlab-ca-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: Asset Betterments
paths:
  /asset-betterments:
    get:
      operationId: listAssetBetterments
      summary: List asset betterments
      tags:
      - Asset Betterments
      description: 'Returns a paginated list of betterments — capital work that extended an asset''s life.

        Requires `asset_betterments:read` scope.'
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - in: query
        name: asset_id
        schema:
          type: string
          format: uuid
      - in: query
        name: project_id
        schema:
          type: string
          format: uuid
      - in: query
        name: work_order_id
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Paginated betterment list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AssetBetterment'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: createAssetBetterment
      summary: Record an asset betterment
      tags:
      - Asset Betterments
      description: 'Requires `asset_betterments:write` scope. `capitalized_amount` and `added_life_years`

        are optional and may be 0. The asset''s `purchase_date` is not changed.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetBettermentCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetBetterment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /asset-betterments/{id}:
    get:
      operationId: getAssetBetterment
      summary: Get an asset betterment
      tags:
      - Asset Betterments
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Betterment detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetBetterment'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateAssetBetterment
      summary: Update an asset betterment
      tags:
      - Asset Betterments
      description: Requires `asset_betterments:write` scope. `asset_id` is immutable.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetBettermentUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AssetBetterment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteAssetBetterment
      summary: Delete an asset betterment
      tags:
      - Asset Betterments
      description: 'Requires `asset_betterments:write` scope. Soft delete — the asset''s net book value and

        remaining life revert to what they were without it.'
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Deleted
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request (validation error or malformed input)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 1000
      description: Items per page
  schemas:
    AssetBetterment:
      type: object
      description: 'Capital work that extended one facility asset''s life — an elevator modernization, a

        boiler retube, a major component replacement. A betterment re-bases the asset''s

        depreciation prospectively: the original basis keeps depreciating on its original

        schedule, and the capitalized amount becomes its own layer depreciating from

        `occurred_on` over the life the work bought. The asset''s `purchase_date` is never

        changed — that column is the depreciation start, the age basis, the replacement-value

        escalation base, the deferred-maintenance test and the renewal forecast anchor, and

        moving it would claim the whole asset is new.


        Distinct from `AssetLifecycleEvent`, which models work expected in future and is keyed

        to an asset type. Distinct from a condition assessment, which records what someone

        observed. Recording a betterment never implies either.

        '
      properties:
        id:
          type: string
          format: uuid
        asset_id:
          type: string
          format: uuid
        occurred_on:
          type: string
          format: date
          description: Date the work went into service — not the invoice date; the layer depreciates from here
        description:
          type: string
          nullable: true
        capitalized_amount:
          type: number
          description: Amount added to the asset's value. Money in the organization's currency - GET /v1/organization-settings for currency_code
        added_life_years:
          type: number
          nullable: true
          description: Extra service life the work bought, in years
        asset_lifecycle_event_id:
          type: string
          format: uuid
          nullable: true
          description: The lifecycle strategy event this executed, if any
        work_order_id:
          type: string
          format: uuid
          nullable: true
        project_id:
          type: string
          format: uuid
          nullable: true
        asset_cost_id:
          type: string
          format: uuid
          nullable: true
          description: The cost row holding the spend, so the money is not double-entered
        recorded_by:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        total:
          type: integer
          example: 142
        total_pages:
          type: integer
          example: 6
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    AssetBettermentCreate:
      type: object
      required:
      - asset_id
      - occurred_on
      description: '`capitalized_amount` and `added_life_years` are both optional and may be 0; omitted,

        the amount is stored as 0 and added life as null.

        '
      properties:
        asset_id:
          type: string
          format: uuid
        occurred_on:
          type: string
          format: date
        description:
          type: string
          nullable: true
        capitalized_amount:
          type: number
          description: Money in the organization's currency - GET /v1/organization-settings for currency_code
        added_life_years:
          type: number
          nullable: true
        asset_lifecycle_event_id:
          type: string
          format: uuid
          nullable: true
        work_order_id:
          type: string
          format: uuid
          nullable: true
        project_id:
          type: string
          format: uuid
          nullable: true
        asset_cost_id:
          type: string
          format: uuid
          nullable: true
    AssetBettermentUpdate:
      type: object
      description: '`asset_id` is immutable — delete and re-create to move a betterment to another asset.

        '
      properties:
        occurred_on:
          type: string
          format: date
        description:
          type: string
          nullable: true
        capitalized_amount:
          type: number
          description: Money in the organization's currency - GET /v1/organization-settings for currency_code
        added_life_years:
          type: number
          nullable: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key from AssetLab Settings > API Keys
x-refined-from:
- assetlab-ca-openapi.yaml
- assetlab-ca-openapi.yaml
x-tagGroups:
- name: Core
  tags:
  - Assets
  - Work Orders
  - Work Requests
  - PM Schedules
  - PM Templates
- name: Facilities
  tags:
  - Sites
  - Buildings
  - Locations
- name: Feature Classification
  tags:
  - Systems
  - System Groups
  - System Classes
  - Asset Types
  - Asset Type Groups
  - Manufacturers
- name: Projects
  tags:
  - Projects
  - Project Sites
  - Project Buildings
  - Project Locations
  - Project System Classes
  - Project System Groups
  - Project Systems
  - Project Assets
  - Project Tasks
  - Project Milestones
  - Project Phases
  - Project Budget Items
  - Project Time Entries
  - Project Comments
  - Project Risks
  - Project Document Folder Templates
- name: Financial
  tags:
  - Budgets
  - Invoices
  - Purchase Orders
  - Expenses
  - Change Orders
  - Cost Categories
  - Asset Costs
  - Asset Replacement Plans
- name: Vendors & Contracts
  tags:
  - Vendors
  - Contracts
  - Vendor Site Assignments
  - Contract Sites
- name: Compliance
  tags:
  - Compliance
  - Compliance Records
- name: Parts & Inventory
  tags:
  - Parts
  - Part Categories
- name: Comments & Documents
  tags:
  - Asset Comments
  - Work Order Comments
  - Asset Documents
  - Project Documents
  - Contract Documents
  - Attachments
  - Upload URLs
- name: Level of Service
  tags:
  - Service Areas
  - Service Area System Classes
  - Service Area Sites
  - LoS Measures
  - LoS Measurements
  - LoS Proposed Targets
  - LoS Targets History
  - System LoS Targets
  - Infrastructure LoS Targets
  - Criticality Modifiers
  - LoS Consequences
  - LoS Status Snapshots
- name: Infrastructure
  tags:
  - Infrastructure Feature Classes
  - Infrastructure Networks
  - Infrastructure Assets
  - Infrastructure Asset Inspections
- name: Dashboard & Analytics
  tags:
  - Dashboard
  - Dashboard Snapshots
  - Site FCI History
  - Asset Risk History
  - Asset Condition Assessments
- name: Configuration
  tags:
  - Asset Statuses
  - Work Categories
  - Building Types
  - Location Types
  - Custom Field Definitions
  - Custom Field Values