openapi: 3.0.0
info:
  description: "The Vantaca API is a JSON based web service. Access to the API is granted by individual Vantaca customers who will grant vendors individual access to their dataset. Credentials can and will vary from one customer to another.  </br></br>Credentials will need to have an accompanying IP Address whitelisted in order to successfully access Vantaca's Standard APIs. All connections must be made using SSL. </br>  </br> **Production URL - api.vantaca.net** </br></br> \nMost /read/ methods can use the parameter **zip** as a boolean. If **true**, the JSON response will be compressed and returned as a zip file. Unless otherwise specified in each endpoint, the zip archive will contain a single file called, **data.json**. *This can reduce the bandwidth needed to process company-wide information*. The parameter is always optional but is recommended when making calls for bulk data. If **false**, the response body will be a JSON object. </br></br> Vantaca's API passes each set of credentials via Basic Authorization with the following required parameters for ***all*** endpoints: </br> - **company**  </br> - **login**  </br> - **pwd**</br></br></br>\n## Changelog:\n  **Version 3.8.0 (5/28/2026)**: \n  </br> - Added new endpoint for write/createActionItemNote. This new endpoint allows for adding of new notes, as well as adding attachments, without the need to step the actionItem.\n  Added new endpoint for read/collectionList\n  </br>\n  </br>To access the most up-to-date version,  [Click Here](https://app.swaggerhub.com/apis/Vantaca/vantacaStandard/)**\n  </br>\n  </br>\n\n## **Vantaca API TERMS OF USE**\n</br>\n\nLast Updated: May 2, 2025 \n\n**1. ACCEPTANCE OF TERMS**\nBy accessing or using the API services provided by Vantaca (\"Provider,\" \"we,\" \"us,\" or \"our\"), you (\"User,\" \"you,\" or \"your\") agree to be bound by these Terms of Use (\"Terms\"). If you are using the API on behalf of an entity, you represent that you have authority to bind that entity to these Terms, and \"you\" refers to that entity. \n\n**2. DEFINITIONS**\n- \"API\": The application programming interface made available by Provider, including swagger based documentation. \n- \"API Key\": The unique authentication credential issued to you that permits access to the API. \n- \"Application\": Any software, website, or service you develop that interfaces with the API. \n- \"Content\": Any data or information accessed or retrieved through the API. \n\n**3. LICENSE GRANT AND RESTRICTIONS**\n\n3.1 License \n\nSubject to these Terms, Provider grants you a limited, non-exclusive, non-transferable, revocable license to access and use the API to develop, test, and support your Application and to integrate your Application with the features and functionality of the API. \n\n3.2 Restrictions \n\nYou shall not: \n\n- Sell, rent, lease, sublicense, redistribute, or syndicate access to the API or API Key\n- Modify, create derivative works, decompile, reverse engineer, or disassemble the API\n- Use the API for any illegal purpose or in violation of any local, state, national, or international law\n- Use the API to develop an Application that replicates or provides similar functionality or features as Vantaca\n- Interfere with or disrupt the integrity or performance of the API or its related systems\n- Attempt to gain unauthorized access to the API or related systems\n- Use the API in a manner that exceeds reasonable request volume or constitutes excessive or abusive usage \n- Remove or alter any proprietary notices or marks on the API or its documentation \n\n**4. API USAGE AND RATE LIMITS**\n\n4.1 Rate Limits\n\nProvider may set and enforce limits on your use of the API in our sole discretion. These limits may include, but are not limited to, the number of API requests that may be made, the number of users you may serve, or other limitations. \n\n4.2 API Keys \n\nYou are responsible for maintaining the security of your API Key and any passwords or credentials. You may not share your API Key with any third party, except for authorized agents acting on your behalf. \n\n4.3 Monitoring and Analytics \n\nProvider may monitor and collect data relating to your usage of the API to ensure compliance with these Terms and for the purposes of improving and enhancing the API. \n\n**5. USER OBLIGATIONS** \n\n5.1 Compliance \n\nYou agree to: \n\n- Comply with all applicable laws and regulations \n- Comply with all provisions of these Terms and any associated documentation \n- Respect the intellectual property, privacy, and other rights of third parties \n- Promptly update your Application to install the most current version of the API when notified \n\n5.2 User Applications \n\nYour Application must: \n\n- Include your own terms of service and privacy policy \n- Accurately disclose the functions and features provided by the API \n- Not imply any partnership with or endorsement by Provider \n\n**6. DATA RIGHTS AND PRIVACY** \n\n6.1 Data Rights \n\nYou retain all rights to your data submitted through the API. You grant Provider a non-exclusive license to access, use, and process your data solely to provide and maintain the API services. \n\n6.2 Privacy \n\nProvider will process any personal data in accordance with our Privacy Policy, which is incorporated by reference into these Terms. You agree to comply with all applicable privacy laws and to provide a legally adequate privacy notice to your users. \n\n**7. MODIFICATIONS**\n\n7.1 API Modifications \n\nProvider reserves the right to modify, suspend, or discontinue the API or any part thereof at any time, with or without notice. We will use commercially reasonable efforts to notify you of material changes. \n\n7.2 Terms Modifications \n\nProvider may modify these Terms at any time by posting the modified Terms. Your continued use of the API following any modification constitutes your acceptance of the modified Terms. \n\n**8. TERMINATION**\n\n8.1 Termination by User \n\nYou may terminate these Terms by discontinuing use of the API. \n\n8.2 Termination by Provider \n\nProvider may terminate these Terms or suspend your access to the API at any time for any reason, including but not limited to, your breach of these Terms. \n\n8.3 Effect of Termination \n\nUpon termination, all licenses granted under these Terms will terminate, and you must cease all use of the API. \n\n**9. DISCLAIMER OF WARRANTIES** \n\nTHE API IS PROVIDED \"AS IS\" AND \"AS AVAILABLE.\" PROVIDER DISCLAIMS ALL WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. PROVIDER DOES NOT WARRANT THAT THE API WILL BE ERROR-FREE, UNINTERRUPTED, OR FREE FROM VIRUSES OR OTHER HARMFUL COMPONENTS. \n\n**10. LIMITATION OF LIABILITY**\n\nIN NO EVENT SHALL PROVIDER BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES ARISING OUT OF OR RELATED TO YOUR USE OF THE API. PROVIDER'S TOTAL LIABILITY ARISING OUT OF OR RELATED TO THESE TERMS SHALL NOT EXCEED THE GREATER OF $100 OR THE AMOUNT PAID BY YOU TO PROVIDER IN THE SIX MONTHS PRECEDING THE EVENT GIVING RISE TO THE LIABILITY. \n\n**11. INDEMNIFICATION** \n\nYou agree to indemnify, defend, and hold harmless Provider and its officers, directors, employees, agents, and affiliates from and against any and all claims, damages, obligations, losses, liabilities, costs, and expenses arising from: (a) your use of the API; (b) your violation of these Terms; (c) your violation of any third-party right; or (d) any claim that your Application caused damage to a third party. \n\n**12. GENERAL PROVISIONS** \n\n12.1 Governing Law \n\nThese Terms shall be governed by and construed in accordance with the laws of [Your Jurisdiction], without regard to its conflict of law principles. \n\n12.2 Dispute Resolution \n\nAny dispute arising from these Terms shall be resolved [specify dispute resolution mechanism, e.g., arbitration, specific courts, etc.]. \n\n12.3 Severability \n\nIf any provision of these Terms is found to be unenforceable, the remaining provisions shall remain in full force and effect. \n\n12.4 No Waiver \n\nNo failure or delay by Provider in exercising any right under these Terms shall operate as a waiver of that or any other right. \n\n12.5 Assignment \n\nYou may not assign these Terms or any rights or obligations hereunder without Provider's prior written consent. Provider may assign these Terms without restriction. \n\n12.6 Entire Agreement \n\nThese Terms constitute the entire agreement between you and Provider regarding the API and supersede all prior agreements and understandings, whether written or oral. \n\n**13. CONTACT INFORMATION** \n\nIf you have any questions about these Terms, please contact us at VendorSupport@vantaca.com \n\n "
  version: 3.8.0
  title: Vantaca's Standard APIs /AP/ /AP/ /read/ API
  contact:
    email: vendorsupport@vantaca.com
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/Vantaca/vantacaStandard/3.8.0
tags:
- name: /read/
  description: 'These methods read data and can be called in bulk or for single entities for more efficient processing. </br>  All calls will use the same URL path: /read/{***method***}'
