Vantaca Architectural Requests (ARC) API

{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/Vantaca/vantacaStandard/3.8.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","contact":{"email":"vendorsupport@vantaca.com"}},"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***}"},{"name":"/write/","description":"These methods write data. Unless otherwise specified, all object types available are paired with individual /read/ to allow full CRUD (Create, Read, Update, and Destory) operations against any item. Note: Entering invalid dates may result in them appearing as null or blank in Vantaca </br> All calls will use the same URL path: /write/{***method***}"},{"name":"/AP/","description":"These methods are specific to AP or Invoice related functions and can only be accessed by designated AP credentials. Note: Entering invalid dates may result in them appearing as null or blank in Vantaca </br> All AP calls will use the same URL path: /AP/{***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":{"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"}}},"parameters":[]},"/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 

# --- truncated at 32 KB (196 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vantaca/refs/heads/main/openapi/vantaca-openapi.json