openapi: 3.2.0
info:
  title: Hostfully Owner Adjustments API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Owner Adjustments
paths:
  /api/v3.3/owner-adjustments/{uid}:
    get:
      tags:
      - Owner Adjustments
      summary: Get owner adjustment by UID
      description: Retrieves a single owner adjustment by its unique identifier
      operationId: findByUid_2
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OwnerAdjustmentApiResponseWrapper'
    put:
      tags:
      - Owner Adjustments
      summary: Update owner adjustment
      description: Updates an existing owner adjustment record
      operationId: updateOwnerAdjustment
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OwnerAdjustmentSavingApi3Dto'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OwnerAdjustmentApiResponseWrapper'
    delete:
      tags:
      - Owner Adjustments
      summary: Delete owner adjustment
      description: Removes an owner adjustment record from the system
      operationId: deleteOwnerAdjustmentByUid
      parameters:
      - name: uid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /api/v3.3/owner-adjustments:
    get:
      tags:
      - Owner Adjustments
      summary: Get owner adjustments by property
      description: Retrieves all owner adjustments for a specific property
      operationId: findAll_5
      parameters:
      - name: propertyUid
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OwnerAdjustmentsApiResponseWrapper'
    post:
      tags:
      - Owner Adjustments
      summary: Create owner adjustment
      description: Creates a new owner adjustment record for the specified property
      operationId: createOwnerAdjustment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OwnerAdjustmentSavingApi3Dto'
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OwnerAdjustmentApiResponseWrapper'
components:
  schemas:
    OwnerAdjustmentsApiResponseWrapper:
      type: object
      properties:
        ownerAdjustment:
          type: array
          items:
            $ref: '#/components/schemas/OwnerAdjustmentApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    OwnerAdjustmentApiResponseWrapper:
      type: object
      properties:
        ownerAdjustment:
          $ref: '#/components/schemas/OwnerAdjustmentApi3Dto'
    OwnerAdjustmentSavingApi3Dto:
      required:
      - amount
      - currency
      - dateAccountedFor
      - name
      - propertyUid
      - taxationRate
      - type
      type: object
      properties:
        currency:
          type: string
          enum:
          - AED
          - ARS
          - AUD
          - BGN
          - BHD
          - BRL
          - CAD
          - CHF
          - CLP
          - CNY
          - COP
          - CZK
          - DKK
          - DOP
          - EUR
          - GBP
          - GTQ
          - HKD
          - HUF
          - IDR
          - IKR
          - ILS
          - INR
          - JPY
          - KES
          - KRW
          - MXN
          - MYR
          - NOK
          - NONE
          - NZD
          - PEN
          - PHP
          - PLN
          - RON
          - RUB
          - SEK
          - SGD
          - THB
          - TRY
          - TWD
          - USD
          - UYU
          - VEF
          - VND
          - VUV
          - JOD
          - SAR
          - EGP
          - ZAR
          - TTD
          - BBD
          - CVE
          - AWG
          - MAD
          - PYG
        name:
          maxLength: 255
          minLength: 1
          type: string
        propertyUid:
          type: string
        amount:
          type: number
        attachedImageUrl:
          maxLength: 255
          minLength: 0
          type: string
        dateAccountedFor:
          type: string
          format: date
        notes:
          type: string
        ownerAdjustmentScheduleUid:
          type: string
        taxationRate:
          type: number
        type:
          type: string
          enum:
          - CLEANING_MAINTENANCE
          - INSURANCE
          - MANAGEMENT_FEES
          - OTHER
          - REPAIRS
          - SUPPLIES
          - UTILITIES
    OwnerAdjustmentApi3Dto:
      type: object
      properties:
        uid:
          type: string
        propertyUid:
          type: string
        ownerAdjustmentScheduleUid:
          type: string
        amount:
          type: number
        attachedImageUrl:
          type: string
        created:
          type: string
          format: date-time
        currency:
          type: string
          enum:
          - AED
          - ARS
          - AUD
          - BGN
          - BHD
          - BRL
          - CAD
          - CHF
          - CLP
          - CNY
          - COP
          - CZK
          - DKK
          - DOP
          - EUR
          - GBP
          - GTQ
          - HKD
          - HUF
          - IDR
          - IKR
          - ILS
          - INR
          - JPY
          - KES
          - KRW
          - MXN
          - MYR
          - NOK
          - NONE
          - NZD
          - PEN
          - PHP
          - PLN
          - RON
          - RUB
          - SEK
          - SGD
          - THB
          - TRY
          - TWD
          - USD
          - UYU
          - VEF
          - VND
          - VUV
          - JOD
          - SAR
          - EGP
          - ZAR
          - TTD
          - BBD
          - CVE
          - AWG
          - MAD
          - PYG
        currencySymbol:
          type: string
        dateAccountedFor:
          type: string
          format: date
        name:
          type: string
        notes:
          type: string
        taxationRate:
          type: number
        type:
          type: string
          enum:
          - CLEANING_MAINTENANCE
          - INSURANCE
          - MANAGEMENT_FEES
          - OTHER
          - REPAIRS
          - SUPPLIES
          - UTILITIES
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true