paths:
  /read/ARCList:
    get:
      tags:
      - /read/
      summary: retrieves a list of all ARC Request action items
      operationId: ARCList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association. *Will filter results to a single association.*
        required: false
        schema:
          type: string
      - in: query
        name: accountNo
        description: unique identifier for a single homeowner account
        schema:
          type: string
      - in: query
        name: xnNumber
        description: unique identifier for an  arc request
        required: false
        schema:
          type: string
      - in: query
        name: includeMessage
        description: if true, messages will be included in response, else, false
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/arcList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed.
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/Association:
    get:
      tags:
      - /read/
      summary: retrieves a list of live associations with related data
      operationId: associationList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association. *Will filter results to a single association.*
        schema:
          type: string
      - in: query
        name: account
        description: unique identifier to return an individual homeowner account
        schema:
          type: string
      - in: query
        name: propertyID
        description: unique identifier to return all accounts for a single property record
        schema:
          type: string
      - in: query
        name: hoid
        description: unique identifier to return all accounts for a single homeowner record
        schema:
          type: integer
      - in: query
        name: includeCharges
        description: if **true**, response will include Charges array, else, **false**, and charges field will display null
        schema:
          type: boolean
      - in: query
        name: includeLateFees
        description: if **true**, response will include Late Fees array, else, **false**, and late fees field will display as null
        schema:
          type: boolean
      - in: query
        name: includeOwners
        description: if **true**, response will include Owner array, else, **false**, and owners field will display as null
        schema:
          type: boolean
      - in: query
        name: includeDocuments
        description: if **true**, response will include Document array, else, **false**, and documents field will display as null.
        schema:
          type: boolean
      - in: query
        name: includeOwnerTransactions
        description: if **true**, Owner array will populate the Transactions array, else, **false** and includeOwnerTransactions field will display as null
        schema:
          type: boolean
      - in: query
        name: includeOwnerChargeTransactions
        description: if **true**, Owner array will populate the chargeTransactions array, else, **false** and chargeTransactions field will display as null
        schema:
          type: boolean
      - in: query
        name: includeNextAssessment
        description: if **true** Owner array will populate the nextAssessment array, else, **false** and nextAssessment array will display as null
        schema:
          type: boolean
      - in: query
        name: includeOwnerBKList
        description: if **true**, Owner array will populate the bkList array, else, **false** and bkList field will display as null
        schema:
          type: boolean
      - in: query
        name: includeBalanceByChargeType
        description: if **true**, Owner array will populate the balanceByChargeType, else, **false** and balanceByChargeType will display as null.
        schema:
          type: boolean
      - in: query
        name: includePropertyCount
        description: if **true**, response will include propertyCount field, else, **false** and propertyCount field will display as null
        schema:
          type: boolean
      - in: query
        name: includeStartingMonthOfFiscalYear
        description: if **true**, response will include startingMonthOfFiscalYear field, else, **false** and startingMonthOfFiscalYear field will display as null.
        schema:
          type: boolean
      - in: query
        name: includeAssessmentFrequency
        description: if **true**, response will include assessmentFrequencies array, else, **false** and assessmentFrequencies array will display as null
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/association
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/AssociationAddress:
    get:
      tags:
      - /read/
      summary: retrieves a list of all association address and their types. If a given address type is not found, it will default to the management companies address.
      operationId: AssociationAddress
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association. *Will filter results to a single association.* *If not provided, will return all address for all associations.*
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/associationAddress'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/AttachmentList:
    get:
      tags:
      - /read/
      summary: retrieves a list of all messages and attachments of a single violation
      operationId: attachmentList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: xnNumber
        description: unique identifier for an  action item
        required: true
        schema:
          type: string
      - in: query
        name: messageID
        description: unique identifier for a single message
        schema:
          type: string
      - in: query
        name: attachmentID
        description: unique identifier for a single attachment
        schema:
          type: string
      - in: query
        name: includeFile
        description: if **true**, attachment will be included in response, else **false**, field will be null.
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/attachmentList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getEmail:
    get:
      tags:
      - /read/
      summary: retrieves a homeowner email.
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates. *The 'zip' parameter is not available on this call.*
      operationId: getEmail
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: emailID
        description: unique identifier for an email address
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getEmail'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getPhone:
    get:
      tags:
      - /read/
      summary: retrieves a homeowner phone number.
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates. *The 'zip' parameter is not available on this call.*
      operationId: getPhone
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: phoneID
        description: unique identifier for a phone number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPhone'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getActionItem:
    parameters: []
    get:
      tags:
      - /read/
      summary: retrieves details about an action item
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates. *The 'zip' parameter is not available on this call.*
      operationId: getActionItem
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: actionItemID
        description: unique identifier for an action item
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionItem'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getAddress:
    get:
      tags:
      - /read/
      summary: retrieves a homeowner address.
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates. *The 'zip' parameter is not available on this call.*
      operationId: getAddress
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: addrID
        description: unique identifier for a homeowner address
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/address
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getCommPreference:
    get:
      tags:
      - /read/
      summary: retrieves a homeowner communication and billing preference.
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates. *The 'zip' parameter is not available on this call.*
      operationId: getCommPreference
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: hoID
        description: unique identifier for a homeowner
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getCommPreference'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/provider:
    get:
      tags:
      - /read/
      summary: retrieves a list of all service providers for the association
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates.
      operationId: getProvider
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: providerID
        description: unique identifier for a service provider
        schema:
          type: integer
      - in: query
        name: includeInsurance
        description: if **true**, resopnse will include providerInsurance array, else **false**, and providerInsurance field will display as null
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/provider
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/providerSingle:
    get:
      tags:
      - /read/
      summary: retrieves a single service providers for the association
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates.
      operationId: getProviderSingle
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: providerID
        description: unique identifier for a homeowner
        required: true
        schema:
          type: integer
      - in: query
        name: includeInsurance
        description: unique identifier for a homeowner
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/provider
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/providerTypeList:
    get:
      tags:
      - /read/
      summary: returns a list of valid provider types for an association
      operationId: returnProviderTypeList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/providerTypeList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getTenantData:
    get:
      tags:
      - /read/
      summary: retrieves a list of all tenants for a given association
      description: This read is intended for use to return tenant information on a given property
      operationId: getTenant
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique string identifier to be used to call for a specific association
        schema:
          type: string
      - in: query
        name: propertyID
        description: unique propertyID to be used to call for a single address
        schema:
          type: integer
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantData'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/getDocument:
    get:
      tags:
      - /read/
      summary: retrieves a single document
      description: This read is intended for use with update calls to quickly confirm single field values before and/or after updates.
      operationId: getDocument
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association
        required: true
        schema:
          type: string
      - in: query
        name: imgID
        description: unique identifier for a document
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success - Binary file. Content will vary based on file type of document. *If the zip parameter is true, the returned zip archive will contain one file with the original file name of the document.
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/violationList:
    get:
      tags:
      - /read/
      summary: retrieves a list of all violations
      operationId: getViolationList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association
        schema:
          type: string
      - in: query
        name: accountNo
        description: unique identifier for a single homeowner account
        schema:
          type: string
      - in: query
        name: xnNumber
        description: unique identifier for a violation
        schema:
          type: string
      - in: query
        name: includeMessages
        description: if **true**, response will include message array, else **false**, messages field will display as null.
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/violationList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/violationTypeList:
    get:
      tags:
      - /read/
      summary: retrieves a list of an association's CCR items
      operationId: getViolationTypeList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/violationTypeList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/workOrderList:
    get:
      tags:
      - /read/
      summary: retrieves a list of all work order action items
      operationId: getWorkOrderList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association
        schema:
          type: string
      - in: query
        name: accountNo
        description: unique identifier for a single homeowner account
        schema:
          type: string
      - in: query
        name: xnNumber
        description: unique identifier for a  violation
        schema:
          type: string
      - in: query
        name: includeMessages
        description: if **true**, response will include message array, else **false**, messages field will display as null.
        schema:
          type: boolean
      - in: query
        name: providerID
        description: unique identifier for a service provider
        schema:
          type: integer
      - in: query
        name: providerContact
        description: 'provider contact name. ***Note***: will only return data for the **Primary** provider contact. if this value is not the primary contact, repsonse will return no content.'
        schema:
          type: string
      - in: query
        name: actionItemStatus
        description: filters by work order action item status. if '-1', response will include closed action items. if '1', response will include open action items
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/workOrderList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/CollectionList:
    get:
      tags:
      - /read/
      summary: retrieves a list of all collection action items
      operationId: getCollectionList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifier for an association. *Will filter results to a single association.*
        required: false
        schema:
          type: string
      - in: query
        name: accountNo
        description: unique identifier for a single homeowner account
        required: false
        schema:
          type: string
      - in: query
        name: xnNumber
        description: unique identifier for a collection action item
        required: false
        schema:
          type: string
      - in: query
        name: includeMessages
        description: if **true**, response will include message array, else **false**, messages field will display as null.
        schema:
          type: boolean
      - in: query
        name: includeAttachments
        description: if **true**, response will include attachments array, else **false**, attachments field will display as null.
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/collectionList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/actionTypeSteps:
    get:
      tags:
      - /read/
      summary: retrieves the details for the specified Action Type
      description: fields in the response body will vary based on the Action Item's Category
      operationId: actionTypeSteps
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: actionTypeID
        description: unique identifier for an Action Type
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/actionTypeSteps'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or parameter values are invalid.
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/homeownerTransactions:
    get:
      tags:
      - /read/
      summary: returns homeowner specific information
      operationId: getHomeownerTransactions
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: accountNo
        in: query
        description: unique identifier for a homeowner account
        schema:
          type: string
        required: true
      - name: fromDate
        in: query
        description: returns transactions from date entered through today's date. If null, response will default to transactions where transactionDate is less than or equal to 30 days ago.</br></br> *date cannot exceed one year prior to today's date*
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getHomeownerTransactions'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/associationDetails:
    get:
      tags:
      - /read/
      summary: returns association specific information
      operationId: getAssociationDetails
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: assocCode
        in: query
        description: unique identifier for an association
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAssociationDetails'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/associationAdditionalInfo:
    get:
      tags:
      - /read/
      summary: returns association additional information
      operationId: getAssociationAdditionalInfo
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: assocCode
        in: query
        description: unique identifier for an association
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAssociationDetails'
              examples:
                Example 1:
                  value:
                  - AssocCustID: 646
                    Group: General
                    Field: Reserve Budget
                    Value: '10000.00'
                  - AssocCustID: 647
                    Group: General
                    Field: Interest Rate
                    Value: '1'
                  - AssocCustID: 648
                    Group: General
                    Field: Export Assoc ID
                    Value: '0'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/homeownerAccountInfo:
    get:
      tags:
      - /read/
      summary: returns homeowner specific information
      operationId: getHomeownerAccountInfo
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: accountNo
        in: query
        description: unique identifier for a homeowner account.</br> **field is only required if no assocCode is provided.**
        schema:
          type: string
        required: true
      - name: assocCode
        in: query
        description: unique identifier for an association. </br> **field is only required if no accountNo is provided.**
        schema:
          type: string
        required: true
      - name: includeAssessments
        in: query
        description: if **true** response will include assessments, else **false** and assessments will be excluded
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getHomeownerAccountInfo'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/homeownerAssessment:
    get:
      tags:
      - /read/
      summary: retrieves a list of all assessments for a given Assocition or specific account. Either an Association Code or AccountNo is required. Can be filtered to only Primary assessments
      operationId: homeownerAssessment
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - in: query
        name: assocCode
        description: unique identifer for an association. *Will filter results to a single association.* *If not provided, must include accountNo*
        required: false
        schema:
          type: string
      - name: accountNo
        in: query
        description: unique identifer for a specific accountNo. If not included, must include assocCode
        required: false
        schema:
          type: string
      - name: primaryAssessments
        in: query
        description: boolean filter to only include primary assessments
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/homeownerAssessments'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/homeownerSearch:
    get:
      tags:
      - /read/
      summary: returns specific homeowner information
      operationId: searchHomeowners
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: accountNo
        in: query
        description: unique identifier for a homeowner account.</br> **field is only required if *phone* or *email* are not provided.**
        required: true
        schema:
          type: string
      - name: phone
        in: query
        description: homeowner's phone number. </br> **field is only required if *accountNo* or *email* are not provided.**
        required: true
        schema:
          type: string
      - name: email
        in: query
        description: homeowner's email address. </br> **field is only required if *accountNo* or *phone* are not provided.**
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/homeownerSearch'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/ccrItemList:
    get:
      tags:
      - /read/
      summary: returns CCR Items and details for the given association
      operationId: getccrItemList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: assocCode
        in: query
        description: unique identifier for an association
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ccrItemList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/glHistoryDetail:
    get:
      tags:
      - /read/
      summary: returns individual transactions that contribute to the GL Balance
      operationId: getGLHistoryDetail
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      - name: accountNo
        in: query
        description: unique identifier for an association
        required: true
        schema:
          type: string
      - name: glCode
        in: query
        description: unique identifier for a gl account
        schema:
          type: string
      - in: query
        name: startDate
        description: beginning date range. *if no startDate is specified, parameter will default to first day of the endDate month.*
        schema:
          type: string
      - in: query
        name: endDate
        description: ending date range. *if no endDate is specified, parameter will default to last day of the startDate month.* **If both startDate and endDate are excluded, default date range will be the previous month.**
        schema:
          type: string
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/glHistoryDetail'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/actionCategoryList:
    get:
      tags:
      - /read/
      summary: returns information for all active action categories
      operationId: getActionCategoryList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/actionCategoryList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
  /read/actionTypeList:
    get:
      tags:
      - /read/
      summary: returns all available steps for active action items
      operationId: getActionTypeList
      parameters:
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/companyParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/loginParam
      - $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/parameters/pwdParam
      responses:
        '200':
          description: OK Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/actionTypeList'
        '204':
          description: no content - call was successful, but no data for given parameters
        '400':
          description: bad request - required parameters are missing or invalid
        '403':
          description: forbidden - authentication failed
        '404':
          description: not found
        '500':
          description: internal error - internal processing error, please contact support if issue persists
components:
  schemas:
    ccrItemList:
      type: object
      properties:
        CCRItemId:
          type: integer
          description: unique identifier for the CCR item
          example: 26
        Group:
          type: string
          description: ccr item group
          example: Rules and Regulations
        CCRItem:
          type: string
          description: CCR item name
          example: Lot Maintenance
        LetterDescription:
          type: string
          description: letter description
          example: Please resolve the outlined issue by the specified date.
        Details:
          type: array
          description: array of CCR details for the given CCR Item
          items:
            $ref: '#/components/schemas/ccrDetails'
    remittanceAddress:
      type: object
      properties:
        AddressID:
          type: integer
          description: unique identifier for the address record
          example: 4
        created:
          type: string
          format: date-time
          description: date-time the address was created
          example: '2022-11-07T18:13:26.48'
        lastmodified:
          type: string
          format: date-time
          description: date-time the address was last modified
          example: '2022-11-07T18:13:26.48'
        address1:
          type: string
          description: the address field 1
          example: 1234 Testing Rd
        address2:
          type: string
          description: the address field 2
          example: 'Unit # 5'
        city:
          type: string
          description: the address city
          example: Wilmington
        state:
          type: string
          description: the address state
          example: NC
        zip:
          type: string
          description: the address zip
          example: '28412'
        county:
          type: string
          description: the address county
          example: New Hanover
    getAssociationDetails:
      type: object
      properties:
        assocCode:
          type: string
          description: unique identifier for an association
          example: 123
        assocName:
          type: string
          description: association name
          example: Lake Placid Association
        assocNickname:
          type: string
          description: association nickname, if applicable
          example: Lake Placid
        assocType:
          type: string
          description: association type
          example: HOA
        taxID:
          type: string
          description: association tax ID
          example: 25-1233455
        address:
          type: string
          description: mailing address
          example: Paper St.
        city:
          type: string
          description: mailing city
          example: Bradford
        state:
          type: string
          description: mailing state
          example: DE
        zip:
          type: string
          description: mailing zip
          example: 19808
        county:
          type: string
          description: mailing county
          example: Nash
        company:
          type: string
          description: management company name
          example: Prestige Management Co.
        numberOfUnits:
          type: integer
          description: number of units within the association
          example: 1337
        isLive:
          type: boolean
          description: if **true** association is currently Live, else **false**
          example: true
        created:
          type: string
          format: date-time
          description: date the association was created
          example: '2018-01-24'
        lastModified:
          type: string
          format: date-time
          description: date the association was last modified
          example: '2023-06-26'
        numberOnSiteAddresses:
          type: integer
          description: number of owner occupied properties
          example: 8
        numberOffSiteAddresses:
          type: integer
          description: number of non-owner occupied properties
          example: 11
        multipleUnitOwners:
          type: boolean
          description: if units are owned by the same entity(matching name), then **YES**, otherwise **NO**
          example: 'YES'
        operatingBalance:
          type: integer
          format: decimal
          description: balance of operating account from the bank register
          example: 70777.98
        reserveBalance:
          type: integer
          format: decimal
          description: reserve accounts balance totals
          example: 6209.12
        numberOwnersDelinquent30:
          type: integer
          description: number of owners with balance over 30 days in regular assessment
          example: 12
        delinquencyAmount30:
          type: integer
          format: decimal
          description: total amount of delinquencies over 30 days for regular assessments
          example: 64753.12
        numberOwnersDelinquent60:
          type: integer
          description: number of owners with balance over 60 days in regular assessment
          example: 11
        delinquencyAmount60:
          type: integer
          format: decimal
          description: total amount of delinquencies over 60 days for regular assessments
          example: 53299.23
        unitsAssessedEquallyAt:
          type: integer
          format: decimal
          description: amount the homeowners are assessed at if all homeowners are assessed at the same amount for regular assessments. If none, field is null
          example: '98.11'
        assessmentsLowRange:
          type: integer
          description: lowest amount that homeowner is assessed at if all homeowners are assessed at different amounts for the regular assessment. If none, field is null
          example: 30
        assessmentHighRange:
          type: integer
          description: highest amount that homeowner is assessed at if all homeowners are assessed at different amounts for the regular assessment. If none, field is null
          example: 500
        reserveBudget:
          type: integer
          format: decimal
          description: amount the association has budgeted for reserves
          example: 2000.2
        incomeBudget:
          type: integer
          format: decimal
          description: amount the association has budgeted for income
          example: 0
        delinquencyDate:
          type: string
          description: number of days that an assessment is considered late
          example: 5
        yearEnd:
          type: string
          format: date-time
          description: fiscal year end date
          example: '2023-10-31'
        interestRate:
          type: string
          description: interest percent that would be charged on past due balance for the regular assessment
          example: 3.21%
        lateFeeCalculation:
          type: string
          description: late fee that would be charged on past due balance for the regular assessment
          example: 0
        startingMonthOfFiscalYear:
          type: integer
          description: starting month of fiscal year
          example: 4
        primaryAssessments:
          type: array
          description: array of primary assessment information
          items:
            $ref: '#/components/schemas/primaryAssessments'
    homeownerTransactions:
      type: object
      properties:
        id:
          type: integer
          description: unique identifier for the ledger item
          example: 5912
        created:
          type: string
          format: date-time
          description: date the transaction was entered
          example: '2018-09-07T05:00:04.937'
        ledgerDate:
          type: string
          format: date-time
          description: effective post date of the transaction
          example: '2018-09-07T00:00:00'
        type:
          type: string
          description: type of transaction, possible values are "Credit Distribution", "Charge", "Payment", "Adjustment", "Writeoff", "Payment Adjustment", "Refund Check", "Refund ACH", "Void"
          example: Charge
        amount:
          type: integer
          format: decimal
          description: charges are positive, payments are negative
          example: 100
        chgDescription:
          type: integer
          description: charge description
          example: Late Fees
        description:
          type: string
          description: additional user entered description
          example: voided cause reasons
    arcList:
      type: object
      properties:
        arcType:
          type: string
          description: ARC type
          example: Mailbox
        xnNumber:
          type: string
          description: unique identifier for an ARC action item
          example: '123456'
        assocCode:
          type: string
          description: unqiue identifier for the association
          example: '100'
        accountNo:
          type: string
          description: unique identifier for a single homeowner account
          example: '100253647'
        propertyID:
          type: string
          description: unique identifier for a single property
          example: '10212'
        hoid:
          type: integer
          description: unique identifier for a homeowner - homeowners can have one or more accounts/properties
          example: '0'
        closed:
          type: boolean
          description: if true, item is currently in step marked 'closed', else false
          example: true
        description:
          type: string
          description: action item description
          example: Your mailbox got knocked off its post.
        subject:
          type: string
          description: action item subject
          example: mailbox inquiry
        createdDate:
          type: string
          format: date-time
          description: date the action item was created
          example: '2021-08-05T15:44:14.85'
        followupDate:
          type: string
          format: date-time
          description: action item followup date, can be null
        dueDate:
          type: string
          format: date-time
          description: action item due date, can be null
        step:
          type: string
          description: current step of the action item
          example: Void
        type:
          type: string
          description: action item type
          example: ARC Request
        lastModified:
          type: string
          format: date-time
          description: last modified date, can be null
        message:
          type: array
          items:
            $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/messages
          description: action item messages and notes
    correspondenceAddress:
      type: object
      properties:
        AddressID:
          type: integer
          description: unique identifier for the address record
          example: 4
        created:
          type: string
          format: date-time
          description: date-time the address was created
          example: '2022-11-07T18:13:26.48'
        lastmodified:
          type: string
          format: date-time
          description: date-time the address was last modified
          example: '2022-11-07T18:13:26.48'
        address1:
          type: string
          description: the address field 1
          example: 1234 Testing Rd
        address2:
          type: string
          description: the address field 2
          example: 'Unit # 5'
        city:
          type: string
          description: the address city
          example: Wilmington
        state:
          type: string
          description: the address state
          example: NC
        zip:
          type: string
          description: the address zip
          example: '28412'
        county:
          type: string
          description: the address county
          example: New Hanover
    workOrderList:
      type: object
      properties:
        providerID:
          type: integer
          description: unique identifier for a single service provider
        xnNumber:
          type: string
          description: unique identifier for a  violation
          example: 34881
        assocCode:
          type: string
          description: unique identifer for an association
          example: 123
        accountNo:
          type: string
          description: unique identifier for a single homeowner account
          example: 12378961
        propertyID:
          type: string
          description: unique identifier for a single property
          example: 4876
        hoID:
          type: integer
          description: unique identifier for a homeowner
          example: 14
        closed:
          type: boolean
          description: if false, item is currently in step marked 'closed', else true
          example: true
        description:
          type: string
          description: action item description
          example: his cans have been in the road for 39 minutes after the garbage pickup
        subject:
          type: string
          description: action item subject
          example: bill's cans!
        createdDate:
          type: string
          description: action item creation date
          format: date-time
          example: '2020-12-09T22:07:05.45'
        followupDate:
          type: string
          description: action item followup date, if any. *can be null*
        dueDate:
          type: string
          description: action item due date, *can be null*
        step:
          type: string
          description: violation action item current step
          example: General Letter
        type:
          type: string
          description: action item
        lastModified:
          type: string
          description: date-timestamp of last modification
          format: date-time
        messages:
          type: array
          items:
            $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/messages
    ActionItemNote:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: time in UTC ActionItem was created
          example: '2025-04-14T17:58:04.073'
        note:
          type: string
          description: the message of the note
          example: 'The following invoice fields were changed: Provider: Post Item, Association:      Condominium Association, Inc., Invoice Date: 2/12/2025, Total: $2,650.00, Pay Type: Misc Check Invoice Detail Added: GL: 203000 - Exchange Account, Fund: Operating, Bank Account: 1026 MAINOPR-7762, Description: Return Deposit Item, Amount: $2,650.00"'
        actionStepID:
          type: integer
          description: uniqueID for the actionStep of the requested actionItem
          example: 270
    homeownerSearch:
      type: object
      properties:
        accountNo:
          type: string
          description: unique identifier for a single account
          example: 100100101
        assocCode:
          type: string
          description: unique identifier for an association
        owners:
          type: array
          items:
            $ref: '#/components/schemas/owners'
        propertyID:
          type: integer
          description: unique identifier for a single property (A property can have one or more accounts/owners, but only one account is "current" owner)
          example: 98123
        address:
          type: string
          description: street number and street name
          example: 537 Paper St.
        city:
          type: string
          description: owner city
          example: Bedford
        state:
          type: string
          description: owner state
          example: NC
        zip:
          type: string
          description: owner zip
          example: 19808
        lotNo:
          type: string
          description: lot address
        block:
          type: string
          description: block address
        phase:
          type: string
    assessmentChargeTags:
      type: object
      properties:
        tagDescr:
          type: string
          description: charge tag description
          example: Main
        amount:
          type: string
          description: charge tag amount
          example: $33.00
        assessmentDay:
          type: integer
          description: calendar day of the assessment
          example: 1
        assessmentMonth:
          type: integer
          description: calendar month of the assessment. **For use with annual assessments, monthly assessments will not have an assessmentMonth**
          example: 12
    providerTypeList:
      type: object
      properties:
        providerTypeID:
          type: integer
          description: unique identifier for the service provider type
          example: 22
        created:
          type: string
          format: date-time
          description: date the provider was created
          example: '2019-05-06T19:40:13.04'
        lastModified:
          type: string
          format: date-time
          description: date the provider was last modified
          example: '2020-02-19T19:35:27.197'
        providerType:
          type: string
          description: service provider type description
          example: Maintenance Repair Services
        inActive:
          type: string
          format: date-time
          description: date the service provider was deleted. *will be null if currently active*
          example: '2023-05-25T21:32:56.85'
    ActionItem:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: time in UTC ActionItem was created
          example: '2025-04-14T17:58:04.073'
        lastModified:
          type: string
          format: date-time
          description: time in UTC ActionItem was last modified
          example: '2025-04-14T17:58:04.087'
        actionTypeID:
          type: integer
          description: uniqueID for the actionType of the requested actionItem
          example: 13
        actionStepID:
          type: integer
          description: uniqueID for the actionStep of the requested actionItem
          example: 270
        actionCategoryID:
          type: integer
          description: uniqueID for the actionCategory of the requested actionItem
          example: 4
        assocCode:
          type: string
          description: association code for where the requested actionItem belongs
          example: '1026'
        descr:
          type: string
          description: description of the action item
          example: Return Deposit Item
        actionItemNotes:
          description: array of items including created, note, stepID
          items:
            $ref: '#/components/schemas/ActionItemNote'
    TenantData:
      type: object
      properties:
        assoc_Code:
          type: string
          format: varchar
          example: '101'
        tenant_ID:
          type: integer
          format: int64
          example: 10571
        property_ID:
          type: integer
          format: int64
          example: 10092
        HOID:
          type: integer
          format: int64
          example: 10092
        tenant_Account:
          type: string
          description: unique identifier for the tenants account
          example: 1010571
        tenant_FirstName:
          type: string
          description: tenant first name
          example: Jimmy
        tenant_LastName:
          type: string
          description: tenant last name
          example: Jones
        SecondaryTenant_FirstName:
          type: string
          description: secondary tenant first name
          example: null
        SecondaryTenant_LastName:
          type: string
          description: secondary tenant last name
          example: null
        Business_Name:
          type: string
          description: name of tenant if it is a buisness
          example: null
        MoveIn_Date:
          type: string
          description: tenant move in datetime
          example: '2023-03-17T00:00:00'
        MoveOut_Date:
          type: string
          description: tenant move out datetime
          example: null
        TenantEmail_ID:
          type: integer
          description: unique identifier for the tenants email
          example: 10111
        Tenant_Email:
          type: string
          description: tenant email
          example: jimm.jones@tenant.com
        TenantPhone_ID:
          type: integer
          description: unique identifier for the tenants phone number
          example: 12366
        Tenant_Phone:
          type: string
          description: tenant phone number
          example: 910-555-1234
        MgtCompany_Name:
          type: string
          description: management company name
          example: A management company
        MgtCompany_ContactName:
          type: string
          description: management company contact
          example: Mr. John Manager
        MgtCompany_ContactPhone:
          type: string
          description: management company phone
          example: 910-555-1234
        MgtCompany_ContactEmail:
          type: string
          description: management company email
          example: amgmt@company.com
        MgtCompany_Address1:
          type: string
          description: management company address1 field
          example: 123 street name
        MgtCompany_Address2:
          type: string
          description: management company address2 field
          example: null
        MgtCompany_City:
          type: string
          description: management company city
          example: Wilmington
        MgtCompany_State:
          type: string
          description: management company state
          example: NC
        MgtCompany_ZipCode:
          type: string
          description: management company zipcode
          example: 28402
    actionTypeList:
      type: object
      properties:
        ActionTypeID:
          type: integer
          description: unique identifier for the action item step
          example: -2
        Descr:
          type: string
          description: action category description
          example: Collections
        ActionCategoryID:
          type: integer
          description: unique identifier for the action category
          example: 4
        Created:
          type: string
          format: date-time
          description: date the action item step was created
          example: '2016-08-09T20:28:27.493'
        LastModified:
          type: string
          format: date-time
          description: date the action item step was created
          example: '2019-03-06T18:26:08.093'
    homeownerAssessments:
      type: object
      properties:
        assocCode:
          type: string
          description: unique value to identify association
          example: LF
        assocName:
          type: string
          description: name of the association
          example: Langley Falls
        accountNo:
          type: string
          description: unique homeowner account number
          example: LF47447
        hoID:
          type: integer
          description: unique ID that identifies the homeowner record for the account
          example: 47398
        propertyID:
          type: integer
          description: unique ID that indetifies the property record
          example: 45482
        assessments:
          type: array
          description: array of assessments
          items:
            $ref: '#/components/schemas/assessments'
    emails:
      type: object
      properties:
        id:
          type: integer
          description: unique identifier for an email
          example: 286994
        created:
          type: string
          format: date-time
          description: date the email was added to the owner's account
          example: '2022-11-07T18:13:26.48'
        lastModified:
          type: string
          format: date-time
          description: date the email was last modified. </br> *if email was never modified, field will be null*
          example: '2023-04-19T18:27:10.833'
        label:
          type: string
          description: email description
          example: email
        email:
          type: string
          description: email address
          example: email@myemail.com
        isPrimary:
          type: boolean
          description: if **true**, email address will be used as owner contact, else **false**
          example: true
    attachmentList:
      type: object
      properties:
        messageID:
          type: string
          description: unique identifier for a single message
          example: 98765
        attachmentID:
          type: string
          description: unique identifier for a single attachment
          example: 22446
        fileName:
          type: string
          description: filename of the attachment with extension
          example: whymymailboxisbroken.pdf
        fileSize:
          type: integer
          description: number of bytes
          example: 647041
        file:
          type: string
          format: base64
    physicalAddress:
      type: object
      properties:
        AddressID:
          type: integer
          description: unique identifier for the address record
          example: 4
        created:
          type: string
          format: date-time
          description: date-time the address was created
          example: '2022-11-07T18:13:26.48'
        lastmodified:
          type: string
          format: date-time
          description: date-time the address was last modified
          example: '2022-11-07T18:13:26.48'
        address1:
          type: string
          description: the address field 1
          example: 1234 Testing Rd
        address2:
          type: string
          description: the address field 2
          example: 'Unit # 5'
        city:
          type: string
          description: the address city
          example: Wilmington
        state:
          type: string
          description: the address state
          example: NC
        zip:
          type: string
          description: the address zip
          example: '28412'
        county:
          type: string
          description: the address county
          example: New Hanover
    associationAddress:
      type: object
      properties:
        Assoc_Code:
          type: string
          description: unique identifier for the association
          example: '999'
        PhysicalAddress:
          type: array
          description: List of physical addresses
          items:
            $ref: '#/components/schemas/physicalAddress'
        CompanyAddress:
          type: array
          description: List of company addresses
          items:
            $ref: '#/components/schemas/companyAddress'
        RemittanceAddress:
          type: array
          description: List of remittance addresses
          items:
            $ref: '#/components/schemas/remittanceAddress'
        CorrespondenceAddress:
          type: array
          description: List of correspondence addresses
          items:
            $ref: '#/components/schemas/correspondenceAddress'
    violationList:
      type: object
      properties:
        ccrItemID:
          type: integer
          description: CCR item id number
          example: 72
        ccrItemDescription:
          type: string
          description: CCR type
          example: General Violation
        ccrLetterDescription:
          type: string
          description: CCR description
          example: Cans in the street!
        InspectionEndDate:
          type: string
          format: date-time
          description: date inspection was concluded *can be null*
        lastModified:
          type: string
          format: date-time
          description: date-timestamp of last modification
          example: '2021-12-09T22:07:05.45'
        CureDate:
          type: string
          format: date-time
          nullable: true
          description: Cure Date of violation action items
          example: ''
        HearingDate:
          type: string
          format: date-time
          description: Hearing Date of violation action items
          nullable: true
          example: ''
        xnNumber:
          type: string
          description: unique identifier for a  violation
          example: 34881
        assocCode:
          type: string
          description: unique identifer for an association
          example: 123
        accountNo:
          type: string
          description: unique identifier for a single homeowner account
          example: 12378961
        propertyID:
          type: string
          description: unique identifier for a single property
          example: 4876
        hoID:
          type: integer
          description: unique identifier for a homeowner
          example: 14
        closed:
          type: boolean
          description: if false, item is currently in step marked 'closed', else true
          example: true
        description:
          type: string
          description: action item description
          example: his cans have been in the road for 39 minutes after the garbage pickup
        subject:
          type: string
          description: action item subject
          example: bill's cans!
        createdDate:
          type: string
          description: action item creation date
          format: date-time
          example: '2020-12-09T22:07:05.45'
        followupDate:
          type: string
          description: action item followup date, if any. *can be null*
        dueDate:
          type: string
          description: action item due date, *can be null*
        stepID:
          type: integer
          description: unique identifier for each action item step
          example: 24
        step:
          type: string
          description: violation action item current step
          example: General Letter
        type:
          type: string
          description: action item type
          example: Standard Violation Letter
        trackingID:
          type: string
          description: unique identifier for tracking purposes
          example: 3623-GMACK
        messages:
          type: array
          items:
            $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/messages
    addresses:
      type: object
      properties:
        id:
          type: integer
          description: unique identifier for the address
          example: 98989
        created:
          type: string
          format: date-time
          description: date the address was created in Vantaca
          example: '2023-05-15T15:35:58.74'
        lastModified:
          type: string
          format: date-time
          example: '2023-05-15T15:35:58.74'
        label:
          type: string
          description: optional label for the address
          example: summer home
        address:
          type: string
          description: mailing address
          example: Paper St.
        city:
          type: string
          description: mailing city
          example: Bradford
        state:
          type: string
          description: mailing state
          example: DE
        zip:
          type: string
          description: mailing zip
          example: 19808
        country:
          type: string
          description: mailing country
          example: CA
        isInternational:
          type: boolean
          description: if true, address is international; if false, address is domestic
          example: false
        isPrimaryMailing:
          type: boolean
          description: if true, address is a mailing address; if false, address is not a mailing address
          example: true
    getHomeownerTransactions:
      type: object
      properties:
        assocCode:
          type: string
          description: unique identifier for an association
        accountNo:
          type: string
          description: unique identifier for a single account
          example: 100100101
        propertyID:
          type: integer
          description: unique identifier for a single property (A property can have one or more accounts/owners, but only one account is "current" owner)
          example: 98123
        hoid:
          type: integer
          description: unique identifier for a homeowner (can represent a joint owner or business/ an owner can have one or more accounts/properties)
          example: 10011
        owners:
          type: array
          items:
            $ref: '#/components/schemas/owners'
        businessName:
          type: string
          description: homeowner's business name
          example: Enchante Apparel
        address:
          type: string
          description: street number and street name
          example: 537 Paper St.
        city:
          type: string
          description: owner city
          example: Bedford
        state:
          type: string
          description: owner state
          example: NC
        zip:
          type: string
          description: owner zip
          example: 19808
        lotNo:
          type: string
          description: lot address
        block:
          type: string
          description: block address
        phase:
          type: string
        settleDate:
          type: string
          format: date-time
          description: date the property was purchased
          example: '1900-01-01T00:00:00'
        previousOwner:
          type: string
          format: date-time
          description: date the property was sold. if null, no previous owner
          example: null
        collectionStatus:
          type: string
          description: current collection status
          example: Need Address Verification
        blockLedger:
          type: boolean
          description: if true, Block Ledger checkbox is enabled on the step's rules, else, false
          example: false
        blockPayments:
          type: boolean
          description: if true, Block Payments checkbox is enabled on the step's rules, else, false
          example: true
        balance:
          type: integer
          format: decimal
          description: current balance
          example: 123,456,789.25
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/homeownerTransactions'
    getPhone:
      type: object
      properties:
        phoneID:
          type: string
          description: unique identifier for a phone number
          example: 6888
        isPrimary:
          type: boolean
          description: if **true**, phone number is used as primary communication preference for homeowner, else **false**
          example: true
        label:
          type: string
          description: label for phone number
          example: gorgc work phone
        phone:
          type: string
          description: homeowner phone number
          example: 1234567890
    violationTypeList:
      type: object
      properties:
        assocCode:
          type: string
          description: unique identifier for an association
          example: ZZZ
        ccrTypeId:
          type: string
          description: CCR type identification number
          example: 25
        ccrType:
          type: string
          description: ccr type
          example: General Violation
        ccrDescription:
          type: string
          description: ccr description
          example: First Violation Warning
        ccrDescriptionId:
          type: string
          description: unique identifier for the ccr description
          example: 144
        ccrLetterDescription:
          type: string
          description: ARC type
          example: Violation letter description
        ccrCurePeriod:
          type: string
          description: number of days the homeowner has to resolve, or "cure" the violation
          example: 22
    getEmail:
      type: object
      properties:
        emailID:
          type: string
          description: unique identifier for an email address
          example: 56788
        isPrimary:
          type: boolean
          description: if **true**, email is used as primary communication preference for homeowner, else **false**
          example: true
        label:
          type: string
          description: label for email address
          example: gorgc work email
        email:
          type: string
          format: email
          description: homeowner email address
          example: gorgc@midas.com
    getCommPreference:
      type: object
      properties:
        hoid:
          type: integer
          description: unique identifier for a homeowner
          example: 33218
        commpref:
          type: string
          description: homeowner's communication preference. possible values are Paper, Text, Email, App
          example: Phone
        billingpref:
          type: string
          description: homeowner's billing communication preference. possible values are Paper, Text, Email
          example: Email
    glHistoryDetail:
      type: object
      properties:
        glCode:
          type: string
          description: unique identifier for the gl account
          example: 10000
        fundId:
          type: integer
          description: unique identifier for the fund
          example: 489
        tranDate:
          type: string
          format: date-time
          description: transaction date
          example: '2023-10-12'
        sectionDescr:
          type: string
          description: gl section name
          example: Asset
        groupDescr:
          type: string
          description: gl group name
          example: Everything
        fundDescr:
          type: string
          description: fund description
          example: Operating
        description:
          type: string
          description: transaction description
          example: '200 Park Avenue Unit 10: Credit Distribution'
        debitCredit:
          type: string
          description: 'debit or credit. possible values: ''C'', ''D'''
          example: C
        amount:
          type: integer
          format: decimal
          description: transaction amount
          example: 125
    actionTypeSteps:
      type: object
      properties:
        actionStepID:
          type: integer
          description: unique identifier for each Step
          example: 481
        actionTypeID:
          type: string
          description: unique identifier for the Action Type
          example: 146
        actionCategoryID:
          type: string
          description: unique identifier for the action type category
          example: 5
        orderNo:
          type: string
          description: unique identifier for each position of the action item's sequence
          example: '1'
        descr:
          type: string
          description: name of the step
          example: Request Received
        closedStep:
          type: boolean
          description: if true, closing step, else, false
          example: false
        sendToList:
          type: string
          description: list of user types that the action item will be sent to upon stepping
          example: -3, -1
        sendToValue:
          description: array of user types that the action item will be sent to
          items:
            type: array
            example:
            - '-3'
            - '-1'
        sendToDescr:
          type: string
          description: user role(s) associated with the sendToValue(s)
          example: Homeowner, Board
        replyToList:
          type: string
          description: list of user types that will receive the action item's replies
          example: '-1'
        replyToValue:
          type: array
          description: array of user types that will receive the action item's replies
          items:
            type: string
            example:
            - '-1'
        replyToDescr:
          type: string
          description: user role(s) associated with the replyToValue(s)
          example: Homeowner
        daysForCriteria:
          nullable: true
          type: string
          example: null
        duration:
          type: integer
          description: duration to remain at this step
          example: 0
        balance:
          type: integer
          description: Minimum Balance to Move On
          example: 0
        decision:
          type: string
          description: user type responsible for decision, if configured. </br> 0 = Not Required </br> 1 = Board Decision </br> 2 - Management Co Decision </br> 3 = Mgmt Co AND Board </br> 4 = Mgmt Co OR Board </br> 5 = Board Vote
          example: 2
        yesNextStepID:
          type: string
          description: next sequential step the action item will be stepped to if decision = yes
          example: 484
        yesNextStepList:
          type: string
          description: list of actionStepIDs that the action item can be stepped to if decision = yes
          example: 484, 486, 489, 495
        yesNextStepValue:
          type: array
          description: array of actionStepIDs that the action item can be stepped to if decision = yes
          items:
            type: string
            example:
            - '484'
            - '486'
            - '489'
            - '495'
        noNextStepID:
          type: integer
          description: next sequential step the action item will be stepped to if decision = no
          example: 492
        noNextStepList:
          type: string
          description: list of actionStepIDs that the action item can be stepped to if decision = no
          example: 492, 493, 1414, 1416
        noNextStepValue:
          type: array
          description: array of actionStepIDs that the action item can be stepped to if decision = no
          items:
            type: string
            example:
            - '492'
            - '493'
            - '1414'
            - '1416'
        reminderInterval:
          type: integer
          nullable: true
          description: reminder interval of the action item
          example: 0
        adminDuration:
          type: integer
          nullable: true
          example: 0
        durBalType:
          type: string
          description: duration/balance setting 0 = OR </br> 1 = AND
          example: 0
        repeatDays:
          type: integer
          description: Repeat (# of Days) setting
          example: 3
        stepDate:
          type: string
          description: ''
          nullable: true
          example: null
        actionID:
          type: string
          description: unique identifer for the additional action item
          example: 0
        actionDescr:
          type: string
          description: additional action item description
          example: (No Additional Action)
        balanceSetting:
          type: string
          nullable: true
          description: ''
          example: 0
        instructions:
          nullable: true
          type: string
          description: information entered in the Instruction's section of the action step
          example: null
        listDescr:
          type: string
          description: description of step (orderNo + descr)
          example: 1 - Request Received
        blockPayment:
          type: boolean
          description: if true, Block Payments checkbox is enabled on the step's rules, else, false
          example: true
        blockLedger:
          type: boolean
          description: if true, Block Ledger checkbox is enabled on the step's rules, else, false
          example: false
        maskAuthor:
          type: boolean
          description: if true, Hide Sender checkbox is enabled on the step's rules, else, false
          example: true
        commOnly:
          type: boolean
          description: ''
          example: false
        holdCollections:
          type: boolean
          description: if true, Hold Collections checkbox is enabled on the step's rules, else, false
          example: false
        holdLateFees:
          type: boolean
          description: if true, Hold Fees checkbox is enabled on the step's rules, else, false
          example: false
        notifyMode:
          type: string
          description: Notifications settings 0 = General User Preference </br> 1 = No Notifications </br> 2 = Paper </br> 3 = Email </br> 4 = Electronic (General User Preference) </br> 5 = Paper and Electronic </br> 6 = (Billing User Preference) </br> 7 = Electronic (Billing User Preference) </br> 8 = Electronic Preference, If none, then paper
          example: '4'
        commMode:
          type: boolean
          description: if true, Send To All checkbox is enabled on the step's rules, else, false
          example: false
        mailAll:
          type: string
          description: mailing format 0 = Mailing Address Only </br> 1 = All Addresses - "Mailing Address with Name" tag </br> 2 = All Adresses - "Mailing Aress with Name" tag (Current Resident)
          example: 0
        combineAttach:
          type: boolean
          description: if true, Combine Attachments checkbox is enabled on the step's rules, else, false
          example: false
        otherDescr:
          type: string
          description: Statement Product Code
          example: ''
        otherMsg:
          type: string
          description: Statement Message
          example: ''
        displayCalendarEventDD:
          type: string
          description: Display Calendar Event settings 0 = (Choose a Display Calendar Event) </br> 1 = Do Not Show </br> 2 = Tentative Calendar Event </br> 3 = Confirmed Calendar Event </br> 4 = Remove Calendar Event
          example: 2
        displayCalendarEventDDDesc:
          type: string
          description: Description associated with the displayCalendarEventDD field
          example: Tentative
        hideFromPortal:
          type: boolean
          description: if true, Hide From Portal checkbox is enabled on the step's rules, else, false
          example: false
        includeInReconPost:
          type: boolean
          description: if true, Include in Reconciliation checkbox is enabled on the step's rules, else, false
          example: false
        CureDate:
          type: string
          format: date-time
          nullable: true
          description: Cure Date of violation action items
          example: ''
        HearingDate:
          type: string
          format: date-time
          description: Hearing Date of violation action items
          nullable: true
          example: ''
    ccrDetails:
      type: object
      properties:
        CCRItemDetailID:
          type: integer
          description: unique identifier for the CCR item detail
          example: 281
        Detail:
          type: string
          description: detail name
          example: Lawn needs to be mowed.
        CurePeriod:
          type: integer
          description: cure period for the CCR item detail
          example: 12
    collectionList:
      type: object
      properties:
        xn:
          type: integer
          description: unique identifier for the collection action item
          example: 30292
        assocCode:
          type: string
          description: unique identifier for an association
          example: '101'
        ownerId:
          type: integer
          description: unique identifier for the owner account
          example: 10106
        hoid:
          type: integer
          description: unique identifier for a homeowner
          example: 0
        propertyId:
          type: integer
          description: unique identifier for a single property
          example: 10102
        closed:
          type: boolean
          description: if **true**, collection action item is closed, else **false**
          example: false
        actionTypeId:
          type: integer
          description: unique identifier for the action type
          example: 124
        actionType:
          type: string
          description: name of the action type
          example: Collections (Standard process)
        actionStepId:
          type: integer
          description: unique identifier for the current action step
          example: 365
        collectionStatus:
          type: string
          description: current status of the collection action item
          example: Processing Lien Paperwork
        collectionStep:
          type: string
          description: current step of the collection action item including step order number
          example: 60 - Processing Lien Paperwork
        subject:
          type: string
          description: subject of the collection action item
          example: pay your bill
        description:
          type: string
          description: description of the collection action item
          example: Balance of $1,448.00 meets the Association's minimum collection balance of $1,000.00 that is at least 30 days old.
        category:
          type: string
          description: action item category
          example: Collections
        actionCategoryId:
          type: integer
          description: unique identifier for the action category
          example: 1
        createdDate:
          type: string
          format: date-time
          description: date the collection action item was created
          example: '2019-10-22T00:00:00'
        followupDate:
          type: string
          format: date-time
          description: follow-up date for the collection action item, can be null
          example: '2019-11-01T00:00:00'
        dueDate:
          type: string
          format: date-time
          nullable: true
          description: due date for the collection action item, can be null
          example: null
        lastModified:
          type: string
          format: date-time
          description: date the collection action item was last modified
          example: '2023-01-18T10:22:05.277'
        balancesSummary:
          type: object
          description: summary of account balance information for the collection action item
          properties:
            accountBalance:
              type: number
              format: decimal
              description: total account balance
              example: 57598.0
            collectibleBalance:
              type: number
              format: decimal
              description: balance eligible for collection
              example: 0.0
            blockPayments:
              type: boolean
              description: if **true**, payments are blocked on this account, else **false**
              example: false
            blockLedger:
              type: boolean
              description: if **true**, ledger is blocked on this account, else **false**
              example: false
        messages:
          type: array
          description: array of messages associated with the action item. *populated when includeMessages = true, else empty array*
          items:
            $ref: https://api.swaggerhub.com/domains/Vantaca/standard_domains/1.2.2#/components/schemas/messages
        attachments:
          type: array
          description: array of attachments associated with the action item. *populated when includeAttachments = true, else empty array*
          items:
            $ref: '#/components/schemas/attachmentList'
    getHomeownerAccountInfo:
      type: object
      properties:
        assocCode:
          type: string
          description: unique identifier for an association
        assocName:
          type: string
          description: association name
          example: Amazing Community Management Experience
        accountNo:
          type: string
          description: unique identifier for a single account
          example: 100100101
        hoid:
          type: integer
          description: unique identifier for a homeowner (can represent a joint owner or business/ an owner can have one or more accounts/properties)
          example: 10011
        owners:
          type: array
          items:
            $ref: '#/components/schemas/owners'
        businessName:
          type: string
          description: homeowner's business name
          example: Enchante Apparel
        propertyID:
          type: integer
          description: unique identifier for a single property (A property can have one or more accounts/owners, but only one account is "current" owner)
          example: 98123
        lotNo:
          type: string
          description: lot address
        block:
          type: string
          description: block address
        phase:
          type: string
        address:
          type: string
          description: street number and street name
          example: 537 Paper St.
        city:
          type: string
          description: owner city
          example: Bedford
        state:
          type: string
          description: owner state
          example: NC
        zip:
          type: string
          description: owner zip
          example: 19808
        country:
          type: string
          description: owner country
          example: US
        legalDescription:
          type: string
          description: legal description of the owner's property
        blockLedger:
          type: boolean
          description: if true, Block Ledger checkbox is enabled on the step's rules, else, false
          example: false
        blockPayments:
          type: boolean
          description: if true, Block Payments checkbox is enabled on the step's rules, else, false
          example: true
        balance:
          type: integer
          format: decimal
          description: current balance
          example: 123,456,789.25
        settleDate:
          type: string
          format: date-time
          description: date the property was purchased
          example: '1900-01-01T00:00:00'
        previousOwner:
          type: string
          format: date-time
          description: date the property was sold. if null, no previous owner
          example: null
        hasAutoPay:
          type: boolean
          description: if **true** billing type is ACH, else **false**
          example: true
        lateDayOfMonth:
          type: integer
          description: day of the month the assessment is considered late
          example: 7
        lateFee:
          type: integer
          format: decimal
          description: late fee that would be charged on past due balance for regular assessment
          example: 10
        hasOpenViolations:
          type: boolean
          description: if **true**, homeowner has open violations, else **false**
          example: true
        isInCollection:
          type: boolean
          description: if **true**, homeowner has a collection status, else **false**
          example: true
        collectionStatus:
          type: string
          description: current step of an open collection action item for the homeowner account
          example: Late Statement
        assocLitigation:
          type: boolean
          description: if **true**, association is in litigation, else **false**
          example: true
        litigationComment:
          type: string
          description: description of litigation
        unsatisfiedJudgementAmount:
          type: string
          description: amount of unsatisfied judgement
          example: 100000
        mailingAddressType:
          type: string
          description: Vantaca stores the mailing address as a pointer to either a property address (propertyID) or and offsite address (addrID found in addresses list for homeowner) possible values include "PropertyAddress", "OffsiteMailingAddress"
          example: PropertyAddress
        communicationPreference:
          type: string
          description: owner communcations preference, possible values are "Paper", "Email", "App", "Text"
          example: Paper
        billingPreference:
          type: string
          description: owner billing communication preference, possible values are "Paper", "Text", "Email"
          example: Paper
        numberOfShares:
          type: integer
          format: decimal
          description: Number of shares for 1098. Up to 2 decimals
          example: '20.01'
        votingShares:
          type: integer
          format: decimal
          description: Number of shares for voting purposes. Up to 4 decimals
          example: '12.1001'
        created:
          type: string
          format: date-time
          description: date the homeowner account was created
          example: '2022-11-07T18:12:05.603'
        lastModified:
          type: string
          format: date-time
          description: last time the homeowner account was modified
          example: '2023-06-14T13:51:36.78'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/addresses'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/phoneNumbers'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/emails'
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/assessments'
    owners:
      type: object
      properties:
        firstName:
          type: string
          description: owner first name
          example: Lando
        lastName:
          type: string
          description: owner last name
          example: Norris
    assessments:
      type: object
      properties:
        accountID:
          type: integer
          description: primary homeowner account number
          example: 77700123
        transactionType:
          type: string
          description: transaction type
          example: Assessment
        transactionDescription:
          type: string
          description: assessment/charge name
          example: Assessment One
        openAmount:
          type: string
          description: assessment/charge balance
          example: 876.54
        amount:
          type: string
          description: assessment/charge amount
          example: 1
        assessment:
          type: string
          description: if YES, regular assessment, else NO
          example: 'NO'
        specialAssessment:
          type: string
          description: if YES, special assessment else NO
          example: 'YES'
        finePenalty:
          type: string
          description: if YES, fine or penalty, else NO
          example: 'NO'
        frequency:
          type: string
          description: assessment frequency (for regular or special assessment only)
        paidThru:
          type: string
          format: date-time
          description: For regular and special assessments, the date that the fee is paid through. </br> For delinquent accounts, the oldest date of a transaction
        dueDate:
          type: string
          format: date-time
          description: payment due date
        lastPaymentDate:
          type: string
          format: date-time
          description: date of last payment
        lastPaymentAmount:
          type: string
          description: amount of last payment
          example: 2700
        nextDueDate:
          type: string
          format: date-time
          description: next due date. if the assessment is paid through for the fiscal year, then the first date for the next fiscal year
        lastmodified:
          type: string
          format: date-time
          description: date the assessment was last modified.</br> **if assessment was never modified, field will be null**
          example: '2022-07-07T01:44:49.307'
        created:
          type: string
          format: date-time
          description: date the assessment was created
          example: '2021-10-12T15:57:26.263'
    primaryAssessments:
      type: object
      properties:
        descr:
          type: string
          description: assessment description
          example: Assessment
        amount:
          type: integer
          description: assessment amount
          example: 50
        frequency:
          type: string
          description: 'assessment frequency. possible values: Monthly, Semi-Annual, Quarterly, Annual'
          example: Monthly
        assessmentType:
          type: string
          description: assessment type
          example: Fixed
        assessmentDay:
          type: integer
          description: calendar day
          example: 1
        assessmentMonth:
          type: integer
          description: calendar month
          example: 12
        assessmentChargeTags:
          type: array
          description: array of assessment charge tags
          items:
            $ref: '#/components/schemas/assessmentChargeTags'
    phoneNumbers:
      type: object
      properties:
        id:
          type: integer
          description: unique identifier for a phone number
          example: 32515
        created:
          type: string
          format: date-time
          description: date the phone number was added to the owner's account
          example: '2023-04-28T15:13:17.883'
        lastModified:
          type: string
          format: date-time
          description: date the phone number was last modified. </br> *if phone number was never modified, field will be null*
          example: null
        label:
          type: string
          description: phone number label
          example: cell phone
        isPrimary:
          type: boolean
          description: if **true**, number will be used for contacting owner, else **false**
          example: true
    companyAddress:
      type: object
      properties:
        AddressID:
          type: integer
          description: unique identifier for the address record
          example: 4
        created:
          type: string
          format: date-time
          description: date-time the address was created
          example: '2022-11-07T18:13:26.48'
        lastmodified:
          type: string
          format: date-time
          description: date-time the address was last modified
          example: '2022-11-07T18:13:26.48'
        address1:
          type: string
          description: the address field 1
          example: 1234 Testing Rd
        address2:
          type: string
          description: the address field 2
          example: 'Unit # 5'
        city:
          type: string
          description: the address city
          example: Wilmington
        state:
          type: string
          description: the address state
          example: NC
        zip:
          type: string
          description: the address zip
          example: '28412'
        county:
          type: string
          description: the address county
          example: New Hanover
    actionCategoryList:
      type: object
      properties:
        ActionCategoryID:
          type: integer
          description: unique identifier for the action category
          example: 4
        Descr:
          type: string
          description: action category description
          example: Collections
x-internal: false