{"openapi":"3.1.0","info":{"title":"Imobzi REST API","description":"# Introduction\nImobzi provides a web programming interface, in the REST model. Through this interface, you can talk to the Imobzi Application, commanding actions and synchronizing with your applications.\n\nThe base communication address is api.imobzi.app, always followed by the secure protocol https:// as a prefix. API versions are grouped by directory, suffixed to the base address (https://api.imobzi.app/v1).\n\nThis document covers the version of API 1.0. The address to communicate through this release is:\n\n```\nhttps://api.imobzi.app/v1/\n```\n\n# Authentication\n\n Authentication on Imobzi is done through the use of a secret key. This key is for the Imobzi API to identify your account, and grant permissions for an Application to communicate with Imobzi.\n\n\n\n## Creating your Secret Key\nCreate your secret key by following the steps below. You must have administrator access.\n\n
    \n\t
  1. Access Imobzi at https://my.imobzi.com or if you are already logged in click here.
    2. \n\t
  2. Click the 'Integrations and Automations' menu. Now click in the 'API Keys' tab and click on the 'New' button and enter the name of the Application that will use the generated key. Copy the key and click 'Save'.
    3. \n
\n\n\n## Authentication Test\nAfter generating your key, if desired, test authentication with this command line in Curl:\n\n```curl\ncurl --request GET --url https://api.imobzi.app/v1/properties\n --header 'X-Imobzi-Secret:34afddae1a7c11e9a10bab89456f8c3b'\n```\n\n## Sandbox\n\nCurrently the API does not have a Sandbox available for testing. We recommend that you carefully create, update and delete data.\n\n\n# Webhooks\nWebhooks allow your application to receive notifications when certain events occur. For example, when a new Contact is created, Imobzi will make a POST request to your URI endpoint letting you know information about the new Contact. You can create Webhooks through the API using the Webhooks creation method below.\n\nWebhooks are the recommended way to be notified about creating, changing, and removing a record in Imobzi, as they are easier to integrate with your application and scale perfectly with your growth.\n\n

Delivery attempts

\n\nEvery time a record is created, updated and deleted, Imobzi will fire the created Webhook immediately. If the Status different from 20X returns, the Imobzi will fire this Webhook 5 more times, will be respectively in 10, 20, 40, 80, 160 minutes.\n\n

Notification format

\n\nThe Webhook endpoint will receive a POST request, containing a JSON object encoded in UTF-8. This object usually contains the complete record, avoiding a request to obtain the rest of the data. The format of the JSON object can be obtained at the first Webhook request.\n\n

List of available Webhooks

\n\n\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n \n\t\t\t\n\t\t\t\n\t\t\n\t\n
EventDescription
deal_createdWhen a new deal is Created
deal_updatedWhen a deal is Updated
deal_deletedWhen a deal is Deleted
document_createdWhen a Document is Created
document_updatedWhen a Document is Updated
document_deletedWhen a Document is Deleted
lead_createdWhen a new Lead is Created
lead_updatedWhen a Lead is Updated
lead_deletedWhen a Lead is Deleted
contact_createdWhen a new Person/Organization is Created
contact_updatedWhen a Person/Organization is Updated
contact_deletedWhen a Person/Organization is Deleted
property_createdWhen a new Property is Created
property_updatedWhen a Property is Updated
property_deletedWhen a Property is Deleted
property_reserve_createdWhen a Property Reserve is Created
property_reserve_updatedWhen a Property Reserve is Updated
property_reserve_deletedWhen a Property Reserve is Deleted
pipeline_group_createdWhen a Pipeline Group is Created
calendar_item_createdWhen a new Item Calendar is Created
calendar_item_updatedWhen a Item Calendar is Updated
calendar_item_deletedWhen a Item Calendar is Deleted
lease_createdWhen a Lease is Created
lease_updatedWhen a Lease is Updated
lease_deletedWhen a Lease is Deleted
contract_createdWhen a Contract is Created
contract_updatedWhen a Contract is Updated
contract_deletedWhen a Contract is Deleted
invoice_createdWhen a Invoice is Created
invoice_updatedWhen a Invoice is Updated
financial_transaction_createdWhen a Financial Transaction is Created
financial_transaction_updatedWhen a Financial Transaction is Updated
financial_transaction_deletedWhen a Financial Transaction is Deleted
analysis_createdWhen a Analysis is Created
analysis_updatedWhen a Analysis is Updated
analysis_deletedWhen a Analysis is Deleted
\n\n# Pagination\nThe first time a list request is executed, the API will generally return 50 records and the cursor to the next 50 records that must be sent on the next request using the cursor parameter.\n\nThe number of records returned per request varies according to the method to be consumed.\n\nThe cursor parameter is optional and should not be sent on the first request.\n\n# Rate limiting\nImobzi has some different rate limits to ensure that any client can not affect the performance of our API by making too many requests too quickly.\n\n\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n
ScopeRate-limit
Application120 requests per minute
Account300 requests per minute
\n\n

Timeout Limit

\nIf a request does not complete within 60 seconds, the request times out and Imobzi returns a Gateway Timeout error.","termsOfService":"https://www.imobzi.com/termos-de-uso-imobzi-versao-4.pdf","contact":{"name":"Imobzi API Support","url":"https://www.imobzi.com/"},"license":{"name":"Imobzi","url":"https://www.imobzi.com/"},"version":"1.0.0","x-logo":{"url":"https://api.imobzi.app/static/images/logotipo-imobzi-developer.svg"}},"servers":[{"url":"https://api.imobzi.app","description":"Live Server"}],"paths":{"/v1/contacts":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A List Of Contacts","description":"Show list to contacts","operationId":"prod_get_contacts_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor received in the previous request","title":"Cursor"},"description":"Cursor received in the previous request"},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"contact","lead","person","organization","all"]},{"type":"null"}],"title":"Contact Type"}},{"name":"media_source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origin of the contact, such as website, name of an advertising portal","title":"Media Source"},"description":"Origin of the contact, such as website, name of an advertising portal"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"enum":["recently_updated","recently_created","desc",null]},{"type":"null"}],"title":"Order"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","my_contacts","my_leads","birthdays_all","birthdays_only_mine","without_deals","with_deals","shared_with_me","shared_with_others","out_of_date","new_contacts","new_leads","pending","inactives","without_interest","out_of_date_90_days",null]},{"type":"null"}],"description":"Predefined smart lists for filtering contacts ex: all, my_contacts, birthdays_all, without_deals, shared_with_me, out_of_date, new_contacts, pending, inactives","title":"Smart List"},"description":"Predefined smart lists for filtering contacts ex: all, my_contacts, birthdays_all, without_deals, shared_with_me, out_of_date, new_contacts, pending, inactives"},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Labels associated with the contact, such as owner, contact, lead, etc","title":"Tags"},"description":"Labels associated with the contact, such as owner, contact, lead, etc"},{"name":"clear_notifications","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clear Notifications"}},{"name":"inactive","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive"}},{"name":"manager_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Id"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"}},{"name":"cursor_current_page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Cursor Current Page"}},{"name":"search_date","in":"query","required":false,"schema":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"title":"Search Date"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},{"name":"filter_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter By"}},{"name":"review_pending","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending"}},{"name":"birthdays_start","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Birthdays Start"}},{"name":"birthdays_end","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Birthdays End"}},{"name":"show_map","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Map"}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lat"}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lng"}},{"name":"radius","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Radius"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContact"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contacts/profile-picture":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve Contact Profile Picture By Email","description":"Retrieve contact profile picture by email","operationId":"Retrieve_contact_profile_picture_by_email_v1_contacts_profile_picture_get","parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string","title":"Email"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Retrieve Contact Profile Picture By Email V1 Contacts Profile Picture Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contacts/search":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A Search List Of Contacts","description":"Search Contacts in the index","operationId":"prod_get_contacts_list_by_search","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor received in the previous request","title":"Cursor"},"description":"Cursor received in the previous request"},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"contact","lead","person","organization","all"]},{"type":"null"}],"title":"Contact Type"}},{"name":"media_source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Origin of the contact, such as website, name of an advertising portal","title":"Media Source"},"description":"Origin of the contact, such as website, name of an advertising portal"},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"enum":["recently_updated","recently_created","desc",null]},{"type":"null"}],"title":"Order"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","my_contacts","my_leads","birthdays_all","birthdays_only_mine","without_deals","with_deals","shared_with_me","shared_with_others","out_of_date","new_contacts","new_leads","pending","inactives","without_interest","out_of_date_90_days",null]},{"type":"null"}],"description":"Predefined smart lists for filtering contacts ex: all, my_contacts, birthdays_all, without_deals, shared_with_me, out_of_date, new_contacts, pending, inactives","title":"Smart List"},"description":"Predefined smart lists for filtering contacts ex: all, my_contacts, birthdays_all, without_deals, shared_with_me, out_of_date, new_contacts, pending, inactives"},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Labels associated with the contact, such as owner, contact, lead, etc","title":"Tags"},"description":"Labels associated with the contact, such as owner, contact, lead, etc"},{"name":"clear_notifications","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clear Notifications"}},{"name":"inactive","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive"}},{"name":"manager_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Id"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"}},{"name":"cursor_current_page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Cursor Current Page"}},{"name":"search_date","in":"query","required":false,"schema":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"title":"Search Date"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},{"name":"filter_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter By"}},{"name":"review_pending","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending"}},{"name":"birthdays_start","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Birthdays Start"}},{"name":"birthdays_end","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Birthdays End"}},{"name":"show_map","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Map"}},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lat"}},{"name":"lng","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lng"}},{"name":"radius","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Radius"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContact"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contact/exists":{"get":{"tags":["Contacts and Leads"],"summary":"Check If Contact Exists","description":"Get contact by email, cpf, cnpj or phone_number","operationId":"prod_get_contact_exists","parameters":[{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"phone_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number"}},{"name":"cpf","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf"}},{"name":"cnpj","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContactExists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contacts/tags":{"get":{"tags":["Contacts Tags"],"summary":"Retrieve A List Of Contact Tag","operationId":"prod_get_contact_tags","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactTagSchema"},"type":"array","title":"Response Prod Get Contact Tags"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contacts Tags"],"summary":"Create A Contact Tag","operationId":"prod_create_contact_tag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTagPostSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContactTagSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contact/tags/{tag_id}":{"get":{"tags":["Contacts Tags"],"summary":"Retrieve A Contact Tag","operationId":"prod_get_contact_tag","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","title":"Tag Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTagSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contacts Tags"],"summary":"Update A Contact Tag","operationId":"Update_a_contact_tag_v1_contact_tags__tag_id__post","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","title":"Tag Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTagPostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContactTagSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contacts Tags"],"summary":"Delete A Contact Tag","operationId":"Delete_a_contact_tag_v1_contact_tags__tag_id__delete","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","title":"Tag Id"}}],"responses":{"204":{"description":"Contact tag was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal-fields":{"get":{"tags":["Fields Deal"],"summary":"Retrieve A List Of Deal Fields","operationId":"Retrieve_a_list_of_deal_fields_v1_deal_fields_get","parameters":[{"name":"pipelines_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipelines Group Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DealsFieldsSchemas"},"title":"Response Retrieve A List Of Deal Fields V1 Deal Fields Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Deal"],"summary":"Create A Deal Field","operationId":"Create_a_deal_field_v1_deal_fields_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealsFieldsCreateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal-field/{field_id}":{"get":{"tags":["Fields Deal"],"summary":"Retrieve A Deal Field","operationId":"Retrieve_a_deal_field_v1_deal_field__field_id__get","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"type":"string","title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealsFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Deal"],"summary":"Update A Deal Field","operationId":"Update_a_deal_field_v1_deal_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"type":"string","title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealsFieldsUpdateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Fields Deal"],"summary":"Delete A Deal Field","operationId":"Delete_a_deal_field_v1_deal_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Deal field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/lost-reason":{"get":{"tags":["Deal Lost Reasons"],"summary":"Retrieve A List Of Deal Lost Reason","operationId":"prod_get_deal_lost_reasons","parameters":[{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},{"name":"without_type","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Type"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DealLostReasonSchema"},"title":"Response Prod Get Deal Lost Reasons"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deal Lost Reasons"],"summary":"Create A Deal Lost Reason","operationId":"prod_create_deal_lost_reason","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealLostReasonPostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealLostReasonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/lost-reason/{reason_id}":{"get":{"tags":["Deal Lost Reasons"],"summary":"Retrieve A Deal Lost Reason","operationId":"prod_get_deal_lost_reason","parameters":[{"name":"reason_id","in":"path","required":true,"schema":{"type":"string","title":"Reason Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealLostReasonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deal Lost Reasons"],"summary":"Update A Deal Lost Reason","operationId":"Update_a_deal_lost_reason_v1_deal_lost_reason__reason_id__post","parameters":[{"name":"reason_id","in":"path","required":true,"schema":{"type":"string","title":"Reason Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealLostReasonPostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealLostReasonSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Deal Lost Reasons"],"summary":"Update A Deal Lost Reason","operationId":"Update_a_deal_lost_reason_v1_deal_lost_reason__reason_id__delete","parameters":[{"name":"reason_id","in":"path","required":true,"schema":{"type":"string","title":"Reason Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/filter-fields":{"get":{"tags":["Deals Filters"],"summary":"Retrieve A List Of Deal Filter Fields","operationId":"prod_get_deal_filter_fields","parameters":[{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseGetDealFilterFields"},"title":"Response Prod Get Deal Filter Fields"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/filters":{"post":{"tags":["Deals Filters"],"summary":"Create Deal Filters","operationId":"Create_Deal_filters_v1_deal_filters_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealFilterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routers__schemas__deal_filter_fields__ResponsePostSchema"},"title":"Response Create Deal Filters V1 Deal Filters Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"get":{"tags":["Deals Filters"],"summary":"Retrieve A List Of Deal Filters","operationId":"prod_get_deal_filters","parameters":[{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseGetDealFiltersSchema"},"title":"Response Prod Get Deal Filters"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/filter/{filter_id}":{"post":{"tags":["Deals Filters"],"summary":"Update A Deal Filter","operationId":"Update_a_Deal_filter_v1_deal_filter__filter_id__post","parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"type":"string","title":"Filter Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealFilterUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/routers__schemas__deal_filter_fields__ResponsePostSchema"},"title":"Response Update A Deal Filter V1 Deal Filter Filter Id Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Deals Filters"],"summary":"Delete A Deal Filter","operationId":"Delete_a_Deal_filter_v1_deal_filter__filter_id__delete","parameters":[{"name":"filter_id","in":"path","required":true,"schema":{"type":"string","title":"Filter Id"}}],"responses":{"204":{"description":"Deal filter was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/range-areas":{"get":{"tags":["Deals"],"summary":"Get Deal Range Areas","description":"Return min and max useful area of deals","operationId":"prod_get_deal_range_areas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/range-values":{"get":{"tags":["Deals"],"summary":"Get Deal Range Values","description":"Return min and max value of deals","operationId":"prod_get_deal_range_values","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deals/search":{"get":{"tags":["Deals"],"summary":"Retrieve A List Of Deals By Search","description":"Search deals by contact or profile","operationId":"prod_get_deals_search","parameters":[{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["lead","person","organization","user","newContact",null]},{"type":"null"}],"title":"Contact Type"}},{"name":"deal_stage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Deal Stage"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},{"name":"initial_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date"}},{"name":"interest","in":"query","required":false,"schema":{"anyOf":[{"enum":["buy","rent","vacation_rental",null]},{"type":"null"}],"title":"Interest"}},{"name":"final_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date"}},{"name":"finality","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","commercial","residential","rural",null]},{"type":"null"}],"title":"Finality"}},{"name":"max_area","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Area"}},{"name":"max_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Value"}},{"name":"min_area","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Area"}},{"name":"min_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Value"}},{"name":"measure_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"}},{"name":"neighborhood","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"}},{"name":"pipeline_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","default","others","cards",null]},{"type":"null"}],"title":"Pipeline Type"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"bathroom","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"}},{"name":"bedroom","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"}},{"name":"garage","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"}},{"name":"suite","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}},{"name":"deals_network","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Deals Network"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"stage","in":"query","required":false,"schema":{"anyOf":[{"enum":["","pre_launch","launch","in_construction","ready",null]},{"type":"null"}],"title":"Stage"}},{"name":"show_activities","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Activities"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","win","lost","stagnant","out_of_date","in progress",null]},{"type":"null"}],"title":"Status"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"}},{"name":"with_participant","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"With Participant"}},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/reports/deals-done":{"get":{"tags":["Deals","Reports"],"summary":"Get Deals Done","description":"'Get Deals Done","operationId":"prod_get_deals_done","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deals":{"get":{"tags":["Deals"],"summary":"Retrieve A Deal List","description":"Get Deal's list","operationId":"prod_get_deals_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"cursor_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cursor Page"}},{"name":"deal_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","buy","rent","vacation_rental",null]},{"type":"null"}],"title":"Deal Type"}},{"name":"deal_status","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","stagnant","in progress","out_of_date","win","lost","property_radar",null]},{"type":"null"}],"title":"Deal Status"}},{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"only_new_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only New Properties"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"}},{"name":"property_in","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property In"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"reserve_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reserve Code"}},{"name":"filter_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit"}},{"name":"user_team","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"User Team"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDeal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deals"],"summary":"Create A New Deal","description":"Create a new deal","operationId":"prod_create_deals","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealsRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal/{deal_id}":{"get":{"tags":["Deals"],"summary":"Retrieve A Deal","description":"Get Deal","operationId":"prod_get_deal","parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deals"],"summary":"Update A Deal","description":"Update Deal","operationId":"Update_a_Deal_v1_deal__deal_id__post","parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Deals"],"summary":"Delete A Deal","description":"Delete deal","operationId":"Delete_a_Deal_v1_deal__deal_id__delete","parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/documents":{"get":{"tags":["Documents"],"summary":"Retrieve A List Of Documents","description":"Get list documents","operationId":"prod_get_documents_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"all","draft","pending_safe_creation","waiting_signature","signed","canceled","file_save"]},{"type":"null"}],"title":"Status"}},{"name":"document_type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"all","electronic_signature","face_to_face_signature","notify_signers","attach_file"]},{"type":"null"}],"title":"Document Type"}},{"name":"link_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Link Id"}},{"name":"link_type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"all","contact","contract","deal","lease","property"]},{"type":"null"}],"title":"Link Type"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"}},{"name":"building_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Id"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"reconcile","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Reconcile"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"enum":["recently_created","oldest_created"],"type":"string"},{"type":"null"}],"title":"Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Documents"],"summary":"Create A Document","description":"Create new document","operationId":"prod_create_documents","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/document/{document_id}":{"get":{"tags":["Documents"],"summary":"Retrieve A Document By Id","description":"Get document","operationId":"prod_get_document","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Documents"],"summary":"Update A Document","description":"Update document","operationId":"Update_a_document_v1_document__document_id__post","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"reconcile","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Reconcile"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Documents"],"summary":"Delete A Document","description":"Delete document","operationId":"Delete_a_document_v1_document__document_id__delete","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"204":{"description":"Document was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/document/{document_id}/duplicate":{"post":{"tags":["Documents"],"summary":"Duplicate Document","description":"Duplicate document file","operationId":"Duplicate_document_v1_document__document_id__duplicate_post","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/documents/files":{"post":{"tags":["Documents"],"summary":"Add A File To The Document","description":"Save document file","operationId":"prod_create_document_files","parameters":[{"name":"document_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},{"name":"blob_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_prod_create_document_files"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Documents"],"summary":"Delete A File To The Document","description":"Save document file","operationId":"Delete_a_file_to_the_document_v1_documents_files_delete","parameters":[{"name":"document_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},{"name":"blob_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/document-fee":{"get":{"tags":["Documents"],"summary":"Document Fee","description":"Get document fee","operationId":"prod_get_document_fee","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentsFee"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/media-sources":{"get":{"tags":["Media Source"],"summary":"Retrieve A List Of Media Sources","operationId":"prod_get_media_sources_list","parameters":[{"name":"only-integrations","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Only-Integrations"}},{"name":"inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaSourcesSchema"},"title":"Response Prod Get Media Sources List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Media Source"],"summary":"Create A Media Source","operationId":"prod_create_media_source","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaSourceCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMediaSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/media-source/{mediasource_id}":{"get":{"tags":["Media Source"],"summary":"Retrieve A Media Source","operationId":"prod_get_media_source","parameters":[{"name":"mediasource_id","in":"path","required":true,"schema":{"type":"string","title":"Mediasource Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaSourcesSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Media Source"],"summary":"Update A Media Source","operationId":"Update_a_media_source_v1_media_source__mediasource_id__post","parameters":[{"name":"mediasource_id","in":"path","required":true,"schema":{"type":"string","title":"Mediasource Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaSourceUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMediaSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Media Source"],"summary":"Delete A Media Source","operationId":"Delete_a_media_source_v1_media_source__mediasource_id__delete","parameters":[{"name":"mediasource_id","in":"path","required":true,"schema":{"type":"string","title":"Mediasource Id"}}],"responses":{"204":{"description":"Media source was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/media-sources-report":{"get":{"tags":["Media Source"],"summary":"Media Sources Report","operationId":"Media_Sources_Report_v1_media_sources_report_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MediaSourcesReportSchema"},"type":"array","title":"Response Media Sources Report V1 Media Sources Report Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/neighborhoods":{"get":{"tags":["Neighborhoods"],"summary":"Retrieve A List Of Neighborhoods","operationId":"prod_get_neighborhoods_list","parameters":[{"name":"only_actives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only Actives"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Search Text"}},{"name":"city_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"City Name"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetNeighborhoods"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Neighborhoods"],"summary":"Create A Neighborhood","operationId":"prod_create_neighborhood","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodsRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/neighborhoods/{neighborhood_id}":{"get":{"tags":["Neighborhoods"],"summary":"Retrieve A Neighborhood By Id","operationId":"prod_get_neighborhood_by_id","parameters":[{"name":"neighborhood_id","in":"path","required":true,"schema":{"type":"string","title":"Neighborhood Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Neighborhoods"],"summary":"Update A Neighborhood","operationId":"Update_a_neighborhood_v1_neighborhoods__neighborhood_id__post","parameters":[{"name":"neighborhood_id","in":"path","required":true,"schema":{"type":"string","title":"Neighborhood Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Neighborhoods"],"summary":"Delete A Neighborhood","operationId":"Delete_a_neighborhood_v1_neighborhoods__neighborhood_id__delete","parameters":[{"name":"neighborhood_id","in":"path","required":true,"schema":{"type":"string","title":"Neighborhood Id"}}],"responses":{"204":{"description":"Neighborhood was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/persons":{"post":{"tags":["Contacts and Leads"],"summary":"Create A Person","description":"Save new person","operationId":"prod_create_person","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsRouterSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreatePerson"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/person/{person_id}":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A Person By Id","description":"Show person","operationId":"Retrieve_a_person_by_id_v1_person__person_id__get","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"string","title":"Person Id"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contacts and Leads"],"summary":"Update A Person","description":"Update person","operationId":"Update_a_person_v1_person__person_id__post","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"string","title":"Person Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contacts and Leads"],"summary":"Delete A Person","description":"Delete person","operationId":"Delete_a_person_v1_person__person_id__delete","parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"string","title":"Person Id"}}],"responses":{"204":{"description":"Person was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/person/code/{person_code}":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A Person By Code","description":"Show person","operationId":"prod_get_person_by_code","parameters":[{"name":"person_code","in":"path","required":true,"schema":{"type":"string","title":"Person Code"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/person-fields":{"get":{"tags":["Fields Contact"],"summary":"Retrieve A List Of Person Fields","operationId":"prod_get_person_fields_list","parameters":[{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PersonFieldsSchemas"},"title":"Response Prod Get Person Fields List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Contact"],"summary":"Create A Person Field","operationId":"prod_create_person_field","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePersonField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/person-field/{field_id}":{"get":{"tags":["Fields Contact"],"summary":"Retrieve A Person Field","operationId":"prod_get_person_field","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Contact"],"summary":"Update A Person Field","operationId":"Update_a_person_field_v1_person_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonFieldSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePersonField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Fields Contact"],"summary":"Delete A Person Field","operationId":"Delete_a_person_field_v1_person_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Person field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/pipelines":{"get":{"tags":["Pipeline"],"summary":"Retrieve A List Of Pipelines","description":"Get pipelines' list","operationId":"prod_get_pipelines_list","parameters":[{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineFieldsSchema"},"title":"Response Prod Get Pipelines List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Pipeline"],"summary":"Create A Pipeline","description":"Create a new pipelines","operationId":"Create_a_Pipeline_v1_pipelines_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePipelineSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/pipeline/{pipeline_id}":{"get":{"tags":["Pipeline"],"summary":"Get A Pipeline","description":"Get pipeline item","operationId":"Get_a_Pipeline_v1_pipeline__pipeline_id__get","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Pipeline"],"summary":"Update A Pipeline","description":"Update pipeline","operationId":"Update_a_Pipeline_v1_pipeline__pipeline_id__post","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePipelineSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Pipeline"],"summary":"Delete A Pipeline","description":"Delete pipeline","operationId":"Delete_a_Pipeline_v1_pipeline__pipeline_id__delete","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"pipeline_to_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline To Id"}},{"name":"exclude_all_deals","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude All Deals"}}],"responses":{"204":{"description":"Pipeline was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/pipeline-groups":{"get":{"tags":["Pipeline Group"],"summary":"Retrieve A List Of Pipeline Group","description":"Get pipeline group","operationId":"prod_get_pipeline_groups_list","parameters":[{"name":"with_pipelines","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"With Pipelines"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"},"title":"Response Prod Get Pipeline Groups List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Pipeline Group"],"summary":"Create A Pipeline Group","description":"Create pipeline group","operationId":"Create_a_Pipeline_group_v1_pipeline_groups_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineGroupRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePipelineGroupSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/pipeline-groups/{pipeline_group_id}":{"get":{"tags":["Pipeline Group"],"summary":"Get A Pipeline Group","operationId":"Get_a_Pipeline_Group_v1_pipeline_groups__pipeline_group_id__get","parameters":[{"name":"pipeline_group_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Group Id"}},{"name":"with_pipelines","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"With Pipelines"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Pipeline Group"],"summary":"Update A Pipeline Group","description":"Update pipeline group","operationId":"Update_a_Pipeline_group_v1_pipeline_groups__pipeline_group_id__post","parameters":[{"name":"pipeline_group_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineGroupUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePipelineGroupSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Pipeline Group"],"summary":"Delete A Pipeline Group","description":"Delete pipeline group","operationId":"Delete_a_Pipeline_group_v1_pipeline_groups__pipeline_group_id__delete","parameters":[{"name":"pipeline_group_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Group Id"}},{"name":"pipeline_to_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline To Id"}},{"name":"exclude_all_deals","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude All Deals"}}],"responses":{"204":{"description":"Pipeline Group was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/range-values":{"post":{"tags":["Property"],"summary":"Property Range Values","description":"Return min and max value of properties","operationId":"prod_create_property_range_values","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyValuesRouterSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/range-areas":{"post":{"tags":["Property"],"summary":"Property Range Areas","description":"Return min and max value of properties","operationId":"prod_create_property_range_areas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyAreas"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/average-value/{neighborhood}/{city}":{"get":{"tags":["Property"],"summary":"Property Average Value","description":"Return min and max value of properties","operationId":"prod_get_property_average_value","parameters":[{"name":"neighborhood","in":"path","required":true,"schema":{"type":"string","title":"Neighborhood"}},{"name":"city","in":"path","required":true,"schema":{"type":"string","title":"City"}},{"name":"property_type","in":"query","required":false,"schema":{"type":"string","default":"","title":"Property Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyAverageValue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/exists":{"get":{"tags":["Property"],"summary":"Property Exists","description":"Get property by address, city, neighborhood and address complement","operationId":"prod_get_property_exists","parameters":[{"name":"address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"}},{"name":"address_complement","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"}},{"name":"neighborhood","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"}},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"}},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},{"name":"building_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"}},{"name":"property_block","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Block"}},{"name":"property_unity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Unity"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/search":{"post":{"tags":["Property"],"summary":"Retrieve A List Of Properties By Search","description":"Search Property in the index","operationId":"prod_property_search_properties_by_search","parameters":[{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}},{"name":"advert_not_equal","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Advert Not Equal"}},{"name":"without_site_highlights","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Without Site Highlights"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"show_network_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Show Network Properties"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertySearchRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertySearchSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/search-suggestion":{"post":{"tags":["Property"],"summary":"Retrieve A List Of Suggestion Properties","description":"Property Search Suggestion in the index","operationId":"prod_create_property_search_suggestion","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertySearchSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/reports/properties":{"get":{"tags":["Property","Reports"],"summary":"Get Properties Report","description":"Get Properties Report","operationId":"Get_Properties_Report_v1_reports_properties_get","parameters":[{"name":"all_brokers","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"All Brokers"}},{"name":"report_name","in":"query","required":true,"schema":{"type":"string","title":"Report Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/{property_id}/deals-match":{"get":{"tags":["Property"],"summary":"Property Deal Match","description":"Get PropertyMatchReports list","operationId":"Property_deal_match_v1_property__property_id__deals_match_get","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyDealsMatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/properties":{"get":{"tags":["Property"],"summary":"Retrieve A List Of Properties","description":"Show list of properties with performance improvements using parallel async calls.","operationId":"prod_get_properties_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"all_brokers","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"All Brokers"}},{"name":"clear_notifications","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clear Notifications"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"","all","available","available_reserved","buildings","my_properties","properties_third_party","properties_with_plaque","properties_without_plaque","shared_with_me","shared_with_others","out_of_date","site_no_publish","site_publish","without_photos","new_properties","pending","updated_by_owner","without_photosnew_properties","properties_without_photos","inactives","with_plaque","reserved","unavailable_properties","rent","sale","vacation_rental","exceeding","outdated","updated","without_location","properties_without_owner"]},{"type":"null"}],"title":"Smart List"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":50,"minimum":1},{"type":"null"}],"default":10,"title":"Limit"}},{"name":"show_map","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Map"}},{"name":"show_network","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Network"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PropertySearchSchema"},{"type":"null"}],"title":"Search"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponseGet"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property"],"summary":"Create A Property","description":"Create a property","operationId":"prod_create_property","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateProperty"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/{property_id}":{"get":{"tags":["Property"],"summary":"Retrieve A Property By Id","description":"Get property by id","operationId":"prod_get_property_by_id","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}},{"name":"dependencies_on_edit","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dependencies On Edit"}},{"name":"member_database","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property"],"summary":"Update A Property","description":"Update a property","operationId":"prod_update_property","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateProperty"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property"],"summary":"Delete A Property","description":"Delete a property","operationId":"prod_delete_property","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}}],"responses":{"204":{"description":"Property was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/{property_id}/quality":{"post":{"tags":["Property"],"summary":"Calculate Property Quality","description":"Calculate property quality","operationId":"Calculate_property_quality_v1_property__property_id__quality_post","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyQuality"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property/code/{property_code}":{"get":{"tags":["Property"],"summary":"Retrieve A Property By Code","description":"Get property by code","operationId":"prod_get_property_by_code","parameters":[{"name":"property_code","in":"path","required":true,"schema":{"type":"string","title":"Property Code"}},{"name":"namespace","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"}},{"name":"dependencies_on_edit","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dependencies On Edit"}},{"name":"member_database","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-cities":{"get":{"tags":["Property"],"summary":"Property Cities","description":"Get cities used in properties","operationId":"prod_get_property_cities","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/properties/generate/description":{"post":{"tags":["Property"],"summary":"Create A Property Descriptions","description":"Generate message by ChatGPT","operationId":"Create_a_property_descriptions_v1_properties_generate_description_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyDescriptionSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyDescriptionSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-buildings/search":{"get":{"tags":["Property"],"summary":"Mirror Details","description":"Search Building","operationId":"prod_get_property_building_search","parameters":[{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"building_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BuildingBySearchResponse"},{"$ref":"#/components/schemas/BuildingByNameResponse"}],"title":"Response Prod Get Property Building Search"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/properties/{property_id}/photos":{"post":{"tags":["Property Photo"],"summary":"Add A Photo In Property","description":"Create photo","operationId":"prod_create_property_photo","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_prod_create_property_photo"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseInsertPhoto"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/properties/{property_id}/photos/{photo_id}":{"put":{"tags":["Property Photo"],"summary":"Update A Photo In Property","description":"Update photo","operationId":"Update_a_photo_in_property_v1_properties__property_id__photos__photo_id__put","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}},{"name":"photo_id","in":"path","required":true,"schema":{"type":"string","title":"Photo Id"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_Update_a_photo_in_property_v1_properties__property_id__photos__photo_id__put"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdatePhoto"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Photo"],"summary":"Delete A Photo In Property","description":"Delete photo","operationId":"Delete_a_photo_in_property_v1_properties__property_id__photos__photo_id__delete","parameters":[{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}},{"name":"photo_id","in":"path","required":true,"schema":{"type":"string","title":"Photo Id"}},{"name":"media_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"","title":"Media Type"}}],"responses":{"204":{"description":"Property Photo was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-types":{"get":{"tags":["Property Types"],"summary":"Retrieve A List Of Property Types","operationId":"prod_get_property_types_list","parameters":[{"name":"only_actives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Only Actives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyTypesSchema"},"title":"Response Prod Get Property Types List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Types"],"summary":"Create A Property Type","operationId":"prod_create_property_type","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyTypesCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyTypesSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-types/{property_type_id}":{"get":{"tags":["Property Types"],"summary":"Retrieve A Property Type","operationId":"prod_get_property_type_by_id","parameters":[{"name":"property_type_id","in":"path","required":true,"schema":{"type":"string","title":"Property Type Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyTypesSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Types"],"summary":"Update A Property Type","operationId":"Update_a_property_type_v1_property_types__property_type_id__post","parameters":[{"name":"property_type_id","in":"path","required":true,"schema":{"type":"string","title":"Property Type Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyTypesUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyTypesSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Types"],"summary":"Delete A Property Type","operationId":"Delete_a_property_type_v1_property_types__property_type_id__delete","parameters":[{"name":"property_type_id","in":"path","required":true,"schema":{"type":"string","title":"Property Type Id"}}],"responses":{"204":{"description":"Property type was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-features":{"get":{"tags":["Property Features"],"summary":"Retrieve A List Of Property Feature","operationId":"prod_get_property_features_list","parameters":[{"name":"only_actives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only Actives"}},{"name":"property_db_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Db Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyFeaturesSchemas"},"title":"Response Prod Get Property Features List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Features"],"summary":"Create A Property Feature","operationId":"prod_create_property_feature","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFeaturesCreateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyFeatures"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-feature/{feature_id}":{"get":{"tags":["Property Features"],"summary":"Retrieve A Property Feature","operationId":"prod_get_property_feature_by_id","parameters":[{"name":"feature_id","in":"path","required":true,"schema":{"type":"string","title":"Feature Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFeaturesSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Features"],"summary":"Update A Property Feature","operationId":"Update_a_property_feature_v1_property_feature__feature_id__post","parameters":[{"name":"feature_id","in":"path","required":true,"schema":{"type":"string","title":"Feature Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFeaturesUpdateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyFeatures"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Features"],"summary":"Delete A Property Feature","operationId":"Delete_a_property_feature_v1_property_feature__feature_id__delete","parameters":[{"name":"feature_id","in":"path","required":true,"schema":{"type":"string","title":"Feature Id"}}],"responses":{"204":{"description":"Property Feature was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-fields":{"get":{"tags":["Fields Property"],"summary":"Retrieve A List Of Property Fields","operationId":"prod_get_property_fields_list","parameters":[{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyFieldsSchemas"},"title":"Response Prod Get Property Fields List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Property"],"summary":"Create A Property Field","operationId":"prod_create_property_field","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFieldsCreateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-field/{field_id}":{"get":{"tags":["Fields Property"],"summary":"Retrieve A Property Field","operationId":"prod_get_property_field_by_id","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Property"],"summary":"Update A Property Field","operationId":"Update_a_property_field_v1_property_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyFieldsUpdateSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePropertyField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Fields Property"],"summary":"Delete A Property Field","operationId":"Delete_a_property_field_v1_property_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Property field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-reserves":{"get":{"tags":["Property Reserves"],"summary":"Retrieve A List Of Property Reserves","operationId":"prod_get_property_reserves_list","parameters":[{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"person","organization","undefined"]},{"type":"null"}],"title":"Contact Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyReserveSchema"},"title":"Response Prod Get Property Reserves List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Reserves"],"summary":"Create A Property Reserve","operationId":"prod_create_property_reserve","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyReservePostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyReserveReponsePostSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-reserve/{reserve_id}":{"get":{"tags":["Property Reserves"],"summary":"Retrieve A Property Reserve","operationId":"prod_get_property_reserve_by_id","parameters":[{"name":"reserve_id","in":"path","required":true,"schema":{"type":"string","title":"Reserve Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyReserveSchema"},"title":"Response Prod Get Property Reserve By Id"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Reserves"],"summary":"Update A Property Reserve","operationId":"Update_a_property_reserve_v1_property_reserve__reserve_id__post","parameters":[{"name":"reserve_id","in":"path","required":true,"schema":{"type":"string","title":"Reserve Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyReserveUpdatePostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyReserveReponsePostSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Reserves"],"summary":"Delete A Property Reserve","operationId":"Delete_a_property_reserve_v1_property_reserve__reserve_id__delete","parameters":[{"name":"reserve_id","in":"path","required":true,"schema":{"type":"string","title":"Reserve Id"}}],"responses":{"204":{"description":"Property reserve was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/organization-fields":{"get":{"tags":["Fields Organization"],"summary":"Retrieve A List Of Organization Fields","operationId":"prod_get_organization_fields_list","parameters":[{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationFieldsSchemas"},"title":"Response Prod Get Organization Fields List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Organization"],"summary":"Create A Organization Field","operationId":"prod_create_organization_field","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOrganizationField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/organization-field/{field_id}":{"get":{"tags":["Fields Organization"],"summary":"Retrieve A Organization Field","operationId":"prod_get_organization_field_by_id","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Fields Organization"],"summary":"Update A Organization Field","operationId":"Update_a_organization_field_v1_organization_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationFieldSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOrganizationField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Fields Organization"],"summary":"Delete A Organization Field","operationId":"Delete_a_organization_field_v1_organization_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Organization field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/organizations":{"post":{"tags":["Contacts and Leads"],"summary":"Create A Organization","description":"Save new Organization","operationId":"prod_create_organization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsRouterSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateOrganization"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/organization/{organization_id}":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A Organization By Id","operationId":"Retrieve_a_organization_by_id_v1_organization__organization_id__get","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","title":"Organization Id"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contacts and Leads"],"summary":"Update A Organization","description":"Update organization","operationId":"Update_a_organization_v1_organization__organization_id__post","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","title":"Organization Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contacts and Leads"],"summary":"Delete A Organization","description":"Delete organization","operationId":"Delete_a_organization_v1_organization__organization_id__delete","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","title":"Organization Id"}}],"responses":{"204":{"description":"Organization was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/organization/code/{organization_code}":{"get":{"tags":["Contacts and Leads"],"summary":"Retrieve A Organization By Code","operationId":"prod_get_organization_by_code","parameters":[{"name":"organization_code","in":"path","required":true,"schema":{"type":"string","title":"Organization Code"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deals-rotations":{"get":{"tags":["Deals Rotations"],"summary":"Retrieve A List Of Deals Rotations","description":"Class for Rotation list","operationId":"Retrieve_a_list_of_deals_rotations_v1_deals_rotations_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"rotation","redistribution","repique","all",""]},{"type":"null"}],"title":"Type"}},{"name":"active","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"","true","false"]},{"type":"null"}],"title":"Active"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealRotations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deals Rotations"],"summary":"Create A Deal Rotation","description":"Class for create Rotation","operationId":"Create_a_deal_rotation_v1_deals_rotations_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealRotationRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealRotationCreateUpdate"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/deal-rotation/{db_id}":{"get":{"tags":["Deals Rotations"],"summary":"Retrieve A Deal Rotation","description":"Get rotation","operationId":"Retrieve_a_deal_rotation_v1_deal_rotation__db_id__get","parameters":[{"name":"db_id","in":"path","required":true,"schema":{"type":"string","title":"Db Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealRotationFieldSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deals Rotations"],"summary":"Update A Deal Rotation","description":"Update rotation","operationId":"Update_a_deal_rotation_v1_deal_rotation__db_id__post","parameters":[{"name":"db_id","in":"path","required":true,"schema":{"type":"string","title":"Db Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealRotationUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDealRotationCreateUpdate"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Deals Rotations"],"summary":"Delete A Deal Rotation","description":"Delete rotation","operationId":"Delete_a_deal_rotation_v1_deal_rotation__db_id__delete","parameters":[{"name":"db_id","in":"path","required":true,"schema":{"type":"string","title":"Db Id"}}],"responses":{"204":{"description":"Deal rotation was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/integration/lead":{"post":{"tags":["Contacts and Leads"],"summary":"Lead Integration (simple!)","description":"Simple method to create a Lead/Contact. Send a Lead/Contact to the API, in a simple way, without worrying about validations, such as if the Lead/Contact exists, the API itself will identify and just update the registration. Another advantage is notifying the user, triggering rotation, creating the deal, etc.","operationId":"Create_Lead_Integration_v1_integration_lead_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadIntegrationSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseLeadIntegration"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/reports/site-analytics":{"get":{"tags":["Reports Sites"],"summary":"Get Site Statistics","operationId":"get_site_statistics_reports","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteStatisticResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/webhooks":{"get":{"tags":["Webhook"],"summary":"Retrieve A List Of Webhooks","operationId":"Retrieve_a_list_of_webhooks_v1_webhooks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseGetSchema"},"type":"array","title":"Response Retrieve A List Of Webhooks V1 Webhooks Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Webhook"],"summary":"Create A Webhooks","operationId":"Create_a_webhooks_v1_webhooks_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__schemas__webhook__ResponsePostSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/webhook/{webhook_id}":{"get":{"tags":["Webhook"],"summary":"Retrieve A Webhook","operationId":"Retrieve_a_webhook_v1_webhook__webhook_id__get","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Webhook"],"summary":"Update A Webhook","operationId":"Update_a_webhook_v1_webhook__webhook_id__post","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/routers__schemas__webhook__ResponsePostSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Webhook"],"summary":"Delete A Webhook","operationId":"Delete_a_webhook_v1_webhook__webhook_id__delete","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"204":{"description":"Webhook was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/user-teams":{"get":{"tags":["Teams"],"summary":"Retrieve A List Of Teams","operationId":"Retrieve_a_list_of_Teams_v1_user_teams_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseTeams"},"type":"array","title":"Response Retrieve A List Of Teams V1 User Teams Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Teams"],"summary":"Create A Team","operationId":"Create_a_Team_v1_user_teams_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/user-team/{team_id}":{"post":{"tags":["Teams"],"summary":"Update A Team","operationId":"Update_a_Team_v1_user_team__team_id__post","parameters":[{"name":"team_id","in":"path","required":true,"schema":{"type":"string","title":"Team Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTeamSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"get":{"tags":["Teams"],"summary":"Retrieve A Team","operationId":"Retrieve_a_Team_v1_user_team__team_id__get","parameters":[{"name":"team_id","in":"path","required":true,"schema":{"type":"string","title":"Team Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseTeams"},"title":"Response Retrieve A Team V1 User Team Team Id Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Teams"],"summary":"Delete A Team","operationId":"Delete_a_Team_v1_user_team__team_id__delete","parameters":[{"name":"team_id","in":"path","required":true,"schema":{"type":"string","title":"Team Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/calendar":{"get":{"tags":["Calendar"],"summary":"Retrieve A List Of Calendar","operationId":"prod_get_calendar_list","parameters":[{"name":"cursor_fw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Fw"}},{"name":"cursor_rw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Rw"}},{"name":"item_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["task","visit","whatsapp","call",null]},{"type":"null"}],"title":"Item Type"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Year"}},{"name":"initial_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date"}},{"name":"final_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date"}},{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":12,"minimum":1},{"type":"null"}],"title":"Month"}},{"name":"day","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Day"}},{"name":"week","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Week"}},{"name":"calendar_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["normal","vacation",null]},{"type":"null"}],"title":"Calendar Type"}},{"name":"schedule","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Schedule"}},{"name":"holiday_year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Holiday Year"}},{"name":"lease_status","in":"query","required":false,"schema":{"anyOf":[{"enum":["all_status","active","ended","canceled","suspended",null]},{"type":"null"}],"title":"Lease Status"}},{"name":"team_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Id"}},{"name":"search_all","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Search All"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetCalendarSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Calendar"],"summary":"Create A Calendar Item","operationId":"prod_create_calendar_item","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarPostSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostCalendarSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/calendar-item/{calendar_id}":{"get":{"tags":["Calendar"],"summary":"Retrieve A Calendar Item","operationId":"prod_get_calendar_item_by_id","parameters":[{"name":"calendar_id","in":"path","required":true,"schema":{"type":"string","title":"Calendar Id"}},{"name":"cursor_fw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Fw"}},{"name":"cursor_rw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Rw"}},{"name":"item_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["task","visit","whatsapp","call",null]},{"type":"null"}],"title":"Item Type"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Year"}},{"name":"initial_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date"}},{"name":"final_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date"}},{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":12,"minimum":1},{"type":"null"}],"title":"Month"}},{"name":"day","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Day"}},{"name":"week","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Week"}},{"name":"calendar_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["normal","vacation",null]},{"type":"null"}],"title":"Calendar Type"}},{"name":"schedule","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Schedule"}},{"name":"holiday_year","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Holiday Year"}},{"name":"lease_status","in":"query","required":false,"schema":{"anyOf":[{"enum":["all_status","active","ended","canceled","suspended",null]},{"type":"null"}],"title":"Lease Status"}},{"name":"team_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Id"}},{"name":"search_all","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Search All"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Calendar"],"summary":"Update A Calendar Item","operationId":"Update_a_calendar_item_v1_calendar_item__calendar_id__post","parameters":[{"name":"calendar_id","in":"path","required":true,"schema":{"type":"string","title":"Calendar Id"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"enum":["create","update","delete","next","all",null]},{"type":"null"}],"title":"Action"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostCalendarSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Calendar"],"summary":"Delete A Calendar Item","operationId":"Delete_a_calendar_item_v1_calendar_item__calendar_id__delete","parameters":[{"name":"calendar_id","in":"path","required":true,"schema":{"type":"string","title":"Calendar Id"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"enum":["create","update","delete","next","all",null]},{"type":"null"}],"title":"Action"}}],"responses":{"204":{"description":"Calendar item was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/user-billing":{"get":{"tags":["User Billing"],"summary":"Retrieve A List Of User Billing","operationId":"Retrieve_a_list_of_User_Billing_v1_user_billing_get","parameters":[{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Pipeline Group Id"}},{"name":"all_users","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Users"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseUserBillingSchema"},"title":"Response Retrieve A List Of User Billing V1 User Billing Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-adverts/{advert_key}":{"get":{"tags":["Property Adverts"],"summary":"Get A Property Advert","description":"Get adverts active","operationId":"Get_a_property_advert_v1_property_adverts__advert_key__get","parameters":[{"name":"advert_key","in":"path","required":true,"schema":{"type":"string","title":"Advert Key"}},{"name":"show_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Properties"}},{"name":"show_all_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show All Properties"}},{"name":"networks","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Networks"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Adverts"],"summary":"Update A Property Adverts","description":"Create and update a advert","operationId":"Update_a_property_adverts_v1_property_adverts__advert_key__post","parameters":[{"name":"advert_key","in":"path","required":true,"schema":{"type":"string","title":"Advert Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsRouterSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Adverts"],"summary":"Delete A Advert","description":"Delete a advert","operationId":"Delete_a_advert_v1_property_adverts__advert_key__delete","parameters":[{"name":"advert_key","in":"path","required":true,"schema":{"type":"string","title":"Advert Key"}}],"responses":{"204":{"description":"Property Adverts was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/property-adverts":{"get":{"tags":["Property Adverts"],"summary":"Retrieve A List Property Adverts","operationId":"Retrieve_a_list_property_adverts_v1_property_adverts_get","parameters":[{"name":"show_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Properties"}},{"name":"show_all_properties","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show All Properties"}},{"name":"networks","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Networks"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Adverts"],"summary":"Create A Property Adverts","description":"Create and update a advert","operationId":"Create_a_property_adverts_v1_property_adverts_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyAdvertsRouterSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/reports/user-performance/":{"get":{"tags":["User Performance"],"summary":"Retrieve User Performance Report","operationId":"Retrieve_User_Performance_report_v1_reports_user_performance__get","parameters":[{"name":"user_id","in":"query","required":false,"schema":{"type":"string","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/reports/user-performance/{user_id}":{"get":{"tags":["User Performance"],"summary":"Retrieve User Performance Report","operationId":"Retrieve_User_Performance_report_v1_reports_user_performance__user_id__get","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contact/{contact_id}/bank-data":{"get":{"tags":["Contact Bank"],"summary":"Retrieve A Contact Bank Data","operationId":"prod_get_contact_bank_data","parameters":[{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","title":"Contact Id"}},{"name":"contact_type","in":"query","required":true,"schema":{"type":"string","title":"Contact Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContactBankData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/{property_code}/vacation-calendar":{"get":{"tags":["Vacation Calendar"],"summary":"Retrieve A Property Vacation Calendar","operationId":"prod_get_vacation_calendar","parameters":[{"name":"property_code","in":"path","required":true,"schema":{"type":"string","title":"Property Code"}},{"name":"start_at","in":"query","required":true,"schema":{"type":"string","title":"Start At"}},{"name":"end_at","in":"query","required":true,"schema":{"type":"string","title":"End At"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VacationCalendarSchema"},"title":"Response Prod Get Vacation Calendar"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/vacation-calendar":{"put":{"tags":["Vacation Calendar"],"summary":"Update A Vacation Calendar Values","operationId":"Update_a_vacation_calendar_values_v1_vacation_calendar_put","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VacationCalendarSchema"},"type":"array","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VacationCalendarSchema"},"type":"array","title":"Response Update A Vacation Calendar Values V1 Vacation Calendar Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/chat-conversations":{"get":{"tags":["Chat conversations"],"summary":"Retrieve A List Of Chats","operationId":"Retrieve_a_list_of_chats_v1_chat_conversations_get","parameters":[{"name":"contact_type","in":"query","required":true,"schema":{"type":"string","title":"Contact Type"}},{"name":"contact_id","in":"query","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseChatConversations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Chat conversations"],"summary":"Create Chat Conversation","operationId":"Create_chat_conversation_v1_chat_conversations_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatConversationsParameters"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Chat Conversation V1 Chat Conversations Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/send/{send_type}":{"post":{"tags":["Send Messaging"],"summary":"Send Messaging","description":"Send messaging by type","operationId":"Send_messaging_v1_send__send_type__post","parameters":[{"name":"send_type","in":"path","required":true,"schema":{"const":"property-owner-review","type":"string","title":"Send Type"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessagingSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/calendar-types":{"get":{"tags":["Calendar Types"],"summary":"Get Calendar Types List","description":"Get calendar types list","operationId":"prod_get_calendar_types_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResponseCalendarTypeGetSchema"},"type":"array","title":"Response Prod Get Calendar Types List"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Calendar Types"],"summary":"Create Calendar Type","description":"Create calendar type","operationId":"prod_create_calendar_type","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarTypeCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCalendarTypesCreateUpdateSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/calendar-types/{calendar_type_id}":{"post":{"tags":["Calendar Types"],"summary":"Update Calendar Type","description":"Update calendar type","operationId":"Update_calendar_type_v1_calendar_types__calendar_type_id__post","parameters":[{"name":"calendar_type_id","in":"path","required":true,"schema":{"type":"string","title":"Calendar Type Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarTypeUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCalendarTypesCreateUpdateSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Calendar Types"],"summary":"Delete Calendar Type","description":"Delete calendar type","operationId":"Delete_calendar_type_v1_calendar_types__calendar_type_id__delete","parameters":[{"name":"calendar_type_id","in":"path","required":true,"schema":{"type":"string","title":"Calendar Type Id"}}],"responses":{"204":{"description":"Calendar type was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/accounts":{"get":{"tags":["WhatsApp"],"summary":"Retrieve A List Of Whatsapp Accounts","description":"Get WhatsApp accounts enabled for third-party access.","operationId":"Retrieve_a_list_of_WhatsApp_accounts_v1_whatsapp_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/account/{account_id}":{"get":{"tags":["WhatsApp"],"summary":"Get Account","description":"Get WhatsApp account","operationId":"Get_account_v1_whatsapp_account__account_id__get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/send-message":{"post":{"tags":["WhatsApp"],"summary":"Send Message","description":"Send new message by WhatsApp","operationId":"Send_message_v1_whatsapp_business_send_message_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppBusinessSendMessageSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/templates":{"post":{"tags":["WhatsApp"],"summary":"Create Template","description":"Send new message by WhatsApp","operationId":"Create_template_v1_whatsapp_business_templates_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppBusinessCreateTemplateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"get":{"tags":["WhatsApp"],"summary":"Retrieve A List Of Templates","description":"Get WhatsApp business templates","operationId":"Retrieve_a_list_of_templates_v1_whatsapp_business_templates_get","parameters":[{"name":"phone_id","in":"query","required":true,"schema":{"type":"string","title":"Phone Id"}},{"name":"account_business_id","in":"query","required":true,"schema":{"type":"string","title":"Account Business Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/{account_id}/templates":{"delete":{"tags":["WhatsApp"],"summary":"Delete Template","description":"Delete template by account and template id.","operationId":"Delete_template_v1_whatsapp_business__account_id__templates_delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}},{"name":"template_id","in":"query","required":true,"schema":{"type":"string","title":"Template Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/send-audio":{"post":{"tags":["WhatsApp"],"summary":"Send Audio","description":"Send new audio by WhatsApp","operationId":"Send_audio_v1_whatsapp_business_send_audio_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Send_audio_v1_whatsapp_business_send_audio_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/send-media":{"post":{"tags":["WhatsApp"],"summary":"Send Media","description":"Send new media by WhatsApp","operationId":"Send_media_v1_whatsapp_business_send_media_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Send_media_v1_whatsapp_business_send_media_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/send-reaction":{"post":{"tags":["WhatsApp"],"summary":"Send Reaction","description":"Send reaction message by WhatsApp","operationId":"Send_reaction_v1_whatsapp_business_send_reaction_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppBusinessSendReactionSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/note":{"post":{"tags":["WhatsApp"],"summary":"Send Note","description":"Send new message by WhatsApp","operationId":"Send_note_v1_whatsapp_note_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppSendNoteSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/note/{message_id}":{"post":{"tags":["WhatsApp"],"summary":"Edit Note","operationId":"Edit_note_v1_whatsapp_note__message_id__post","parameters":[{"name":"message_id","in":"path","required":true,"schema":{"type":"string","title":"Message Id"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppSendNoteSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/send-template":{"post":{"tags":["WhatsApp"],"summary":"Send Message With Template","description":"Send a message via the official WhatsApp, using a template approved by Meta","operationId":"Send_Message_With_Template_v1_whatsapp_business_send_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppBusinessSendTemplateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp-business/mark-messages-read":{"post":{"tags":["WhatsApp"],"summary":"Mark Messages As Read","description":"Mark received business messages as read.","operationId":"Mark_messages_as_read_v1_whatsapp_business_mark_messages_read_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppBusinessMarkMessagesReadSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/{account_id}/chats":{"get":{"tags":["WhatsApp"],"summary":"Retrieve A List Of Chats","description":"Get WhatsApp chats","operationId":"Retrieve_a_list_of_chats_v1_whatsapp__account_id__chats_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","unread","groups",null]},{"type":"null"}],"title":"Smart List"}},{"name":"manager_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Id"}},{"name":"team_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team Id"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"}},{"name":"label","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/whatsapp/{account_id}/{chat_id}/messages":{"get":{"tags":["WhatsApp"],"summary":"Retrieve A List Of Messages","description":"Get WhatsApp chat messages","operationId":"Retrieve_a_list_of_messages_v1_whatsapp__account_id___chat_id__messages_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}},{"name":"chat_id","in":"path","required":true,"schema":{"type":"string","title":"Chat Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/utils/{utils_type}":{"get":{"tags":["Utils"],"summary":"Retrieve Utils By Type","operationId":"get_utils_by_type","parameters":[{"name":"utils_type","in":"path","required":true,"schema":{"enum":["get-next-business-day","get-compound-interest","get-checking-account-balance","create-checking-account-item"],"type":"string","title":"Utils Type"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"}},{"name":"invoice_value","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Value"}},{"name":"credit_card_percentage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Card Percentage"}},{"name":"credit_card_installment_percentage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"default":0,"title":"Credit Card Installment Percentage"}},{"name":"cash_payment_rate","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"default":0,"title":"Cash Payment Rate"}},{"name":"payment_installment_rate","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"default":0,"title":"Payment Installment Rate"}},{"name":"installment_interest_start","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":1,"title":"Installment Interest Start"}},{"name":"pass_on_fixed_rate","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pass On Fixed Rate"}},{"name":"pass_on_installments_fee","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pass On Installments Fee"}},{"name":"account_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"real_estate","title":"Account Type"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"product","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product"}},{"name":"database","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"}},{"name":"product_transaction","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Transaction"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetUtils"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/banks":{"get":{"tags":["Banks","ERP"],"summary":"Retrieve A List Of Banks","description":"Displays bank's list","operationId":"prod_get_banks_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetBanks"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Banks","ERP"],"summary":"Create A New Bank","description":"Save new bank","operationId":"prod_post_banks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanksFieldsSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostBanks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/bank/{bank_id}":{"get":{"tags":["Banks","ERP"],"summary":"Retrieve A Bank By Bank Id","description":"Show bank","operationId":"prod_get_banks_bank_id","parameters":[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetBanksBankId"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/commission/onlending":{"get":{"tags":["Financial commissions"],"summary":"Get Commission Onlending Receipt","operationId":"Get_commission_onlending_receipt_v1_commission_onlending_get","parameters":[{"name":"commission_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"gross_receipt","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"null"}],"title":"Gross Receipt"}},{"name":"commission_statement","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Commission Statement"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextTemplatesSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contracts":{"get":{"tags":["Contracts","ERP"],"summary":"Retrieve A List Of Contracts","description":"Get contracts list","operationId":"prod_get_contracts_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["bimonthly_signature_actives","quarterly_signature_actives","four_monthly_signature_actives","semi_annual_signature_actives","annual_signature_actives","biannual_signature_actives","triannual_signature_actives","quadrennial_signature_actives","all","actives","daily_signature_actives","monthly_signature_actives","sales_actives","actives_with_time_indeterminate","actives_with_invoices_late","checklist_pending_items","with_annual_readjustment","without_annual_readjustment","contracts_canceled","contracts_suspended","contracts_traveling","contracts_ended","contracts_in_review","contracts_to_finish","insurance_and_additional_to_expire","insurance_and_additional_late",null]},{"type":"null"}],"title":"Smart List"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetContracts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contracts","ERP"],"summary":"Create A New Contract","description":"Create contract","operationId":"prod_create_contracts","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractsFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostContracts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contract/code/{contract_code}":{"get":{"tags":["Contracts","ERP"],"summary":"Retrieve A Contract By Contract Code","description":"Get contract","operationId":"prod_get_contract_by_code","parameters":[{"name":"contract_code","in":"path","required":true,"schema":{"type":"string","title":"Contract Code"}},{"name":"contract_id","in":"query","required":false,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetContract"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contracts"],"summary":"Update A Contract By Contract Code","description":"Update contract","operationId":"Update_a_contract_by_contract_code_v1_contract_code__contract_code__post","parameters":[{"name":"contract_code","in":"path","required":true,"schema":{"type":"string","title":"Contract Code"}},{"name":"contract_id","in":"query","required":false,"schema":{"type":"string","title":"Contract Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractsFieldsUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePutContract"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contract/{contract_id}":{"get":{"tags":["Contracts","ERP"],"summary":"Retrieve A Contract By Contract Id","description":"Get contract","operationId":"prod_get_contract_by_id","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}},{"name":"contract_code","in":"query","required":false,"schema":{"type":"string","title":"Contract Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetContract"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contracts"],"summary":"Update A Contract By Contract Id","description":"Update contract","operationId":"Update_a_contract_by_contract_id_v1_contract__contract_id__post","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}},{"name":"contract_code","in":"query","required":false,"schema":{"type":"string","title":"Contract Code"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractsFieldsUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePutContract"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contracts"],"summary":"Delete Contract By Contract Id","description":"Delete contract","operationId":"Delete_contract_by_contract_id_v1_contract__contract_id__delete","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contract-fields":{"get":{"tags":["Contract Fields","ERP"],"summary":"Retrieve A List Of Contract Fields Personalized","operationId":"prod_get_contract_fields","parameters":[{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractFieldsSchemas"},"title":"Response Prod Get Contract Fields"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contract Fields","ERP"],"summary":"Create A Contract Field Personalized","operationId":"prod_create_contract_field","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContractField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/contract-field/{field_id}":{"get":{"tags":["Contract Fields","ERP"],"summary":"Retrieve A Contract Field Personalized By Id","operationId":"prod_get_contract_field","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contract Fields"],"summary":"Update A Contract Field","operationId":"Update_a_contract_field_v1_contract_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseContractField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contract Fields"],"summary":"Delete A Contract Field","operationId":"Delete_a_contract_field_v1_contract_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Contract field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/invoices":{"get":{"tags":["Invoices","ERP"],"summary":"Get List Invoices","operationId":"prod_get_list_invoices","parameters":[{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Account Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"lease_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Lease Id"}},{"name":"contract_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contract Id"}},{"name":"contract_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Type"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":1,"title":"Page"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"asc","title":"Sort By"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"payment_method","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","bank_slip","credit_card","pix","cash","transference","all_payments","bank_check","deposit"],"type":"string"},{"type":"null"}],"title":"Payment Method"}},{"name":"payments_methods_available","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","bank_slip","credit_card","pix","cash","transference","all_payments","bank_check","deposit",null]},{"type":"null"}],"title":"Payments Methods Available"}},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"enum":["paid_at","due_date","created_at","updated_at",null]},{"type":"null"}],"title":"Period"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetListInvoices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Invoices","ERP"],"summary":"Create Invoice","operationId":"prod_create_invoice","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/invoice/{invoice_id}":{"get":{"tags":["Invoices","ERP"],"summary":"Get Invoice By Invoice Id","operationId":"prod_get_invoice","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"verify_and_att_invoice","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"Verify And Att Invoice"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Invoices"],"summary":"Invoice Update","operationId":"invoice_update_v1_invoice__invoice_id__post","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/categories":{"get":{"tags":["Financial categories","ERP"],"summary":"Retrieve A List Of Financial Categories","operationId":"prod_get_financial_categories","parameters":[{"name":"category_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by category type: expense or revenue","title":"Category Type"},"description":"Filter by category type: expense or revenue"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FinancialCategorySchema"},"title":"Response Prod Get Financial Categories"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial categories","ERP"],"summary":"Create A Financial Category","operationId":"prod_create_financial_category","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialCategorySchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFinancialCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/category/{category_id}":{"get":{"tags":["Financial categories","ERP"],"summary":"Retrieve A Financial Category","operationId":"prod_get_financial_category_by_category_id","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialCategorySchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial categories"],"summary":"Update A Financial Category","operationId":"Update_a_financial_category_v1_financial_category__category_id__post","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}},{"name":"action","in":"query","required":false,"schema":{"type":"string","title":"Action"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialCategoryUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFinancialCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Financial categories"],"summary":"Delete A Financial Category","operationId":"Delete_a_financial_category_v1_financial_category__category_id__delete","parameters":[{"name":"category_id","in":"path","required":true,"schema":{"type":"string","title":"Category Id"}}],"responses":{"204":{"description":"Financial category was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/agreement":{"post":{"tags":["Lease Agreement"],"summary":"Lease-Agreement","operationId":"lease_agreement_v1_lease_agreement_post","parameters":[{"name":"namespace","in":"query","required":true,"schema":{"type":"string","title":"Namespace"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_lease_agreement_v1_lease_agreement_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"204":{"description":"no content"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/item-description":{"get":{"tags":["lease-item-description","ERP"],"summary":"Get Lease Item Description Default List","operationId":"prod_get_lease_item_description","parameters":[{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"}},{"name":"group","in":"query","required":false,"schema":{"anyOf":[{"enum":["Invoice","Landlord","Lease"],"type":"string"},{"type":"null"}],"title":"Group"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Prod Get Lease Item Description"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/checklist":{"get":{"tags":["lease-checklist","ERP"],"summary":"Get Lease Checklist Default","operationId":"prod_get_lease_checklist_default","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LeaseChecklistFieldsSchema"},"type":"array","title":"Response Prod Get Lease Checklist Default"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/landlord/accounts":{"get":{"tags":["Financial landlord accounts","ERP"],"summary":"Retrieve A List Of Financial Landlord Accounts","description":"Get financial landlord accounts","operationId":"prod_get_financial_landlord_accounts_list","parameters":[{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["person","organization"],"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"contact_finances","in":"query","required":false,"schema":{"enum":["undefined","true",null],"title":"Contact Finances"}},{"name":"balance_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Balance Type"}},{"name":"credit_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Balance Page"}},{"name":"debit_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debit Balance Page"}},{"name":"without_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Without Balance Page"}},{"name":"debit_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debit Balance"}},{"name":"credit_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Balance"}},{"name":"without_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Without Balance"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialLandlordsAccountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/landlord/account/{landlord_account_id}":{"get":{"tags":["Financial landlord accounts","ERP"],"summary":"Retrieve A Financial Landlord Account","description":"Get financial landlord account","operationId":"prod_get_financial_landlord_account","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["person","organization"],"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"contact_finances","in":"query","required":false,"schema":{"enum":["undefined","true",null],"title":"Contact Finances"}},{"name":"balance_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Balance Type"}},{"name":"credit_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Balance Page"}},{"name":"debit_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debit Balance Page"}},{"name":"without_balance_page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Without Balance Page"}},{"name":"debit_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Debit Balance"}},{"name":"credit_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Balance"}},{"name":"without_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Without Balance"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialLandlordAccountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/accounts":{"get":{"tags":["Financial accounts","ERP"],"summary":"Retrieve A List Of Financial Accounts","description":"Get financial accounts list","operationId":"prod_get_financial_accounts","parameters":[{"name":"all_financial_accounts","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"All Financial Accounts"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial accounts","ERP"],"summary":"Create A Financial Accounts","description":"Create financial account","operationId":"prod_create_financial_account","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialAccountsFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/account/{account_id}":{"get":{"tags":["Financial accounts","ERP"],"summary":"Get Financial Accounts","description":"Get financial account","operationId":"prod_get_financial_account","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial accounts"],"summary":"Update Financial Accounts","description":"Update financial account","operationId":"Update_financial_accounts_v1_financial_account__account_id__post","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialAccountsFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Financial accounts"],"summary":"Delete Financial Account","description":"Delete financial account","operationId":"Delete_financial_account_v1_financial_account__account_id__delete","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/tags":{"get":{"tags":["Financial Tags","ERP"],"summary":"Financial-Tags","description":"Get a list of financial tags","operationId":"prod_get_financial_tags","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Prod Get Financial Tags"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/landlord/account/individual-onlending/{landlord_transaction_id}":{"get":{"tags":["Financial Landlord Account Onlending"],"summary":"Financial-Landlord-Onlending-By-Invoice","description":"Get financial landlord accounts","operationId":"financial_landlord_onlending_by_invoice_v1_financial_landlord_account_individual_onlending__landlord_transaction_id__get","parameters":[{"name":"landlord_transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Transaction Id"}},{"name":"preview_onlending","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Preview Onlending"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/transactions":{"get":{"tags":["Financial Transactions","ERP"],"summary":"Get List Financial-Transactions","description":"Get financial transaction list","operationId":"prod_get_financial_transactions","parameters":[{"name":"filter_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Type"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Account Id"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Page"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"tags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Tags"}},{"name":"conciliation_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conciliation Type"}},{"name":"repeat_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Type"}},{"name":"category","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Category"}},{"name":"subcategory","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Subcategory"}},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort By"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"from_contact","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"From Contact"}},{"name":"property_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionsResponseGet"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial Transactions","ERP"],"summary":"Create Financial Transaction","description":"Create a new financial transaction","operationId":"prod_create_financial_transaction","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionResponsePost"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/transaction/{transaction_id}":{"get":{"tags":["Financial Transactions","ERP"],"summary":"Get Financial Transaction","description":"Get financial transaction","operationId":"prod_get_financial_transaction","parameters":[{"name":"transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Transaction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionResponseGet"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial Transactions"],"summary":"Update Financial Transaction","description":"Update financial transaction","operationId":"Update_financial_transaction_v1_financial_transaction__transaction_id__post","parameters":[{"name":"transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Transaction Id"}},{"name":"update_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Update All"}},{"name":"update_bank_operation","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Update Bank Operation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTransactionResponsePost"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Financial Transactions"],"summary":"Delete Financial Transaction","description":"Delete financial transaction","operationId":"Delete_financial_transaction_v1_financial_transaction__transaction_id__delete","parameters":[{"name":"transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Transaction Id"}},{"name":"delete_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delete All"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/invoice/{invoice_id}/send-notification":{"post":{"tags":["Invoice send notification","ERP"],"summary":"Integration-Send-Notification","description":"Invoice send notification handler","operationId":"prod_invoice_send_notification","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"name":"notification_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["email","whatsapp"],"type":"string"},{"type":"null"}],"title":"Notification Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSendNotificationReponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/calculate-insurance":{"get":{"tags":["Lease Insurance"],"summary":"Calculate Insurance","description":"Get real estate details","operationId":"calculate_insurance_v1_lease_calculate_insurance_get","parameters":[{"name":"insurance_type","in":"query","required":true,"schema":{"enum":["fire_insurance","bail_insurance","credpago"],"type":"string","title":"Insurance Type"}},{"name":"user","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"}},{"name":"property_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type"}},{"name":"insured_value_for_fire","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Insured Value For Fire"}},{"name":"insurance_category","in":"query","required":false,"schema":{"anyOf":[{"enum":["business","residential"],"type":"string"},{"type":"null"}],"title":"Insurance Category"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"}},{"name":"tenant_document","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Document"}},{"name":"zipcode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"}},{"name":"person_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Person Type"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"company_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"}},{"name":"installments","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments"}},{"name":"assistance","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assistance"}},{"name":"lease_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Lease Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"cep","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cep"}},{"name":"lease_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lease Value"}},{"name":"iptu_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Iptu Value"}},{"name":"water_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Water Value"}},{"name":"light_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Light Value"}},{"name":"gas_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Gas Value"}},{"name":"start_contract","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Contract"}},{"name":"end_contract","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Contract"}},{"name":"condominium_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Condominium Value"}},{"name":"other_taxes","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Other Taxes"}},{"name":"safe_start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safe Start At"}},{"name":"safe_end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safe End At"}},{"name":"property_damage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Damage"}},{"name":"indoor_painting","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Indoor Painting"}},{"name":"external_painting","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Painting"}},{"name":"contract_fine","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Fine"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"tenant_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Name"}},{"name":"logradouro","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logradouro"}},{"name":"numero","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Numero"}},{"name":"bairro","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bairro"}},{"name":"cidade","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cidade"}},{"name":"estado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Estado"}},{"name":"complemento","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Complemento"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseInsurance"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/hire-insurance":{"post":{"tags":["Lease Insurance"],"summary":"Hire Insurance","operationId":"hire_insurance_v1_lease_hire_insurance_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HireInsuranceRouterSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseHireInsurance"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/cancel-insurance":{"post":{"tags":["Lease Insurance"],"summary":"Cancel Insurance","operationId":"cancel_insurance_v1_lease_cancel_insurance_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelInsuranceRouterSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCancelInsurance"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/no-cancellation-insurance":{"post":{"tags":["Lease Insurance"],"summary":"No Cancellation Of Insurance","operationId":"no_cancellation_of_insurance_v1_lease_no_cancellation_insurance_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoCancellationInsurance"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"204":{"description":"No Content","message":"ok"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/calculate":{"post":{"tags":["Lease Calculate","ERP"],"summary":"Lease-Calculate","operationId":"prod_lease_calculate","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseCalculateParamsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/leases":{"get":{"tags":["lease","ERP"],"summary":"Get Leases","operationId":"prod_get_leases","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"owner_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Id"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"search_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"}},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Smart List"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeaseResponseSchema"},"title":"Response Prod Get Leases"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["lease","ERP"],"summary":"Create A Lease","operationId":"prod_create_lease","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseResponsePost"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/{lease_id}":{"get":{"tags":["lease"],"summary":"Get Lease By Db Id","operationId":"Get_lease_by_db_id_v1_lease__lease_id__get","parameters":[{"name":"lease_id","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Id"}},{"name":"lease_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["lease"],"summary":"Update Lease","operationId":"Update_lease_v1_lease__lease_id__post","parameters":[{"name":"lease_id","in":"path","required":true,"schema":{"type":"string","title":"Lease Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["lease"],"summary":"Delete Lease","operationId":"Delete_lease_v1_lease__lease_id__delete","parameters":[{"name":"lease_id","in":"path","required":true,"schema":{"type":"string","title":"Lease Id"}}],"responses":{"204":{"description":"Lease deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease/code/{lease_code}":{"get":{"tags":["lease","lease-code","ERP"],"summary":"Get Lease By Code","operationId":"prod_get_lease_by_code","parameters":[{"name":"lease_code","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code"}},{"name":"lease_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease-fields":{"get":{"tags":["Lease Fields","ERP"],"summary":"Retrieve A List Of Lease Fields","operationId":"prod_get_lease_fields","parameters":[{"name":"with_inactives","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Inactives"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseLeaseField"},"title":"Response Prod Get Lease Fields"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Lease Fields","ERP"],"summary":"Create A Lease Field","operationId":"prod_create_lease_field","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseLeaseField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/lease-field/{field_id}":{"get":{"tags":["Lease Fields","ERP"],"summary":"Retrieve A Lease Field","operationId":"prod_get_lease_field","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseFieldsSchemas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Lease Fields"],"summary":"Update A Lease Field","operationId":"Update_a_lease_field_v1_lease_field__field_id__post","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaseFieldsSchemas"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseLeaseField"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Lease Fields"],"summary":"Delete A Lease Field","operationId":"Delete_a_lease_field_v1_lease_field__field_id__delete","parameters":[{"name":"field_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"}}],"responses":{"204":{"description":"Contract field was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/notas-fiscais":{"get":{"tags":["Nota Fiscal","ERP"],"summary":"Get Notas Fiscal List","operationId":"prod_get_notas_fiscais","parameters":[{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"sorted_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"desc","title":"Sorted By"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"date","title":"Order By"}},{"name":"from_contact","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"From Contact"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetNotasFiscal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Nota Fiscal","ERP"],"summary":"Create A New Nota Fiscal","operationId":"prod_create_nota_fiscal","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostNotaFiscal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/nota-fiscal/{nota_fiscal_key}":{"get":{"tags":["Nota Fiscal","ERP"],"summary":"Get Nota Fiscal","operationId":"prod_get_nota_fiscal","parameters":[{"name":"nota_fiscal_key","in":"path","required":true,"schema":{"type":"string","title":"Nota Fiscal Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetNotaFiscal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Nota Fiscal"],"summary":"Update Nota Fiscal","operationId":"Update_Nota_Fiscal_v1_nota_fiscal__nota_fiscal_key__post","parameters":[{"name":"nota_fiscal_key","in":"path","required":true,"schema":{"type":"string","title":"Nota Fiscal Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotaFiscalSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Nota Fiscal"],"summary":"Delete Nota Fiscal","operationId":"Delete_Nota_Fiscal_v1_nota_fiscal__nota_fiscal_key__delete","parameters":[{"name":"nota_fiscal_key","in":"path","required":true,"schema":{"type":"string","title":"Nota Fiscal Key"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/landlord/account/{landlord_account_id}/transactions":{"get":{"tags":["Financial landlord account transactions","ERP"],"summary":"Get Transactions Financial Landlord Account","description":"Get a list of financial landlord transactions","operationId":"prod_get_financial_landlord_account_transactions","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Page"}},{"name":"property_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},{"name":"show_previous_balance","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"default":true,"title":"Show Previous Balance"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialLandlordAccountTransactionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial landlord account transactions","ERP"],"summary":"Create Financial Landlord Account Transaction","description":"Create a new financial landlord transaction","operationId":"prod_create_financial_landlord_account_transaction","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandlordTransactionsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/landlord/account/{landlord_account_id}/transaction/{landlord_transaction_id}":{"get":{"tags":["Financial landlord account transactions","ERP"],"summary":"Get Financial Landlord Account Transaction","description":"Get a landlord account transaction","operationId":"prod_get_financial_landlord_account_transaction","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}},{"name":"landlord_transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Transaction Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialLandlordAccountTransactionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Financial landlord account transactions"],"summary":"Update Landlord Transaction","description":"Update a landlord account transaction","operationId":"Update_landlord_transaction_v1_financial_landlord_account__landlord_account_id__transaction__landlord_transaction_id__post","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}},{"name":"landlord_transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Transaction Id"}},{"name":"update_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Update All"}},{"name":"confirmed_delete","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Confirmed Delete"}},{"name":"delete_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Delete All"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandlordTransactionsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Financial landlord account transactions"],"summary":"Delete Landlord Transaction","description":"Delete a financial landlord transaction","operationId":"Delete_landlord_transaction_v1_financial_landlord_account__landlord_account_id__transaction__landlord_transaction_id__delete","parameters":[{"name":"landlord_account_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Account Id"}},{"name":"landlord_transaction_id","in":"path","required":true,"schema":{"type":"string","title":"Landlord Transaction Id"}},{"name":"update_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Update All"}},{"name":"confirmed_delete","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Confirmed Delete"}},{"name":"delete_all","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Delete All"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/financial/transaction/{transaction_type}/{description}/match":{"get":{"tags":["Financial Transaction Match","ERP"],"summary":"Financial-Transaction-Match","description":"Get Financial Transactions Match By Description","operationId":"prod_get_financial_transaction_match","parameters":[{"name":"transaction_type","in":"path","required":true,"schema":{"type":"string","title":"Transaction Type"}},{"name":"description","in":"path","required":true,"schema":{"type":"string","title":"Description"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetFinancialTransactionMatch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/real-estate/posts/{post_id}/comments":{"get":{"tags":["Real Estate Posts Comment"],"summary":"Retrieve A Real Estate Posts Comment","operationId":"get_post_comments","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"search_term","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Term"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Real Estate Posts Comment"],"summary":"Create A Real Estate Post Comments","operationId":"create_post_comment_no_id","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"query","required":false,"schema":{"type":"string","title":"Comment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkGroupPostsCommentsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/real-estate/posts/{post_id}/comments/{comment_id}":{"post":{"tags":["Real Estate Posts Comment"],"summary":"Create A Real Estate Post Comments","operationId":"create_post_comment_with_id","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkGroupPostsCommentsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Real Estate Posts Comment"],"summary":"Delete A Real Estate Post","operationId":"delete_post_comment","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/real-estate/posts/{post_id}/comments/{comment_id}/replies":{"get":{"tags":["Real Estate Posts Comment"],"summary":"Retrieve A Real Estate Posts Comment Replies","operationId":"get_post_comment_replies","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Real Estate Posts Comment"],"summary":"Create A Real Estate Post Comment Replies","operationId":"create_post_comment_reply_no_id","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}},{"name":"reply_id","in":"query","required":false,"schema":{"type":"string","title":"Reply Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkGroupPostsCommentsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/real-estate/posts/{post_id}/comments/{comment_id}/replies/{reply_id}":{"post":{"tags":["Real Estate Posts Comment"],"summary":"Create A Real Estate Post Comment Replies","operationId":"create_post_comment_reply","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}},{"name":"reply_id","in":"path","required":true,"schema":{"type":"string","title":"Reply Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkGroupPostsCommentsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Real Estate Posts Comment"],"summary":"Delete A Real Estate Post Comment Replies","operationId":"delete_post_comment_reply","parameters":[{"name":"post_id","in":"path","required":true,"schema":{"type":"string","title":"Post Id"}},{"name":"comment_id","in":"path","required":true,"schema":{"type":"string","title":"Comment Id"}},{"name":"reply_id","in":"path","required":true,"schema":{"type":"string","title":"Reply Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/subscription/deployment-fees":{"get":{"tags":["Subscription"],"summary":"Subscription-Deployment-Fees","description":"Get subscription deployment fees","operationId":"subscription_deployment_fees_v1_subscription_deployment_fees_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/subscription/plans/{locale}":{"get":{"tags":["Subscription"],"summary":"Subscription-Plans-Locale","description":"Get subscription plans by locale","operationId":"subscription_plans_locale_v1_subscription_plans__locale__get","parameters":[{"name":"locale","in":"path","required":true,"schema":{"type":"string","title":"Locale"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/revision/{register_type}":{"get":{"tags":["Revisions"],"summary":"Retrieve A List Of Revisions (Backup)","operationId":"prod_get_revisions_backups_list","parameters":[{"name":"register_type","in":"path","required":true,"schema":{"type":"string","description":"Type of register to retrieve revisions, Literal[\n 'property', 'report', 'site_content', 'contact', 'lead', 'text_template', 'deal',\n 'calendar', 'lease', 'signature_and_sale', 'parameters', 'site_pages_configuration']","title":"Register Type"},"description":"Type of register to retrieve revisions, Literal[\n 'property', 'report', 'site_content', 'contact', 'lead', 'text_template', 'deal',\n 'calendar', 'lease', 'signature_and_sale', 'parameters', 'site_pages_configuration']"},{"name":"order_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Date"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},{"name":"action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"pipeline_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetRevisions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/revision/{register_type}/{revision_key}":{"get":{"tags":["Revisions"],"summary":"Retrieve A List Of Revisions (Backup)","operationId":"prod_get_revision_backup_detail","parameters":[{"name":"register_type","in":"path","required":true,"schema":{"type":"string","description":"Type of register to retrieve revisions, Literal[\n 'property', 'report', 'site_content', 'contact', 'lead', 'text_template', 'deal',\n 'calendar', 'lease', 'signature_and_sale', 'parameters', 'site_pages_configuration']","title":"Register Type"},"description":"Type of register to retrieve revisions, Literal[\n 'property', 'report', 'site_content', 'contact', 'lead', 'text_template', 'deal',\n 'calendar', 'lease', 'signature_and_sale', 'parameters', 'site_pages_configuration']"},{"name":"revision_key","in":"path","required":true,"schema":{"type":"string","description":"Revision key to retrieve the backup details","title":"Revision Key"},"description":"Revision key to retrieve the backup details"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetRevisions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Revisions"],"summary":"Retrieve A List Of Revisions","operationId":"Retrieve_a_list_of_Revisions_v1_revision__register_type___revision_key__post","parameters":[{"name":"register_type","in":"path","required":true,"schema":{"type":"string","title":"Register Type"}},{"name":"revision_key","in":"path","required":true,"schema":{"type":"string","title":"Revision Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetRevisions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/timeline":{"get":{"tags":["Timelines"],"summary":"Retrieve A List Of Timeline","operationId":"prod_get_timelines_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Cursor"}},{"name":"parent_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Type"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Text"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"parent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Parent Id"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelinesGetResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Timelines"],"summary":"Create A New Timeline Item","operationId":"prod_create_timeline","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelinePostResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/timeline-item/{timeline_key}":{"get":{"tags":["Timelines"],"summary":"Retrieve A Timeline Item","operationId":"prod_get_timeline_item","parameters":[{"name":"timeline_key","in":"path","required":true,"schema":{"type":"string","title":"Timeline Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineGetResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Timelines"],"summary":"Update A New Timeline Item","operationId":"Update_a_new_timeline_item_v1_timeline_item__timeline_key__post","parameters":[{"name":"timeline_key","in":"path","required":true,"schema":{"type":"string","title":"Timeline Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelinePostResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Timelines"],"summary":"Delete A Timeline Item","operationId":"Delete_a_timeline_item_v1_timeline_item__timeline_key__delete","parameters":[{"name":"timeline_key","in":"path","required":true,"schema":{"type":"string","title":"Timeline Key"}}],"responses":{"204":{"description":"Timeline item was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/users":{"get":{"tags":["Users"],"summary":"Retrieve A User List","operationId":"prod_get_users_list","parameters":[{"name":"user_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email"}},{"name":"user_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name"}},{"name":"network_database","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Database"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"global_search","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Global Search"}},{"name":"all_users","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Users"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseUsers"},"title":"Response Prod Get Users List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/users/ranking":{"get":{"tags":["Users"],"summary":"Get Users Ranking","operationId":"prod_get_users_ranking","parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Year"}},{"name":"month","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Month"}},{"name":"deal_interest","in":"query","required":false,"schema":{"anyOf":[{"enum":["buy","rent","other",null]},{"type":"null"}],"title":"Deal Interest"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseUsersRanking"},"title":"Response Prod Get Users Ranking"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/notifications":{"get":{"tags":["Notifications"],"summary":"Retrieve A List Of Notifications","description":"Notification's list of user","operationId":"prod_get_notifications_list","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},{"name":"mark_all_read","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mark All Read"}},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"enum":[null,"mention","calendar","system","contact","deal","document","lease","invoice","financial","deal_rotation","integration","report","contract","analysis","property","dimob","nota_fiscal","all"]},{"type":"null"}],"title":"Category"}},{"name":"include_category_count","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Category Count"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseNotificationSchema"},"title":"Response Prod Get Notifications List"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Notifications"],"summary":"Create A Notification","description":"Create notification to user","operationId":"prod_create_notification","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostNotificationSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/notification/{notification_id}":{"post":{"tags":["Notifications"],"summary":"Update A Notification","description":"Set notification as read","operationId":"Update_a_Notification_v1_notification__notification_id__post","parameters":[{"name":"notification_id","in":"path","required":true,"schema":{"type":"string","title":"Notification Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationUpdateRouterSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePostNotificationSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/cf-analysis":{"get":{"tags":["Credit Financing Analysis"],"summary":"Retrieve A List Of Credit Financing Analysis","operationId":"Retrieve_a_list_of_Credit_Financing_Analysis_v1_cf_analysis_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","draft","send_to_analysis","waiting_analysis","analysis_done","reanalyze"],"type":"string"},{"type":"null"}],"default":"all","title":"Status"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","fc_analise","custom_analysis"],"type":"string"},{"type":"null"}],"default":"all","title":"Type"}},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"}},{"name":"contact_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"}},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"}},{"name":"order","in":"query","required":false,"schema":{"anyOf":[{"enum":["recently_created","oldest_created"],"type":"string"},{"type":"null"}],"title":"Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCFAnalysisList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Credit Financing Analysis"],"summary":"Create Credit Financing Analysis","operationId":"Create_Credit_Financing_Analysis_v1_cf_analysis_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CFAnalysisFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCFAnalysis"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/cf-analysis/{analysis_id}":{"get":{"tags":["Credit Financing Analysis"],"summary":"Retrieve A Credit Financing Analysis","operationId":"Retrieve_a_Credit_Financing_Analysis_v1_cf_analysis__analysis_id__get","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","title":"Analysis Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CFAnalysisFieldsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Credit Financing Analysis"],"summary":"Update Credit Financing Analysis","operationId":"Update_Credit_Financing_Analysis_v1_cf_analysis__analysis_id__post","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","title":"Analysis Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CFAnalysisFieldsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCFAnalysis"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Credit Financing Analysis"],"summary":"Delete Credit Financing Analysis","operationId":"Delete_Credit_Financing_Analysis_v1_cf_analysis__analysis_id__delete","parameters":[{"name":"analysis_id","in":"path","required":true,"schema":{"type":"string","title":"Analysis Id"}}],"responses":{"204":{"description":"Credit Financing Analysis was deleted"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/analysis-fee":{"get":{"tags":["Credit Financing Analysis"],"summary":"Credit Financing Analysis Fee","operationId":"Credit_Financing_Analysis_Fee_v1_analysis_fee_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCFAnalysisFee"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/checklists":{"get":{"tags":["checklists"],"summary":"Get All Checklist Templates","description":"Get all checklist templates","operationId":"get_all_checklists","parameters":[{"name":"links","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Links"}},{"name":"pipeline_groups_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Groups Ids"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChecklistSchema"},"title":"Response Get All Checklists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["checklists"],"summary":"Create Checklist Template","description":"Create new checklist template","operationId":"create_checklist_template","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/checklists/{checklist_id}":{"put":{"tags":["checklists"],"summary":"Update Checklist Template","description":"Update checklist template","operationId":"update_checklist_template","parameters":[{"name":"checklist_id","in":"path","required":true,"schema":{"type":"string","title":"Checklist Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["checklists"],"summary":"Delete Checklist Template","description":"Delete checklist template","operationId":"delete_checklist_template","parameters":[{"name":"checklist_id","in":"path","required":true,"schema":{"type":"string","title":"Checklist Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/imobzi-ia/multimodal/process":{"post":{"tags":["imobzi-IA"],"summary":"Process Multimodal File (Audio, Pdf, Image)","description":"Process an audio, PDF or image file and return structured JSON data.","operationId":"Process_multimodal_file__audio__PDF__image__v1_imobzi_ia_multimodal_process_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_Process_multimodal_file__audio__PDF__image__v1_imobzi_ia_multimodal_process_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessedDocumentSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/user/llm-keys":{"get":{"tags":["arkis-agents-sdk"],"summary":"Get Arkis Account Llm Keys Config","operationId":"Get_Arkis_account_LLM_keys_config_v1_arkis_user_llm_keys_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["arkis-agents-sdk"],"summary":"Save Arkis Account Llm Keys Config","operationId":"Save_Arkis_account_LLM_keys_config_v1_arkis_user_llm_keys_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisLLMKeysConfigSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/chat-sessions":{"get":{"tags":["arkis-agents-sdk"],"summary":"Get Arkis Agents Sdk Chat Sessions","operationId":"Get_Arkis_Agents_SDK_chat_sessions_v1_arkis_chat_sessions_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(active|deleted|archived)$"},{"type":"null"}],"default":"active","title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"direction","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(asc|desc)$"},{"type":"null"}],"default":"desc","title":"Direction"}},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Search Text"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["arkis-agents-sdk"],"summary":"Create Arkis Agents Sdk Chat Session","operationId":"Create_Arkis_Agents_SDK_chat_session_v1_arkis_chat_sessions_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisChatSessionCreateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/chat-session/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"Update Arkis Agents Sdk Chat Session","operationId":"Update_Arkis_Agents_SDK_chat_session_v1_arkis_chat_session__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatSessionSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"get":{"tags":["arkis-agents-sdk"],"summary":"Get Arkis Agents Sdk Chat Session And Billing Details","operationId":"Get_Arkis_Agents_SDK_chat_session_and_billing_details_v1_arkis_chat_session__session_id__get","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/ask/{session_id}":{"get":{"tags":["arkis-agents-sdk"],"summary":"Get Arkis Agents Sdk Chat Messages","operationId":"Get_Arkis_Agents_SDK_chat_messages_v1_arkis_ask__session_id__get","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":0,"default":20,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["arkis-agents-sdk"],"summary":"Arkis Agents Sdk Ask Question","operationId":"Arkis_Agents_SDK_ask_question_v1_arkis_ask__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisAgentAskSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["arkis-agents-sdk"],"summary":"Delete Arkis Agents Sdk Chat Session","operationId":"Delete_Arkis_Agents_SDK_chat_session_v1_arkis_ask__session_id__delete","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/chat-session/{session_id}/rewind":{"post":{"tags":["arkis-agents-sdk"],"summary":"Rewind Arkis Agents Sdk Chat Session","description":"Hide the messages and delete the agent items saved after ``after_message_id``.\n\nThe messages are kept (marked with ``rewound_at``) so the consumption\nbilled per message still counts them; the history skips them and the\nagent no longer remembers them.","operationId":"Rewind_Arkis_Agents_SDK_chat_session_v1_arkis_chat_session__session_id__rewind_post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisRewindSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/chat-session/{session_id}/message/{message_id}/feedback":{"post":{"tags":["arkis-agents-sdk"],"summary":"Save Feedback For An Arkis Answer","description":"Last vote wins; the structured log is what the team queries.","operationId":"Save_feedback_for_an_Arkis_answer_v1_arkis_chat_session__session_id__message__message_id__feedback_post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"message_id","in":"path","required":true,"schema":{"type":"string","title":"Message Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisFeedbackSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/chat-sessions/details":{"get":{"tags":["arkis-agents-sdk"],"summary":"Get Arkis Agents Sdk Chat Session Details","operationId":"Get_Arkis_Agents_SDK_chat_session_details_v1_arkis_chat_sessions_details_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/image/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"Generate Or Edit An Image Via Arkis Agents Sdk","description":"Always stream one Agents SDK image interaction as SSE.","operationId":"Generate_or_edit_an_image_via_Arkis_Agents_SDK_v1_arkis_image__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisImageRequestSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/voice/session/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"Create Arkis Voice Session","operationId":"Create_Arkis_voice_session_v1_arkis_voice_session__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisVoiceSessionSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/voice/turns/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"Save Arkis Voice Turns","operationId":"Save_Arkis_voice_turns_v1_arkis_voice_turns__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisVoiceTurnsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/voice/heartbeat/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"Arkis Voice Heartbeat","operationId":"Arkis_voice_heartbeat_v1_arkis_voice_heartbeat__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisVoiceCallSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/arkis/voice/end/{session_id}":{"post":{"tags":["arkis-agents-sdk"],"summary":"End Arkis Voice Call","operationId":"End_Arkis_voice_call_v1_arkis_voice_end__session_id__post","parameters":[{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArkisVoiceEndSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/agent/tts":{"post":{"tags":["imobzi-IA"],"summary":"Generate Tts Audio For A Message Or Preview Text","operationId":"Generate_TTS_audio_for_a_message_or_preview_text_v1_agent_tts_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TTSRequestSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/agent/tts/voices":{"get":{"tags":["imobzi-IA"],"summary":"List Curated Tts Voices","operationId":"List_curated_TTS_voices_v1_agent_tts_voices_get","parameters":[{"name":"lang","in":"query","required":false,"schema":{"type":"string","default":"pt-BR","title":"Lang"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/agent/text-templates":{"get":{"tags":["imobzi-IA"],"summary":"List Arkis Interaction Text Templates","operationId":"List_Arkis_interaction_text_templates_v1_agent_text_templates_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(mcp|image_generate|image_edit)$"},{"type":"null"}],"title":"Type"}},{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":10},{"type":"null"}],"title":"Locale"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/adverts/site-highlights":{"get":{"tags":["Site Highlights"],"summary":"Get List Of Site Highlights","operationId":"Get_list_of_site_highlights_v1_adverts_site_highlights_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/SectionSchema"},"type":"object","title":"Response Get List Of Site Highlights V1 Adverts Site Highlights Get"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"put":{"tags":["Site Highlights"],"summary":"Changing The Order Of Properties","operationId":"Changing_the_order_of_properties_v1_adverts_site_highlights_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutSiteHighlightsRequestSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"message":"Site highlights updated successfully"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Site Highlights"],"summary":"Adding Property To Highlights","operationId":"Adding_property_to_highlights_v1_adverts_site_highlights_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSiteHighlightsRequestSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"message":"Site highlights updated successfully"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/adverts/site-highlight/{section_id}/{property_id}":{"delete":{"tags":["Site Highlights"],"summary":"Delete Property Highlight","operationId":"Delete_property_highlight_v1_adverts_site_highlight__section_id___property_id__delete","parameters":[{"name":"section_id","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Section Id"}},{"name":"property_id","in":"path","required":true,"schema":{"type":"string","title":"Property Id"}}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/deals":{"get":{"tags":["Deals Tools"],"summary":"Search Deals","description":"Find and list deals in CRM pipelines. To find a deal by code such as VL-933, send the complete code in deal_code_raw. Pipeline group names use their exact display value; invalid names return options for selection. Without filters, returns up to 50 in-progress deals. Read-only.","operationId":"mcp_tool_search_deals","parameters":[{"name":"deal_code_raw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw deal code","description":"Raw deal code exactly as the user mentioned, e.g. 'AVA-12', 'VEN-42' or '12'. Use this whenever the user refers to a deal by its code — pass the full string here and the tool will extract the number and pipeline prefix automatically. Do NOT split the code manually or set deal_code / pipeline_group_prefix separately when using this field. Examples: user says 'negócio AVA-12' → deal_code_raw='AVA-12'; user says 'negócio 12' → deal_code_raw='12'."},"description":"Raw deal code exactly as the user mentioned, e.g. 'AVA-12', 'VEN-42' or '12'. Use this whenever the user refers to a deal by its code — pass the full string here and the tool will extract the number and pipeline prefix automatically. Do NOT split the code manually or set deal_code / pipeline_group_prefix separately when using this field. Examples: user says 'negócio AVA-12' → deal_code_raw='AVA-12'; user says 'negócio 12' → deal_code_raw='12'."},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search text","description":"Free-text search across the deal title, description, and custom string fields. Use dedicated contact, property, and deal-code fields when the user provides those identifiers. Send the raw text without quotes or special formatting. Examples: 'apartamento moema', 'proposta comercial'."},"description":"Free-text search across the deal title, description, and custom string fields. Use dedicated contact, property, and deal-code fields when the user provides those identifiers. Send the raw text without quotes or special formatting. Examples: 'apartamento moema', 'proposta comercial'."},{"name":"deal_code","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Deal code","description":"Numeric portion of a deal code, without letters or a hyphen. Prefer deal_code_raw when the user provides a code, because that field preserves and parses the complete value. When populating this field directly, pair it with pipeline_group_prefix or the exact pipeline_group_name. Example: 12."},"description":"Numeric portion of a deal code, without letters or a hyphen. Prefer deal_code_raw when the user provides a code, because that field preserves and parses the complete value. When populating this field directly, pair it with pipeline_group_prefix or the exact pipeline_group_name. Example: 12."},{"name":"pipeline_group_prefix","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group prefix","description":"Short alphanumeric prefix that identifies a pipeline group, such as AVA in AVA-12. Normally this is extracted automatically from deal_code_raw. When populated directly, use it with the numeric deal_code. It takes priority over pipeline_group_name if both are sent."},"description":"Short alphanumeric prefix that identifies a pipeline group, such as AVA in AVA-12. Normally this is extracted automatically from deal_code_raw. When populated directly, use it with the numeric deal_code. It takes priority over pipeline_group_name if both are sent."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Name (or part of the name) of the person or organization associated with the deal. Substring search, case-insensitive, diacritics ignored. The tool resolves the contact before filtering deals. Use when the user asks for deals of a specific contact by name. Prefer contact_email when an email is available (more precise). Example values: 'João', 'Silva', 'Construtora ABC'."},"description":"Name (or part of the name) of the person or organization associated with the deal. Substring search, case-insensitive, diacritics ignored. The tool resolves the contact before filtering deals. Use when the user asks for deals of a specific contact by name. Prefer contact_email when an email is available (more precise). Example values: 'João', 'Silva', 'Construtora ABC'."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Exact email of the person or organization linked to the deal. Case-insensitive. The tool resolves the contact and filters its deals. Prefer this over contact_name when email is known — it is more precise and avoids ambiguity with similar names. Format: user@domain.com. Example: 'maria@empresa.com'."},"description":"Exact email of the person or organization linked to the deal. Case-insensitive. The tool resolves the contact and filters its deals. Prefer this over contact_name when email is known — it is more precise and avoids ambiguity with similar names. Format: user@domain.com. Example: 'maria@empresa.com'."},{"name":"contact_phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Exact phone number of the person or organization linked to the deal. Case-insensitive. The tool resolves the contact and filters its deals. Preferred when available because it avoids ambiguity for duplicated names. Format: +55 11 91234-5678. Example: '+55 11 91234-5678'."},"description":"Exact phone number of the person or organization linked to the deal. Case-insensitive. The tool resolves the contact and filters its deals. Preferred when available because it avoids ambiguity for duplicated names. Format: +55 11 91234-5678. Example: '+55 11 91234-5678'."},{"name":"contact_legal_identification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact legal identification","description":"Legal identification of the contact, such as CPF for individuals or CNPJ for companies. Used as an additional filter to identify the contact when email or name are not sufficient. It must match exactly one contact. Example values: '123.456.789-00' for CPF, '12.345.678/0001-00' for CNPJ."},"description":"Legal identification of the contact, such as CPF for individuals or CNPJ for companies. Used as an additional filter to identify the contact when email or name are not sufficient. It must match exactly one contact. Example values: '123.456.789-00' for CPF, '12.345.678/0001-00' for CNPJ."},{"name":"contact_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Exact public code of the person or organization linked to the deal. Use it when the contact is already identified by code; the tool resolves the contact directly and filters its associated deals."},"description":"Exact public code of the person or organization linked to the deal. Use it when the contact is already identified by code; the tool resolves the contact directly and filters its associated deals."},{"name":"pipeline_group_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Exact display name of the pipeline group used to filter deals. A pipeline group is the funnel that contains stages; it is not a stage. Remove the word 'Funil' from user input: 'funil de Vendas' → 'Vendas' and 'funil Locação' → 'Locação'. Do not send a short prefix such as VEN in this field. If the name is not found, the tool returns pipeline group options."},"description":"Exact display name of the pipeline group used to filter deals. A pipeline group is the funnel that contains stages; it is not a stage. Remove the word 'Funil' from user input: 'funil de Vendas' → 'Vendas' and 'funil Locação' → 'Locação'. Do not send a short prefix such as VEN in this field. If the name is not found, the tool returns pipeline group options."},{"name":"stage_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage name","description":"Pipeline stage name used to filter deals. A stage is a step inside a pipeline group, so combine this field with pipeline_group_name to avoid ambiguity across funnels. When a pipeline group is provided, comparison also ignores case, diacritics, and special characters. Examples: 'Proposta Enviada', 'Negociação', 'Fechamento', 'Novo Lead'."},"description":"Pipeline stage name used to filter deals. A stage is a step inside a pipeline group, so combine this field with pipeline_group_name to avoid ambiguity across funnels. When a pipeline group is provided, comparison also ignores case, diacritics, and special characters. Examples: 'Proposta Enviada', 'Negociação', 'Fechamento', 'Novo Lead'."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["in progress","win","lost","stagnant","out_of_date"],"type":"string"},{"type":"null"}],"title":"Deal status","description":"Filter deals by their current status. Send one of the exact slug values listed below — NOT the Portuguese term. Translation map from Portuguese: em andamento / aberto → 'in progress', ganho / ganhou / fechado → 'win', perdido / perdeu → 'lost', estagnado / parado → 'stagnant', atrasado / vencido → 'out_of_date'. Example: user says 'negócios ganhos' → status='win'."},"description":"Filter deals by their current status. Send one of the exact slug values listed below — NOT the Portuguese term. Translation map from Portuguese: em andamento / aberto → 'in progress', ganho / ganhou / fechado → 'win', perdido / perdeu → 'lost', estagnado / parado → 'stagnant', atrasado / vencido → 'out_of_date'. Example: user says 'negócios ganhos' → status='win'."},{"name":"deal_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","buy","rent","vacation_rental"],"type":"string"},{"type":"null"}],"title":"Deal type","description":"Filter by the deal interest type (what the client wants). Send one of the exact slug values — NOT Portuguese. Translation map: compra / venda → 'buy', aluguel / locação → 'rent', temporada → 'vacation_rental'. Example: user says 'negócios de locação' → deal_type='rent'."},"description":"Filter by the deal interest type (what the client wants). Send one of the exact slug values — NOT Portuguese. Translation map: compra / venda → 'buy', aluguel / locação → 'rent', temporada → 'vacation_rental'. Example: user says 'negócios de locação' → deal_type='rent'."},{"name":"user_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker name","description":"Responsible broker name or partial name. The lookup is case-insensitive and considers active users. It must resolve to exactly one user; otherwise the tool returns options for disambiguation. When the user refers to their own deals ('meus negócios', 'minhas vendas', 'meus leads', 'minha carteira'), leave this field empty and set requesting_user_only=true. Examples: 'Maria', 'Carlos Souza'."},"description":"Responsible broker name or partial name. The lookup is case-insensitive and considers active users. It must resolve to exactly one user; otherwise the tool returns options for disambiguation. When the user refers to their own deals ('meus negócios', 'minhas vendas', 'meus leads', 'minha carteira'), leave this field empty and set requesting_user_only=true. Examples: 'Maria', 'Carlos Souza'."},{"name":"user_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker email","description":"Responsible broker email. Exact match, case-insensitive. Preferred when available because it avoids ambiguity for duplicated names. When the user refers to their OWN deals ('meus negócios', 'minhas vendas'), do NOT set this field — use requesting_user_only=True instead."},"description":"Responsible broker email. Exact match, case-insensitive. Preferred when available because it avoids ambiguity for duplicated names. When the user refers to their OWN deals ('meus negócios', 'minhas vendas'), do NOT set this field — use requesting_user_only=True instead."},{"name":"requesting_user_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Requesting user only","description":"Set to true when the user refers to their own deals using possessive language: 'meus negócios', 'minhas vendas', 'meus leads', 'minha carteira', 'meus negócios em andamento', 'minhas oportunidades'. When true, results are restricted to the requesting user's deals regardless of read permissions. Do NOT set this when the user asks about another broker's deals. If user_name or user_email is also provided, that explicit broker takes precedence."},"description":"Set to true when the user refers to their own deals using possessive language: 'meus negócios', 'minhas vendas', 'meus leads', 'minha carteira', 'meus negócios em andamento', 'minhas oportunidades'. When true, results are restricted to the requesting user's deals regardless of read permissions. Do NOT set this when the user asks about another broker's deals. If user_name or user_email is also provided, that explicit broker takes precedence."},{"name":"team_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Team name","description":"Name of the team responsible for the deal. The tool resolves the team name. Must match exactly one team. Example values: 'Equipe Comercial', 'Time Vendas SP'."},"description":"Name of the team responsible for the deal. The tool resolves the team name. Must match exactly one team. Example values: 'Equipe Comercial', 'Time Vendas SP'."},{"name":"property_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property code","description":"Code of the property linked to the deal. Exact match. This is the property's own code, not the deal code. The tool resolves the property and filters deals that include it in their presented-property list. Send as string. Example values: '876', 'AP-302'."},"description":"Code of the property linked to the deal. Exact match. This is the property's own code, not the deal code. The tool resolves the property and filters deals that include it in their presented-property list. Send as string. Example values: '876', 'AP-302'."},{"name":"property_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property address","description":"Address (or part of the address) of the property linked to the deal. Substring search, case-insensitive. Used to find deals associated with properties at a given location. Can be combined with property_code for precision. Example values: 'Av. Paulista', 'Rua das Flores, 100'."},"description":"Address (or part of the address) of the property linked to the deal. Substring search, case-insensitive. Used to find deals associated with properties at a given location. Can be combined with property_code for precision. Example values: 'Av. Paulista', 'Rua das Flores, 100'."},{"name":"create_period","in":"query","required":false,"schema":{"anyOf":[{"enum":["today","this_week","this_month","last_month","last_three_months","current_year","last_year"],"type":"string"},{"type":"null"}],"title":"Creation period","description":"Filter deals by when they were CREATED. Send one of the exact keyword values — the backend converts it to a date range. Allowed values and their meaning: 'today' = created today, 'this_week' = created in the current week (Mon–Sun), 'this_month' = created in the current month, 'last_month' = created in the previous month, 'last_three_months' = created in the last 3 months, 'current_year' = created in the current year, 'last_year' = created in the previous year. Example: user says 'negócios criados esta semana' → create_period='this_week'."},"description":"Filter deals by when they were CREATED. Send one of the exact keyword values — the backend converts it to a date range. Allowed values and their meaning: 'today' = created today, 'this_week' = created in the current week (Mon–Sun), 'this_month' = created in the current month, 'last_month' = created in the previous month, 'last_three_months' = created in the last 3 months, 'current_year' = created in the current year, 'last_year' = created in the previous year. Example: user says 'negócios criados esta semana' → create_period='this_week'."},{"name":"update_period","in":"query","required":false,"schema":{"anyOf":[{"enum":["today","this_week","this_month","last_month","last_three_months","current_year","last_year"],"type":"string"},{"type":"null"}],"title":"Update period","description":"Filter deals by when they were last UPDATED (any field change). Same keyword values as create_period. Use this when the user asks about recent activity or changes. Example: user says 'negócios atualizados hoje' → update_period='today'."},"description":"Filter deals by when they were last UPDATED (any field change). Same keyword values as create_period. Use this when the user asks about recent activity or changes. Example: user says 'negócios atualizados hoje' → update_period='today'."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pagination cursor","description":"Opaque pagination cursor accepted by the backend. Send it only when a cursor was supplied by external context; do not invent one or send it on the first request. The current MCP tool response does not expose the next cursor."},"description":"Opaque pagination cursor accepted by the backend. Send it only when a cursor was supplied by external context; do not invent one or send it on the first request. The current MCP tool response does not expose the next cursor."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Deals Tools"],"summary":"Create Deal","description":"Create a deal in a CRM pipeline. Requires title, pipeline_group_name, stage_name, value, and at least one contact identifier. Use 'primeira etapa' when no stage is specified, use value=0 when no amount is provided, and omit the responsible user to assign the requesting user. Write operation: creates a deal.","operationId":"mcp_tool_create_deal","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealCreateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/deal/{deal_code}":{"put":{"tags":["Deals Tools"],"summary":"Update Deal","description":"Update a deal by numeric or prefixed code. Preserve complete prefixed codes such as VL-933; for numeric codes, also provide pipeline_group_name. Only provided fields are changed. Use stage_name to move the deal within its current pipeline group. Write operation: modifies a deal.","operationId":"mcp_tool_update_deal","parameters":[{"name":"deal_code","in":"path","required":true,"schema":{"type":"string","title":"Deal code","description":"Deal identifier to update. Required. Accepts a numeric code such as '653' or a complete prefixed code such as 'LOC-11' or 'VL-933'. Preserve the prefix and hyphen exactly as provided. Send the identifier in deal_code for this operation."},"description":"Deal identifier to update. Required. Accepts a numeric code such as '653' or a complete prefixed code such as 'LOC-11' or 'VL-933'. Preserve the prefix and hyphen exactly as provided. Send the identifier in deal_code for this operation."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealUpdateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Deals Tools"],"summary":"Delete Deal","description":"Delete a deal by numeric or prefixed code. Preserve complete prefixed codes such as VL-933; for numeric codes, also provide pipeline_group_name. This action is irreversible and requires explicit user confirmation. Write operation: deletes a deal.","operationId":"mcp_tool_delete_deal","parameters":[{"name":"deal_code","in":"path","required":true,"schema":{"type":"string","title":"Deal code","description":"Deal identifier to delete. Accepts a numeric code such as '653' or a complete prefixed code such as 'LOC-11' or 'VL-933'. Preserve the prefix and hyphen exactly as provided. Send the identifier in deal_code for this operation. The action is irreversible and requires explicit user confirmation."},"description":"Deal identifier to delete. Accepts a numeric code such as '653' or a complete prefixed code such as 'LOC-11' or 'VL-933'. Preserve the prefix and hyphen exactly as provided. Send the identifier in deal_code for this operation. The action is irreversible and requires explicit user confirmation."},{"name":"pipeline_group_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Exact pipeline group display name used to identify the funnel. Provide it when deal_code is numeric, such as '653'. Omit it for a prefixed code such as 'VL-933', because the prefix resolves the pipeline group."},"description":"Exact pipeline group display name used to identify the funnel. Provide it when deal_code is numeric, such as '653'. Omit it for a prefixed code such as 'VL-933', because the prefix resolves the pipeline group."}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/calendars":{"get":{"tags":["Calendar Tools"],"summary":"Search Calendar Items","description":"Find appointments, scheduled tasks, visits, calls, and scheduled WhatsApp items. Filter by title, type, status, responsible user, contact, property, deal, or date range. If no period is provided, defaults to the current month (this_month). For activity history, use search_timelines. Read-only.","operationId":"mcp_tool_search_calendars","parameters":[{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Full-text search across title, description, and location fields. Do NOT use this to filter by event type (visit, task, call, whatsapp). When the user asks for items of a specific type ('visitas', 'tarefas', 'ligações', 'chamadas', 'zap'), use item_type instead.","title":"Search Text"},"description":"Full-text search across title, description, and location fields. Do NOT use this to filter by event type (visit, task, call, whatsapp). When the user asks for items of a specific type ('visitas', 'tarefas', 'ligações', 'chamadas', 'zap'), use item_type instead."},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar item title (full or partial).","title":"Title"},"description":"Calendar item title (full or partial)."},{"name":"item_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar item type filter. Use when the user asks for items of a specific type. Map Portuguese terms: 'visita', 'visitas' → 'visit'; 'tarefa', 'tarefas', 'lembrete', 'lembretes', 'todo' → 'task'; 'ligação', 'ligações', 'ligacao', 'ligacoes', 'chamada', 'chamadas', 'call' → 'call'; 'whatsapp', 'zap', 'wpp' → 'whatsapp'. Also accepts active custom type names.","title":"Item Type"},"description":"Calendar item type filter. Use when the user asks for items of a specific type. Map Portuguese terms: 'visita', 'visitas' → 'visit'; 'tarefa', 'tarefas', 'lembrete', 'lembretes', 'todo' → 'task'; 'ligação', 'ligações', 'ligacao', 'ligacoes', 'chamada', 'chamadas', 'call' → 'call'; 'whatsapp', 'zap', 'wpp' → 'whatsapp'. Also accepts active custom type names."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["active","canceled"],"type":"string"},{"type":"null"}],"description":"Calendar item status: active or canceled.","title":"Status"},"description":"Calendar item status: active or canceled."},{"name":"done","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Completion filter: true (done) or false (pending).","title":"Done"},"description":"Completion filter: true (done) or false (pending)."},{"name":"user_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Responsible user name (partial match allowed). Use ONLY when filtering by a specific OTHER user's calendar. When the user refers to their OWN items ('meus compromissos', 'minha agenda', 'minhas tarefas', 'meus eventos', 'minha semana') do NOT set this field — set requesting_user_only=True instead.","title":"User Name"},"description":"Responsible user name (partial match allowed). Use ONLY when filtering by a specific OTHER user's calendar. When the user refers to their OWN items ('meus compromissos', 'minha agenda', 'minhas tarefas', 'meus eventos', 'minha semana') do NOT set this field — set requesting_user_only=True instead."},{"name":"user_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Responsible user email (exact match, preferred for disambiguation). Use ONLY when filtering by a specific OTHER user's calendar. When the user refers to their OWN items ('meus compromissos', 'minha agenda'), do NOT set this field — set requesting_user_only=True instead.","title":"User Email"},"description":"Responsible user email (exact match, preferred for disambiguation). Use ONLY when filtering by a specific OTHER user's calendar. When the user refers to their OWN items ('meus compromissos', 'minha agenda'), do NOT set this field — set requesting_user_only=True instead."},{"name":"requesting_user_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Requesting user only","description":"Set to true when the user refers to their own calendar items using possessive language: 'meus compromissos', 'minha agenda', 'minhas tarefas', 'meus eventos', 'meus lembretes', 'meu calendário', 'minha semana', 'my appointments'. When true, results are restricted to the requesting user's items regardless of read permissions. Do NOT set this when the user asks about another person's calendar. If user_name or user_email is also provided, that explicit user filter takes precedence."},"description":"Set to true when the user refers to their own calendar items using possessive language: 'meus compromissos', 'minha agenda', 'minhas tarefas', 'meus eventos', 'meus lembretes', 'meu calendário', 'minha semana', 'my appointments'. When true, results are restricted to the requesting user's items regardless of read permissions. Do NOT set this when the user asks about another person's calendar. If user_name or user_email is also provided, that explicit user filter takes precedence."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related contact name (parent or guest).","title":"Contact Name"},"description":"Related contact name (parent or guest)."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related contact email (preferred for higher precision).","title":"Contact Email"},"description":"Related contact email (preferred for higher precision)."},{"name":"contact_phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related contact phone number. Accepts flexible formatting with or without country code, area code, dashes and spaces. Example: '11999887766', '+55 11 99988-7766'.","title":"Contact Phone"},"description":"Related contact phone number. Accepts flexible formatting with or without country code, area code, dashes and spaces. Example: '11999887766', '+55 11 99988-7766'."},{"name":"contact_legal_identification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related contact legal identification (CPF or CNPJ). Example: '123.456.789-00' or '12345678000190'.","title":"Contact Legal Identification"},"description":"Related contact legal identification (CPF or CNPJ). Example: '123.456.789-00' or '12345678000190'."},{"name":"property_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related property code.","title":"Property Code"},"description":"Related property code."},{"name":"property_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Related property address (partial match allowed).","title":"Property Address"},"description":"Related property address (partial match allowed)."},{"name":"deal_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Deal code in numeric or prefixed format, such as 653 or VEN-653. For a numeric code, also provide pipeline_group_name; a prefixed code resolves the pipeline from its prefix.","title":"Deal Code"},"description":"Deal code in numeric or prefixed format, such as 653 or VEN-653. For a numeric code, also provide pipeline_group_name; a prefixed code resolves the pipeline from its prefix."},{"name":"pipeline_group_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pipeline group name. Provide it when deal_code is numeric; omit it when the code already contains a pipeline prefix.","title":"Pipeline Group Name"},"description":"Pipeline group name. Provide it when deal_code is numeric; omit it when the code already contains a pipeline prefix."},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"enum":["today","this_week","this_month","last_month","last_three_months","current_year","last_year"],"type":"string"},{"type":"null"}],"description":"Date period shortcut for filtering calendar items by date range. Map Portuguese terms from the user's message to the correct value: 'hoje', 'hoje mesmo', 'neste dia' → 'today'; 'esta semana', 'essa semana', 'nesta semana', 'semana atual' → 'this_week'; 'este mês', 'esse mês', 'neste mês', 'mês atual' → 'this_month' (default); 'mês passado', 'mês anterior' → 'last_month'; 'últimos 3 meses', 'últimos três meses', 'trimestre' → 'last_three_months'; 'este ano', 'esse ano', 'ano atual' → 'current_year'; 'ano passado', 'ano anterior' → 'last_year'. When the user provides a specific date or explicit date range, use start_at/end_at instead.","default":"this_month","title":"Period"},"description":"Date period shortcut for filtering calendar items by date range. Map Portuguese terms from the user's message to the correct value: 'hoje', 'hoje mesmo', 'neste dia' → 'today'; 'esta semana', 'essa semana', 'nesta semana', 'semana atual' → 'this_week'; 'este mês', 'esse mês', 'neste mês', 'mês atual' → 'this_month' (default); 'mês passado', 'mês anterior' → 'last_month'; 'últimos 3 meses', 'últimos três meses', 'trimestre' → 'last_three_months'; 'este ano', 'esse ano', 'ano atual' → 'current_year'; 'ano passado', 'ano anterior' → 'last_year'. When the user provides a specific date or explicit date range, use start_at/end_at instead."},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Explicit start datetime in ISO 8601 format (overrides period). Calendar times are interpreted as America/Sao_Paulo wall-clock values. Use when the user provides a specific date like '22/05/2026' or '2026-05-22'. Convert DD/MM/YYYY to ISO 8601 (YYYY-MM-DD). Example: '22/05/2026' → '2026-05-22T00:00:00'.","title":"Start At"},"description":"Explicit start datetime in ISO 8601 format (overrides period). Calendar times are interpreted as America/Sao_Paulo wall-clock values. Use when the user provides a specific date like '22/05/2026' or '2026-05-22'. Convert DD/MM/YYYY to ISO 8601 (YYYY-MM-DD). Example: '22/05/2026' → '2026-05-22T00:00:00'."},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Explicit end datetime in ISO 8601 format (overrides period). Calendar times are interpreted as America/Sao_Paulo wall-clock values. Use together with start_at when the user specifies a date range.","title":"End At"},"description":"Explicit end datetime in ISO 8601 format (overrides period). Calendar times are interpreted as America/Sao_Paulo wall-clock values. Use together with start_at when the user specifies a date range."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum number of returned items. Default: 20.","default":20,"title":"Limit"},"description":"Maximum number of returned items. Default: 20."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Calendar Tools"],"summary":"Create Calendar Item","description":"Create an appointment, task, visit, call, or WhatsApp calendar item. Requires title and either initial_date or relative_initial_date; initial_time defaults to 09:00 when a relative date has no time. Visits require a contact and property. If no responsible user is provided, assigns the requesting user. Write operation: creates a calendar item.","operationId":"mcp_tool_create_calendar","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarCreateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"put":{"tags":["Calendar Tools"],"summary":"Update Calendar Item","description":"Update a calendar item identified by title and initial_date, matched at day precision. Optional selector fields can disambiguate, and the selector must resolve to exactly one item. Put only changed fields in updates. For recurring items, apply_scope defaults to this and controls affected occurrences. Write operation: modifies a calendar item.","operationId":"mcp_tool_update_calendar","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarUpdateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Calendar Tools"],"summary":"Delete Calendar Item","description":"Delete a calendar item identified by title and initial_date, matched at day precision. Optional selector fields can disambiguate, and the selector must resolve to exactly one item. For recurring items, apply_scope defaults to this and controls affected occurrences. This action is irreversible and requires explicit user confirmation. Write operation: deletes a calendar item.","operationId":"mcp_tool_delete_calendar","parameters":[{"name":"selector","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Serialized selector payload (JSON or dict-like string).","title":"Selector"},"description":"Serialized selector payload (JSON or dict-like string)."},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Calendar item title used with initial_date to identify the item. The title is matched as a phrase.","title":"Title"},"description":"Calendar item title used with initial_date to identify the item. The title is matched as a phrase."},{"name":"initial_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Reference date or datetime in ISO 8601 format. It is interpreted in America/Sao_Paulo and matched at calendar-day precision.","title":"Initial Date"},"description":"Reference date or datetime in ISO 8601 format. It is interpreted in America/Sao_Paulo and matched at calendar-day precision."},{"name":"user_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional user filter for disambiguation.","title":"User Name"},"description":"Optional user filter for disambiguation."},{"name":"user_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional user email filter for disambiguation.","title":"User Email"},"description":"Optional user email filter for disambiguation."},{"name":"item_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional item type filter for disambiguation.","title":"Item Type"},"description":"Optional item type filter for disambiguation."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional contact name filter for disambiguation.","title":"Contact Name"},"description":"Optional contact name filter for disambiguation."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional contact email filter for disambiguation.","title":"Contact Email"},"description":"Optional contact email filter for disambiguation."},{"name":"property_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional property code filter for disambiguation.","title":"Property Code"},"description":"Optional property code filter for disambiguation."},{"name":"property_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional property address filter for disambiguation.","title":"Property Address"},"description":"Optional property address filter for disambiguation."},{"name":"apply_scope","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Scope for a recurring item: this deletes only the selected occurrence, next deletes the selected and following occurrences, and all deletes the entire series. Default: this.","title":"Apply Scope"},"description":"Scope for a recurring item: this deletes only the selected occurrence, next deletes the selected and following occurrences, and all deletes the entire series. Default: this."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CalendarDeleteParams"},{"type":"null"}],"title":"Params"}}}},"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/contacts":{"get":{"tags":["Contacts Tools"],"summary":"Search Contacts","description":"Find people, organizations, clients, and leads in the CRM. Put a person's or company's name in contact_name, and use the dedicated fields for email, phone, CPF, or CNPJ. Without filters, returns up to 20 active non-lead contacts, ordered by most recently updated. Read-only.","operationId":"mcp_tool_search_contacts","parameters":[{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search text","description":"General free-text search across indexed contact fields. Use it for a broad query or a public contact code. When the user provides a known name, email, phone, CPF, or CNPJ, prefer the corresponding dedicated field."},"description":"General free-text search across indexed contact fields. Use it for a broad query or a public contact code. When the user provides a known name, email, phone, CPF, or CNPJ, prefer the corresponding dedicated field."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Partial or complete name of a person or organization, matched without case or diacritic sensitivity. Use this field whenever a name is the search criterion. If an exact search returns no records and this is the only identifier, the tool may return similar names. Examples: 'Tiago', 'Maria Silva', 'Construtora ABC'."},"description":"Partial or complete name of a person or organization, matched without case or diacritic sensitivity. Use this field whenever a name is the search criterion. If an exact search returns no records and this is the only identifier, the tool may return similar names. Examples: 'Tiago', 'Maria Silva', 'Construtora ABC'."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Exact contact email, matched case-insensitively."},"description":"Exact contact email, matched case-insensitively."},{"name":"contact_phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Contact phone with or without punctuation, area code, and country code. Formatting is ignored and the value must contain at least eight digits."},"description":"Contact phone with or without punctuation, area code, and country code. Formatting is ignored and the value must contain at least eight digits."},{"name":"contact_legal_identification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact legal identification","description":"Contact CPF or CNPJ with or without formatting."},"description":"Contact CPF or CNPJ with or without formatting."},{"name":"contact_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["person","organization","all"],"type":"string"},{"type":"null"}],"title":"Contact type","description":"Filter by entity type. Use 'person' for individuals, 'organization' for companies, or 'all' to include people, organizations, and leads. Without this field, the normal contact search excludes leads."},"description":"Filter by entity type. Use 'person' for individuals, 'organization' for companies, or 'all' to include people, organizations, and leads. Without this field, the normal contact search excludes leads."},{"name":"contact_status","in":"query","required":false,"schema":{"anyOf":[{"enum":["active","inactive","all"],"type":"string"},{"type":"null"}],"title":"Contact status","description":"Filter by activation status. Use 'active', 'inactive', or 'all'. Defaults to 'active'.","default":"active"},"description":"Filter by activation status. Use 'active', 'inactive', or 'all'. Defaults to 'active'."},{"name":"is_lead","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lead only","description":"Set to true to return only leads; this takes precedence over contact_type. Leave it unset for a normal contact search, which excludes leads by default."},"description":"Set to true to return only leads; this takes precedence over contact_type. Leave it unset for a normal contact search, which excludes leads by default."},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags","description":"Comma-separated tags used to filter contacts. Multiple tags are matched with OR semantics. Example: 'client,vip'."},"description":"Comma-separated tags used to filter contacts. Multiple tags are matched with OR semantics. Example: 'client,vip'."},{"name":"manager_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager name","description":"Name or partial name of the manager responsible for the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. When the user asks for their own contacts, leave this field empty and set requesting_user_only=true. Examples: 'Maria', 'Carlos Souza'."},"description":"Name or partial name of the manager responsible for the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. When the user asks for their own contacts, leave this field empty and set requesting_user_only=true. Examples: 'Maria', 'Carlos Souza'."},{"name":"manager_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager email","description":"Exact email of the manager responsible for the contact. Prefer this over manager_name when available because it avoids name ambiguity."},"description":"Exact email of the manager responsible for the contact. Prefer this over manager_name when available because it avoids name ambiguity."},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["shared_with_me","shared_with_others","without_manager","without_email","without_phone","with_deal","without_deal","favorites","pending","out_of_date","out_of_date_90_days","new_contacts","birthdays_all","birthdays_only_mine","my_contacts"],"type":"string"},{"type":"null"}],"title":"Smart list","description":"Predefined contact filter. Use: 'shared_with_me' or 'shared_with_others' for sharing; 'without_manager', 'without_email', or 'without_phone' for missing data; 'with_deal' or 'without_deal' for deal linkage; 'favorites' for favorites; 'pending' for pending review; 'out_of_date' for contacts not updated in 365 days; 'out_of_date_90_days' for 90 days; 'new_contacts' for contacts created in the last 30 days; 'birthdays_all' or 'birthdays_only_mine' for today's birthdays; and 'my_contacts' for contacts owned by the requesting user."},"description":"Predefined contact filter. Use: 'shared_with_me' or 'shared_with_others' for sharing; 'without_manager', 'without_email', or 'without_phone' for missing data; 'with_deal' or 'without_deal' for deal linkage; 'favorites' for favorites; 'pending' for pending review; 'out_of_date' for contacts not updated in 365 days; 'out_of_date_90_days' for 90 days; 'new_contacts' for contacts created in the last 30 days; 'birthdays_all' or 'birthdays_only_mine' for today's birthdays; and 'my_contacts' for contacts owned by the requesting user."},{"name":"requesting_user_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Requesting user only","description":"Set to true when the user refers to their own contacts using phrases such as 'meus contatos', 'meus clientes', 'meus leads', or 'contatos que eu tenho'. When smart_list is omitted, this applies smart_list='my_contacts'. Do not set it when the user asks about another manager's contacts."},"description":"Set to true when the user refers to their own contacts using phrases such as 'meus contatos', 'meus clientes', 'meus leads', or 'contatos que eu tenho'. When smart_list is omitted, this applies smart_list='my_contacts'. Do not set it when the user asks about another manager's contacts."},{"name":"create_period","in":"query","required":false,"schema":{"anyOf":[{"enum":["today","this_week","this_month","last_month","last_three_months","current_year","last_year"],"type":"string"},{"type":"null"}],"title":"Creation period","description":"Filter by contact creation date. Allowed values: 'today', 'this_week', 'this_month', 'last_month', 'last_three_months', 'current_year', and 'last_year'. Example: 'contatos criados esta semana' → create_period='this_week'."},"description":"Filter by contact creation date. Allowed values: 'today', 'this_week', 'this_month', 'last_month', 'last_three_months', 'current_year', and 'last_year'. Example: 'contatos criados esta semana' → create_period='this_week'."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pagination cursor","description":"Opaque pagination cursor. Send it only when a cursor was supplied by external context; do not invent one or send it on the first request. The current MCP tool response does not expose the next cursor."},"description":"Opaque pagination cursor. Send it only when a cursor was supplied by external context; do not invent one or send it on the first request. The current MCP tool response does not expose the next cursor."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Contacts Tools"],"summary":"Create Contact","description":"Create a person or organization contact in the CRM. Provide fullname or firstname for a person, or organization_name for an organization. The contact type is inferred when omitted. If no manager or tags are provided, assigns the requesting user and the 'contact' tag. Write operation: creates a contact.","operationId":"mcp_tool_create_contact","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/contact/{contact_code}":{"put":{"tags":["Contacts Tools"],"summary":"Update Contact","description":"Update a person or organization identified by contact_code. If only a name, email, phone, CPF, or CNPJ is known, use search_contacts first to obtain the code required by the path. Selector fields such as contact_email identify the record; fields such as email contain the new value. Only provided update fields are changed. Write operation: modifies a contact.","operationId":"mcp_tool_update_contact","parameters":[{"name":"contact_code","in":"path","required":true,"schema":{"type":"string","title":"Contact code","description":"Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts."},"description":"Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Contacts Tools"],"summary":"Delete Contact","description":"Delete a contact identified by contact_code. If only a name, email, phone, CPF, or CNPJ is known, use search_contacts first to obtain the code required by the path. This action is irreversible and requires explicit user confirmation. Write operation: deletes a contact.","operationId":"mcp_tool_delete_contact","parameters":[{"name":"contact_code","in":"path","required":true,"schema":{"type":"string","title":"Contact code","description":"Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts. The action is irreversible and requires explicit user confirmation."},"description":"Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts. The action is irreversible and requires explicit user confirmation."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Exact email, case-insensitive."},"description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Exact email, case-insensitive."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. It must identify exactly one person or organization."},"description":"Fallback selector for the existing contact, used only when contact_code does not resolve. It must identify exactly one person or organization."},{"name":"contact_phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Formatting is ignored and the phone must contain at least eight digits."},"description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Formatting is ignored and the phone must contain at least eight digits."},{"name":"contact_legal_identification","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact legal identification selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Accepts CPF or CNPJ with or without formatting."},"description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Accepts CPF or CNPJ with or without formatting."}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/timelines":{"get":{"tags":["Timeline Tools"],"summary":"Search Timeline Items","description":"Find historical activity attached to a person, organization, property, active lease, or deal/card. Requires an identifier for the parent entity and returns up to 50 recent items. Use search_calendars for scheduled or future calendar items. Read-only.","operationId":"mcp_tool_search_timelines","parameters":[{"name":"parent_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["person","organization","property","lease","deal"],"type":"string"},{"type":"null"}],"title":"Parent entity type","description":"Type of entity whose timeline will be searched. It may be inferred when identifiers are provided for exactly one entity category. For lease, provide a property identifier so the tool can find its active lease."},"description":"Type of entity whose timeline will be searched. It may be inferred when identifiers are provided for exactly one entity category. For lease, provide a property identifier so the tool can find its active lease."},{"name":"contact_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Partial or complete name of a person or organization."},"description":"Partial or complete name of a person or organization."},{"name":"contact_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Exact contact email address, matched case-insensitively."},"description":"Exact contact email address, matched case-insensitively."},{"name":"contact_phone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Contact phone number; common formatting variations are accepted."},"description":"Contact phone number; common formatting variations are accepted."},{"name":"contact_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Public CRM contact code, for example 289 or C-289."},"description":"Public CRM contact code, for example 289 or C-289."},{"name":"property_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property code","description":"Complete public property code, for example AP-001."},"description":"Complete public property code, for example AP-001."},{"name":"property_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property address","description":"Partial or complete property address used to resolve the parent property."},"description":"Partial or complete property address used to resolve the parent property."},{"name":"deal_code","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numeric deal code","description":"Numeric deal/card code, for example 653. Provide pipeline_group_name with a numeric code. Use deal_code_raw instead when the code includes a prefix."},"description":"Numeric deal/card code, for example 653. Provide pipeline_group_name with a numeric code. Use deal_code_raw instead when the code includes a prefix."},{"name":"deal_code_raw","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Complete deal code","description":"Deal/card code exactly as provided, for example VL-1491, AVA-12, or 653. Use this field for a prefixed code and preserve the prefix and hyphen. The tool resolves its pipeline automatically; do not split it into deal_code and pipeline_group_name."},"description":"Deal/card code exactly as provided, for example VL-1491, AVA-12, or 653. Use this field for a prefixed code and preserve the prefix and hyphen. The tool resolves its pipeline automatically; do not split it into deal_code and pipeline_group_name."},{"name":"pipeline_group_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Display name of the deal/card pipeline. Provide it with a numeric deal_code; omit it when deal_code_raw contains a prefixed code."},"description":"Display name of the deal/card pipeline. Provide it with a numeric deal_code; omit it when deal_code_raw contains a prefixed code."},{"name":"timeline_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","note","email","task","call","visit","whatsapp","deal","lead","system","document","property_review","lease_status","checklist","association","revision","property_reserve"],"type":"string"},{"type":"null"}],"title":"Timeline item type","description":"Filter by timeline item type. Omit it or use all to return every type."},"description":"Filter by timeline item type. Omit it or use all to return every type."},{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content search","description":"Phrase-prefix search across item content, title, and description. Use an excerpt that appears at the beginning of the relevant phrase."},"description":"Phrase-prefix search across item content, title, and description. Use an excerpt that appears at the beginning of the relevant phrase."},{"name":"start_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start date","description":"Inclusive start date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing."},"description":"Inclusive start date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing."},{"name":"end_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End date","description":"Inclusive end date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing."},"description":"Inclusive end date in YYYY-MM-DD format. Provide both start_at and end_at; the date filter is not applied when either boundary is missing."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pagination cursor","description":"Cursor returned by the previous search response for the next page."},"description":"Cursor returned by the previous search response for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Timeline Tools"],"summary":"Create Timeline Item","description":"Create a note or checklist in the timeline of a person, organization, property, active lease, or deal/card. Provide content for a note, or title and at least one named checklist item for a checklist. The item must be linked to a parent entity. Write operation: creates a timeline item.","operationId":"mcp_tool_create_timeline","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineCreateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"put":{"tags":["Timeline Tools"],"summary":"Update Timeline Item","description":"Update a note or checklist selected by its parent entity, a content or title excerpt, and an optional creation date. The selector must resolve exactly one item; ambiguous matches return options for refinement. System-generated timeline items are read-only. Write operation: modifies a timeline item.","operationId":"mcp_tool_update_timeline","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineUpdateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Timeline Tools"],"summary":"Delete Timeline Item","description":"Delete a note or checklist selected by its parent entity, a content or title excerpt, and an optional creation date. The selector must resolve exactly one item; ambiguous matches return options for refinement. This action is irreversible and requires explicit user confirmation. Write operation: deletes a timeline item.","operationId":"mcp_tool_delete_timeline","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimelineDeleteParams"}}}},"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/properties":{"get":{"tags":["Property Tools"],"summary":"Search Properties","description":"Find and list properties by code, address, characteristics, price ceiling, finality, registered property type, status, or responsible listing broker. Without a custom limit, returns up to 10 properties per page. Read-only.","operationId":"mcp_tool_search_properties","parameters":[{"name":"search_text","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"General search","description":"Free-text search across the property index, including address, neighborhood, city, code, and description. Use this for a free-form phrase or a city without a neighborhood. Do not combine it with property_address or neighborhood."},"description":"Free-text search across the property index, including address, neighborhood, city, code, and description. Use this for a free-form phrase or a city without a neighborhood. Do not combine it with property_address or neighborhood."},{"name":"property_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property code","description":"Exact public property code. Preserve the complete value, for example AP-001."},"description":"Exact public property code. Preserve the complete value, for example AP-001."},{"name":"property_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property address","description":"Partial or complete street address, with or without a number. Use it for a logradouro such as 'Avenida Paulista', 'Av. Paulista, 1000', or 'Rua Augusta, 200'. Do not also send search_text."},"description":"Partial or complete street address, with or without a number. Use it for a logradouro such as 'Avenida Paulista', 'Av. Paulista, 1000', or 'Rua Augusta, 200'. Do not also send search_text."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["available","pending","rented","reserved","solded","with_proposal","solded_by_third_parties","rented_by_third_parties","suspended"],"type":"string"},{"type":"null"}],"title":"Property status","description":"Property status filter: available, pending, rented, reserved, solded, with_proposal, solded_by_third_parties, rented_by_third_parties, or suspended."},"description":"Property status filter: available, pending, rented, reserved, solded, with_proposal, solded_by_third_parties, rented_by_third_parties, or suspended."},{"name":"interest","in":"query","required":false,"schema":{"anyOf":[{"enum":["buy","rent","vacation_rental"],"type":"string"},{"type":"null"}],"title":"Commercial interest","description":"Transaction filter. Map 'comprar', 'compra', 'venda', or 'à venda' to buy; 'alugar', 'aluguel', or 'locação' to rent; and 'temporada' or 'diária' to vacation_rental. Omit this field when the user provides only a monetary value, so value searches sale and rental prices. The value filter is not applied with vacation_rental."},"description":"Transaction filter. Map 'comprar', 'compra', 'venda', or 'à venda' to buy; 'alugar', 'aluguel', or 'locação' to rent; and 'temporada' or 'diária' to vacation_rental. Omit this field when the user provides only a monetary value, so value searches sale and rental prices. The value filter is not applied with vacation_rental."},{"name":"finality","in":"query","required":false,"schema":{"anyOf":[{"enum":["residential","commercial","rural"],"type":"string"},{"type":"null"}],"title":"Property finality","description":"Usage classification: residential, commercial, or rural. Send it only when the user states the finality; do not infer it during search because incorrectly classified records could be excluded."},"description":"Usage classification: residential, commercial, or rural. Send it only when the user states the finality; do not infer it during search because incorrectly classified records could be excluded."},{"name":"property_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property type","description":"Property type from the account-specific catalog, for example 'Apartamento', 'Casa de Condomínio', or 'Chácara'. The tool accepts registered labels, normalized names, and common Portuguese or English aliases. An unknown type returns the available registered options before the search is executed."},"description":"Property type from the account-specific catalog, for example 'Apartamento', 'Casa de Condomínio', or 'Chácara'. The tool accepts registered labels, normalized names, and common Portuguese or English aliases. An unknown type returns the available registered options before the search is executed."},{"name":"smart_list","in":"query","required":false,"schema":{"anyOf":[{"enum":["all","available","my_properties","site_publish","site_no_publish","pending","inactives","without_photos","reserved","rented","solded","vacation_rental","sale","rent","without_location"],"type":"string"},{"type":"null"}],"title":"Smart list","description":"Preconfigured property list: all, available, my_properties, site_publish, site_no_publish, pending, inactives, without_photos, reserved, rented, solded, vacation_rental, sale, rent, or without_location. Use my_properties for 'meus imóveis'; use site_publish for 'publicados no site'."},"description":"Preconfigured property list: all, available, my_properties, site_publish, site_no_publish, pending, inactives, without_photos, reserved, rented, solded, vacation_rental, sale, rent, or without_location. Use my_properties for 'meus imóveis'; use site_publish for 'publicados no site'."},{"name":"requesting_user_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Requesting user's properties only","description":"Set to true when the user refers to their own properties using self-referential language: 'meus imóveis', 'minha carteira de imóveis', 'imóveis que eu tenho', or 'meus apartamentos'. When no explicit smart_list is provided, true is equivalent to smart_list='my_properties'. An explicit smart_list takes precedence. Do not use this for another broker, such as 'imóveis do corretor João'."},"description":"Set to true when the user refers to their own properties using self-referential language: 'meus imóveis', 'minha carteira de imóveis', 'imóveis que eu tenho', or 'meus apartamentos'. When no explicit smart_list is provided, true is equivalent to smart_list='my_properties'. An explicit smart_list takes precedence. Do not use this for another broker, such as 'imóveis do corretor João'."},{"name":"neighborhood","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood","description":"Neighborhood name, for example 'Santo Amaro', 'Pinheiros', or 'Ipanema'. Use property_address for a street or avenue. When city is also provided, the tool searches the combined neighborhood and city text. Do not also send search_text."},"description":"Neighborhood name, for example 'Santo Amaro', 'Pinheiros', or 'Ipanema'. Use property_address for a street or avenue. When city is also provided, the tool searches the combined neighborhood and city text. Do not also send search_text."},{"name":"city","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City used together with neighborhood, for example 'São Paulo' or 'Curitiba'. The structured search does not apply city by itself; for a city-only request, put the city in search_text."},"description":"City used together with neighborhood, for example 'São Paulo' or 'Curitiba'. The structured search does not apply city by itself; for a city-only request, put the city in search_text."},{"name":"bedroom_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum bedrooms","description":"Minimum number of bedrooms. Map 'apartamento com 2 dormitórios', 'a partir de 2 quartos', or 'pelo menos 2 quartos' to bedroom_min=2."},"description":"Minimum number of bedrooms. Map 'apartamento com 2 dormitórios', 'a partir de 2 quartos', or 'pelo menos 2 quartos' to bedroom_min=2."},{"name":"bedroom_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum bedrooms","description":"Maximum number of bedrooms. Combine with bedroom_min for a range. For 'exatamente 2 quartos', set both bedroom_min and bedroom_max to 2."},"description":"Maximum number of bedrooms. Combine with bedroom_min for a range. For 'exatamente 2 quartos', set both bedroom_min and bedroom_max to 2."},{"name":"suite_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum suites","description":"Minimum number of suites. Map 'pelo menos 1 suíte' or 'de preferência uma suíte' to suite_min=1."},"description":"Minimum number of suites. Map 'pelo menos 1 suíte' or 'de preferência uma suíte' to suite_min=1."},{"name":"suite_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum suites","description":"Maximum number of suites. Combine with suite_min to define a range."},"description":"Maximum number of suites. Combine with suite_min to define a range."},{"name":"bathroom_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum bathrooms","description":"Minimum number of bathrooms. Use for requests such as 'com 2 banheiros' or 'pelo menos 2 banheiros'."},"description":"Minimum number of bathrooms. Use for requests such as 'com 2 banheiros' or 'pelo menos 2 banheiros'."},{"name":"garage_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum parking spaces","description":"Minimum number of parking spaces. Use for requests such as '2 vagas de garagem' or 'com garagem'."},"description":"Minimum number of parking spaces. Use for requests such as '2 vagas de garagem' or 'com garagem'."},{"name":"floor_min","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum floor","description":"Minimum unit floor. Map 'acima do 15º andar' to floor_min=16 and 'a partir do 10º andar' to floor_min=10."},"description":"Minimum unit floor. Map 'acima do 15º andar' to floor_min=16 and 'a partir do 10º andar' to floor_min=10."},{"name":"floor_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum floor","description":"Maximum unit floor. Map 'até o 5º andar' to floor_max=5."},"description":"Maximum unit floor. Map 'até o 5º andar' to floor_max=5."},{"name":"value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price ceiling","description":"Maximum monetary value. With interest='buy', applies sale_value <= value; with interest='rent', applies rental_value <= value; without interest, accepts either positive sale_value or rental_value up to this ceiling. A lower-bound price request is not supported. This filter is not applied to vacation_rental."},"description":"Maximum monetary value. With interest='buy', applies sale_value <= value; with interest='rent', applies rental_value <= value; without interest, accepts either positive sale_value or rental_value up to this ceiling. A lower-bound price request is not supported. This filter is not applied to vacation_rental."},{"name":"user_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker name","description":"Name of a specific listing broker used to filter properties. For the requesting user's own properties, use requesting_user_only=true."},"description":"Name of a specific listing broker used to filter properties. For the requesting user's own properties, use requesting_user_only=true."},{"name":"user_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker email","description":"Email of a specific listing broker used for a more precise filter. For the requesting user's own properties, use requesting_user_only=true."},"description":"Email of a specific listing broker used for a more precise filter. For the requesting user's own properties, use requesting_user_only=true."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","title":"Limit","description":"Maximum number of properties per page. Defaults to 10; allowed range is 1 to 50.","default":10},"description":"Maximum number of properties per page. Defaults to 10; allowed range is 1 to 50."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pagination cursor","description":"Cursor returned by the previous search response for the next page."},"description":"Cursor returned by the previous search response for the next page."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"post":{"tags":["Property Tools"],"summary":"Create Property","description":"Create a property. Requires address, city, state, neighborhood, property_type, and at least one of sale_value or rental_value. Put apartment, suite, block, or room details in address_complement and send monetary values as numbers. When no responsible broker is provided, assigns the requesting user. Write operation: creates a property.","operationId":"mcp_tool_create_property","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCreateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}},"/v1/mcp/tool/property/{property_code}":{"put":{"tags":["Property Tools"],"summary":"Update Property","description":"Update a property identified by property_code. If only its address or other details are known, use search_properties first to obtain the code required by the path. Only provided fields are changed; blank strings are ignored and do not clear existing values. Write operation: modifies a property.","operationId":"mcp_tool_update_property","parameters":[{"name":"property_code","in":"path","required":true,"schema":{"type":"string","title":"Property code","description":"Complete public code of the property to identify it for update or deletion. Preserve the value exactly, for example AP-001."},"description":"Complete public code of the property to identify it for update or deletion. Preserve the value exactly, for example AP-001."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}},"delete":{"tags":["Property Tools"],"summary":"Delete Property","description":"Delete a property identified by property_code. If only its address or other details are known, use search_properties first to obtain the code required by the path. This action is irreversible and requires explicit user confirmation. Write operation: deletes a property.","operationId":"mcp_tool_delete_property","parameters":[{"name":"property_code","in":"path","required":true,"schema":{"type":"string","title":"Property code","description":"Complete public code of the property to identify it for update or deletion. Preserve the value exactly, for example AP-001."},"description":"Complete public code of the property to identify it for update or deletion. Preserve the value exactly, for example AP-001."}],"responses":{"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Bad request","description":"Bad request"}}}}}},"401":{"description":"Not Authorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Authorized","description":"Not Authorized"}}}}}},"403":{"description":"Not permitted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not permitted","description":"Not permitted"}}}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Not Found","description":"Not Found"}}}}}}}}}},"components":{"schemas":{"AccountFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"AccountFieldsSchema"},"AccountTCSSchema":{"properties":{"agency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agency"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"account_number_dv":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number Dv"},"beneficiary_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Beneficiary Code"},"company_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Code"}},"type":"object","title":"AccountTCSSchema"},"AnalyticsSiteSchema":{"properties":{"yesterday":{"type":"integer","title":"Yesterday"},"monthly":{"type":"integer","title":"Monthly"},"quarterly":{"type":"integer","title":"Quarterly"},"active_now":{"type":"integer","title":"Active Now"}},"type":"object","required":["yesterday","monthly","quarterly","active_now"],"title":"AnalyticsSiteSchema"},"AnnualReadjustmentSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the annual readjustment"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"ID intern of the annual readjustment in database"}},"type":"object","title":"AnnualReadjustmentSchema"},"ArkisAgentAskSchema":{"properties":{"input_ask":{"type":"string","title":"Input Ask"},"provider":{"type":"string","enum":["openai","google","meta"],"title":"Provider","default":"openai"},"model":{"type":"string","title":"Model","default":"gpt-6-luna"},"mcp_config":{"additionalProperties":true,"type":"object","title":"Mcp Config"},"tts":{"anyOf":[{"$ref":"#/components/schemas/ArkisTTSAskSchema"},{"type":"null"}]},"reasoning_effort":{"anyOf":[{"type":"string","enum":["low","medium","high"]},{"type":"null"}],"title":"Reasoning Effort"},"web_search":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Web Search"},"stream_events":{"items":{"type":"string","enum":["steps","reasoning"]},"type":"array","title":"Stream Events"},"context":{"items":{"$ref":"#/components/schemas/ArkisContextItemSchema"},"type":"array","maxItems":10,"title":"Context"},"instruction":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Instruction"},"voice":{"anyOf":[{"$ref":"#/components/schemas/ArkisVoiceAskSchema"},{"type":"null"}]}},"type":"object","required":["input_ask"],"title":"ArkisAgentAskSchema"},"ArkisChatSessionCreateSchema":{"properties":{"title":{"type":"string","title":"Title"}},"type":"object","required":["title"],"title":"ArkisChatSessionCreateSchema"},"ArkisContextItemSchema":{"properties":{"kind":{"type":"string","enum":["contact","organization","property","deal","lease","contract","invoice"],"title":"Kind"},"code":{"type":"string","maxLength":64,"minLength":1,"title":"Code"},"title":{"anyOf":[{"type":"string","maxLength":160},{"type":"null"}],"title":"Title"}},"type":"object","required":["kind","code"],"title":"ArkisContextItemSchema","description":"CRM record the user is looking at or cited with ``@``."},"ArkisFeedbackSchema":{"properties":{"rating":{"type":"string","enum":["up","down"],"title":"Rating"},"reasons":{"items":{"type":"string","enum":["incorrect","ignored_data","incomplete","slow","other"]},"type":"array","maxItems":5,"title":"Reasons"},"comment":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Comment"}},"type":"object","required":["rating"],"title":"ArkisFeedbackSchema"},"ArkisImageRequestSchema":{"properties":{"prompt":{"type":"string","minLength":1,"title":"Prompt"},"mode":{"type":"string","enum":["generate","edit"],"title":"Mode","default":"generate"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"image_ref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Ref"},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"provider":{"anyOf":[{"type":"string","enum":["openai","google","meta"]},{"type":"null"}],"title":"Provider"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"}},"type":"object","required":["prompt"],"title":"ArkisImageRequestSchema","description":"Generate or edit an image through the Arkis Agents SDK flow."},"ArkisLLMKeyConfigSchema":{"properties":{"key":{"type":"string","title":"Key","default":""},"active":{"type":"boolean","title":"Active","default":false}},"type":"object","title":"ArkisLLMKeyConfigSchema","description":"Provider patch; defaults initialize new providers, omitted fields preserve existing values."},"ArkisLLMKeysConfigSchema":{"properties":{"google":{"anyOf":[{"$ref":"#/components/schemas/ArkisLLMKeyConfigSchema"},{"type":"null"}]},"openai":{"anyOf":[{"$ref":"#/components/schemas/ArkisLLMKeyConfigSchema"},{"type":"null"}]},"meta":{"anyOf":[{"$ref":"#/components/schemas/ArkisLLMKeyConfigSchema"},{"type":"null"}]}},"type":"object","title":"ArkisLLMKeysConfigSchema"},"ArkisRewindSchema":{"properties":{"after_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After Message Id"}},"type":"object","title":"ArkisRewindSchema","description":"Keep the conversation up to ``after_message_id``; ``None`` clears it."},"ArkisTTSAskSchema":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"voice":{"type":"string","title":"Voice","default":"pt-BR-FranciscaNeural"}},"type":"object","title":"ArkisTTSAskSchema"},"ArkisVoiceAskSchema":{"properties":{"call_id":{"type":"string","maxLength":200,"minLength":1,"title":"Call Id","description":"Realtime call that delegated the question"},"display_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Input","description":"Transcribed speech saved as the user message, cut at 4000 characters"},"history_limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"History Limit","description":"Maximum agent items read from the history","default":40}},"type":"object","required":["call_id"],"title":"ArkisVoiceAskSchema","description":"Question delegated by a voice call."},"ArkisVoiceCallSchema":{"properties":{"call_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Call Id"}},"type":"object","required":["call_id"],"title":"ArkisVoiceCallSchema"},"ArkisVoiceEndSchema":{"properties":{"call_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Call Id"},"reason":{"type":"string","enum":["user","inactivity","background","minimized","switched","closed","max_duration","limit","error"],"title":"Reason","default":"user"}},"type":"object","required":["call_id"],"title":"ArkisVoiceEndSchema"},"ArkisVoiceSessionSchema":{"properties":{"sdp":{"type":"string","maxLength":50000,"minLength":1,"title":"Sdp","description":"SDP offer"},"voice":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Voice","description":"Realtime voice; unknown ones fall back to marin"},"context":{"items":{"$ref":"#/components/schemas/ArkisContextItemSchema"},"type":"array","maxItems":10,"title":"Context"}},"type":"object","required":["sdp"],"title":"ArkisVoiceSessionSchema","description":"WebRTC offer that opens a Realtime call for the chat session."},"ArkisVoiceTurnSchema":{"properties":{"item_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Item Id"},"role":{"type":"string","enum":["user","assistant"],"title":"Role"},"content":{"type":"string","maxLength":10000,"title":"Content","default":""},"at":{"type":"string","format":"date-time","title":"At"},"interrupted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interrupted"},"previous_item_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Previous Item Id"}},"type":"object","required":["item_id","role","at"],"title":"ArkisVoiceTurnSchema","description":"One transcribed turn of the call."},"ArkisVoiceTurnsSchema":{"properties":{"call_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Call Id"},"turns":{"items":{"$ref":"#/components/schemas/ArkisVoiceTurnSchema"},"type":"array","maxItems":50,"minItems":1,"title":"Turns"}},"type":"object","required":["call_id","turns"],"title":"ArkisVoiceTurnsSchema"},"AssignorSchema":{"properties":{"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"trading_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trading Name"},"cpf_cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf Cnpj"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"address_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Number"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"}},"type":"object","title":"AssignorSchema"},"AttachmentsFieldsSchema":{"properties":{"attachment_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Attachment Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"file_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Type"},"size":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Size"},"blob_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key"}},"type":"object","title":"AttachmentsFieldsSchema"},"BankDataSchema":{"properties":{"bank_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Bank Id","description":"Unique identifier of the bank."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action to be performed, such as create, update, or delete."},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique identifier of the record."},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name","description":"Name of the bank."},"organization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization Id","description":"Unique identifier of the organization associated with the bank account."},"person_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Person Id","description":"Unique identifier of the person associated with the bank account."},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account","description":"Bank account number."},"agency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agency","description":"Bank branch (agency) number."},"account_type":{"anyOf":[{"enum":["checking_account","savings_account",null]},{"type":"null"}],"title":"Account Type","description":"Type of the bank account. Can be 'checking_account' or 'savings_account'."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes","description":"Additional notes or remarks related to the bank account."}},"type":"object","title":"BankDataSchema","description":"Bank Data fields"},"BankFeePJBankSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"BankFeePJBankSchema"},"BanksFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"ID intern of the bank in the database. Required for create"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code of the bank. Required for create","examples":["001"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Bank name. Required for create","examples":["Banco do Brasil"]},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Url","description":"URL of the bank logo"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id","description":"ID intern or alternative ID of the bank in the database"}},"type":"object","title":"BanksFieldsSchema"},"BannerSectionSchema":{"properties":{"background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Background"},"main_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Image"},"background_type":{"anyOf":[{"type":"string","enum":["image","color"]},{"type":"null"}],"title":"Background Type"},"button_action":{"anyOf":[{"$ref":"#/components/schemas/CustomButtonSchema"},{"type":"null"}]},"text_locale":{"type":"string","enum":["left","right"],"title":"Text Locale"}},"type":"object","required":["text_locale"],"title":"BannerSectionSchema"},"Body_Process_multimodal_file__audio__PDF__image__v1_imobzi_ia_multimodal_process_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"},"extraction_hint":{"type":"string","title":"Extraction Hint"}},"type":"object","required":["file"],"title":"Body_Process_multimodal_file__audio__PDF__image__v1_imobzi_ia_multimodal_process_post"},"Body_Send_audio_v1_whatsapp_business_send_audio_post":{"properties":{"number":{"type":"string","title":"Number"},"phone_id":{"type":"string","title":"Phone Id"},"replied_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replied Message Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"uploadFile":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Uploadfile"}},"type":"object","required":["number","phone_id","account_business_id","uploadFile"],"title":"Body_Send_audio_v1_whatsapp_business_send_audio_post"},"Body_Send_media_v1_whatsapp_business_send_media_post":{"properties":{"number":{"type":"string","title":"Number"},"mediatype":{"type":"string","enum":["image","video","document"],"title":"Mediatype"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"phone_id":{"type":"string","title":"Phone Id"},"replied_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replied Message Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"uploadFile":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Uploadfile"}},"type":"object","required":["number","mediatype","phone_id","account_business_id","uploadFile"],"title":"Body_Send_media_v1_whatsapp_business_send_media_post"},"Body_Update_a_photo_in_property_v1_properties__property_id__photos__photo_id__put":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"}},"type":"object","title":"Body_Update_a_photo_in_property_v1_properties__property_id__photos__photo_id__put"},"Body_lease_agreement_v1_lease_agreement_post":{"properties":{"uuid":{"title":"Uuid"},"type_post":{"title":"Type Post"},"message":{"title":"Message"},"email":{"title":"Email"}},"type":"object","required":["uuid","type_post","message"],"title":"Body_lease_agreement_v1_lease_agreement_post"},"Body_prod_create_document_files":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"Upload file"}},"type":"object","required":["file"],"title":"Body_prod_create_document_files"},"Body_prod_create_property_photo":{"properties":{"uploadFile":{"type":"string","format":"binary","title":"Uploadfile"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"ignore_watermark":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Watermark"}},"type":"object","required":["uploadFile"],"title":"Body_prod_create_property_photo"},"BradescoTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"bradesco","title":"Name","default":"bradesco"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"certificate_pfx":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Pfx"},"certificate_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Password"},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"}},"type":"object","title":"BradescoTecnoSpeedSchema"},"BuildingByNameResponse":{"properties":{"rent_preview_income":{"type":"number","title":"Rent Preview Income"},"sale_preview_income":{"type":"number","title":"Sale Preview Income"},"sale_income":{"type":"number","title":"Sale Income"},"rent_income":{"type":"number","title":"Rent Income"},"units_status":{"items":{"$ref":"#/components/schemas/UnitsStatus"},"type":"array","title":"Units Status"},"units_grouped":{"items":{"$ref":"#/components/schemas/UnitsGrouped"},"type":"array","title":"Units Grouped"}},"type":"object","required":["rent_preview_income","sale_preview_income","sale_income","rent_income","units_status","units_grouped"],"title":"BuildingByNameResponse"},"BuildingBySearchResponse":{"properties":{"db_id":{"type":"string","title":"Db Id"},"name":{"type":"string","title":"Name"},"search":{"type":"string","title":"Search"},"code":{"type":"string","title":"Code"}},"type":"object","required":["db_id","name","search","code"],"title":"BuildingBySearchResponse"},"BuildingHighlightSchema":{"properties":{"bathroom":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"bedroom":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"building_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__site_pages_configuration__CoverPhotoSchema"},{"type":"null"}]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"exclusivity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exclusivity"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"garage":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"photos":{"anyOf":[{"items":{"$ref":"#/components/schemas/routers__schemas__site_pages_configuration__CoverPhotoSchema"},"type":"array"},{"type":"null"}],"title":"Photos","default":[]},"rental_value":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"sale_value":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"site_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Description"},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Title"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"suite":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]},"total_rental_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Rental Value"},"useful_area":{"anyOf":[{"$ref":"#/components/schemas/MinMaxSchema"},{"type":"null"}]}},"type":"object","title":"BuildingHighlightSchema"},"BuildingParametersSchema":{"properties":{"available":{"type":"integer","title":"Available"},"rented":{"type":"integer","title":"Rented"},"inactive":{"type":"integer","title":"Inactive"},"reserved":{"type":"integer","title":"Reserved"},"with_proposal":{"type":"integer","title":"With Proposal"},"total":{"type":"integer","title":"Total"},"pending":{"type":"integer","title":"Pending"},"solded":{"type":"integer","title":"Solded"}},"type":"object","required":["available","rented","inactive","reserved","with_proposal","total","pending","solded"],"title":"BuildingParametersSchema"},"CFAnalysisDealSchema":{"properties":{"deal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Key"},"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"CFAnalysisDealSchema"},"CFAnalysisFieldsSchema":{"properties":{"status":{"anyOf":[{"type":"string","enum":["draft","send_to_analysis","waiting_analysis","analysis_done","reanalyze"]},{"type":"null"}],"title":"Status"},"type":{"anyOf":[{"type":"string","enum":["fc_analise","custom_analysis"]},{"type":"null"}],"title":"Type"},"lease_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lease Value"},"condominium_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Condominium Value"},"iptu_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Iptu Value"},"total_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Value"},"suitors":{"items":{"$ref":"#/components/schemas/CFAnalysisSuitorFieldsSchema"},"type":"array","title":"Suitors","default":[]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"lease":{"anyOf":[{"$ref":"#/components/schemas/CFAnalysisLeaseSchema"},{"type":"null"}]},"property":{"anyOf":[{"$ref":"#/components/schemas/CFAnalysisPropertySchema"},{"type":"null"}]},"deal":{"anyOf":[{"$ref":"#/components/schemas/CFAnalysisDealSchema"},{"type":"null"}]},"report":{"anyOf":[{"$ref":"#/components/schemas/CFAnalysisReportSchema"},{"type":"null"}]}},"type":"object","title":"CFAnalysisFieldsSchema"},"CFAnalysisLeaseSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"CFAnalysisLeaseSchema"},"CFAnalysisPropertySchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"CFAnalysisPropertySchema"},"CFAnalysisReportSchema":{"properties":{"seem":{"type":"string","title":"Seem"},"recommendation":{"type":"string","title":"Recommendation"}},"type":"object","required":["seem","recommendation"],"title":"CFAnalysisReportSchema"},"CFAnalysisSuitorFieldsSchema":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"},"suitor_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Suitor Type"},"suitor_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suitor Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"document_valid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Document Valid"},"financial_profile":{"anyOf":[{"$ref":"#/components/schemas/SuitorFinancialProfileFieldsSchema"},{"type":"null"}]}},"type":"object","title":"CFAnalysisSuitorFieldsSchema"},"CalendarCreateParams":{"properties":{"title":{"type":"string","title":"Title","description":"Calendar item title (required)."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"Absolute start datetime in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). The informed clock time is interpreted in America/Sao_Paulo, with or without a suffix. Use ONLY when the user provides an explicit date (e.g. '03/06/2026 às 9h'). For relative expressions ('amanhã', 'hoje', 'próxima segunda') use relative_initial_date + initial_time instead. Either initial_date OR relative_initial_date must be provided."},"relative_initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relative Initial Date","description":"Relative day/date expression for the start date. The backend resolves this deterministically using current date/time in America/Sao_Paulo (no LLM guessing). Preferred canonical values: today, tomorrow, day_after_tomorrow, next_monday, next_tuesday, next_wednesday, next_thursday, next_friday, next_saturday, next_sunday, next_week, end_of_week, end_of_month, next_month_same_day. Also accepts natural Portuguese expressions like: 'amanhã', 'depois de amanhã', 'próxima segunda', 'segunda-feira', 'semana que vem', 'fim do mês', 'daqui a 2 dias às 8h30'. Use together with initial_time when the time is not included in this expression."},"initial_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Time","description":"Time component for the start datetime in HH:MM (24h) format. Use together with relative_initial_date. Examples: '09:00', '14:30', '8h' → '08:00', '9h' → '09:00'. If omitted, defaults to 09:00."},"final_date":{"type":"string","title":"Final Date","description":"End datetime in ISO 8601 format, interpreted as an America/Sao_Paulo wall-clock value."},"item_type":{"type":"string","title":"Item Type","description":"Calendar item type. Accepts the built-in values task, visit, call, or whatsapp, and active custom type names. Default: task. Visits require a contact and a property.","default":"task"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional calendar item description."},"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"Whether the item lasts all day."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Whether the item is already completed."},"status":{"anyOf":[{"type":"string","enum":["active","canceled"]},{"type":"null"}],"title":"Status","description":"Optional status: active or canceled."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Responsible user name. If neither user_name nor user_email is provided, the item is assigned to the requesting user."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email","description":"Responsible user email (exact match, preferred for disambiguation). If neither user_email nor user_name is provided, the item is assigned to the requesting user."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name","description":"Primary contact name for this item."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Email","description":"Primary contact email (preferred)."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Phone","description":"Primary contact phone number. Accepts flexible formatting with or without country code, area code, dashes and spaces."},"contact_legal_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Legal Identification","description":"Primary contact legal identification (CPF or CNPJ)."},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code","description":"Related property code."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address","description":"Related property address."},"notification_by":{"anyOf":[{"items":{"type":"string","enum":["email","whatsapp"]},"type":"array"},{"type":"null"}],"title":"Notification By","description":"Notification channels: email and/or whatsapp."},"show_observations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Observations","description":"Whether observations should be shown in communications."},"recurring":{"anyOf":[{"$ref":"#/components/schemas/CalendarRecurringParams"},{"type":"null"}],"description":"Recurrence configuration."},"deal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Code","description":"Optional deal code to link, in numeric or prefixed format, such as 653 or VEN-653. For a numeric code, also provide pipeline_group_name."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Name","description":"Pipeline group name. Provide it when deal_code is numeric; omit it when the code already contains a pipeline prefix."}},"type":"object","required":["title"],"title":"CalendarCreateParams","description":"Define calendar create parameters."},"CalendarDeleteParams":{"properties":{"selector":{"$ref":"#/components/schemas/CalendarSelectorParams","description":"Human-friendly selector to identify the calendar item."},"apply_scope":{"anyOf":[{"type":"string","enum":["this","next","all"]},{"type":"null"}],"title":"Apply Scope","description":"Scope for a recurring item: this deletes only the selected occurrence, next deletes the selected and following occurrences, and all deletes the entire series. Default: this.","default":"this"}},"type":"object","required":["selector"],"title":"CalendarDeleteParams","description":"Define calendar delete parameters."},"CalendarDigitalFieldsSchema":{"properties":{"initial_date":{"type":"string","title":"Initial Date"},"final_date":{"type":"string","title":"Final Date"},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation"},"event_type":{"type":"string","title":"Event Type"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"}},"type":"object","required":["initial_date","final_date","event_type","db_id"],"title":"CalendarDigitalFieldsSchema"},"CalendarPostSchema":{"properties":{"calendar":{"$ref":"#/components/schemas/CalendarSchema","description":"All values for create calendar include in, ex: {\n 'calendar': {item_type: 'task', initial_date: '2023-10-10T10:00:00+03:00', final_date: '2023-10-10T11:00:00+03:00', title: 'Meeting'}}"}},"type":"object","required":["calendar"],"title":"CalendarPostSchema"},"CalendarRecurringParams":{"properties":{"freq":{"anyOf":[{"type":"string","enum":["daily","weekly","monthly","yearly"]},{"type":"null"}],"title":"Freq","description":"Recurring frequency: daily, weekly, monthly, or yearly."},"interval":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interval","description":"Interval between occurrences. Default: 1.","default":1},"by_day":{"items":{"type":"string"},"type":"array","title":"By Day","description":"Weekdays for recurrence (for example: ['mo', 'we', 'fr'])."},"by_month":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"By Month","description":"Month for yearly recurrence (for example: '1' for January)."},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count","description":"Number of occurrences."},"until":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Until","description":"Recurrence end date in ISO 8601 format."}},"type":"object","title":"CalendarRecurringParams","description":"Define calendar recurring parameters."},"CalendarReminderSchema":{"properties":{"whatsapp_account_id":{"type":"string","title":"Whatsapp Account Id"},"whatsapp_chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Whatsapp Chat Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"template_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Name"},"body_variables":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Body Variables","default":[]},"button_variables":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Button Variables","default":[]}},"type":"object","required":["whatsapp_account_id"],"title":"CalendarReminderSchema"},"CalendarSchema":{"properties":{"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"Indicates if the event lasts the whole day. Optional."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the item or event. Optional."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Marks the item as completed. Optional."},"google_calendar_event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Google Calendar Event Id","description":"Google Calendar event ID. Used for syncing. Optional."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"Start date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date","description":"End date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item."},"notification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notification","description":"Text or configuration for a notification. Optional."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title or name of the item. Optional but recommended."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Item subtype (e.g. 'open_house', 'custom_type'). Optional."},"item_type":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Item Type","description":"Main type of the item. Required. Examples: 'task', 'visit', 'call', etc."},"parent":{"anyOf":[{"$ref":"#/components/schemas/ParentSchema"},{"type":"null"}],"description":"Linked parent entity (e.g. deal or contact). Optional."},"user":{"anyOf":[{"$ref":"#/components/schemas/UserProfileSchema"},{"type":"null"}],"description":"User responsible for this item. Optional (create with user in header if not send)."},"links_timeline":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinksTimelineSchema"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Links Timeline","description":"Related timeline links (objects or IDs). Optional.","default":[]},"contact_type":{"anyOf":[{"enum":[null,"person","lead","organization"]},{"type":"null"}],"title":"Contact Type","description":"Type of contact related to the item. Optional."},"timezone":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Timezone","description":"Timezone offset used for date/time fields (e.g. '+3' or '+03:00'). Optional but important for correct scheduling."},"location":{"anyOf":[{"$ref":"#/components/schemas/GeoLocationSchema"},{"items":{"type":"number"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Location","description":"Geographic location of the item. Optional. Can be object, coordinates or address string."},"notification_by":{"items":{"type":"string"},"type":"array","title":"Notification By","description":"Channels to send notification (e.g. ['email', 'push']). Optional."},"send_by":{"anyOf":[{"items":{"type":"string","const":"whatsapp"},"type":"array"},{"type":"null"}],"title":"Send By","description":"Channels used to send this calendar item automatically.","default":[]},"show_observations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Observations","description":"If true, show internal notes or observations. Optional."},"recurring":{"anyOf":[{"$ref":"#/components/schemas/RecurringSchema"},{"type":"null"}],"description":"Recurring configuration for the item. Optional."},"reminder":{"anyOf":[{"$ref":"#/components/schemas/CalendarReminderSchema"},{"type":"null"}],"description":"WhatsApp chat reminder linked to this calendar item. Optional."},"recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recurring Id","description":"ID of the recurring item (if part of a series). Optional."},"group_recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Recurring Id","description":"ID for the group of recurring items. Optional."},"original_recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Recurring Id","description":"Original ID from which this recurring item was created. Optional."},"guests":{"items":{"$ref":"#/components/schemas/GuestsSchema"},"type":"array","title":"Guests","description":"List of guests invited to the item. Optional.","default":[]},"properties":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParentSchema"},{"$ref":"#/components/schemas/PropertyDigitalFieldsSchema"}]},"type":"array","title":"Properties","description":"Related properties. Required only if item_type is 'visit'.","default":[]},"calendar_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Calendar Id","description":"ID of the calendar associated with this item. Optional."},"address":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Address","description":"Address related to the item. Optional."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the item (e.g. 'confirmed', 'canceled'). Optional."},"resend_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resend Notification","description":"If true, forces notification to be sent again. Optional."},"properties_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Properties In Data","default":false}},"type":"object","required":["item_type"],"title":"CalendarSchema"},"CalendarSelectorParams":{"properties":{"title":{"type":"string","title":"Title","description":"Calendar item title used with initial_date to identify the item. The title is matched as a phrase."},"initial_date":{"type":"string","title":"Initial Date","description":"Reference date or datetime in ISO 8601 format. It is interpreted in America/Sao_Paulo and matched at calendar-day precision."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Optional user filter for disambiguation."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email","description":"Optional user email filter for disambiguation."},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type","description":"Optional item type filter for disambiguation."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name","description":"Optional contact name filter for disambiguation."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Email","description":"Optional contact email filter for disambiguation."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Phone","description":"Optional contact phone filter for disambiguation."},"contact_legal_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Legal Identification","description":"Optional contact legal identification filter for disambiguation."},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code","description":"Optional property code filter for disambiguation."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address","description":"Optional property address filter for disambiguation."}},"type":"object","required":["title","initial_date"],"title":"CalendarSelectorParams","description":"Define calendar selector parameters."},"CalendarTypeCreateSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the calendar type","examples":["Holiday"]},"icon":{"type":"string","title":"Icon","description":"Icon of the calendar type","examples":["🎉"]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is the calendar type active?","default":true}},"type":"object","required":["name","icon"],"title":"CalendarTypeCreateSchema"},"CalendarTypeUpdateSchema":{"properties":{"name":{"type":"string","title":"Name"},"icon":{"type":"string","title":"Icon"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","required":["name","icon"],"title":"CalendarTypeUpdateSchema"},"CalendarUpdateFieldsParams":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"New title."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"New description."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"New start datetime in America/Sao_Paulo wall-clock ISO 8601."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date","description":"New end datetime in America/Sao_Paulo wall-clock ISO 8601."},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type","description":"New item type."},"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"New all_day value."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"New done value."},"status":{"anyOf":[{"type":"string","enum":["active","canceled"]},{"type":"null"}],"title":"Status","description":"New status: active or canceled."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"New responsible user name."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email","description":"New responsible user email (exact match, preferred for disambiguation)."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name","description":"New primary contact name."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Email","description":"New primary contact email."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Phone","description":"New primary contact phone number."},"contact_legal_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Legal Identification","description":"New primary contact legal identification (CPF or CNPJ)."},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code","description":"New related property by code."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address","description":"New related property by address."},"notification_by":{"anyOf":[{"items":{"type":"string","enum":["email","whatsapp"]},"type":"array"},{"type":"null"}],"title":"Notification By","description":"New notification channels."},"show_observations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Observations","description":"New show_observations value."},"recurring":{"anyOf":[{"$ref":"#/components/schemas/CalendarRecurringParams"},{"type":"null"}],"description":"Recurrence update when applicable."},"deal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Code","description":"New linked deal code in numeric or prefixed format, such as 653 or VEN-653. For a numeric code, also provide pipeline_group_name. Send an empty string to remove the current deal link."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Name","description":"Pipeline group name. Provide it when deal_code is numeric; omit it when the code already contains a pipeline prefix."},"resend_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resend Notification","description":"Resend notification when applicable."}},"type":"object","title":"CalendarUpdateFieldsParams","description":"Define calendar update fields parameters."},"CalendarUpdateParams":{"properties":{"selector":{"$ref":"#/components/schemas/CalendarSelectorParams","description":"Human-friendly selector to identify the calendar item."},"updates":{"$ref":"#/components/schemas/CalendarUpdateFieldsParams","description":"Fields to update."},"apply_scope":{"anyOf":[{"type":"string","enum":["this","next","all"]},{"type":"null"}],"title":"Apply Scope","description":"Scope for a recurring item: this changes only the selected occurrence, next changes the selected and following occurrences, and all changes the entire series. Default: this.","default":"this"}},"type":"object","required":["selector","updates"],"title":"CalendarUpdateParams","description":"Define calendar update parameters."},"CalendarUpdateRouterSchema":{"properties":{"calendar":{"anyOf":[{"$ref":"#/components/schemas/CalendarUpdateSchema"},{"type":"null"}]}},"type":"object","title":"CalendarUpdateRouterSchema"},"CalendarUpdateSchema":{"properties":{"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"Indicates if the event lasts the whole day. Optional."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the item or event. Optional."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Marks the item as completed. Optional."},"google_calendar_event_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Google Calendar Event Id","description":"Google Calendar event ID. Used for syncing. Optional."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"Start date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date","description":"End date and time in ISO format. Must include +3 hours offset (UTC+3). Required when creating the item."},"notification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notification","description":"Text or configuration for a notification. Optional."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title or name of the item. Optional but recommended."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Item subtype (e.g. 'open_house', 'custom_type'). Optional."},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ParentSchema"},{"type":"null"}],"description":"Linked parent entity (e.g. deal or contact). Optional."},"user":{"anyOf":[{"$ref":"#/components/schemas/UserProfileSchema"},{"type":"null"}],"description":"User responsible for this item. Optional (create with user in header if not send)."},"links_timeline":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinksTimelineSchema"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Links Timeline","description":"Related timeline links (objects or IDs). Optional.","default":[]},"contact_type":{"anyOf":[{"enum":[null,"person","lead","organization"]},{"type":"null"}],"title":"Contact Type","description":"Type of contact related to the item. Optional."},"timezone":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Timezone","description":"Timezone offset used for date/time fields (e.g. '+3' or '+03:00'). Optional but important for correct scheduling."},"location":{"anyOf":[{"$ref":"#/components/schemas/GeoLocationSchema"},{"items":{"type":"number"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Location","description":"Geographic location of the item. Optional. Can be object, coordinates or address string."},"notification_by":{"items":{"type":"string"},"type":"array","title":"Notification By","description":"Channels to send notification (e.g. ['email', 'push']). Optional."},"send_by":{"anyOf":[{"items":{"type":"string","const":"whatsapp"},"type":"array"},{"type":"null"}],"title":"Send By","description":"Channels used to send this calendar item automatically.","default":[]},"show_observations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Observations","description":"If true, show internal notes or observations. Optional."},"recurring":{"anyOf":[{"$ref":"#/components/schemas/RecurringSchema"},{"type":"null"}],"description":"Recurring configuration for the item. Optional."},"reminder":{"anyOf":[{"$ref":"#/components/schemas/CalendarReminderSchema"},{"type":"null"}],"description":"WhatsApp chat reminder linked to this calendar item. Optional."},"recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recurring Id","description":"ID of the recurring item (if part of a series). Optional."},"group_recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Recurring Id","description":"ID for the group of recurring items. Optional."},"original_recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Recurring Id","description":"Original ID from which this recurring item was created. Optional."},"guests":{"items":{"$ref":"#/components/schemas/GuestsSchema"},"type":"array","title":"Guests","description":"List of guests invited to the item. Optional.","default":[]},"properties":{"items":{"anyOf":[{"$ref":"#/components/schemas/ParentSchema"},{"$ref":"#/components/schemas/PropertyDigitalFieldsSchema"}]},"type":"array","title":"Properties","description":"Related properties. Required only if item_type is 'visit'.","default":[]},"calendar_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Calendar Id","description":"ID of the calendar associated with this item. Optional."},"address":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Address","description":"Address related to the item. Optional."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the item (e.g. 'confirmed', 'canceled'). Optional."},"resend_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resend Notification","description":"If true, forces notification to be sent again. Optional."},"properties_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Properties In Data","default":false}},"type":"object","title":"CalendarUpdateSchema"},"CancelInsuranceRouterSchema":{"properties":{"insurance_id":{"type":"integer","title":"Insurance Id"},"lease_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Lease Id"}},"type":"object","required":["insurance_id","lease_id"],"title":"CancelInsuranceRouterSchema"},"CategoriesPJBankSchema":{"properties":{"bank_fee":{"anyOf":[{"$ref":"#/components/schemas/BankFeePJBankSchema"},{"type":"null"}]}},"type":"object","title":"CategoriesPJBankSchema"},"ChatConversations":{"properties":{"session_id":{"type":"string","title":"Session Id"},"state":{"type":"string","title":"State"},"last_message":{"type":"string","title":"Last Message"},"updated_at":{"type":"string","title":"Updated At"}},"type":"object","required":["session_id","state","last_message","updated_at"],"title":"ChatConversations"},"ChatConversationsParameters":{"properties":{"contact_type":{"type":"string","title":"Contact Type"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Contact Id"}},"type":"object","required":["contact_type","contact_id"],"title":"ChatConversationsParameters"},"ChatSessionSchema":{"properties":{"title":{"type":"string","title":"Title"},"status":{"type":"string","enum":["active","archived","deleted"],"title":"Status","default":"active"}},"type":"object","required":["title"],"title":"ChatSessionSchema"},"ChecklistCreateSchema":{"properties":{"title":{"type":"string","title":"Title"},"items":{"items":{"$ref":"#/components/schemas/ChecklistItemSchema"},"type":"array","title":"Items"},"private":{"type":"boolean","title":"Private"},"links":{"items":{"type":"string"},"type":"array","title":"Links"},"pipeline_groups_ids":{"items":{"type":"string"},"type":"array","title":"Pipeline Groups Ids"}},"type":"object","required":["title","items"],"title":"ChecklistCreateSchema","description":"Checklist create schema"},"ChecklistItemParam":{"properties":{"name":{"type":"string","title":"Item name","description":"Non-empty text describing the checklist item."},"checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Checked","description":"Whether the checklist item is completed. Defaults to false.","default":false}},"type":"object","required":["name"],"title":"ChecklistItemParam","description":"Define a timeline checklist item."},"ChecklistItemSchema":{"properties":{"name":{"type":"string","title":"Name"},"checked":{"type":"boolean","title":"Checked","default":false},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation"}},"type":"object","required":["name"],"title":"ChecklistItemSchema","description":"Checklist item schema"},"ChecklistSchema":{"properties":{"db_id":{"type":"string","title":"Db Id"},"title":{"type":"string","title":"Title"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"items":{"items":{"$ref":"#/components/schemas/ChecklistItemSchema"},"type":"array","title":"Items","default":[]},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"links":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Links","default":[]},"pipeline_groups_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Pipeline Groups Ids","default":[]}},"type":"object","required":["db_id","title"],"title":"ChecklistSchema","description":"Checklist schema"},"ChecklistUpdateSchema":{"properties":{"title":{"type":"string","title":"Title"},"items":{"items":{"$ref":"#/components/schemas/ChecklistItemSchema"},"type":"array","title":"Items"},"links":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Links","default":[]},"pipeline_groups_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Pipeline Groups Ids","default":[]},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"}},"type":"object","required":["title","items"],"title":"ChecklistUpdateSchema","description":"Checklist update schema"},"CitySchema":{"properties":{"administrative_area_level_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Administrative Area Level 1","description":"State or province of the city"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country of the city"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Database ID of the city"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the city"}},"type":"object","title":"CitySchema"},"ContactCreateParams":{"properties":{"contact_type":{"anyOf":[{"type":"string","enum":["person","organization"]},{"type":"null"}],"title":"Contact type","description":"Type of contact to create. Use 'person' for an individual or 'organization' for a company. When omitted, organization_name or cnpj selects organization, while fullname, firstname, or cpf selects person. When the type is omitted, mixed person and organization signals require user clarification."},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full name","description":"Preferred name field for a person. Send the complete name here when it is available; the tool separates first name and surname automatically. Do not split it manually into firstname and lastname. Example: 'Ana das Graças Silva' → fullname='Ana das Graças Silva'."},"firstname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First name","description":"First name of a person. Use it only when fullname is unavailable and the name components are already known separately."},"lastname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last name","description":"Complete surname of a person. Use it only with firstname when fullname is unavailable. Preserve particles such as 'das', 'de', and 'dos'. Example: lastname='das Dores'."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Organization name","description":"Name of the organization. Provide it when creating an organization contact."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Primary contact email. It is normalized to lowercase and checked for an existing contact before creation."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"Primary contact phone. Punctuation is removed, at least eight digits are required, and the value is checked for an existing contact before creation."},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"CPF","description":"CPF of a person, with or without formatting. The check digits are validated and the value is checked for an existing contact before creation."},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"CNPJ","description":"CNPJ of an organization, with or without formatting. The check digits are validated and the value is checked for an existing contact before creation."},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Tags used to categorize the contact. When omitted, the tool assigns the 'contact' tag. Include 'lead' when the new person should be treated as a lead."},"manager_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager name","description":"Name or partial name of the manager to assign to the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. Omit both manager fields; creation then assigns the requesting user, while update keeps the current manager."},"manager_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager email","description":"Exact email of the manager to assign. Prefer this over manager_name when available. Omit both manager fields to assign the requesting user."},"birthday":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birthday","description":"Person's birthday. Accepted formats: YYYY-MM-DD, DD/MM/YYYY, or DD-MM-YYYY."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Contact address as free text."},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation","description":"Free-text note about the contact."}},"type":"object","title":"ContactCreateParams","description":"Define contact creation parameters."},"ContactFieldsSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the contact is active"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Marks the contact as a favorite"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Full name of the contact (required for creation person, contact or lead not required for organization)"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code","description":"Custom code or reference for the contact"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the linked contact record"},"contact_type":{"anyOf":[{"enum":["lead","person","organization",null]},{"type":"null"}],"title":"Contact Type","description":"Type of contact"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Timestamp when the contact was created"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Associated database name or ID"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age","description":"Age of the contact, if applicable"},"media_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source","description":"Primary media source associated with the contact"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the contact's profile image"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image","description":"Base64 or path to the contact's profile image"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags associated with the contact","default":[]},"crisp_people_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Crisp People Id","description":"ID used by Crisp for chat integrations"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database-specific ID of the contact"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Database key or token for internal reference"},"deal_rotation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Rotation Id","description":"ID of the rotation rule for deals"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id","description":"Landlord's account ID if linked"},"last_updated_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Updated At","description":"Timestamp of the last update"},"manager":{"anyOf":[{"$ref":"#/components/schemas/ManagerSchema"},{"type":"null"}],"description":"Manager responsible for the contact"},"managers_shared":{"items":{"$ref":"#/components/schemas/ManagerSchema"},"type":"array","title":"Managers Shared","description":"List of managers who share this contact","default":[]},"media_sources":{"items":{"$ref":"#/components/schemas/MediaSourceSchema-Output"},"type":"array","title":"Media Sources","description":"List of media sources","default":[]},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database","description":"Database ID of the member who owns the contact"},"member_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Id","description":"Registration ID of the member"},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the contact is shared via a network group"},"network":{"anyOf":[{"$ref":"#/components/schemas/ContactNetworkSchema"},{"type":"null"}],"description":"Network-related information for the contact"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"If true, this contact is private to the creator"},"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer","description":"Indicates if this contact is a payer (e.g., in a rental deal)"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"URL of a custom image for the contact"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRouterSchema"},"type":"array","title":"Properties","description":"List of properties linked to the contact","default":[]},"review_pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending","description":"Indicates if the contact is pending review"},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key used to control revisions or updates"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"General type or classification of the contact"},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj","description":"Company CNPJ (required if CPF is not provided)"},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"Personal CPF (required if CNPJ is not provided)"},"not_search_profile_picture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Search Profile Picture","description":"Skip automatic profile picture lookup"},"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","description":"Banking information related to the contact","default":[]},"pix":{"items":{"$ref":"#/components/schemas/PixSchemaSchema"},"type":"array","title":"Pix","description":"PIX keys or data for financial transactions","default":[]},"tags_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tags In Data","description":"Flag to indicate if tags are already embedded in the data","default":false},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager","description":"Indicates whether the contact can have a manager reassigned on rotations"},"location":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Location","description":"Geographic location of the contact"}},"type":"object","title":"ContactFieldsSchema"},"ContactNetworkSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"ContactNetworkSchema"},"ContactTagPostSchema":{"properties":{"contact_tag":{"$ref":"#/components/schemas/ContactTagSchema","description":"All values for create calendar include in this object ex: {\n 'contact_tag': {'name': 'VIP', 'label': 'Important', 'default': True}}"}},"type":"object","required":["contact_tag"],"title":"ContactTagPostSchema"},"ContactTagSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the contact tag","examples":["VIP","Customer"]},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Label of the contact tag","examples":["Important","Regular"]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Is the contact tag default?","examples":[true,false]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database ID of the contact tag"}},"type":"object","required":["name"],"title":"ContactTagSchema"},"ContactUpdateParams":{"properties":{"contact_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Public contact code placed in the request path. It is the primary selector and takes priority over email, name, phone, or CPF/CNPJ when it resolves to a contact. Preserve the code returned by search_contacts."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Exact email, case-insensitive. This field identifies the existing record; use email for the new value."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. It must identify exactly one person or organization. This field identifies the existing record; use fullname, firstname, lastname, or organization_name for the new name."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Formatting is ignored and the phone must contain at least eight digits. This field identifies the existing record; use phone for the new value."},"contact_legal_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact legal identification selector","description":"Fallback selector for the existing contact, used only when contact_code does not resolve. Accepts CPF or CNPJ with or without formatting. This field identifies the existing record; use cpf or cnpj for the new value."},"firstname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New first name","description":"New first name for a person. Prefer fullname when the complete new name is known."},"lastname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New last name","description":"New surname for a person. Preserve particles such as 'das', 'de', and 'dos'."},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New full name","description":"New complete name for a person. Prefer this field over manually splitting the value into firstname and lastname."},"organization_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New organization name","description":"New name for an organization contact. Use fullname for a person contact."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New email","description":"New primary email for the contact. This is an update value; contact_email is only a fallback selector for the existing record."},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New phone","description":"New primary phone for the contact. Punctuation is removed and at least eight digits are required. contact_phone is only a fallback selector."},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"CPF","description":"New CPF for a person, with or without formatting. The check digits are validated."},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"CNPJ","description":"New CNPJ for an organization, with or without formatting. The check digits are validated."},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Replacement tag list for the contact."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Set true to activate or false to deactivate the contact."},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Set true to mark or false to unmark the contact as a favorite."},"manager_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New manager name","description":"Name or partial name of the manager to assign to the contact. The lookup is case-insensitive and must resolve to one active user; otherwise the tool returns options for disambiguation. Omit both manager fields; creation then assigns the requesting user, while update keeps the current manager."},"manager_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New manager email","description":"Exact email of the new responsible manager. Prefer this over manager_name when available. Omit both manager fields to keep the current manager."},"birthday":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New birthday","description":"New birthday for a person. Accepted formats: YYYY-MM-DD, DD/MM/YYYY, or DD-MM-YYYY."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New address","description":"New address for the contact as free text."},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New observation","description":"New free-text note about the contact."}},"type":"object","title":"ContactUpdateParams","description":"Define contact update parameters."},"ContractChecklistSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Checked"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order"}},"type":"object","title":"ContractChecklistSchema"},"ContractContactSchema":{"properties":{"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key","description":"Contact key"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id","description":"ID intern of the contact in database"},"payer":{"type":"boolean","title":"Payer","description":"Indicates if the contact is a payer"},"type":{"type":"string","title":"Type","description":"Type of the contact","examples":["person if has CPF","company if has CNPJ"]}},"type":"object","required":["db_id","payer","type"],"title":"ContractContactSchema"},"ContractFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","description":"Allow multiple selections","default":true},"typebox":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typebox","description":"Display as typebox","default":false}},"type":"object","required":["typevalue"],"title":"ContractFieldConfigurationSchemas"},"ContractFieldsSchemaResponse":{"properties":{"annual_readjustment_key":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Annual Readjustment Key","description":"Anuual readjustment key for the contract"},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode","description":"Billing mode for the contract"},"checklist":{"items":{"$ref":"#/components/schemas/ContractChecklistSchema"},"type":"array","title":"Checklist","description":"Checklist items associated with the contract","default":[]},"code":{"type":"string","title":"Code","description":"Contract code unique identifier"},"contacts":{"items":{"$ref":"#/components/schemas/ContractContactSchema"},"type":"array","title":"Contacts","description":"Contacts list related to the contract"},"contract_type":{"enum":["sale","monthly_signature","daily_signature","bimonthly","quarterly","four_monthly","semi_annual","annual","biannual","triannual","quadrennial",null],"title":"Contract Type","description":"Contract type. Required for create","examples":["sale","monthly_signature","daily_signature"]},"created_at":{"type":"string","title":"Created At","description":"Created date"},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage charged for installment payments via credit card"},"credit_card_pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Fixed Rate","description":"Indicates whether the fixed card fee will be passed on to the customer"},"credit_card_pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Installments Fee","description":"Defines whether the interest on card installments will be passed on"},"credit_card_auto_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Auto Charge","description":"Defines whether invoices are charged automatically on the due date using the card the payer marked for automatic debit"},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","description":"Percentage of fee on credit card transactions"},"current_installment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Installment","description":"Current installment number of the contract"},"daily_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Daily Value","description":"Daily value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Addional description for the contract"},"due_day":{"type":"string","title":"Due Day","description":"Due day for the contract payments"},"duration":{"type":"integer","title":"Duration","description":"Contract Duration"},"end_at":{"type":"string","title":"End At","description":"End date of the contract in ISO format (yyyy-mm-dd)"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge","description":"Fine charge indicates if there is a fine for late payment"},"fine_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent Late Payment","description":"Percentage of the fine applied in case of late payment"},"in_progress":{"type":"boolean","title":"In Progress","description":"Indicate if the contract is in progress"},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Define if the contract is included in DIMOB"},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate","description":"Indicate if the contract has an indeterminate duration"},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value","description":"Initial value of the contract"},"insurances":{"items":{"$ref":"#/components/schemas/ContractInsuranceSchema"},"type":"array","title":"Insurances","description":"Insurance list related to the contract","default":[]},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge","description":"Define if there is an interest charge for late payments"},"interest_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent Late Payment","description":"Percentage of interest applied in case of late payment"},"invoice_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Description","description":"Additional description for the invoice"},"items":{"items":{"$ref":"#/components/schemas/InvoiceItemSchema"},"type":"array","title":"Items","description":"Item list related to the contract","default":[]},"last_annual_readjustment_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Annual Readjustment At","description":"Last date of annual readjustment"},"monthly_value":{"type":"number","title":"Monthly Value","description":"Monthly value of the contract, if not contract sale"},"next_invoice_due_date":{"type":"string","title":"Next Invoice Due Date","description":"Next due date for the invoice"},"next_invoice_end_at":{"type":"string","format":"date","title":"Next Invoice End At","description":"Next invoice end at date"},"next_invoice_generate_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Generate In","description":"Next invoice generate date"},"next_invoice_start_at":{"type":"string","format":"date","title":"Next Invoice Start At","description":"Next invoice start at date"},"next_invoice_value":{"type":"number","title":"Next Invoice Value","description":"Next invoice value"},"nota_fiscal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nota Fiscal","description":"Indicate if the contract generates a nota fiscal"},"notification":{"anyOf":[{"$ref":"#/components/schemas/ContractNotificationSchema"},{"type":"null"}],"description":"Configurations for authomatic notifications related to the contract"},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Max installment allow in the contract"},"property":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Property","description":"Property related to the contract"},"proportional_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proportional In Next Invoice","description":"Define if the next invoice has proportional value"},"receipt_methods":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Contract payment methods(can be more than one)."},"receipt_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Method","description":"Define receipt method for the invoice (ex: Bank slip, credit card, pix)"},"send_nota_fiscal_in_invoice_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Nota Fiscal In Invoice Create","description":"Indicate if the nota fiscal should be sent when the invoice is created"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Define the source of the contract (ex: imobzi, digital real state)"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At","description":"Start at date of the contract"},"status":{"anyOf":[{"type":"string","enum":["active","ended","suspended","in_review","in_progress","traveling"]},{"type":"null"}],"title":"Status","description":"Current status of the contract (ex: active, inactive, suspend, in_progress)"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At","description":"Last date the contract was updated"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Valor total do contrato."},"duration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration Type","description":""},"has_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Invoice","description":"Indicate if the contract has an invoice"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Intern id identifier of the contract in database"},"next_invoice_generate_days_before":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Invoice Generate Days Before","description":"Number of days before the due date to generate the next invoice"}},"type":"object","required":["code","contacts","created_at","due_day","duration","end_at","in_progress","next_invoice_due_date","next_invoice_end_at","next_invoice_start_at","next_invoice_value"],"title":"ContractFieldsSchemaResponse"},"ContractFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/ContractFieldConfigurationSchemas","description":"Field configuration"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Set as default field","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name","description":"Parameter name for text template"}},"type":"object","required":["configuration"],"title":"ContractFieldsSchemas"},"ContractInsuranceSchema":{"properties":{"base_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Value"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"end_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End At"},"installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments"},"installment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Installment Value"},"insurance_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Insurance Id"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"start_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start At"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},"type":"object","title":"ContractInsuranceSchema"},"ContractNotificationSchema":{"properties":{"send_due_notification_to_contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Due Notification To Contact","description":"Indicates if due notifications should be sent to the contact"},"send_invoice_to_contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Contact","description":"Indicates if the invoice should be sent to the contact"},"send_invoice_to_contact_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Contact Whatsapp","description":"Indicates if the invoice should be sent to the contact via WhatsApp"},"send_overdue_notification_to_contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification To Contact","description":"Indicates if overdue notifications should be sent to the contact"},"send_insurance_close_due_date_to_contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Insurance Close Due Date To Contact","description":"Indicates if insurance close due date notifications should be sent to the contact"},"send_notification_readjustment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Readjustment","description":"Indicates if readjustment notifications should be sent"},"send_whatsapp_notification_readjustment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Whatsapp Notification Readjustment","description":"Indicates if readjustment notifications should be sent via WhatsApp"},"send_notification_invoice_paid_after_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Invoice Paid After Due Date","description":"Indicates if the real estate agency should be notified when an invoice is paid after the due date"}},"type":"object","title":"ContractNotificationSchema"},"ContractsFieldsSchema":{"properties":{"annual_readjustment":{"anyOf":[{"$ref":"#/components/schemas/AnnualReadjustmentSchema"},{"type":"null"}],"description":"Annual readjustment configuration for the contract"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the contract. Required for create"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the contract. Required for create"},"checklist":{"items":{"$ref":"#/components/schemas/ContractChecklistSchema"},"type":"array","title":"Checklist","description":"Checklist items associated with the contract","default":[]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Contract code"},"field_values":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Field Values","description":"Fields and their values associated with the contract","default":[]},"contacts":{"items":{"$ref":"#/components/schemas/ContractContactSchema"},"type":"array","title":"Contacts","description":"Contacts related in the contract","default":[]},"contract_type":{"enum":["sale","monthly_signature","daily_signature","bimonthly","quarterly","four_monthly","semi_annual","annual","biannual","triannual","quadrennial",null],"title":"Contract Type","description":"Contract type. Required for create","examples":["sale","monthly_signature","daily_signature"]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Created at contract"},"current_installment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Installment","description":"Current installment number of the contract","default":1},"daily_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Daily Value","description":"Daily value for the contract","default":0},"due_day":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Day","description":"Due day for the contract payments. Required for create"},"billing_mode":{"type":"string","enum":["normal","early"],"title":"Billing Mode","description":"Billing mode for the contract","default":"normal","examples":["normal","early"]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"ID Intern of the contract in database"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description for the contract","default":""},"duration":{"type":"integer","title":"Duration","description":"Time duration for the contract","default":12},"duration_type":{"type":"string","title":"Duration Type","description":"Duration type for the contract","default":"months"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At","description":"End date of the contract. Required for create"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge","description":"Define if contract has fine charge","default":true},"fine_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent Late Payment","description":"Percentage of fine applied in case of late payment","default":0},"has_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Invoice","description":"Check if the contract has an invoice","default":false},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Define if the contract is included in DIMOB (Declaração de Imposto de Renda de Pessoa Física)","default":false},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate","description":"Define if the contract is indeterminate time","default":false},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value","description":"Contract initial value","default":0},"invoice_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Description","description":"Description for the invoice","default":""},"in_progress":{"type":"boolean","title":"In Progress","description":"Define if the contract is in progress","default":false},"insurances":{"items":{"$ref":"#/components/schemas/ContractInsuranceSchema"},"type":"array","title":"Insurances","description":"Insurances related to the contract","default":[]},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge","description":"Define if contract has interest charge","default":true},"interest_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent Late Payment","description":"Percentage of interest applied in case of late payment","default":0},"invoice_items_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice Items Value","description":"Total value of invoice items related to the contract","default":0},"irrf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf","description":"Define if the contract has IRRF (Imposto de Renda Retido na Fonte)","default":false},"items":{"items":{"$ref":"#/components/schemas/InvoiceItemSchema"},"type":"array","title":"Items","description":"items related to the contract","default":[]},"last_annual_readjustment_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Annual Readjustment At","description":"Last date of annual readjustment for the contract"},"monthly_value":{"type":"number","title":"Monthly Value","description":"Monthly value for the contract, if not contract sale"},"next_invoice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice","description":"Next invoice","default":""},"next_invoice_due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Due Date","description":"Next due date for the invoice. Required for create"},"next_invoice_end_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Next Invoice End At","description":"Next invoice end at date. Required for create"},"next_invoice_generate_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Generate In","description":"Next invoice generate date, usually due date -10 days. Required for create"},"next_invoice_start_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Next Invoice Start At","description":"Next invoice start at date. Required for create"},"next_invoice_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value","description":"Next invoice value. Required for create"},"nota_fiscal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nota Fiscal","description":"Indicate if the contract generates a nota fiscal (invoice)","default":false},"notification":{"anyOf":[{"$ref":"#/components/schemas/ContractNotificationSchema"},{"type":"null"}],"description":"Configurations for automatic notifications related to the contract"},"property":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Property","description":"Property related to the contract, if for sale"},"proportional_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proportional In Next Invoice","description":"Define if the next invoice has proportional value","default":false},"receipt_methods":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Contract payment methods(can be more than one)."},"send_nota_fiscal_in_invoice_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Nota Fiscal In Invoice Create","description":"Indicate if the nota fiscal should be sent when the invoice is created","default":false},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Source of the contract","default":"imobzi","examples":["imobzi","digital_real_state"]},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At","description":"Start at date of the contract. Required for create"},"status":{"type":"string","enum":["active","ended","suspended","in_review","in_progress","traveling"],"title":"Status","description":"Current contract status","default":"active","examples":["active","ended","suspended","in_review","in_progress","traveling"]},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At","description":"Last date the contract was updated"},"value":{"type":"number","title":"Value","description":"Value for the contract","default":0},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","description":"Percentage charged for credit card transactions","default":2.99},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage charged for installment payments via credit card","default":5.49},"credit_card_pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Fixed Rate","description":"Indicates whether the fixed card fee will be passed on to the customer","default":false},"credit_card_pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Installments Fee","description":"Defines whether the interest on card installments will be passed on","default":false},"credit_card_auto_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Auto Charge","description":"Defines whether invoices are charged automatically on the due date using the card the payer marked for automatic debit","default":false},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of installments allowed for the contract","default":12}},"type":"object","title":"ContractsFieldsSchema"},"ContractsFieldsUpdateSchema":{"properties":{"account":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"annual_readjustment":{"anyOf":[{"$ref":"#/components/schemas/AnnualReadjustmentSchema"},{"type":"null"}]},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory"},"checklist":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractChecklistSchema"},"type":"array"},{"type":"null"}],"title":"Checklist"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"field_values":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Field Values"},"contacts":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractContactSchema"},"type":"array"},{"type":"null"}],"title":"Contacts"},"contract_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Type"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"current_installment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Installment"},"daily_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Daily Value"},"due_day":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Day"},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration"},"duration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration Type"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge"},"fine_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent Late Payment"},"has_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Invoice"},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob"},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate"},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value"},"invoice_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Description"},"in_progress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Progress"},"insurances":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractInsuranceSchema"},"type":"array"},{"type":"null"}],"title":"Insurances"},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge"},"interest_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent Late Payment"},"invoice_items_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice Items Value"},"irrf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf"},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/InvoiceItemSchema"},"type":"array"},{"type":"null"}],"title":"Items"},"items_management_fee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Items Management Fee"},"last_annual_readjustment_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Annual Readjustment At"},"lease_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Type"},"management_fee":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Management Fee"},"monthly_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Monthly Value"},"next_invoice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice"},"next_invoice_due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Due Date"},"next_invoice_end_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Next Invoice End At"},"next_invoice_generate_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Generate In"},"next_invoice_start_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Next Invoice Start At"},"next_invoice_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value"},"nota_fiscal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nota Fiscal"},"notification":{"anyOf":[{"$ref":"#/components/schemas/ContractNotificationSchema"},{"type":"null"}]},"property":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Property"},"proportional_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proportional In Next Invoice"},"receipt_methods":{"anyOf":[{"$ref":"#/components/schemas/ReceiptMethodsSchema"},{"type":"null"}]},"receipt_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Method"},"send_nota_fiscal_in_invoice_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Nota Fiscal In Invoice Create"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","default":"imobzi"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","default":2.99},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","default":5.49},"credit_card_pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Fixed Rate","default":false},"credit_card_pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Installments Fee","default":false},"credit_card_auto_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Auto Charge","default":false},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","default":12}},"type":"object","title":"ContractsFieldsUpdateSchema"},"ContractsListFieldsSchema":{"properties":{"code":{"type":"string","title":"Code","description":"Contract code"},"contract_type":{"type":"string","title":"Contract Type","description":"Contract type"},"key":{"type":"string","title":"Key","description":"Contract key"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id","description":"ID intern of the contract in database"},"value":{"type":"number","title":"Value","description":"Contract value","default":0},"next_invoice_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value","description":"Next invoice value"},"status":{"type":"string","enum":["active","ended","suspended","in_review","in_progress","traveling"],"title":"Status","description":"Contract status","examples":["active","ended","suspended","in_review","in_progress","traveling"]},"start_at":{"type":"string","title":"Start At","description":"Contract start at date, in format ISO"},"contacts":{"items":{"$ref":"#/components/schemas/ContractContactSchema"},"type":"array","title":"Contacts","description":"Contact list related to the contract"},"source":{"anyOf":[{"type":"string","enum":["imobzi","digital_real_state"]},{"type":"null"}],"title":"Source","description":"Source of the contract","default":"imobzi","examples":["imobzi","digital_real_state"]},"in_progress":{"type":"boolean","title":"In Progress","description":"Indicates if the contract is in progress"},"insurances":{"items":{"$ref":"#/components/schemas/ContractInsuranceSchema"},"type":"array","title":"Insurances","description":"Insurances related to the contract","default":[]},"invoice_items_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Invoice Items Value","description":"Value of invoice items related to the contract","default":0}},"type":"object","required":["code","contract_type","key","db_id","status","start_at","contacts","in_progress"],"title":"ContractsListFieldsSchema"},"CustomButtonActionSchema":{"properties":{"content":{"anyOf":[{"$ref":"#/components/schemas/CustomPageActionSchema"},{"type":"null"}]},"content_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Key"},"content_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Id"},"modal_type":{"anyOf":[{"type":"string","enum":["simulator","contact","whatsapp","visit","contact_broker","reserve"]},{"type":"null"}],"title":"Modal Type"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"queryparams":{"anyOf":[{"$ref":"#/components/schemas/QueryparamsSchema"},{"type":"null"}]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url"}},"type":"object","title":"CustomButtonActionSchema"},"CustomButtonSchema":{"properties":{"active":{"type":"boolean","title":"Active"},"label":{"type":"string","title":"Label"},"location":{"type":"string","enum":["header","search","widget","widget_share","menu","header_menu","banner"],"title":"Location"},"type":{"type":"string","enum":["property_filter","internal_link","external_link","linked_content","phone","whatsapp","modal","share"],"title":"Type"},"is_icon":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Icon"},"max_char":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Char"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"action":{"anyOf":[{"$ref":"#/components/schemas/CustomButtonActionSchema"},{"type":"null"}]},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position"}},"type":"object","required":["active","label","location","type"],"title":"CustomButtonSchema"},"CustomPageActionSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Description"},"meta_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Title"},"page_body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page Body"},"page_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page Title"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","title":"CustomPageActionSchema"},"DealCardInfoSchema":{"properties":{"field_id":{"type":"string","title":"Field Id"},"position":{"type":"integer","title":"Position"},"name":{"type":"string","title":"Name"}},"type":"object","required":["field_id","position","name"],"title":"DealCardInfoSchema"},"DealCodeSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"pipeline_group":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group"}},"type":"object","title":"DealCodeSchema"},"DealCommissionContactSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"emails":{"items":{"type":"string"},"type":"array","title":"Emails","default":[]},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"DealCommissionContactSchema"},"DealCommissionInstallmentSchema":{"properties":{"repeat_index":{"type":"integer","title":"Repeat Index"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"value":{"type":"number","title":"Value"},"due_date":{"type":"string","title":"Due Date"},"paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Paid"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At"}},"type":"object","required":["repeat_index","value","due_date"],"title":"DealCommissionInstallmentSchema","description":"Individual installment configuration of a commission apportionment."},"DealCommissionSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"contact":{"anyOf":[{"$ref":"#/components/schemas/DealCommissionContactSchema"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"discount_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Discount Percentage"},"discount_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Discount Value"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function"},"generate_expense":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Expense"},"has_transaction":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Transaction"},"installments":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Installments"},"installment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Installment Value"},"net_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Value"},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage"},"split_installments":{"anyOf":[{"items":{"$ref":"#/components/schemas/DealCommissionInstallmentSchema"},"type":"array"},{"type":"null"}],"title":"Split Installments"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory"},"transaction_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Status"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},"type":"object","title":"DealCommissionSchema"},"DealContactSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"email":{"items":{"type":"string"},"type":"array","title":"Email","default":[]},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"DealContactSchema"},"DealCreateParams":{"properties":{"title":{"type":"string","title":"Deal title","description":"Title of the deal. REQUIRED. Should be a short, descriptive label for the business opportunity. If the user does not provide a title, generate one automatically as 'Novo Negócio - {contact_name}'. Example values: 'Venda Apt 302 - João Silva', 'Locação Sala Comercial Centro'."},"pipeline_group_name":{"type":"string","title":"Pipeline group name","description":"Exact display name of the pipeline group where the deal will be created. Required. A pipeline group is the funnel that contains stages, while stage_name identifies a step inside that funnel. Remove the word 'Funil' from user input: 'funil de Vendas' → 'Vendas', 'funil de Locação' → 'Locação', and 'Funil de Vendas & Locação' → 'Vendas & Locação'. Do not send a short prefix such as VEN. If the exact name is not found, the tool returns pipeline group options."},"stage_name":{"type":"string","title":"Stage name","description":"Stage where the deal starts inside pipeline_group_name. Required. A stage is a step inside the selected pipeline group, not the funnel itself. If the user does not specify a stage, send 'primeira etapa' to select the first stage. Stage comparison ignores case, diacritics, and special characters. For creation, an unknown stage currently falls back to the first stage and the response reports that fallback. Examples: 'Novo Lead', 'Visita Agendada', 'Proposta Enviada', 'Negociação', 'Fechamento'."},"value":{"type":"number","title":"Deal value","description":"Monetary value of the deal in BRL (Brazilian Reais). REQUIRED. Send as a plain number WITHOUT currency symbols or thousand separators. Use dot as decimal separator. If the user does not specify a value, send 0. For rent deals this is the monthly rent value. For buy deals this is the total sale price. Example values: 0, 350000.00, 2500.50, 1200000."},"interest":{"type":"string","enum":["buy","rent","vacation_rental"],"title":"Deal interest","description":"Type of business interest for this deal. Defaults to 'buy'. Send one of the exact slug values — NOT Portuguese. Translation map: compra / venda → 'buy', aluguel / locação → 'rent', temporada / aluguel por temporada → 'vacation_rental'. For interest='vacation_rental', provide both vacation_start and vacation_end.","default":"buy"},"vacation_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation start","description":"Start date of the vacation rental period. Provide it when interest='vacation_rental'; it is ignored otherwise. Format: ISO 8601 datetime string. Example: '2026-11-20T00:00:00.000Z'."},"vacation_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation end","description":"End date of the vacation rental period. Provide it when interest='vacation_rental'; it is ignored otherwise. Must be after vacation_start. Format: ISO 8601 datetime string. Example: '2026-11-30T00:00:00.000Z'."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal description","description":"Free-text notes or additional details about the deal. Can include property preferences, client requirements, negotiation context, etc. No format restrictions. Example: 'Cliente procura apartamento 3 quartos, vista para o mar, orçamento máximo de 500 mil'."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Email of the contact (person or organization) to link to this deal. The tool resolves the contact and detects whether it is a person or organization. Prefer this over contact_name — it is more precise and avoids ambiguity when multiple contacts share similar names. If both contact_email and contact_name are provided, both are used in the search (AND logic). Format: user@domain.com. Example: 'joao.silva@gmail.com'."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Full name of the contact to link to this deal. Use it when contact_email is unavailable or to narrow the lookup. The name must match exactly one contact — if multiple contacts match, the backend returns an error listing them for disambiguation. Example values: 'João Silva', 'Construtora ABC Ltda'."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Phone number of the contact to link to this deal. Used as an additional filter to identify the contact when email or name are not sufficient. It must match exactly one contact. Format: 11 91234-5678. Example: '11 91234-5678'."},"contact_legal_identification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact legal identification","description":"Legal identification of the contact, such as CPF for individuals or CNPJ for companies. Used as an additional filter to identify the contact when email or name are not sufficient. It must match exactly one contact. Example values: '123.456.789-00' for CPF, '12.345.678/0001-00' for CNPJ."},"contact_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Exact public code of the contact to link. Use it when the contact is already identified by code. The runtime may also populate it automatically when the contact was created or selected in the same conversation. Examples: '12345', 'CON-001'."},"pipeline_group_stable_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stable pipeline group ID","description":"Internal Firestore document ID of the pipeline group, injected automatically by the runtime during stage disambiguation. Do NOT populate this field manually. When present, it bypasses the name-based pipeline group lookup so that a retry after stage disambiguation always resolves the same funnel regardless of any inconsistency between the user-provided name and the database."},"status":{"type":"string","enum":["in progress","win","lost"],"title":"Deal status","description":"Initial status of the deal. Almost always 'in progress' for new deals. Only change this if the user explicitly asks to create a deal as already won or lost. Allowed values: 'in progress', 'win', 'lost'. Note: this field uses SPACES ('in progress'), not underscores.","default":"in progress"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker name","description":"Responsible broker name or partial name. The lookup is case-insensitive and considers active users. It must resolve to exactly one user; otherwise the tool returns options for disambiguation. Omit both user_name and user_email to keep or assign the requesting user, depending on the operation. Examples: 'Maria', 'Carlos Souza'."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker email","description":"Responsible broker email. Exact match, case-insensitive. Preferred when available because it avoids ambiguity for duplicated names. Omit both user_email and user_name to assign the requesting user."}},"type":"object","required":["title","pipeline_group_name","stage_name","value"],"title":"DealCreateParams","description":"Define deal create parameters."},"DealFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","default":true},"typebox":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typebox","default":false}},"type":"object","required":["typevalue"],"title":"DealFieldConfigurationSchemas"},"DealFieldsSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Identifier code for the deal."},"new_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Code","description":"New code to update the deal."},"deal_codes":{"items":{"$ref":"#/components/schemas/DealCodeSchema"},"type":"array","title":"Deal Codes","description":"List of deal codes related to this deal.","default":[]},"commission":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission","description":"Total commission value for the deal."},"commission_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Percent","description":"Commission percentage."},"commission_mode_calc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Mode Calc","description":"Commission calculation mode."},"commission_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Discount","description":"Commission discount."},"commission_discount_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Discount Percent","description":"Commission discount percentage."},"commission_after_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission After Discount","description":"Total commission minus commission discount."},"contact":{"anyOf":[{"$ref":"#/components/schemas/DealContactSchema"},{"type":"null"}],"description":"Contact associated with the deal."},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"Required only when creating a deal, not for Kanban management."},"contact_type":{"enum":["person","organization",null],"title":"Contact Type","description":"Required only when creating a deal, not for Kanban management."},"date_close":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Close","description":"Expected or actual closing date of the deal."},"deals_links":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Deals Links","description":"Links to related deals."},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Internal database ID for the deal."},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Internal database key for the deal."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description or notes about the deal."},"deal_before_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Before Id","description":"ID of the previous deal, if applicable."},"entry_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Entry Value","description":"Initial value or entry amount for the deal."},"flag":{"items":{"type":"string"},"type":"array","title":"Flag","description":"Custom flags or tags associated with the deal.","default":[]},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Indicates if the deal is marked as a favorite."},"fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Fields","description":"Custom fields and their values."},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/DealGuaranteesSchema"},{"type":"null"}],"description":"Guarantees associated with the deal."},"interest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest"},"monthly_income":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Monthly Income","description":"Monthly income related to the deal."},"network":{"anyOf":[{"$ref":"#/components/schemas/NetworkInfoSchema"},{"type":"null"}],"description":"Network information for the deal."},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the deal is shared with network group members."},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"},{"type":"null"}],"description":"Pipeline group details."},"pipeline_group_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id","description":"ID of the pipeline group. Value is required when creating a new deal."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Name","description":"Name of the pipeline group."},"profile":{"items":{"$ref":"#/components/schemas/DealProfileSchema"},"type":"array","title":"Profile","description":"List of profiles associated with the deal.","default":[]},"progress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Progress","description":"Current progress status of the deal."},"properties_presented":{"items":{"$ref":"#/components/schemas/DealPropertyPresentedSchema"},"type":"array","title":"Properties Presented","description":"List of properties presented in the deal.","default":[]},"properties_captured":{"items":{"$ref":"#/components/schemas/DealPropertyCapturedSchema"},"type":"array","title":"Properties Captured","description":"List of captured properties in the deal.","default":[]},"proposal":{"anyOf":[{"$ref":"#/components/schemas/MemberProposalSchema"},{"type":"null"}],"description":"Proposal details related to the deal."},"reserves_expired":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reserves Expired","description":"Number of expired reserves."},"stage":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Stage"},"stage_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage Count","description":"Number of stages passed through."},"stage_history":{"items":{"$ref":"#/components/schemas/StageHistorySchema"},"type":"array","title":"Stage History","description":"History of stage transitions."},"status":{"anyOf":[{"enum":["stagnant","in progress","out_of_date","win","lost",null]},{"type":"null"}],"title":"Status"},"stagnant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stagnant","description":"Indicates whether the deal is stagnant."},"activities_overdue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Overdue","description":"Number of overdue activities."},"activities_scheduled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Scheduled","description":"Number of scheduled activities."},"today_activities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Today Activities","description":"Number of activities scheduled for today."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the deal. Required when creating a deal. If create a deal and not provided by user, use default 'New Deal + contact_name'."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Creation timestamp of the deal."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At","description":"Last updated timestamp of the deal."},"user":{"anyOf":[{"$ref":"#/components/schemas/DealUserSchema"},{"type":"null"}],"description":"User assigned to the deal."},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"ID of the user assigned to the deal."},"vacation_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation End","description":"End date of vacation period related to the deal."},"vacation_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation Start","description":"Start date of vacation period related to the deal."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Total monetary value of the deal. Required only when creating a deal, not for Kanban management."},"visits":{"items":{"$ref":"#/components/schemas/DealVisitSchema"},"type":"array","title":"Visits","description":"List of visits related to the deal.","default":[]},"without_activities":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Activities","description":"Indicates if the deal has no activities."},"commissions":{"items":{"$ref":"#/components/schemas/DealCommissionSchema"},"type":"array","title":"Commissions","description":"Detailed commission information.","default":[]},"generate_financial_income":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Financial Income","description":"Indicates if the deal generates financial income."},"generate_gross_receipt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Gross Receipt","description":"Indicates if the deal generates gross receipts."},"commission_was_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Commission Was Created","description":"Indicates if a commission record was created."},"net_commission":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Commission","description":"Net commission amount."},"generate_financial_transactions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Financial Transactions","description":"Indicates if financial transactions are generated for the deal."},"lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost Reason","description":"Reason why the deal was lost."},"lost_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost Comment","description":"Comment providing more details about the lost deal."},"participants":{"items":{"$ref":"#/components/schemas/ParticipantInfoSchema"},"type":"array","title":"Participants","description":"List of participants involved in the deal.","default":[]},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"Indicates if the deal is private."},"send_property_match":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match","description":"Indicates if property match emails should be sent."},"send_property_match_by_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match By Whatsapp","description":"Indicates if property match should be sent via WhatsApp."},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","description":"List of default values for custom fields.","default":[]},"send_for_lease_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send For Lease Online"},"from_rotation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"From Rotation","description":"Indicates if the deal originated from rotation."},"rotation_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rotation Description","description":"Description of how the deal was rotated."},"without_property":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Property","description":"Indicate if the deal not has linked with property"}},"type":"object","title":"DealFieldsSchema"},"DealFilterSchema":{"properties":{"name":{"type":"string","title":"Name"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"pipeline_group_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"},"filters":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Filters","default":[]}},"type":"object","required":["name"],"title":"DealFilterSchema"},"DealFilterUpdateSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"pipeline_group_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id"},"filters":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Filters","default":[]}},"type":"object","title":"DealFilterUpdateSchema"},"DealGuaranteesSchema":{"properties":{"guarantor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guarantor"},"bail":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bail"},"surety_bond":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Surety Bond"},"bond_application":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bond Application"},"credpago":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credpago"},"requirements":{"items":{"type":"string"},"type":"array","title":"Requirements","default":[]},"flag":{"items":{"type":"string"},"type":"array","title":"Flag","default":[]}},"type":"object","title":"DealGuaranteesSchema"},"DealLostReasonPostSchema":{"properties":{"deals_lost_reason":{"$ref":"#/components/schemas/DealLostReasonSchema","description":"All values for create deal lost reason include in this object ex: {\n 'deals_lost_reason': {'name': 'Reason 1', 'active': True, 'types': ['type1', 'type2']}}"}},"type":"object","required":["deals_lost_reason"],"title":"DealLostReasonPostSchema"},"DealLostReasonSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the deal lost reason","examples":["Reason 1"]},"active":{"type":"boolean","title":"Active","description":"Is the deal lost reason active?"},"types":{"items":{"type":"string"},"type":"array","title":"Types","description":"Types associated with the deal lost reason","default":[]}},"type":"object","required":["name","active"],"title":"DealLostReasonSchema"},"DealProfileSchema":{"properties":{"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"},"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"},"profile_idx":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Idx"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"minimum_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Minimum Area"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"neighborhoods":{"items":{"type":"string"},"type":"array","title":"Neighborhoods","default":[]},"cities":{"items":{"type":"string"},"type":"array","title":"Cities","default":[]},"features":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"additionalProperties":true,"type":"object"}],"title":"Features"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"interest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest"}},"type":"object","title":"DealProfileSchema"},"DealPropertyCapturedSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address"},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"},"property_situation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Situation"}},"type":"object","title":"DealPropertyCapturedSchema"},"DealPropertyPresentedSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address"},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"},"property_situation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Situation"},"seen":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Seen"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},"type":"object","title":"DealPropertyPresentedSchema"},"DealPropertyVisitSchema":{"properties":{"available_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Available Digital Real Estate"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"DealPropertyVisitSchema"},"DealRangeValueSchema":{"properties":{"rent_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rent Min"},"rent_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rent Max"},"sale_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale Min"},"sale_max":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale Max"}},"type":"object","title":"DealRangeValueSchema"},"DealRotationFieldSchema":{"properties":{"interest":{"items":{"enum":[null,"rent","buy","vacation_rental","without_interest"]},"type":"array","title":"Interest","default":[]},"property_stage":{"items":{"enum":[null,"none","pre_launch","launch","in_construction","ready"]},"type":"array","title":"Property Stage","default":[]},"users":{"items":{"$ref":"#/components/schemas/DealRotationUser"},"type":"array","title":"Users","default":[]},"final_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Value"},"last_updated_at":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Last Updated At"},"end_hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Hour"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority"},"property_features":{"items":{"$ref":"#/components/schemas/DealRotationProperty"},"type":"array","title":"Property Features","default":[]},"lead_with_attendance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lead With Attendance"},"type":{"anyOf":[{"enum":[null,"rotation","redistribution","repique"]},{"type":"null"}],"title":"Type"},"property_types":{"items":{"$ref":"#/components/schemas/DealRotationProperty"},"type":"array","title":"Property Types","default":[]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"description":{"type":"string","title":"Description"},"ignore_distribution":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Distribution"},"distribution_option":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Distribution Option"},"start_hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Hour"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"cities":{"items":{"type":"string"},"type":"array","title":"Cities","default":[]},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_visit":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_reserve":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_group_origin":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_origin":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_group_to":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_to":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"neighborhoods":{"items":{"type":"string"},"type":"array","title":"Neighborhoods","default":[]},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value"},"days":{"items":{"enum":[null,"monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"type":"array","title":"Days","default":[]},"media_sources":{"items":{"type":"string"},"type":"array","title":"Media Sources","default":[]},"next_schedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Schedule"},"codes":{"items":{"type":"string"},"type":"array","title":"Codes","default":[]},"buildings":{"items":{"type":"string"},"type":"array","title":"Buildings","default":[]},"notify_users":{"items":{"$ref":"#/components/schemas/DealRotationUser"},"type":"array","title":"Notify Users","default":[]},"always_create_deal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Always Create Deal"},"execution_mode":{"anyOf":[{"enum":[null,"once_per_day","by_period"]},{"type":"null"}],"title":"Execution Mode"},"contact_new_deal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contact New Deal"},"pipeline_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline In Data","default":false},"pipeline_group_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Group In Data","default":false},"pipeline_visit_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Visit In Data","default":false},"pipeline_reserve_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Reserve In Data","default":false},"days_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Days In Data","default":false},"interest_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest In Data","default":false},"min_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Min Value"},"max_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Max Value"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"deal_lost_date_initial":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Date Initial"},"deal_lost_date_final":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Date Final"},"deal_lost_reason":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Deal Lost Reason"},"confirmed_repique":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confirmed Repique"}},"type":"object","required":["description"],"title":"DealRotationFieldSchema"},"DealRotationPipeline":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DealRotationPipeline"},"DealRotationProperty":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DealRotationProperty"},"DealRotationResponseSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"next_schedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Schedule"},"pipeline":{"$ref":"#/components/schemas/PipelineFieldsSchema"},"pipeline_group":{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"}},"type":"object","required":["pipeline","pipeline_group"],"title":"DealRotationResponseSchema"},"DealRotationRouterSchema":{"properties":{"rotation":{"anyOf":[{"$ref":"#/components/schemas/DealRotationFieldSchema"},{"type":"null"}]}},"type":"object","title":"DealRotationRouterSchema"},"DealRotationUpdateFieldSchema":{"properties":{"interest":{"items":{"enum":[null,"rent","buy","vacation_rental","without_interest"]},"type":"array","title":"Interest","default":[]},"property_stage":{"items":{"enum":[null,"none","pre_launch","launch","in_construction","ready"]},"type":"array","title":"Property Stage","default":[]},"users":{"items":{"$ref":"#/components/schemas/DealRotationUser"},"type":"array","title":"Users","default":[]},"final_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Value"},"last_updated_at":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Last Updated At"},"end_hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Hour"},"priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Priority"},"property_features":{"items":{"$ref":"#/components/schemas/DealRotationProperty"},"type":"array","title":"Property Features","default":[]},"lead_with_attendance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lead With Attendance"},"type":{"anyOf":[{"enum":[null,"rotation","redistribution","repique"]},{"type":"null"}],"title":"Type"},"property_types":{"items":{"$ref":"#/components/schemas/DealRotationProperty"},"type":"array","title":"Property Types","default":[]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"ignore_distribution":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Distribution"},"distribution_option":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Distribution Option"},"start_hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Hour"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"cities":{"items":{"type":"string"},"type":"array","title":"Cities","default":[]},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_visit":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_reserve":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_group_origin":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_origin":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_group_to":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"pipeline_to":{"anyOf":[{"$ref":"#/components/schemas/DealRotationPipeline"},{"type":"null"}]},"neighborhoods":{"items":{"type":"string"},"type":"array","title":"Neighborhoods","default":[]},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value"},"days":{"items":{"enum":[null,"monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"type":"array","title":"Days","default":[]},"media_sources":{"items":{"type":"string"},"type":"array","title":"Media Sources","default":[]},"next_schedule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Schedule"},"codes":{"items":{"type":"string"},"type":"array","title":"Codes","default":[]},"buildings":{"items":{"type":"string"},"type":"array","title":"Buildings","default":[]},"notify_users":{"items":{"$ref":"#/components/schemas/DealRotationUser"},"type":"array","title":"Notify Users","default":[]},"always_create_deal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Always Create Deal"},"execution_mode":{"anyOf":[{"enum":[null,"once_per_day","by_period"]},{"type":"null"}],"title":"Execution Mode"},"contact_new_deal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contact New Deal"},"pipeline_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline In Data","default":false},"pipeline_group_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Group In Data","default":false},"pipeline_visit_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Visit In Data","default":false},"pipeline_reserve_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pipeline Reserve In Data","default":false},"days_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Days In Data","default":false},"interest_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest In Data","default":false},"min_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Min Value"},"max_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Max Value"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"deal_lost_date_initial":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Date Initial"},"deal_lost_date_final":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Date Final"},"deal_lost_reason":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Deal Lost Reason"},"confirmed_repique":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confirmed Repique"},"skip_auto_reorder":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Auto Reorder"}},"type":"object","title":"DealRotationUpdateFieldSchema"},"DealRotationUpdateRouterSchema":{"properties":{"rotation":{"anyOf":[{"$ref":"#/components/schemas/DealRotationUpdateFieldSchema"},{"type":"null"}]}},"type":"object","title":"DealRotationUpdateRouterSchema"},"DealRotationUser":{"properties":{"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"DealRotationUser"},"DealRouterSchema":{"properties":{"deal":{"$ref":"#/components/schemas/DealFieldsSchema"}},"type":"object","required":["deal"],"title":"DealRouterSchema"},"DealUpdateParams":{"properties":{"deal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal code","description":"Deal identifier to update. Required. Accepts a numeric code such as '653' or a complete prefixed code such as 'LOC-11' or 'VL-933'. Preserve the prefix and hyphen exactly as provided. Send the identifier in deal_code for this operation."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Exact pipeline group display name used to identify the funnel. Provide it when deal_code is numeric, such as '653'. Omit it for a prefixed code such as 'VL-933', because the prefix resolves the pipeline group."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal title","description":"New title for the deal. Send only if the user wants to rename it. Example: 'Venda Apt 302 - Atualizado'."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Deal value","description":"Updated monetary value in BRL. Plain number, dot as decimal separator, no currency symbols. Example values: 400000.00, 3500.50."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal description","description":"Updated notes or description for the deal. Replaces the existing description entirely (not appended). Example: 'Cliente renegociou valor para 450 mil'."},"status":{"anyOf":[{"type":"string","enum":["in progress","win","lost","stagnant","out_of_date"]},{"type":"null"}],"title":"Deal status","description":"Change the deal status. Send one of the exact values below. Use exactly: 'in progress', 'win', 'lost', 'stagnant', 'out_of_date'. Translation map from Portuguese: em andamento / reabrir → 'in progress', ganho / ganhou / fechado → 'win', perdido / perdeu → 'lost', estagnado / parado → 'stagnant', atrasado / vencido → 'out_of_date'. When setting status='lost', also provide lost_reason and optionally lost_comment."},"stage_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage name","description":"Move the deal to a different pipeline stage by name. The stage must exist within the deal's current pipeline group. Comparison ignores case, diacritics, and special characters. If the stage is not found, the tool returns valid stages for selection. Example values: 'Proposta Enviada', 'Fechamento'."},"interest":{"anyOf":[{"type":"string","enum":["buy","rent","vacation_rental"]},{"type":"null"}],"title":"Deal interest","description":"Change the deal interest type. Send one of the exact slugs. Translation: compra→'buy', aluguel→'rent', temporada→'vacation_rental'. If changing to 'vacation_rental', also provide vacation_start and vacation_end."},"vacation_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation start","description":"Start date of the vacation rental period. Provide it when interest='vacation_rental'. Format: ISO 8601 datetime. Example: '2026-12-01T00:00:00.000Z'."},"vacation_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation end","description":"End date of the vacation rental period. Provide it when interest='vacation_rental'. Must be after vacation_start. Format: ISO 8601 datetime. Example: '2026-12-15T00:00:00.000Z'."},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Mark (true) or unmark (false) the deal as a favorite. Favorites are highlighted in the UI for quick access. Send true to favorite, false to unfavorite."},"lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost reason","description":"Reason the deal was lost. Only relevant when status='lost'. Should be a short label describing why (e.g. 'Preço acima do mercado', 'Cliente desistiu', 'Escolheu concorrente'). Ignored if status is not 'lost'."},"lost_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost comment","description":"Additional free-text comment explaining why the deal was lost. Complements lost_reason with more detail. Only relevant when status='lost'. Example: 'O cliente encontrou um imóvel mais barato na região'."},"date_close":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Closing date","description":"Expected or actual closing date of the deal. Format: YYYY-MM-DD (date only, no time). Use for forecasting or to record when a deal was closed. Example: '2026-06-15'."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker name","description":"Responsible broker name or partial name. The lookup is case-insensitive and considers active users. It must resolve to exactly one user; otherwise the tool returns options for disambiguation. Omit both user_name and user_email to keep or assign the requesting user, depending on the operation. Examples: 'Maria', 'Carlos Souza'."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Broker email","description":"Responsible broker email. Exact match, case-insensitive. Preferred when available because it avoids ambiguity for duplicated names. Omit both user_email and user_name to keep the current responsible broker."}},"type":"object","title":"DealUpdateParams","description":"Parameters for updating an existing deal."},"DealUserSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"contact_manager":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Manager"}},"type":"object","title":"DealUserSchema"},"DealVisitSchema":{"properties":{"calendar_item_db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calendar Item Db Id"},"calendar_item_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calendar Item Key"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"property":{"anyOf":[{"$ref":"#/components/schemas/DealPropertyVisitSchema"},{"type":"null"}]}},"type":"object","title":"DealVisitSchema"},"DealsFieldSchemas":{"properties":{"field_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Id"},"configuration":{"$ref":"#/components/schemas/DealFieldConfigurationSchemas"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"pipelines_groups_key":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Pipelines Groups Key","default":[]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","default":false}},"type":"object","required":["configuration"],"title":"DealsFieldSchemas"},"DealsFieldsCreateSchemas":{"properties":{"deal_field":{"$ref":"#/components/schemas/DealsFieldsSchemas"}},"type":"object","required":["deal_field"],"title":"DealsFieldsCreateSchemas"},"DealsFieldsGetSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"flag":{"items":{"type":"string"},"type":"array","title":"Flag","description":"Custom flags or tags associated with the deal.","default":[]},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"status":{"anyOf":[{"enum":["stagnant","in progress","out_of_date","win","lost",null]},{"type":"null"}],"title":"Status"},"commissions":{"items":{"$ref":"#/components/schemas/DealCommissionSchema"},"type":"array","title":"Commissions","description":"Detailed commission information.","default":[]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"deal_codes":{"items":{"$ref":"#/components/schemas/DealCodeSchema"},"type":"array","title":"Deal Codes","description":"List of deal codes associated with the deal.","default":[]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Required only when creating a deal, not for Kanban management."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"stagnant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stagnant"},"stage_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage Date"},"send_property_match":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match"},"send_property_match_by_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match By Whatsapp"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite"},"date_close":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Close"},"stage_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage Name"},"stage_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage Position"},"stage_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage Count"},"interest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest"},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Name"},"pipeline_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Key"},"pipeline_group_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Type"},"participants":{"items":{"$ref":"#/components/schemas/ParticipantInfoSchema"},"type":"array","title":"Participants","description":"List of participants involved in the deal.","default":[]},"without_activities":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Activities"},"contact":{"anyOf":[{"$ref":"#/components/schemas/DealContactSchema"},{"type":"null"}]},"user":{"anyOf":[{"$ref":"#/components/schemas/DealUserSchema"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"reserves_expired":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reserves Expired"},"activities_scheduled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Scheduled"},"activities_overdue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Overdue"},"today_activities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Today Activities"}},"type":"object","required":["status"],"title":"DealsFieldsGetSchema"},"DealsFieldsSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Identifier code for the deal."},"new_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Code","description":"New code to update the deal."},"deal_codes":{"items":{"$ref":"#/components/schemas/DealCodeSchema"},"type":"array","title":"Deal Codes","description":"List of deal codes related to this deal.","default":[]},"commission":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission","description":"Total commission value for the deal."},"commission_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Percent","description":"Commission percentage."},"commission_mode_calc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission Mode Calc","description":"Commission calculation mode."},"commission_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Discount","description":"Commission discount."},"commission_discount_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission Discount Percent","description":"Commission discount percentage."},"commission_after_discount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Commission After Discount","description":"Total commission minus commission discount."},"contact":{"anyOf":[{"$ref":"#/components/schemas/DealContactSchema"},{"type":"null"}],"description":"Contact associated with the deal."},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"Required only when creating a deal, not for Kanban management."},"contact_type":{"enum":["person","organization",null],"title":"Contact Type","description":"Required only when creating a deal, not for Kanban management."},"date_close":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Close","description":"Expected or actual closing date of the deal."},"deals_links":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Deals Links","description":"Links to related deals."},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Internal database ID for the deal."},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Internal database key for the deal."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description or notes about the deal."},"deal_before_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Before Id","description":"ID of the previous deal, if applicable."},"entry_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Entry Value","description":"Initial value or entry amount for the deal."},"flag":{"items":{"type":"string"},"type":"array","title":"Flag","description":"Custom flags or tags associated with the deal.","default":[]},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Indicates if the deal is marked as a favorite."},"fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Fields","description":"Custom fields and their values."},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/DealGuaranteesSchema"},{"type":"null"}],"description":"Guarantees associated with the deal."},"interest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest","description":"\n Interest rate or related information. Literal: ['buy', 'rent', 'vacation_rental'],\n required when creating a deal. If use tool 'prod_create_deals' and not provided by user,\n use default 'buy'."},"monthly_income":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Monthly Income","description":"Monthly income related to the deal."},"network":{"anyOf":[{"$ref":"#/components/schemas/NetworkInfoSchema"},{"type":"null"}],"description":"Network information for the deal."},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the deal is shared with network group members."},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"},{"type":"null"}],"description":"Pipeline group details."},"pipeline_group_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Pipeline Group Id","description":"ID of the pipeline group. Value is required when creating a new deal."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline Group Name","description":"Name of the pipeline group."},"profile":{"items":{"$ref":"#/components/schemas/DealProfileSchema"},"type":"array","title":"Profile","description":"List of profiles associated with the deal.","default":[]},"progress":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Progress","description":"Current progress status of the deal."},"properties_presented":{"items":{"$ref":"#/components/schemas/DealPropertyPresentedSchema"},"type":"array","title":"Properties Presented","description":"List of properties presented in the deal.","default":[]},"properties_captured":{"items":{"$ref":"#/components/schemas/DealPropertyCapturedSchema"},"type":"array","title":"Properties Captured","description":"List of captured properties in the deal.","default":[]},"proposal":{"anyOf":[{"$ref":"#/components/schemas/MemberProposalSchema"},{"type":"null"}],"description":"Proposal details related to the deal."},"reserves_expired":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reserves Expired","description":"Number of expired reserves."},"stage":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Stage","description":"This value is pipeline_id. Value is required when creating a new deal."},"stage_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage Count","description":"Number of stages passed through."},"stage_history":{"items":{"$ref":"#/components/schemas/StageHistorySchema"},"type":"array","title":"Stage History","description":"History of stage transitions."},"status":{"anyOf":[{"enum":["stagnant","in progress","out_of_date","win","lost",null]},{"type":"null"}],"title":"Status","description":"REQUIRED when creating a deal (POST /v1/deals), tool (prod_create_deals). If use tool 'prod_create_deals' and not provided by user, use default 'in progress'. Literal: stagnant, in progress, out_of_date, win, lost."},"stagnant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stagnant","description":"Indicates whether the deal is stagnant."},"activities_overdue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Overdue","description":"Number of overdue activities."},"activities_scheduled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Activities Scheduled","description":"Number of scheduled activities."},"today_activities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Today Activities","description":"Number of activities scheduled for today."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the deal. Required when creating a deal. If create a deal and not provided by user, use default 'New Deal + contact_name'."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Creation timestamp of the deal."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At","description":"Last updated timestamp of the deal."},"user":{"anyOf":[{"$ref":"#/components/schemas/DealUserSchema"},{"type":"null"}],"description":"User assigned to the deal."},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"ID of the user assigned to the deal."},"vacation_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation End","description":"End date of vacation period related to the deal."},"vacation_start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vacation Start","description":"Start date of vacation period related to the deal."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Total monetary value of the deal. Required only when creating a deal, not for Kanban management."},"visits":{"items":{"$ref":"#/components/schemas/DealVisitSchema"},"type":"array","title":"Visits","description":"List of visits related to the deal.","default":[]},"without_activities":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Activities","description":"Indicates if the deal has no activities."},"commissions":{"items":{"$ref":"#/components/schemas/DealCommissionSchema"},"type":"array","title":"Commissions","description":"Detailed commission information.","default":[]},"generate_financial_income":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Financial Income","description":"Indicates if the deal generates financial income."},"generate_gross_receipt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Gross Receipt","description":"Indicates if the deal generates gross receipts."},"commission_was_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Commission Was Created","description":"Indicates if a commission record was created."},"net_commission":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Commission","description":"Net commission amount."},"generate_financial_transactions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Financial Transactions","description":"Indicates if financial transactions are generated for the deal."},"lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost Reason","description":"Reason why the deal was lost."},"lost_comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lost Comment","description":"Comment providing more details about the lost deal."},"participants":{"items":{"$ref":"#/components/schemas/ParticipantInfoSchema"},"type":"array","title":"Participants","description":"List of participants involved in the deal.","default":[]},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"Indicates if the deal is private."},"send_property_match":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match","description":"Indicates if property match emails should be sent."},"send_property_match_by_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Property Match By Whatsapp","description":"Indicates if property match should be sent via WhatsApp."},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","description":"List of default values for custom fields.","default":[]},"send_for_lease_online":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send For Lease Online","description":"Indicates if the deal should be sent to online lease platform."},"from_rotation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"From Rotation","description":"Indicates if the deal originated from rotation."},"rotation_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rotation Description","description":"Description of how the deal was rotated."},"without_property":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Without Property","description":"Indicate if the deal not has linked with property"}},"type":"object","title":"DealsFieldsSchema"},"DealsFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/DealFieldConfigurationSchemas"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"pipelines_groups_key":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Pipelines Groups Key","default":[]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","default":false}},"type":"object","required":["configuration"],"title":"DealsFieldsSchemas"},"DealsFieldsUpdateSchemas":{"properties":{"deal_field":{"$ref":"#/components/schemas/DealsFieldSchemas"}},"type":"object","required":["deal_field"],"title":"DealsFieldsUpdateSchemas"},"DealsRouterSchema":{"properties":{"deal":{"$ref":"#/components/schemas/DealsFieldsSchema","description":"All params in the deal, ex: {'deal': {'title': 'Deal 1', 'value': 1000}}"}},"type":"object","required":["deal"],"title":"DealsRouterSchema"},"DocumentContactSchema":{"properties":{"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DocumentContactSchema"},"DocumentContractSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"DocumentContractSchema"},"DocumentDealSchema":{"properties":{"deal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Key"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DocumentDealSchema"},"DocumentFieldsSchema":{"properties":{"ignore_short_url":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Short Url","description":"If true, disables automatic short URL generation for the document"},"signers":{"items":{"$ref":"#/components/schemas/DocumentSignerSchema"},"type":"array","title":"Signers","description":"List of people who will sign the document","default":[]},"contacts":{"items":{"$ref":"#/components/schemas/DocumentContactSchema"},"type":"array","title":"Contacts","description":"List of contacts associated with the document","default":[]},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Origin or platform of the document creation (e.g., CRM, automation). Required for documents created via API"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"Type of the document, such as contract, lease, or inspection. Required for documents created via API"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the document (e.g., pending, signed, canceled). Required for documents created via API"},"name":{"type":"string","title":"Name","description":"Name or title of the document"},"sign_in_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sign In Order","description":"If true, signers must sign in the defined order"},"shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shared","description":"If true, the document will be shared with the involved parties"},"invoice_key":{"anyOf":[{},{"type":"null"}],"title":"Invoice Key","description":"Invoice identifier associated with the document, if applicable"},"inspection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inspection Id","description":"ID of the inspection linked to this document"},"digital_inspection":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Inspection","description":"Indicates whether the document is related to a digital inspection"},"text_templates":{"items":{"$ref":"#/components/schemas/DocumentTemplateSchema"},"type":"array","title":"Text Templates","description":"Required when no files are provided for the document. A list of text-based templates used to generate the document","default":[]},"deal":{"anyOf":[{"$ref":"#/components/schemas/DocumentDealSchema"},{"type":"null"}],"description":"Information about the related deal"},"lease":{"anyOf":[{"$ref":"#/components/schemas/DocumentLeaseSchema"},{"type":"null"}],"description":"Information about the related lease"},"contract":{"anyOf":[{"$ref":"#/components/schemas/DocumentContractSchema"},{"type":"null"}],"description":"Information about the related contract"},"property":{"anyOf":[{"$ref":"#/components/schemas/DocumentPropertySchema"},{"type":"null"}],"description":"Details of the associated property"},"visit":{"anyOf":[{"$ref":"#/components/schemas/DocumentPropertySchema"},{"type":"null"}],"description":"Property visit data linked to this document"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"Internal comments or notes about the document"},"file":{"anyOf":[{"$ref":"#/components/schemas/DocumentFileSchema"},{"type":"null"}],"description":"Deprecated field. Use 'files' instead"},"files":{"items":{"$ref":"#/components/schemas/DocumentFileSchema"},"type":"array","title":"Files","description":"Required if no text template is provided for the document. List of uploaded files to be signed","default":[]},"signer_digital":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Digital","description":"Email or identifier of the digital signer, if applicable"}},"type":"object","required":["name"],"title":"DocumentFieldsSchema"},"DocumentFileSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the file"},"file_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Type","description":"Type of the file"},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size","description":"Size of the file"},"blob_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key","description":"Blob key of the file"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Path of the file"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL of the file"},"short_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Key","description":"Short key of the file"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the file"}},"type":"object","title":"DocumentFileSchema"},"DocumentLeaseSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DocumentLeaseSchema"},"DocumentPropertySchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"DocumentPropertySchema"},"DocumentRouterSchema":{"properties":{"document":{"$ref":"#/components/schemas/DocumentFieldsSchema","description":"All params in the document, ex: {'document': {'name': 'Contract 1', 'signers': [...], 'files': [...]}}"}},"type":"object","required":["document"],"title":"DocumentRouterSchema"},"DocumentSignerSchema":{"properties":{"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"contact_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"signer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Email"},"item_action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Action"},"authentication_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authentication Method"},"certificate_icpbr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Certificate Icpbr"},"face_to_face_signature":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Face To Face Signature"},"document_with_photo":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Document With Photo"},"document_with_selfie":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Document With Selfie"},"foreign":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Foreign"},"signer_number":{"anyOf":[{"$ref":"#/components/schemas/SignerNumberSchema"},{"type":"null"}]},"signer":{"anyOf":[{"$ref":"#/components/schemas/SignerSchema"},{"type":"null"}]},"signer_upload_documents":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Signer Upload Documents"},"signer_upload_documents_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Upload Documents Message"},"send_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Email"},"signer_whatsapp_number":{"anyOf":[{"$ref":"#/components/schemas/PhoneSchema"},{"type":"null"}]},"certificate_icpbr_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Icpbr Type"},"certificate_icpbr_cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Icpbr Cpf"},"certificate_icpbr_cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Icpbr Cnpj"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position"}},"type":"object","title":"DocumentSignerSchema"},"DocumentTemplateSchema":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"type":"object","title":"DocumentTemplateSchema"},"DocumentUpdateFieldsSchema":{"properties":{"ignore_short_url":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Short Url","description":"If true, disables automatic short URL generation for the document"},"signers":{"items":{"$ref":"#/components/schemas/DocumentSignerSchema"},"type":"array","title":"Signers","description":"List of people who will sign the document","default":[]},"contacts":{"items":{"$ref":"#/components/schemas/DocumentContactSchema"},"type":"array","title":"Contacts","description":"List of contacts associated with the document","default":[]},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Origin or platform of the document creation (e.g., CRM, automation). Required for documents created via API"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"Type of the document, such as contract, lease, or inspection. Required for documents created via API"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the document (e.g., pending, signed, canceled). Required for documents created via API"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"sign_in_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sign In Order","description":"If true, signers must sign in the defined order"},"shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shared","description":"If true, the document will be shared with the involved parties"},"invoice_key":{"anyOf":[{},{"type":"null"}],"title":"Invoice Key","description":"Invoice identifier associated with the document, if applicable"},"inspection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inspection Id","description":"ID of the inspection linked to this document"},"digital_inspection":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Inspection","description":"Indicates whether the document is related to a digital inspection"},"text_templates":{"items":{"$ref":"#/components/schemas/DocumentTemplateSchema"},"type":"array","title":"Text Templates","description":"Required when no files are provided for the document. A list of text-based templates used to generate the document","default":[]},"deal":{"anyOf":[{"$ref":"#/components/schemas/DocumentDealSchema"},{"type":"null"}],"description":"Information about the related deal"},"lease":{"anyOf":[{"$ref":"#/components/schemas/DocumentLeaseSchema"},{"type":"null"}],"description":"Information about the related lease"},"contract":{"anyOf":[{"$ref":"#/components/schemas/DocumentContractSchema"},{"type":"null"}],"description":"Information about the related contract"},"property":{"anyOf":[{"$ref":"#/components/schemas/DocumentPropertySchema"},{"type":"null"}],"description":"Details of the associated property"},"visit":{"anyOf":[{"$ref":"#/components/schemas/DocumentPropertySchema"},{"type":"null"}],"description":"Property visit data linked to this document"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"Internal comments or notes about the document"},"file":{"anyOf":[{"$ref":"#/components/schemas/DocumentFileSchema"},{"type":"null"}],"description":"Deprecated field. Use 'files' instead"},"files":{"items":{"$ref":"#/components/schemas/DocumentFileSchema"},"type":"array","title":"Files","description":"Required if no text template is provided for the document. List of uploaded files to be signed","default":[]},"signer_digital":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signer Digital","description":"Email or identifier of the digital signer, if applicable"}},"type":"object","title":"DocumentUpdateFieldsSchema"},"DocumentUpdateRouterSchema":{"properties":{"document":{"$ref":"#/components/schemas/DocumentUpdateFieldsSchema"},"reconcile":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reconcile","default":false}},"type":"object","required":["document"],"title":"DocumentUpdateRouterSchema"},"FieldValueDefault":{"properties":{"field_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Field Id"},"value":{"anyOf":[{},{"type":"null"}],"title":"Value"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"FieldValueDefault"},"FinancialAccountNotaFiscalSchema":{"properties":{"landlord_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Transaction Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"FinancialAccountNotaFiscalSchema"},"FinancialAccountsBankSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"FinancialAccountsBankSchema"},"FinancialAccountsFieldsSchema":{"properties":{"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"initial_value":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"null"}],"title":"Initial Value"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"agency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agency"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"bank":{"anyOf":[{"$ref":"#/components/schemas/FinancialAccountsBankSchema"},{"type":"null"}]},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite"},"bank_integrations":{"anyOf":[{"items":{"oneOf":[{"$ref":"#/components/schemas/PJBankSchema"},{"$ref":"#/components/schemas/ImobziBankSlipSchema"},{"$ref":"#/components/schemas/PJBankCreditCardSchema"},{"$ref":"#/components/schemas/ItauTecnoSpeedSchema"},{"$ref":"#/components/schemas/InterTecnoSpeedSchema"},{"$ref":"#/components/schemas/SicrediTecnoSpeedSchema"},{"$ref":"#/components/schemas/SicoobTecnoSpeedSchema"},{"$ref":"#/components/schemas/SantanderTecnoSpeedSchema"},{"$ref":"#/components/schemas/BradescoTecnoSpeedSchema"}],"discriminator":{"propertyName":"name","mapping":{"bradesco":"#/components/schemas/BradescoTecnoSpeedSchema","imobzi_bank_slip":"#/components/schemas/ImobziBankSlipSchema","inter":"#/components/schemas/InterTecnoSpeedSchema","itau":"#/components/schemas/ItauTecnoSpeedSchema","pjbank":"#/components/schemas/PJBankSchema","pjbank_card":"#/components/schemas/PJBankCreditCardSchema","santander":"#/components/schemas/SantanderTecnoSpeedSchema","sicoob":"#/components/schemas/SicoobTecnoSpeedSchema","sicredi":"#/components/schemas/SicrediTecnoSpeedSchema"}}},"type":"array"},{"type":"null"}],"title":"Bank Integrations"},"generate_keys":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Keys","default":false},"generate_certificate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Generate Certificate","default":false},"certificate_to_bank":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate To Bank"}},"type":"object","title":"FinancialAccountsFieldsSchema"},"FinancialCategorySchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database ID intern"},"name":{"type":"string","title":"Name","description":"Category name"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Category subcategory. Required for create"},"category_type":{"type":"string","enum":["expense","revenue",""],"title":"Category Type","description":"Category type"}},"type":"object","required":["name","category_type"],"title":"FinancialCategorySchema"},"FinancialCategoryUpdateSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database ID intern"},"name":{"type":"string","title":"Name","description":"Category name"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Category subcategory. Required for create"},"category_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Type"},"move_transactions_to":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Move Transactions To"}},"type":"object","required":["name"],"title":"FinancialCategoryUpdateSchema"},"FinancialContactFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Unique identifier of the contact in the database. Can be string or integer depending on the source."},"type":{"anyOf":[{"type":"string","enum":["lead","person","organization","contact","user"]},{"type":"null"}],"title":"Type","description":"Type of contact related to the financial transaction. Can be one of: 'lead', 'person', 'organization', or 'contact'."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Full name of the contact."},"email":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email"}},"type":"object","title":"FinancialContactFieldsSchema"},"FinancialContactSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"email":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email","default":[]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"FinancialContactSchema"},"FinancialLandlordAccountAttachments":{"properties":{"attachment_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Attachment Id","description":"Unique identifier of the attachment."},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path","description":"Internal storage path of the attachment file."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Original name of the attachment file."},"file_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Type","description":"MIME type or extension of the attachment (e.g., 'image/png', 'pdf')."},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size","description":"Size of the file, usually represented in bytes or a readable format (e.g., '2MB')."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Public or signed URL to access the attachment."},"blob_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key","description":"Key reference to the file stored in blob storage."}},"type":"object","title":"FinancialLandlordAccountAttachments"},"FinancialLandlordAccountContact":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"FinancialLandlordAccountContact"},"FinancialLandlordAccountCredit":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"FinancialLandlordAccountCredit"},"FinancialLandlordAccountDebit":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"FinancialLandlordAccountDebit"},"FinancialLandlordAccountLease":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"FinancialLandlordAccountLease"},"FinancialLandlordAccountResponse":{"properties":{"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Landlord Account Id","description":"ID of the landlord account"},"contact_key":{"type":"string","title":"Contact Key","description":"Key of the contact associated with the landlord account"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Contact Id","description":"ID of the contact associated with the landlord account"},"contact_type":{"type":"string","title":"Contact Type","description":"Type of the contact associated with the landlord account"},"contact_name":{"type":"string","title":"Contact Name","description":"Name of the contact associated with the landlord account"},"contact_profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Profile Image","description":"Profile image of the contact associated with the landlord account"},"balance":{"type":"number","title":"Balance","description":"Current balance of the landlord account"}},"type":"object","required":["landlord_account_id","contact_key","contact_id","contact_type","contact_name","balance"],"title":"FinancialLandlordAccountResponse"},"FinancialLandlordAccountTransactionResponse":{"properties":{"landlord_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Transaction Id"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"group_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Id"},"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key"},"guaranteed_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guaranteed Rental"},"guaranteed_rental_is_paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guaranteed Rental Is Paid"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At"},"repeat_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Frequency"},"repeat_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Type"},"repeat_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Total"},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"invoice_onlending_split":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Onlending Split"},"account_debit":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountDebit"},{"type":"null"}]},"account_credit":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountCredit"},{"type":"null"}]},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"nota_fiscal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nota Fiscal Key"},"financial_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Financial Transaction Id"},"lease_item_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lease Item Index"},"lease_item_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Item Description"},"lease":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Lease"},"transaction_paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Transaction Paid"},"transaction_operation_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transaction Operation Id"},"custom_json":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Json"},"contact":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Contact"},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address"},"property_address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address Complement"},"property_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Property Code"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"},"attachments":{"items":{"$ref":"#/components/schemas/FinancialLandlordAccountAttachments"},"type":"array","title":"Attachments","default":[]}},"type":"object","title":"FinancialLandlordAccountTransactionResponse"},"FinancialLandlordAccountTransactionsResponse":{"properties":{"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"has_invoice_overdue":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Invoice Overdue"},"transactions":{"items":{"$ref":"#/components/schemas/FinancialLandlordAccountTransactionResponse"},"type":"array","title":"Transactions","default":[]}},"type":"object","title":"FinancialLandlordAccountTransactionsResponse"},"FinancialLandlordsAccountResponse":{"properties":{"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total","description":"Total balance of the landlord accounts"},"total_credit_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Credit Balance","description":"Total credit balance of the landlord accounts"},"total_debit_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Debit Balance","description":"Total debit balance of the landlord accounts"},"debit_balance":{"items":{"$ref":"#/components/schemas/StringValue"},"type":"array","title":"Debit Balance","description":"List of debit balances for landlord accounts","default":[]},"without_balance":{"items":{"$ref":"#/components/schemas/StringValue"},"type":"array","title":"Without Balance","description":"List of landlord accounts without balance","default":[]},"debit_balance_next_page":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Debit Balance Next Page","description":"Next page for debit balance pagination"},"credit_balance_next_page":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Balance Next Page","description":"Next page for credit balance pagination"},"without_balance_next_page":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Without Balance Next Page","description":"Next page for accounts without balance pagination"}},"type":"object","title":"FinancialLandlordsAccountResponse"},"FinancialTransactionFieldSchema":{"properties":{"account":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"account_credit":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Type"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"total_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"invoice_onlending_account_credit":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"invoice_onlending_split":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Onlending Split"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id"},"paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Paid"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At"},"repeat_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Type"},"sum_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sum Type"},"repeat_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Frequency"},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type"},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags associated with the transaction.","default":[]},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method"},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type"},"financial_conciliation_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Financial Conciliation Transaction Id"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"bank_slip_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bank Slip Id"},"lease_item_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lease Item Index"},"lease_item_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Item Description"},"contact":{"anyOf":[{"$ref":"#/components/schemas/FinancialContactFieldsSchema"},{"type":"null"}]},"landlord_account_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id"},"landlord_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Transaction Id"},"landlord_transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Transaction Type"},"operation_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Operation Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"day_last_item":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Day Last Item"},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key"},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code"},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address"},"property_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Property Id"}},"type":"object","title":"FinancialTransactionFieldSchema"},"FinancialTransactionResponseGet":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation"},"financial_conciliation_transaction_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Financial Conciliation Transaction Id"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id"},"paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Paid"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type"},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"operation_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Operation Id"},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method"},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"contact":{"anyOf":[{"$ref":"#/components/schemas/FinancialContactFieldsSchema"},{"type":"null"}]},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentsFieldsSchema"},"type":"array","title":"Attachments","description":"List of attached files (e.g., receipts, invoices, proofs of payment).","default":[]},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags associated with the transaction.","default":[]},"account_from":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"account_to":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}]},"bank_slip_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bank Slip Id"},"bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Type"},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key"},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Code"},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address"},"property_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Property Id"}},"type":"object","title":"FinancialTransactionResponseGet"},"FinancialTransactionResponsePost":{"properties":{"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id"}},"type":"object","title":"FinancialTransactionResponsePost"},"FinancialTransactionsResponseGet":{"properties":{"coming_expenses":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coming Expenses"},"coming_incomes":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coming Incomes"},"expenses":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Expenses"},"incomes":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Incomes"},"next_page":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Page"},"previous_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Previous Balance"},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total"},"transaction_type_rule":{"items":{"type":"string"},"type":"array","title":"Transaction Type Rule","default":["income","initial_value","expense","transference"]},"transactions":{"items":{"$ref":"#/components/schemas/FinancialTransactionFieldSchema"},"type":"array","title":"Transactions","description":"List of financial transactions retrieved.","default":[]},"user_has_conciliation_permission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"User Has Conciliation Permission"}},"type":"object","title":"FinancialTransactionsResponseGet"},"FinancialTransactionsSchema":{"properties":{"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type","description":"Type of financial transaction. Supported values: 'income', 'expense', 'transference'. Required."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"Payment method used if the transaction is marked as paid. Required when 'paid' = true (e.g., 'credit_card', 'pix', 'boleto')."},"bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Type","description":"Reference name for the bank integration that will be sent to the bank."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Monetary value of the transaction. Must be greater than zero. Required for all transaction types."},"interest_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Interest Value","description":"Interest applied to the transaction, if any."},"additional_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Additional Value","description":"Additional charges or fees applied to the transaction."},"discount_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Discount Value","description":"Discount amount applied to the transaction."},"account":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Financial account linked to the transaction. Required for 'income' and 'expense'. Must include 'db_id'."},"account_from":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Source account when transferring funds. Required for 'transference'."},"account_to":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Destination account when transferring funds. Required for 'transference'."},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentsFieldsSchema"},"type":"array","title":"Attachments","description":"List of attached files (e.g., receipts, invoices, proofs of payment).","default":[]},"paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Paid","description":"Indicates whether the transaction is paid (true/false). If true, both 'paid_at' and 'payment_method' are required."},"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key","description":"Unique key identifier of the contact linked to the transaction."},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key","description":"PIX key used for payment (e.g., CPF, email, phone number, random key)."},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type","description":"Type of PIX key (e.g., 'cpf', 'email', 'phone', 'random')."},"account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Key","description":"Unique account key identifier. Can be used instead of 'account'."},"financial_conciliation_transaction_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Financial Conciliation Transaction Id","description":"ID of a related conciliation transaction, if applicable."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Transaction category (e.g., 'Rent', 'Utilities'). Must be a valid system category."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Detailed transaction subcategory (e.g., 'Electricity', 'Water'). Typically requires 'category'."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Free text description or notes about the transaction."},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation","description":"Optional free text observation about the transaction."},"tags":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Tags","description":"One or more tags used to classify the transaction. Can be a single string or a list of strings.","default":[]},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At","description":"Date when the transaction was paid. Required if 'paid' = true. Format: 'YYYY-MM-DD'."},"account_credit":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Account credited by the transaction (mainly for internal use)."},"contact":{"anyOf":[{"$ref":"#/components/schemas/FinancialContactFieldsSchema"},{"type":"null"}],"description":"Contact information linked to the transaction. Required for creation."},"repeat_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Type","description":"Recurrence type of the transaction. Supported values: 'unique', 'recurrent', 'installment'. Required."},"repeat_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Total","description":"Total number of repetitions for a recurring transaction. Cannot exceed 999."},"repeat_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Frequency","description":"Frequency of recurrence (e.g., 'monthly', 'weekly'). Required if 'repeat_type' != 'unique'."},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date","description":"Due date of the transaction. Required. Format: 'YYYY-MM-DD'."},"duplicated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Duplicated","description":"Indicates if this transaction is a duplicate of another (true/false)."},"qrcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qrcode","description":"QR Code string (usually Base64) for PIX payment."},"bar_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bar Code","description":"Bar code string for boleto or other slip-based payment methods."},"landlord_transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Transaction Type","description":"Specific type of transaction related to landlord operations (e.g., 'rent_payment')."},"send_not_onlending_report":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"null"}],"title":"Send Not Onlending Report","description":"Whether this transaction should appear in the 'not-onlending' report (true/false)."},"sum_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sum Type","description":"Specific type of transaction sum (e.g., 'bank_slip_fee')."},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key","description":"Property urlsafe key to link the transaction to a specific property."}},"type":"object","title":"FinancialTransactionsSchema"},"FinancingSimulatorSchema":{"properties":{"default_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Price"},"minimum_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Minimum Price"},"maximum_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum Price"},"standard_entry":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Standard Entry"},"interest_rate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interest Rate"},"years":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Years"}},"type":"object","title":"FinancingSimulatorSchema"},"GeoCoordinatesSchema":{"properties":{"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat"},"lon":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lon"}},"type":"object","title":"GeoCoordinatesSchema"},"GeoLocationSchema":{"properties":{"coordinates":{"anyOf":[{"$ref":"#/components/schemas/GeoCoordinatesSchema"},{"type":"null"}]},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"}},"type":"object","title":"GeoLocationSchema"},"GuestsSchema":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"GuestsSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HireInsuranceRouterSchema":{"properties":{"insurance_type":{"anyOf":[{"type":"string","enum":["fire_insurance","bail_insurance","credpago"]},{"type":"null"}],"title":"Insurance Type"},"insurance_category":{"anyOf":[{"type":"string","enum":["business","residential"]},{"type":"null"}],"title":"Insurance Category"},"index_to_save":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Index To Save"},"lease_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Lease Id"},"installments_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments Number"},"base_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Value"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"installment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Installment Value"},"renew":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Renew"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User"},"assistance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assistance"},"installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"},"safe_start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safe Start At"},"safe_end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Safe End At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"payment_condition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Condition"},"tenant_mother_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Mother Name"},"recurrent_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Recurrent Value"},"recurrent_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Recurrent Total"},"insurance_recurrent_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Insurance Recurrent Total"},"insurance_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Insurance Value"},"insurance_recurrent_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Insurance Recurrent Value"}},"type":"object","title":"HireInsuranceRouterSchema"},"HotscoolSchema":{"properties":{"access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access Token"},"courses":{"items":{"type":"string"},"type":"array","title":"Courses","description":"List of courses the user is enrolled in.","default":[]},"last_access":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Access"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"HotscoolSchema"},"ImobziBankSlipSchema":{"properties":{"name":{"type":"string","const":"imobzi_bank_slip","title":"Name","default":"imobzi_bank_slip"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"pix":{"anyOf":[{"$ref":"#/components/schemas/PixSchema"},{"type":"null"}]},"request_authorization":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Authorization"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"name_or_company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Or Company Name"},"cpf_cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf Cnpj"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"ImobziBankSlipSchema"},"InterTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"inter","title":"Name","default":"inter"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"certificate_crt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Crt"},"certificate_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Key"},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"}},"type":"object","title":"InterTecnoSpeedSchema"},"InvoiceAccountSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id","description":"Unique identifier for the account"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the account"}},"type":"object","required":["db_id"],"title":"InvoiceAccountSchema"},"InvoiceBeneficiarySchema":{"properties":{"action":{"anyOf":[{"enum":["PUT","DELETE","POST",null]},{"type":"null"}],"title":"Action","description":"Action to be performed with the beneficiary","examples":["PUT","DELETE","POST"]},"bank_data":{"anyOf":[{"$ref":"#/components/schemas/BanksFieldsSchema"},{"type":"null"}],"description":"Bank data of the beneficiary, if exist and not have split pix"},"bank_data_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Data Key","description":"Bank data key of the beneficiary, if exist and not have split pix"},"beneficiary_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Beneficiary Id","description":"Unique identifier for the beneficiary, if exist"},"contact_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id","description":"Unique identifier database for the contact associated with the beneficiary"},"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key","description":"Key database of the contact associated with the beneficiary. Required for create a new beneficiary"},"invoice_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Id","description":"Unique identifier database for the invoice. Required for create a new beneficiary"},"lease_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Key","description":"Key database of the lease associated with the invoice, if exist"},"onlending_data":{"anyOf":[{"$ref":"#/components/schemas/InvoiceOnlendingDataSchema"},{"type":"null"}],"description":"Onlending data associated with the beneficiary, if exist"},"parent_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Unique identifier database for the parent entity, if exist"},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key","description":"Key database of the property associated with the invoice, if exist"},"split_pix":{"anyOf":[{"$ref":"#/components/schemas/SplitPixSchema"},{"type":"null"}],"description":"Split Pix data for the beneficiary, if exist"}},"type":"object","title":"InvoiceBeneficiarySchema"},"InvoiceContactSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id","description":"Unique identifier for the contact"},"type":{"type":"string","title":"Type","description":"Type of contact if person or organization"}},"type":"object","required":["db_id","type"],"title":"InvoiceContactSchema"},"InvoiceContractSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code identifier for the contract. Required for create"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Unique identifier for the contract. Required for create"},"new_link":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"New Link","description":"Indicates if the contract has a new link with other contract"}},"type":"object","title":"InvoiceContractSchema"},"InvoiceItemSchema":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id","description":"ID intern of the invoice item"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action to be performed on the invoice item","examples":["create","update","delete"]},"bar_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bar Code","description":"Bar code of the invoice item"},"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key","description":"Key of the contact associated with the invoice item"},"description":{"type":"string","title":"Description","description":"Description of the invoice item","default":""},"invoice_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Id","description":"ID intern generated automatically"},"invoice_item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Item Id","description":"ID intern of the invoice item"},"value":{"type":"number","title":"Value","description":"Value of the invoice item","default":0},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Indicates if the invoice item is included in DIMOB (Declaração de Imposto de Renda de Pessoa Física)","default":false},"until_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Due Date","description":"Indicates if the invoice item is valid until the due date","default":false},"behavior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behavior","description":"Behavior of the invoice item","default":"","examples":["charge_tenant","charge_tenant_and_onlend"]},"charge_management_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Charge Management Fee","description":"Indicates if the invoice item includes a management fee","default":false},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"Due date for the invoice item"},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type","description":"Type of the invoice item","default":"lease_value","examples":["lease_value"]},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Financial category of the invoice item"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Financial subcategory of the invoice item"},"created_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Created At","description":"Created at date of the invoice item"},"updated_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Updated At","description":"Last date the invoice item was updated"},"recurrent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recurrent","description":"Indicates if the invoice item is recurrent","default":false},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"Start date of the invoice item in ISO format (yyyy-mm-dd)","default":""},"repeat_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Total","description":"Total number of repetitions for the invoice item","default":0},"repeat_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Index","description":"Current repetition index of the invoice item","default":0},"contact":{"anyOf":[{"$ref":"#/components/schemas/ContractContactSchema"},{"type":"null"}],"description":"Contact associated with the invoice item"},"has_annual_readjustment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Annual Readjustment","description":"Indicates if the invoice item has an annual readjustment"}},"type":"object","title":"InvoiceItemSchema"},"InvoiceItemsSchema":{"properties":{"value":{"type":"number","title":"Value","description":"Value of the invoice item"},"description":{"type":"string","title":"Description","description":"Description of the invoice item"},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Indicate if the item should be included in DIMOB (Declaração de Informações sobre Movimentação Imobiliária)"},"charge_management_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Charge Management Fee","description":"Indicate if the item should charge management fee"},"until_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Due Date","description":"Indicate if the item is valid until the due date"},"landlords":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/StringValue"},{"type":"string"},{"type":"integer"}]},"type":"array"},{"type":"null"}],"title":"Landlords","description":"List of landlords associated with the invoice item, if exist"},"bar_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bar Code","description":"Bar code of the invoice item, if exist"},"behavior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behavior","description":"Behavior of the invoice item. Required for create","examples":["charge_tenant_and_onlend","charge_tenant","charge_tenant_and_real_state_manager","charge_real_state_manager"]},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Financial category of the invoice item, if exist"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Financial subcategory of the invoice item, if exist"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date","description":"Due date of the invoice item, if the item is charge_tenant_and_real_state_manager, format YYYY-MM-DD"},"contact":{"anyOf":[{"$ref":"#/components/schemas/InvoiceContactSchema"},{"type":"null"}],"description":"Contact associated with the invoice item, if the item is charge_tenant_and_real_state_manager, if exist"},"invoice_item_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Invoice Item Id"},"action":{"anyOf":[{"enum":["PUT","DELETE","POST",null]},{"type":"null"}],"title":"Action","description":"Action to be performed with the invoice item","examples":["PUT","DELETE","POST"]}},"type":"object","required":["value","description"],"title":"InvoiceItemsSchema"},"InvoiceLeaseSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Unique identifier for the lease"}},"type":"object","title":"InvoiceLeaseSchema"},"InvoiceOnlendingDataSchema":{"properties":{"bank_data_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Data Key"},"onlending_mode":{"type":"string","title":"Onlending Mode"},"onlending_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Onlending Value"},"percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percent"},"split_pix":{"anyOf":[{"$ref":"#/components/schemas/SplitPixSchema"},{"type":"null"}]}},"type":"object","required":["onlending_mode"],"title":"InvoiceOnlendingDataSchema"},"InvoicePropertySchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id","description":"Unique identifier for the property"}},"type":"object","required":["db_id"],"title":"InvoicePropertySchema"},"InvoiceSchema":{"properties":{"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date","description":"Due date of the invoice, format YYYY-MM-DD. Required for create a new invoice"},"payments_methods_available":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Available payment methods for the invoice. Required for create a new invoice"},"lease":{"anyOf":[{"$ref":"#/components/schemas/InvoiceLeaseSchema"},{"type":"null"}],"description":"Lease associated with the invoice, if exist"},"beneficiaries":{"items":{"$ref":"#/components/schemas/InvoiceBeneficiarySchema"},"type":"array","title":"Beneficiaries","description":"List of beneficiaries associated with the invoice when lease linked in invoice, if exist","default":[]},"contract":{"anyOf":[{"$ref":"#/components/schemas/InvoiceContractSchema"},{"type":"null"}],"description":"Contract associated with the invoice, if exist"},"contact":{"anyOf":[{"$ref":"#/components/schemas/InvoiceContactSchema"},{"type":"null"}],"description":"Contact associated with the invoice, if exist. Required for create a new invoice"},"items":{"items":{"anyOf":[{"$ref":"#/components/schemas/InvoiceItemsSchema"},{"$ref":"#/components/schemas/LeaseItemFieldsSchema"}]},"type":"array","title":"Items","description":"List of items associated with the invoice, if exist","default":[]},"reference_start_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Reference Start At","description":"Start date of the reference period for the invoice, format YYYY-MM-DD"},"reference_end_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Reference End At","description":"End date of the reference period for the invoice, format YYYY-MM-DD"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the invoice, if exist"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the invoice, if exist"},"custom_variables":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"additionalProperties":true,"type":"object"}]},"type":"array"},{"type":"null"}],"title":"Custom Variables","description":"Custom variables associated with the invoice, if exist"},"property":{"anyOf":[{"$ref":"#/components/schemas/InvoicePropertySchema"},{"type":"null"}],"description":"Property associated with the invoice, if exist"},"installment_invoice_manual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Installment Invoice Manual"},"anticipate_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Anticipate Invoice","description":"Indicate if the invoice is an anticipate invoice, if invoice is associated with a sale contract"},"send_invoice_notification_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice Notification Email","description":"Indicate if the invoice notification should be sent by email"},"send_invoice_notification_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice Notification Whatsapp","description":"Indicate if the invoice notification should be sent by WhatsApp"},"rental_invoice_manual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rental Invoice Manual","description":"Indicate if the invoice is a rental invoice, if invoice is associated with a lease","default":true},"payment_method":{"anyOf":[{"type":"string","enum":["bank_slip","credit_card","pix","cash","transference","bank_check","deposit"]},{"type":"null"}],"title":"Payment Method","description":"Payment method used for the invoice","examples":["bank_slip","credit_card","pix","cash"]},"status":{"type":"string","enum":["pending","paid","partially_paid","expired","deleted","canceled","all","overdue","draft","in_process"],"title":"Status","description":"Current status of the invoice","examples":["pending","paid","partially_paid","expired","deleted","canceled","draft"]},"account":{"anyOf":[{"$ref":"#/components/schemas/InvoiceAccountSchema"},{"type":"null"}],"description":"Account associated with the invoice, if exist"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At","description":"Paid date when the invoice was paid, format YYYY-MM-DD"},"difference_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Difference Value","description":"Difference value applied to the invoice when paid with a different value than the total"},"interest_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Value","description":"Interest value applied to the invoice if overdue"},"installments":{"anyOf":[{"items":{},"type":"array"},{"type":"integer"},{"type":"null"}],"title":"Installments"},"send_receipt_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Receipt Tenant","description":"Indicate if the receipt should be sent to the tenant, if exist"},"send_overdue_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification","description":"Indicate if the overdue notification should be sent, if exist"},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of installments allowed if payment method is credit card"},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","description":"Percentage of the credit card fee applied to the invoice, if exist"},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage of the credit card installment fee applied to the invoice, if exist"},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge","description":"Indicate if the interest percent should be applied to the invoice. Only used to define interest_percent, it is not stored in the invoice"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge","description":"Indicate if the fine percent should be applied to the invoice. Only used to define fine_percent, it is not stored in the invoice"},"interest_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent","description":"Interest percentage applied to overdue invoice charge fee, if exist"},"fine_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent","description":"Fine percentage applied to overdue invoice charge fee, if exist"},"pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pass On Fixed Rate","description":"Indicate if the invoice has a fixed rate that should be passed on to the tenant"},"pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pass On Installments Fee","description":"Indicate if the invoice has installments fee that should be passed on to the tenant"},"pay_automatically_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pay Automatically Due Date","description":"Indicate if the invoice can be charged automatically on the credit card of the payer on the due date"},"interest_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest Description","description":"Description of the interest applied to the invoice, if exist"},"charge_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Fee Value","description":"Value of the charge fee applied to the invoice, if exist"},"charge_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Fee","description":"Charge fee value applied to the invoice, if exist"},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Id","description":"Operation identifier for the invoice, if exist"},"quantity_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Quantity Installments","description":"Number of installments for the invoice, if exist"},"credit_card_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Card Info","description":"Credit card information associated with the invoice, if exist"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Name of the user who created the invoice, if exist"},"bank_slip_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bank Slip Id","description":"Bank slip identifier the invoice, when the invoice was send bank"},"bank_slip_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Slip Url","description":"Bank slip url the invoice, when the invoice was send bank"},"bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Type","description":"Bank type associated with the invoice, if exist"},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode","description":"Barcode of the invoice, if exist"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Creation date of the invoice, format YYYY-MM-DD. Only applied for third-party access users, used for refactoring/recharging with a previous reference period"},"only_beneficiaries_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only Beneficiaries In Data","description":"Indicates if the invoice data should only include beneficiaries. This is used when the invoice is related to a lease and only the beneficiaries are needed in the response.","default":false},"confirm_cancel_onlending_paid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confirm Cancel Onlending Paid","description":"Indicate if the user confirmed the cancellation of an invoice that already has a paid onlending to the landlord","default":false}},"type":"object","title":"InvoiceSchema"},"InvoiceSendNotificationReponseSchema":{"properties":{"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"}},"type":"object","title":"InvoiceSendNotificationReponseSchema"},"InvoicesFieldsSchemas":{"properties":{"total_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Value","description":"Total value of the invoice"},"invoice_id":{"type":"string","title":"Invoice Id","description":"Unique identifier for the invoice"},"status":{"type":"string","enum":["pending","paid","partially_paid","expired","deleted","canceled","all","overdue","in_process"],"title":"Status","description":"Current status of the invoice","default":"pending","examples":["pending","paid","partially_paid","expired","deleted","canceled"]},"due_date":{"type":"string","title":"Due Date","description":"Due date of the invoice","examples":["2025-10-01"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the invoice"},"charge_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Fee Value","description":"Value of the charge fee applied to the invoice"},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge","description":"Fixed interest charge for late payment"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge","description":"Fixed fine charge for late payment"},"interest_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent","description":"Interest percentage applied to overdue invoice charge fee"},"fine_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent","description":"Fine percentage applied to overdue invoice charge fee"},"payment_method":{"anyOf":[{"type":"string","enum":["bank_slip","credit_card","pix","cash","transference","bank_check","deposit"]},{"type":"null"}],"title":"Payment Method","description":"Payment method used for the invoice","examples":["bank_slip","credit_card","pix","cash"]},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At","description":"Paid date when the invoice was paid","examples":["2025-10-01"]},"payments_methods_available":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Available payment methods for the invoice. Required for create a new invoice"},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of installments allowed if payment method is credit card"},"interest_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Value","description":"Interest value applied to the invoice if overdue"},"difference_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Difference Value","description":"Difference value applied to the invoice when paid with a different value than the total"},"invoice_url":{"type":"string","title":"Invoice Url","description":"URL to access the invoice details in web","examples":["https://fatura.imobzi.com/ac-fezg2211236e7k/4b93651c6e3511f093541b6a3214867c-b699"]},"contact":{"$ref":"#/components/schemas/InvoiceContactSchema","description":"Contact information associated with the invoice"},"contract":{"$ref":"#/components/schemas/InvoiceContractSchema","description":"Contract associated with the invoice, if exist"},"property":{"anyOf":[{"$ref":"#/components/schemas/InvoicePropertySchema"},{"type":"null"}],"description":"Property associated with the invoice, if exist"},"account":{"anyOf":[{"$ref":"#/components/schemas/InvoiceAccountSchema"},{"type":"null"}],"description":"Account associated with the invoice, if exist"},"bank_slip_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Slip Id","description":"Bank slip identifier the invoice, when the invoice was send bank"},"bank_slip_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Slip Url","description":"Bank slip url the invoice, when the invoice was send bank"},"onlending_split":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Onlending Split","description":"Indicate if the invoice was split onlending to landlord, only for receipt account integration PJBank"},"category":{"type":"string","title":"Category","description":"Category of the invoice"},"subcategory":{"type":"string","title":"Subcategory","description":"Subcategory of the invoice"}},"type":"object","required":["invoice_id","due_date","invoice_url"],"title":"InvoicesFieldsSchemas"},"ItauTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"itau","title":"Name","default":"itau"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"token_temp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Token Temp"},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"}},"type":"object","title":"ItauTecnoSpeedSchema"},"LandlordTransactionsSchema":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the transaction."},"transaction_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Type","description":"Type of the transaction (e.g., 'credit', 'debit')."},"financial_transaction_bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Financial Transaction Bank Type","description":"Reference name for the bank integration that will be sent to the bank. (This field will be save only in financial transaction)"},"contact":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountContact"},{"type":"null"}],"description":"Associated contact information for the transaction."},"repeat_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Type","description":"Defines the recurrence type of the transaction (e.g., 'monthly', 'yearly')."},"repeat_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Repeat Frequency","description":"Frequency of recurrence (e.g., every 2 weeks, every 3 months)."},"repeat_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Total","description":"Total number of times the transaction should repeat."},"lease_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Key","description":"Unique identifier for the lease associated with the transaction."},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At","description":"Date when the transaction was paid. ⚠️ Must be provided in 'YYYY-MM-DD' format (e.g., '2025-08-15'). Do not use 'YYYY/MM/DD', as it will cause a parsing error."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Monetary value of the transaction."},"attachments":{"items":{"$ref":"#/components/schemas/FinancialLandlordAccountAttachments"},"type":"array","title":"Attachments","description":"List of file attachments related to the transaction.","default":[]},"account_debit":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountDebit"},{"type":"null"}],"description":"Account information for the debit side of the transaction."},"account_credit":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountCredit"},{"type":"null"}],"description":"Account information for the credit side of the transaction."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the transaction (e.g., 'Rent', 'Maintenance')."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the transaction (e.g., 'Water Bill', 'Repair')."},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"Identifier of the linked invoice, if applicable."},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id","description":"Identifier of the property related to the transaction."},"send_not_onlending_report":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Not Onlending Report","description":"Indicates whether the transaction should be included in the 'not onlending' report."},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key","description":"PIX key used for payment, if applicable."},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type","description":"Type of PIX key (e.g., 'CPF', 'CNPJ', 'email', 'phone')."},"nota_fiscal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nota Fiscal Key","description":"Unique key of the associated Nota Fiscal (invoice)."},"lease":{"anyOf":[{"$ref":"#/components/schemas/FinancialLandlordAccountLease"},{"type":"null"}],"description":"Lease details associated with the transaction."},"financial_transaction_bar_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Financial Transaction Bar Code","description":"Bar code related to the financial transaction (e.g., boleto)."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"Method of payment (e.g., 'PIX', 'boleto', 'credit_card')."}},"type":"object","title":"LandlordTransactionsSchema"},"LeadIntegrationSchema":{"properties":{"leadOrigin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Leadorigin"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp"},"clientListingId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientlistingid","description":"Property code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"ddd":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ddd"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"phoneNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phonenumber"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"alpha2Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alpha2Code"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"LeadIntegrationSchema"},"LeaseAnnualReadjustmentFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"LeaseAnnualReadjustmentFieldsSchema"},"LeaseBeneficiariesFieldsSchema":{"properties":{"bank_data":{"anyOf":[{"$ref":"#/components/schemas/BanksFieldsSchema"},{"type":"null"}],"description":"Bank information of the beneficiary."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Unique beneficiary code identifier."},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Internal database identifier for the beneficiary."},"onlending_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onlending Date","description":"Date of onlending in 'DD-MM-YYYY' format (e.g., '19-08-2025')."},"onlending_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onlending Mode","description":"Mode of onlending (e.g., automatic, manual)."},"onlending_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Onlending Value","description":"Amount of the onlending value assigned to the beneficiary."},"parent_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Identifier of the parent entity associated with the beneficiary."},"percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percent","description":"Percentage of the total amount assigned to the beneficiary."},"split_pix":{"anyOf":[{"$ref":"#/components/schemas/SplitPixSchema"},{"type":"null"}],"description":"PIX split configuration details for the beneficiary."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of beneficiary (e.g., landlord, guarantor, investor)."}},"type":"object","title":"LeaseBeneficiariesFieldsSchema"},"LeaseCalculateParamsSchema":{"properties":{"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"Duration of the lease, as an integer. Required for period-based calculations (e.g., type=period_by_duration, start_at_by_duration)."},"duration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration Type","description":"Unit of duration. Allowed values: 'month', 'year', 'day'. ⚠️ Plural forms (e.g., 'months') are not accepted."},"method":{"anyOf":[{"type":"string","enum":["installments","in_cash"]},{"type":"null"}],"title":"Method","description":"Calculation method. Used mainly in type=vacation_rental_installments. Accepted values are not fully documented; expected like 'split_equal'. Required if type is vacation_rental_installments"},"installments_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments Amount","description":"Number of installments. Required when method splits the value (e.g., vacation_rental_installments with split_equal)."},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At","description":"Lease start date. Date format depends on type:\n- DD-MM-YYYY for invoice, onlending, period_by_duration, period_by_end_at, start_at_by_duration.\n- ISO YYYY-MM-DD for invoice_reference and possibly lease_rescission_value."},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At","description":"Lease end date (ISO YYYY-MM-DD). Required for invoice_reference, period_by_end_at, and start_at_by_duration."},"onlending":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Onlending","description":"Onlending configuration. Requires start_at, in_progress, due_day, has_invoice, first_rental_in_next_invoice, and beneficiaries[]."},"lease_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lease Value","description":"Total lease value. Preferred for beneficiary and onlending calculations. ⚠️ Do not confuse with 'value', which is used in invoice/management_fee."},"beneficiary":{"anyOf":[{"$ref":"#/components/schemas/LeaseBeneficiariesFieldsSchema"},{"type":"null"}],"description":"Main beneficiary of the lease. Expected in type=beneficiary. Example: {db_id:1, type:'landlord', percent:100}."},"beneficiaries":{"items":{"$ref":"#/components/schemas/LeaseBeneficiariesFieldsSchema"},"type":"array","title":"Beneficiaries","description":"List of beneficiaries. Required for onlending calculations. Distribution is applied after management_fee if present.","default":[]},"next_invoice_end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice End At","description":"End date of the next invoice period (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now."},"next_invoice_start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Start At","description":"Start date of the next invoice period (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now."},"next_invoice_due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Due Date","description":"Due date of the next invoice (ISO YYYY-MM-DD). Required in type=generate_next_invoice_now."},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode","description":"Billing mode (e.g., monthly, quarterly)."},"due_day":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Due Day","description":"Day of the month when the payment is due. Required in type=invoice, onlending, vacation_rental_installments."},"first_rental_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"First Rental In Next Invoice","description":"Whether the first rental should be included in the next invoice. Required in type=invoice and onlending."},"has_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Invoice","description":"Whether invoices are generated for this lease. Required in type=invoice and onlending."},"in_progress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Progress","description":"Whether the lease is currently active. Required in type=onlending and generate_next_invoice_now."},"irrf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf","description":"Whether IRRF (withholding tax) is applied."},"irrf_management_fee_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Management Fee Discount","description":"Whether IRRF applies a discount on management fee."},"irrf_simplified_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Simplified Discount","description":"Whether simplified IRRF discount is applied."},"lease_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code","description":"Unique lease code identifier."},"management_fee":{"anyOf":[{"$ref":"#/components/schemas/LeaseManagementFeeFieldsSchema"},{"type":"null"}],"description":"Management fee configuration. Required in type=management_fee (e.g., {percent:10})."},"property":{"anyOf":[{"$ref":"#/components/schemas/LeasePropertyFieldsSchema"},{"type":"null"}],"description":"Property details linked to the lease."},"tenants":{"items":{"$ref":"#/components/schemas/LeaseTenantFieldsSchema"},"type":"array","title":"Tenants","description":"List of tenants associated with the lease.","default":[]},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Monetary value used in invoice, management_fee, and simple calculations. ⚠️ Not used for beneficiary distribution; for that, use lease_value."},"items":{"items":{"$ref":"#/components/schemas/LeaseItemFieldsSchema"},"type":"array","title":"Items","description":"Additional lease items (e.g., insurance, services). ⚠️ Items are not included in next_invoice_value; only 'value' is used in the total calculation.","default":[]},"rescission_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rescission Date","description":"Rescission date if the lease is terminated early (ISO YYYY-MM-DD). Required in type=lease_rescission_value, but module may also require next_invoice_* fields."},"reference_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Date","description":"Reference date for adjustments (ISO YYYY-MM-DD)."},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate","description":"Whether the lease has an indeterminate (open-ended) duration."},"calculate_from_imobzi":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Calculate From Imobzi","description":"Calculate negative value when come Imobzi"}},"type":"object","title":"LeaseCalculateParamsSchema"},"LeaseChecklistDetailsKeysSchema":{"properties":{"in_place":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Place","description":"Indicates if the keys are in place","default":false},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Date for the checklist keys"}},"type":"object","title":"LeaseChecklistDetailsKeysSchema"},"LeaseChecklistDetailsSchema":{"properties":{"get_keys":{"anyOf":[{"$ref":"#/components/schemas/LeaseChecklistDetailsKeysSchema"},{"type":"null"}],"description":"Keys for checklist details"},"files":{"items":{"$ref":"#/components/schemas/DocumentFileSchema"},"type":"array","title":"Files","description":"List of files associated with the checklist item","default":[]}},"type":"object","title":"LeaseChecklistDetailsSchema"},"LeaseChecklistFieldsSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the checklist item"},"details":{"anyOf":[{"$ref":"#/components/schemas/LeaseChecklistDetailsSchema"},{"type":"null"}],"description":"Details of the checklist item"},"checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Checked","description":"Indicates if the checklist item is checked"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the checklist item"},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Order of the checklist item"}},"type":"object","required":["name"],"title":"LeaseChecklistFieldsSchema"},"LeaseDigitalDocument":{"properties":{"front_identity_document":{"anyOf":[{"$ref":"#/components/schemas/DocumentFileSchema"},{"type":"null"}]},"proof_residence":{"anyOf":[{"$ref":"#/components/schemas/DocumentFileSchema"},{"type":"null"}]},"back_identity_document":{"anyOf":[{"$ref":"#/components/schemas/DocumentFileSchema"},{"type":"null"}]}},"type":"object","title":"LeaseDigitalDocument"},"LeaseFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","default":true},"typebox":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typebox","default":false}},"type":"object","required":["typevalue"],"title":"LeaseFieldConfigurationSchemas"},"LeaseFieldsSchema":{"properties":{"additional_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Additional Guests","description":"Number of additional guests allowed."},"account":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Financial account linked to the onlendings. Must include 'db_id'."},"additional_value_guest":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Additional Value Guest","description":"Additional charge per extra guest."},"annual_readjustment":{"anyOf":[{"$ref":"#/components/schemas/LeaseAnnualReadjustmentFieldsSchema"},{"type":"null"}],"description":"Annual readjustment details."},"beneficiaries":{"items":{"$ref":"#/components/schemas/LeaseBeneficiariesFieldsSchema"},"type":"array","title":"Beneficiaries","description":"List of lease beneficiaries.","default":[]},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode","description":"Billing mode for the lease (e.g., monthly, quarterly)."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the lease."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the lease."},"checklist":{"items":{"$ref":"#/components/schemas/LeaseChecklistFieldsSchema"},"type":"array","title":"Checklist","description":"Checklist associated with the lease.","default":[]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Unique code identifying the lease."},"field_values":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Field Values","description":"Custom field values in key-value format.","default":[]},"create_onlending_item":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Create Onlending Item","description":"Indicates if onlending item should be created."},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage applied for credit card installment."},"credit_card_pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Fixed Rate","description":"Indicates if fixed rate should be passed on credit card payments."},"credit_card_pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Installments Fee","description":"Indicates if installment fees should be passed on credit card payments."},"credit_card_auto_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Auto Charge","description":"Indicates if invoices should be charged automatically on the due date using the card the payer marked for automatic debit."},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","description":"Credit card percentage fee applied."},"daily_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Daily Value","description":"Daily rental value."},"deal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Key","description":"Key associated with the deal."},"documents":{"anyOf":[{"$ref":"#/components/schemas/LeaseDigitalDocument"},{"type":"null"}],"description":"Digital documents linked to the lease."},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"Lease duration as an integer (e.g., 12 for twelve months)."},"duration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration Type","description":"Duration unit. Only 'month' is supported."},"due_day":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Day","description":"Day of the month when payment is due (1–31)."},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At","description":"Lease end date in 'YYYY-MM-DD' format."},"federal_income_tax":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Federal Income Tax","description":"Federal income tax details.","default":[]},"fine_charge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fine Charge","description":"Fixed fine charge for late payment."},"fine_percent_late_payment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fine Percent Late Payment","description":"Fine percentage for late payment."},"first_rental_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"First Rental In Next Invoice","description":"Indicates if the first rental should be charged in the next invoice."},"first_rental_installment":{"items":{"$ref":"#/components/schemas/LeaseFirstRentalInstallmentFieldsSchema"},"type":"array","title":"First Rental Installment","description":"First rental installment details.","default":[]},"guaranteed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guaranteed","description":"Indicates if the lease is guaranteed."},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/LeaseGuaranteeFieldsSchema"},{"type":"null"}],"description":"Guarantee details of the lease."},"guarantee_amount_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guarantee Amount Months","description":"Number of months covered by the guarantee."},"guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guests","description":"Maximum number of guests allowed."},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Indicates if the lease should be included in DIMOB reporting."},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate","description":"Indicates if the lease is indeterminate."},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value","description":"Initial lease value."},"insurances":{"items":{"$ref":"#/components/schemas/LeaseInsuranceFieldsSchema"},"type":"array","title":"Insurances","description":"List of insurance details associated with the lease.","default":[]},"interest_charge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interest Charge","description":"Fixed interest charge for late payment."},"interest_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent Late Payment","description":"Interest percentage applied for late payment."},"in_progress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Progress","description":"Indicates if the lease is currently in progress."},"invoice_shortcut":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Shortcut","description":"Indicates if invoice shortcut is enabled."},"irrf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf","description":"Indicates if IRRF (withholding tax) is applied."},"irrf_management_fee_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Management Fee Discount","description":"Indicates if IRRF management fee discount is applied."},"irrf_simplified_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Simplified Discount","description":"Indicates if simplified IRRF discount is applied."},"items":{"items":{"$ref":"#/components/schemas/LeaseItemFieldsSchema"},"type":"array","title":"Items","description":"List of items included in the lease.","default":[]},"last_annual_readjustment_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Annual Readjustment At","description":"Date of the last annual readjustment in 'YYYY-MM-DD' format."},"lease_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Type","description":"Type of lease (e.g., residential, commercial)."},"management_fee":{"anyOf":[{"$ref":"#/components/schemas/LeaseManagementFeeFieldsSchema"},{"type":"null"}],"description":"Details of the management fee applied."},"next_invoice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice","description":"Date of the next invoice generation in 'YYYY-MM-DD' format."},"next_invoice_due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Due Date","description":"Due date of the next invoice in 'YYYY-MM-DD' format."},"next_invoice_end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice End At","description":"End date of the next invoice period in 'YYYY-MM-DD' format."},"next_invoice_generate_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Generate In","description":"Date when the next invoice should be generated in 'YYYY-MM-DD' format."},"next_invoice_start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Start At","description":"Start date of the next invoice period in 'YYYY-MM-DD' format."},"next_invoice_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value","description":"Value of the next invoice. Must be explicitly provided at lease creation."},"newCodeProperty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Newcodeproperty","description":"Code of the new property if updated."},"new_owners":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOwnerSchema"},"type":"array"},{"type":"null"}],"title":"New Owners"},"notification":{"anyOf":[{"$ref":"#/components/schemas/LeaseNotificationFieldsSchema"},{"type":"null"}],"description":"Notification settings related to the lease."},"nota_fiscal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nota Fiscal","description":"Indicates if nota fiscal (invoice) is generated."},"nota_fiscal_product":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Nota Fiscal Product","description":"Indicate if notas fiscal has product"},"onlending":{"anyOf":[{"$ref":"#/components/schemas/LeaseOnlendingFieldsSchema"},{"type":"null"}],"description":"Onlending configuration. Requires at least 'mode' and/or 'amount_days'. For automatic on-receipt, use mode='amount_days' and amount_days=0."},"onlending_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Onlending Charge","description":"Indicates if onlending charges apply."},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of allowed payment installments."},"property":{"anyOf":[{"$ref":"#/components/schemas/LeasePropertyFieldsSchema"},{"type":"null"}],"description":"Details of the property associated with the lease."},"receipt_methods":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Lease payment methods(can be more than one)."},"send_due_notification_to_sponsor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Due Notification To Sponsor","description":"Indicates if due notifications should be sent to the sponsor."},"send_guarantee_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Guarantee Closeduedate To Tenant","description":"Indicates if guarantee close due date notifications should be sent to tenant."},"send_insurance_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Insurance Closeduedate To Tenant","description":"Indicates if insurance close due date notifications should be sent to tenant."},"send_invoice_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Tenant","description":"Indicates if invoices should be sent to the tenant."},"send_onlending_to_landlord":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Onlending To Landlord","description":"Indicates if onlending details should be sent to the landlord."},"send_overdue_notification_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification To Tenant","description":"Indicates if overdue notifications should be sent to tenant."},"send_notification_invoice_paid_after_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Invoice Paid After Due Date","description":"Indicates if the real estate agency should be notified when an invoice is paid after the due date."},"send_nota_fiscal_in_invoice_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Nota Fiscal In Invoice Create","description":"Indicate if the nota fiscal should be sent when the invoice is created (This field will only be used when the management type is owned properties)."},"service_fee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Fee","description":"Service fee amount applied."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Source of the lease creation."},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At","description":"Lease start date in 'YYYY-MM-DD' format."},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the lease (default: active).","default":"active"},"tenants":{"items":{"$ref":"#/components/schemas/LeaseTenantFieldsSchema"},"type":"array","title":"Tenants","description":"List of tenants associated with the lease."},"termination":{"anyOf":[{"$ref":"#/components/schemas/LeaseTerminationFieldsSchema"},{"type":"null"}],"description":"Termination details of the lease."},"vacation_rental_receipt_option":{"anyOf":[{"$ref":"#/components/schemas/LeaseVacationRentalReceiptOptionFieldsSchema"},{"type":"null"}],"description":"Vacation rental receipt options."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Total lease value."},"only_checklist_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only Checklist In Data","description":"If true, only checklist information will be included in the data.","default":false},"update_beneficiaries":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Update Beneficiaries","description":"If true, beneficiaries will be updated with the provided data.","default":false},"beneficiaries_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Beneficiaries In Data","default":false},"guarantee_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guarantee In Data","default":false},"insurances_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Insurances In Data","default":false},"field_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Field Values In Data","default":false},"items_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Items In Data","default":false}},"type":"object","title":"LeaseFieldsSchema"},"LeaseFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/LeaseFieldConfigurationSchemas"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name"}},"type":"object","required":["configuration"],"title":"LeaseFieldsSchemas"},"LeaseFirstRentalInstallmentFieldsSchema":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"string"}],"title":"Value"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"}},"type":"object","required":["value"],"title":"LeaseFirstRentalInstallmentFieldsSchema"},"LeaseGuaranteeFieldsSchema":{"properties":{"guarantee_type":{"type":"string","title":"Guarantee Type"},"start_at":{"type":"string","title":"Start At"},"end_at":{"type":"string","title":"End At"},"details":{"additionalProperties":true,"type":"object","title":"Details"},"sponsor":{"anyOf":[{"$ref":"#/components/schemas/LeaseGuaranteeSponsorFieldsSchema"},{"type":"null"}]},"sponsors":{"items":{"$ref":"#/components/schemas/LeaseGuaranteeSponsorFieldsSchema"},"type":"array","title":"Sponsors","default":[]}},"type":"object","required":["guarantee_type","start_at","end_at","details"],"title":"LeaseGuaranteeFieldsSchema"},"LeaseGuaranteeSponsorFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id"},"type":{"type":"string","title":"Type"}},"type":"object","required":["db_id","type"],"title":"LeaseGuaranteeSponsorFieldsSchema"},"LeaseInsuranceFieldsSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"start_at":{"type":"string","title":"Start At"},"end_at":{"type":"string","title":"End At"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"base_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Base Value"},"installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Installments"},"installment_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Installment Value"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"insurance_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Insurance Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"assistance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assistance"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"},"value_insured_assistance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Insured Assistance"},"value_insurance_assistance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Insurance Assistance"}},"type":"object","required":["start_at","end_at"],"title":"LeaseInsuranceFieldsSchema"},"LeaseItemContactFieldSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"LeaseItemContactFieldSchema"},"LeaseItemFieldsSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action associated with the lease item (e.g., create, update, delete)."},"contact":{"anyOf":[{"$ref":"#/components/schemas/LeaseItemContactFieldSchema"},{"type":"null"}],"description":"Contact information related to the lease item."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Detailed description of the lease item."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Monetary value of the lease item."},"behavior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Behavior","description":"Defines the behavior of the lease item (e.g., fixed, variable, recurrent)."},"landlords":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array"}],"title":"Landlords","description":"List or dictionary of landlords associated with the lease item."},"recurrent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Recurrent","description":"Indicates if the lease item is recurrent."},"repeat_total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Total","description":"Total number of repetitions for the lease item if recurrent."},"repeat_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Repeat Index","description":"Current repetition index for the recurrent lease item."},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Indicates if the lease item should be included in DIMOB reporting."},"item_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Type","description":"Type of the lease item (e.g., rent, fee, tax)."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Financial category of the lease item."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Financial subcategory of the lease item."},"charge_management_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Charge Management Fee","description":"Indicates if a management fee should be charged for this lease item."},"until_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Until Due Date","description":"Defines if the item is valid until its due date."},"bar_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bar Code","description":"Bar code associated with the lease item payment."},"autopay_on_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autopay On Due Date","description":"Indicates if the item should be automatically paid on the due date."},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date","description":"Due date for the lease item in 'DD-MM-YYYY' format (e.g., '19-08-2025')."},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"Start date of the lease item in 'DD-MM-YYYY' format (e.g., '01-01-2025')."},"payment_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method","description":"Payment method for the lease item (e.g., PIX, boleto, credit card)."},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key","description":"PIX key used for payment."},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type","description":"Type of the PIX key (e.g., CPF, CNPJ, email, phone)."},"account_credit":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Account credited with the lease item payment."}},"additionalProperties":true,"type":"object","title":"LeaseItemFieldsSchema"},"LeaseManagementFeeFieldsSchema":{"properties":{"management_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Management Type"},"percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percent"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"first_rent_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"First Rent Percent"},"first_rent_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"First Rent Value"}},"type":"object","title":"LeaseManagementFeeFieldsSchema"},"LeaseNotificationFieldsSchema":{"properties":{"send_invoice_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Tenant"},"send_overdue_notification_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification To Tenant"},"send_invoice_to_tenant_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Tenant Whatsapp"},"send_landlord_onlending_whatsapp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Landlord Onlending Whatsapp"},"send_onlending_to_landlord":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Onlending To Landlord"},"send_due_notification_to_sponsor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Due Notification To Sponsor"},"send_due_notification_to_landlord":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Due Notification To Landlord"},"send_guarantee_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Guarantee Closeduedate To Tenant"},"send_insurance_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Insurance Closeduedate To Tenant"},"send_notification_readjustment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Readjustment"},"send_whatsapp_notification_readjustment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Whatsapp Notification Readjustment"},"send_notification_invoice_paid_after_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Invoice Paid After Due Date"}},"type":"object","title":"LeaseNotificationFieldsSchema"},"LeaseOnlendingFieldsSchema":{"properties":{"onlending_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onlending Type"},"mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mode"},"amount_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Days"},"onlending_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Onlending Mode"},"fixed_day":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fixed Day"}},"type":"object","title":"LeaseOnlendingFieldsSchema"},"LeasePropertyFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"}},"type":"object","required":["db_id"],"title":"LeasePropertyFieldsSchema"},"LeaseResponsePost":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"LeaseResponsePost"},"LeaseResponseSchema":{"properties":{"additional_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Additional Guests","description":"Number of additional guests allowed."},"account":{"anyOf":[{"$ref":"#/components/schemas/AccountFieldsSchema"},{"type":"null"}],"description":"Financial account linked to the onlendings. Must include 'db_id'."},"additional_value_guest":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Additional Value Guest","description":"Additional charge per extra guest."},"annual_readjustment":{"anyOf":[{"$ref":"#/components/schemas/LeaseAnnualReadjustmentFieldsSchema"},{"type":"null"}],"description":"Annual readjustment details."},"beneficiaries":{"items":{"$ref":"#/components/schemas/LeaseBeneficiariesFieldsSchema"},"type":"array","title":"Beneficiaries","description":"List of lease beneficiaries.","default":[]},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode","description":"Billing mode for the lease (e.g., monthly, quarterly)."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the lease."},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the lease."},"checklist":{"items":{"$ref":"#/components/schemas/LeaseChecklistFieldsSchema"},"type":"array","title":"Checklist","description":"Checklist associated with the lease.","default":[]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Unique code identifying the lease."},"field_values":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Field Values","description":"Custom field values in key-value format.","default":[]},"create_onlending_item":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Create Onlending Item","description":"Indicates if onlending item should be created."},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage applied for credit card installment."},"credit_card_pass_on_fixed_rate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Fixed Rate","description":"Indicates if fixed rate should be passed on credit card payments."},"credit_card_pass_on_installments_fee":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Pass On Installments Fee","description":"Indicates if installment fees should be passed on credit card payments."},"credit_card_auto_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Credit Card Auto Charge","description":"Indicates if invoices should be charged automatically on the due date using the card the payer marked for automatic debit."},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage","description":"Credit card percentage fee applied."},"daily_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Daily Value","description":"Daily rental value."},"deal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Key","description":"Key associated with the deal."},"documents":{"anyOf":[{"$ref":"#/components/schemas/LeaseDigitalDocument"},{"type":"null"}],"description":"Digital documents linked to the lease."},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration"},"duration_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration Type"},"due_day":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Due Day"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"},"federal_income_tax":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Federal Income Tax","description":"Federal income tax details.","default":[]},"fine_charge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fine Charge","description":"Fixed fine charge for late payment."},"fine_percent_late_payment":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fine Percent Late Payment","description":"Fine percentage for late payment."},"first_rental_in_next_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"First Rental In Next Invoice","description":"Indicates if the first rental should be charged in the next invoice."},"first_rental_installment":{"items":{"$ref":"#/components/schemas/LeaseFirstRentalInstallmentFieldsSchema"},"type":"array","title":"First Rental Installment","description":"First rental installment details.","default":[]},"guaranteed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guaranteed","description":"Indicates if the lease is guaranteed."},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/LeaseGuaranteeFieldsSchema"},{"type":"null"}],"description":"Guarantee details of the lease."},"guarantee_amount_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guarantee Amount Months","description":"Number of months covered by the guarantee."},"guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Guests","description":"Maximum number of guests allowed."},"include_in_dimob":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include In Dimob","description":"Indicates if the lease should be included in DIMOB reporting."},"indeterminate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Indeterminate","description":"Indicates if the lease is indeterminate."},"initial_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Initial Value","description":"Initial lease value."},"insurances":{"items":{"$ref":"#/components/schemas/LeaseInsuranceFieldsSchema"},"type":"array","title":"Insurances","description":"List of insurance details associated with the lease.","default":[]},"interest_charge":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interest Charge","description":"Fixed interest charge for late payment."},"interest_percent_late_payment":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent Late Payment","description":"Interest percentage applied for late payment."},"in_progress":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Progress","description":"Indicates if the lease is currently in progress."},"invoice_shortcut":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Shortcut","description":"Indicates if invoice shortcut is enabled."},"irrf":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf","description":"Indicates if IRRF (withholding tax) is applied."},"irrf_management_fee_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Management Fee Discount","description":"Indicates if IRRF management fee discount is applied."},"irrf_simplified_discount":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Irrf Simplified Discount","description":"Indicates if simplified IRRF discount is applied."},"items":{"items":{"$ref":"#/components/schemas/LeaseItemFieldsSchema"},"type":"array","title":"Items","description":"List of items included in the lease.","default":[]},"last_annual_readjustment_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Annual Readjustment At","description":"Date of the last annual readjustment in 'YYYY-MM-DD' format."},"lease_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Type","description":"Type of lease (e.g., residential, commercial)."},"management_fee":{"anyOf":[{"$ref":"#/components/schemas/LeaseManagementFeeFieldsSchema"},{"type":"null"}],"description":"Details of the management fee applied."},"next_invoice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice","description":"Date of the next invoice generation in 'YYYY-MM-DD' format."},"next_invoice_due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Due Date","description":"Due date of the next invoice in 'YYYY-MM-DD' format."},"next_invoice_end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice End At","description":"End date of the next invoice period in 'YYYY-MM-DD' format."},"next_invoice_generate_in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Generate In","description":"Date when the next invoice should be generated in 'YYYY-MM-DD' format."},"next_invoice_start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Invoice Start At","description":"Start date of the next invoice period in 'YYYY-MM-DD' format."},"next_invoice_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value","description":"Value of the next invoice. Must be explicitly provided at lease creation."},"newCodeProperty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Newcodeproperty","description":"Code of the new property if updated."},"new_owners":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOwnerSchema"},"type":"array"},{"type":"null"}],"title":"New Owners"},"notification":{"anyOf":[{"$ref":"#/components/schemas/LeaseNotificationFieldsSchema"},{"type":"null"}],"description":"Notification settings related to the lease."},"nota_fiscal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nota Fiscal","description":"Indicates if nota fiscal (invoice) is generated."},"nota_fiscal_product":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Nota Fiscal Product","description":"Indicate if notas fiscal has product"},"onlending":{"anyOf":[{"$ref":"#/components/schemas/LeaseOnlendingFieldsSchema"},{"type":"null"}],"description":"Onlending configuration. Requires at least 'mode' and/or 'amount_days'. For automatic on-receipt, use mode='amount_days' and amount_days=0."},"onlending_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Onlending Charge","description":"Indicates if onlending charges apply."},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of allowed payment installments."},"property":{"anyOf":[{"$ref":"#/components/schemas/LeasePropertyFieldsSchema"},{"type":"null"}],"description":"Details of the property associated with the lease."},"receipt_methods":{"$ref":"#/components/schemas/ReceiptMethodsSchema","description":"Lease payment methods(can be more than one)."},"send_due_notification_to_sponsor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Due Notification To Sponsor","description":"Indicates if due notifications should be sent to the sponsor."},"send_guarantee_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Guarantee Closeduedate To Tenant","description":"Indicates if guarantee close due date notifications should be sent to tenant."},"send_insurance_closeduedate_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Insurance Closeduedate To Tenant","description":"Indicates if insurance close due date notifications should be sent to tenant."},"send_invoice_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Invoice To Tenant","description":"Indicates if invoices should be sent to the tenant."},"send_onlending_to_landlord":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Onlending To Landlord","description":"Indicates if onlending details should be sent to the landlord."},"send_overdue_notification_to_tenant":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification To Tenant","description":"Indicates if overdue notifications should be sent to tenant."},"send_notification_invoice_paid_after_due_date":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Notification Invoice Paid After Due Date","description":"Indicates if the real estate agency should be notified when an invoice is paid after the due date."},"send_nota_fiscal_in_invoice_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Nota Fiscal In Invoice Create","description":"Indicate if the nota fiscal should be sent when the invoice is created (This field will only be used when the management type is owned properties)."},"service_fee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Service Fee","description":"Service fee amount applied."},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the lease (default: active).","default":"active"},"tenants":{"items":{"$ref":"#/components/schemas/LeaseTenantFieldsSchema"},"type":"array","title":"Tenants","description":"List of tenants associated with the lease."},"termination":{"anyOf":[{"$ref":"#/components/schemas/LeaseTerminationFieldsSchema"},{"type":"null"}],"description":"Termination details of the lease."},"vacation_rental_receipt_option":{"anyOf":[{"$ref":"#/components/schemas/LeaseVacationRentalReceiptOptionFieldsSchema"},{"type":"null"}],"description":"Vacation rental receipt options."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value"},"only_checklist_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Only Checklist In Data","description":"If true, only checklist information will be included in the data.","default":false},"update_beneficiaries":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Update Beneficiaries","description":"If true, beneficiaries will be updated with the provided data.","default":false},"beneficiaries_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Beneficiaries In Data","default":false},"guarantee_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guarantee In Data","default":false},"insurances_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Insurances In Data","default":false},"field_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Field Values In Data","default":false},"items_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Items In Data","default":false}},"additionalProperties":true,"type":"object","title":"LeaseResponseSchema"},"LeaseTenantFieldsSchema":{"properties":{"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer"},"type":{"type":"string","title":"Type"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]}},"type":"object","required":["type","db_id"],"title":"LeaseTenantFieldsSchema"},"LeaseTerminationFieldsSchema":{"properties":{"installments":{"items":{"$ref":"#/components/schemas/LeaseTerminationInstallmentsFieldsSchema"},"type":"array","title":"Installments","default":[]},"calculate_proportional_days":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Calculate Proportional Days"},"move_out_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Move Out Date"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"LeaseTerminationFieldsSchema"},"LeaseTerminationInstallmentsFieldsSchema":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"}},"type":"object","title":"LeaseTerminationInstallmentsFieldsSchema"},"LeaseVacationRentalReceiptInstallmentFieldsSchema":{"properties":{"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"}},"type":"object","title":"LeaseVacationRentalReceiptInstallmentFieldsSchema"},"LeaseVacationRentalReceiptOptionFieldsSchema":{"properties":{"method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Method"},"installments":{"items":{"$ref":"#/components/schemas/LeaseVacationRentalReceiptInstallmentFieldsSchema"},"type":"array","title":"Installments","description":"List of installments for the vacation rental receipt.","default":[]}},"type":"object","title":"LeaseVacationRentalReceiptOptionFieldsSchema"},"LinksTimelineSchema":{"properties":{"link_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Link Id"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"link_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Code"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"}},"type":"object","title":"LinksTimelineSchema"},"ListingBrokerFieldsSchema":{"properties":{"email":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Email","default":[]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gender"},"phone":{"anyOf":[{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Phone","default":[]}},"type":"object","title":"ListingBrokerFieldsSchema"},"ListingBrokersSchema":{"properties":{"db_id":{"type":"string","title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","required":["db_id"],"title":"ListingBrokersSchema"},"ManagerSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"ignore_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Notification"},"user":{"anyOf":[{"$ref":"#/components/schemas/UserSchema"},{"type":"null"}]}},"type":"object","title":"ManagerSchema"},"MediaSourceCreateSchema":{"properties":{"media_source":{"$ref":"#/components/schemas/MediaSourcesSchema","description":"All params in the media source, ex: {'media_source': {\n 'name': 'Google Ads', 'type': 'ads', 'active': true, 'default': false}}"}},"type":"object","required":["media_source"],"title":"MediaSourceCreateSchema"},"MediaSourceSchema-Output":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"MediaSourceSchema","description":"ContactMediaSource fields "},"MediaSourceUpdateSchema":{"properties":{"media_source":{"$ref":"#/components/schemas/routers__schemas__media_source__MediaSourceSchema"}},"type":"object","required":["media_source"],"title":"MediaSourceUpdateSchema"},"MediaSourcesReportSchema":{"properties":{"month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Month"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year"},"general":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"General"}},"type":"object","title":"MediaSourcesReportSchema"},"MediaSourcesSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the media source","examples":["Google Ads"]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the media source","examples":["ads","social","email"]},"active":{"type":"boolean","title":"Active","description":"Whether the media source is active"},"default":{"type":"boolean","title":"Default","description":"Whether the media source is the default"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings","description":"Settings for the media source"}},"type":"object","required":["name","active","default"],"title":"MediaSourcesSchema"},"MemberProposalSchema":{"properties":{"network_group_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Group Database"},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"response":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response"},"user":{"anyOf":[{"$ref":"#/components/schemas/UserProfileSchema"},{"type":"null"}]},"property":{"anyOf":[{"$ref":"#/components/schemas/NetworkPropertySchema"},{"type":"null"}]},"deal":{"anyOf":[{"$ref":"#/components/schemas/NetworkDealFieldsSchema"},{"type":"null"}]}},"type":"object","title":"MemberProposalSchema"},"MinMaxSchema":{"properties":{"min":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"null"}],"title":"Min"},"max":{"anyOf":[{"type":"number"},{"type":"integer"},{"type":"null"}],"title":"Max"}},"type":"object","title":"MinMaxSchema"},"NeighborhoodFieldSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the neighborhood","examples":["Vila Olímpia"]},"zone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zone","description":"Zone of the neighborhood","examples":["Zona Sul"]},"city_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City Id"},"city":{"anyOf":[{"$ref":"#/components/schemas/CitySchema"},{"type":"null"}],"description":"City data of the neighborhood"},"mercado_livre_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mercado Livre Id","description":"Mercado Livre ID of the neighborhood","examples":["ML123"]},"mercado_livre_city_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mercado Livre City Id","description":"Mercado Livre city ID of the neighborhood","examples":["ML_CITY_123"]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","required":["name"],"title":"NeighborhoodFieldSchema"},"NeighborhoodRouterSchema":{"properties":{"neighborhood":{"$ref":"#/components/schemas/NeighborhoodFieldSchema"}},"type":"object","required":["neighborhood"],"title":"NeighborhoodRouterSchema"},"NeighborhoodsFieldsGetSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"city":{"anyOf":[{"$ref":"#/components/schemas/CitySchema"},{"type":"null"}]},"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"type":"string","title":"Name"},"zone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zone"}},"type":"object","required":["name"],"title":"NeighborhoodsFieldsGetSchema"},"NeighborhoodsFieldsSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the neighborhood","examples":["Vila Olímpia"]},"zone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zone","description":"Zone of the neighborhood","examples":["Zona Sul"]},"city_id":{"type":"string","title":"City Id","description":"ID of the city the neighborhood belongs to","examples":["123"]},"city":{"anyOf":[{"$ref":"#/components/schemas/CitySchema"},{"type":"null"}],"description":"City data of the neighborhood"},"mercado_livre_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mercado Livre Id","description":"Mercado Livre ID of the neighborhood","examples":["ML123"]},"mercado_livre_city_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mercado Livre City Id","description":"Mercado Livre city ID of the neighborhood","examples":["ML_CITY_123"]}},"type":"object","required":["name","city_id"],"title":"NeighborhoodsFieldsSchema"},"NeighborhoodsRouterSchema":{"properties":{"neighborhood":{"$ref":"#/components/schemas/NeighborhoodsFieldsSchema","description":"All params in the neighborhood, ex: {'neighborhood': {'name': 'Vila Olímpia', 'city_id': 123}}"}},"type":"object","required":["neighborhood"],"title":"NeighborhoodsRouterSchema"},"NeighborhoodsSchema":{"properties":{"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"neighborhoods":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhoods"}},"type":"object","title":"NeighborhoodsSchema"},"NeighborhoodsSectionSchema":{"properties":{"neighborhood":{"items":{"$ref":"#/components/schemas/NeighborhoodsSchema"},"type":"array","title":"Neighborhood","default":[]},"property_type":{"items":{"type":"string"},"type":"array","title":"Property Type","default":[]},"cities":{"items":{"type":"string"},"type":"array","title":"Cities","default":[]}},"type":"object","title":"NeighborhoodsSectionSchema"},"NetworkDealFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"NetworkDealFieldsSchema"},"NetworkGroupPostCommentSchema":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Content of the comment"}},"type":"object","title":"NetworkGroupPostCommentSchema"},"NetworkGroupPostsCommentsSchema":{"properties":{"comment":{"$ref":"#/components/schemas/NetworkGroupPostCommentSchema","description":"Comment data for the network group post."}},"type":"object","required":["comment"],"title":"NetworkGroupPostsCommentsSchema"},"NetworkInfoSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","title":"NetworkInfoSchema"},"NetworkPropertySchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"NetworkPropertySchema"},"NoCancellationInsurance":{"properties":{"insurance_id":{"type":"integer","title":"Insurance Id"},"lease_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Lease Id"},"lease_status":{"type":"string","enum":["canceled","ended"],"title":"Lease Status"}},"type":"object","required":["insurance_id","lease_id","lease_status"],"title":"NoCancellationInsurance"},"NotaFiscalClienteEnderecoSchema":{"properties":{"pais":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pais"},"uf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf"},"cidade":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cidade"},"logradouro":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logradouro"},"complemento":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Complemento"},"bairro":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bairro"},"cep":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cep"}},"type":"object","title":"NotaFiscalClienteEnderecoSchema"},"NotaFiscalClienteSchema":{"properties":{"contact_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Key","description":"Unique key used to identify the contact in the system"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database identifier of the contact"},"tipo_pessoa":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tipo Pessoa","description":"Type of person: 'Física' (individual) or 'Jurídica' (legal entity)"},"nome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nome","description":"Full name or business name of the contact"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"cpf_cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf Cnpj","description":"CPF (individual) or CNPJ (legal entity) number of the contact"},"inscricao_municipal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inscricao Municipal","description":"Municipal registration number of the contact"},"inscricao_estadual":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inscricao Estadual","description":"State registration number of the contact"},"telefone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telefone","description":"Phone number of the contact"},"endereco":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalClienteEnderecoSchema"},{"type":"null"}],"description":"Address information of the contact, required for creating a new Nota Fiscal"},"contact":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalContactSchema"},{"type":"null"}],"description":"Additional contact details, if available"}},"type":"object","title":"NotaFiscalClienteSchema"},"NotaFiscalContactSchema":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"NotaFiscalContactSchema"},"NotaFiscalIbsCbsPropertySchema":{"properties":{"fiscal_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Registration Number"},"cib_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cib Code"},"property_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key"}},"type":"object","title":"NotaFiscalIbsCbsPropertySchema"},"NotaFiscalIbsCbsSchema":{"properties":{"tax_situation_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Situation Code"},"tax_classification_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Classification Code"},"operation_indicator_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Indicator Code"},"operation_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operation Type"},"property":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalIbsCbsPropertySchema"},{"type":"null"}]}},"type":"object","title":"NotaFiscalIbsCbsSchema"},"NotaFiscalSchema":{"properties":{"cliente":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalClienteSchema"},{"type":"null"}],"description":"Information about the client associated with the invoice"},"valor_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Total","description":"Total amount of the invoice"},"data_competencia":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Competencia","description":"Competence date of the invoice (ISO 8601 format)"},"servico":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalServicoSchema"},{"type":"null"}],"description":"Details of the service(s) included in the invoice"},"transactions":{"items":{"$ref":"#/components/schemas/FinancialAccountNotaFiscalSchema"},"type":"array","title":"Transactions","description":"List of financial transactions related to the invoice","default":[]},"is_draft":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Draft","description":"Indicates whether the invoice is a draft (not yet issued)"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action to be applied to the invoice (e.g., 'create', 'update', 'cancel')"},"send_to_authorization":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send To Authorization","description":"If true, the invoice will be sent for authorization"},"send_to_all_emails":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send To All Emails","description":"If true, the invoice will be sent to every email registered on the contact"},"product":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Product"}},"type":"object","title":"NotaFiscalSchema"},"NotaFiscalServicoResponseSchema":{"properties":{"descricao":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descricao"},"aliquota_iss":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Aliquota Iss"},"cnae":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnae"},"iss_retido_fonte":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Iss Retido Fonte"},"codigo_servico_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Servico Municipio"},"descricao_servico_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descricao Servico Municipio"},"item_lista_servico_c116":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Lista Servico C116"},"uf_prestacao_servico":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf Prestacao Servico"},"municipio_prestacao_servico":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipio Prestacao Servico"},"valor_pis":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Pis"},"valor_ir":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Ir"},"valor_csll":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Csll"},"valor_cofins":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Cofins"},"valor_inss":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Inss"},"codigo_nbs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Nbs"},"codigo_tributacao_nacional":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Tributacao Nacional"},"ibs_cbs":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalIbsCbsSchema"},{"type":"null"}]}},"type":"object","title":"NotaFiscalServicoResponseSchema"},"NotaFiscalServicoSchema":{"properties":{"descricao":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Descricao"},"aliquota_iss":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Aliquota Iss"},"cnae":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnae"},"iss_retido_fonte":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Iss Retido Fonte"},"codigo_servico_municipio":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Servico Municipio"},"item_lista_servico_c116":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Lista Servico C116"},"uf_prestacao_servico":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf Prestacao Servico"},"municipio_prestacao_servico":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Municipio Prestacao Servico"},"valor_pis":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Pis"},"valor_ir":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Ir"},"valor_csll":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Csll"},"valor_cofins":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Cofins"},"valor_inss":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Inss"},"codigo_nbs":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Nbs"},"codigo_tributacao_nacional":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Codigo Tributacao Nacional"},"ibs_cbs":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalIbsCbsSchema"},{"type":"null"}]}},"type":"object","title":"NotaFiscalServicoSchema"},"NotasFiscaisField":{"properties":{"consumidor_final":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Consumidor Final"},"enviar_por_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enviar Por Email"},"send_to_all_emails":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send To All Emails"},"invoice_ids":{"items":{"type":"integer"},"type":"array","title":"Invoice Ids","default":[]},"nota_fiscal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nota Fiscal Id"},"numero":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numero"},"producao":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Producao"},"rps_numero":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rps Numero"},"rps_serie":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rps Serie"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_motivo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Motivo"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"valor_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Valor Total"},"xml_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Xml Url"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"cliente":{"anyOf":[{"$ref":"#/components/schemas/NotaFiscalClienteSchema"},{"type":"null"}]},"servico":{"$ref":"#/components/schemas/NotaFiscalServicoResponseSchema"},"data_criacao":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Criacao"},"data_competencia":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Competencia"}},"type":"object","required":["servico"],"title":"NotasFiscaisField"},"NotificationFieldsSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the notification is active."},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Indicates whether the notification is marked as a favorite."},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Full name of the user or entity related to the notification."},"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Internal database identifier for the notification."},"title":{"type":"string","title":"Title","description":"Title of the notification."},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code or identifier associated with the notification."},"description":{"type":"string","title":"Description","description":"Detailed description of the notification."},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action related to the notification, such as open, dismiss, or mark as read."},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo","description":"URL or path to an image associated with the notification."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type or category of the notification."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Date when the notification was created or scheduled."},"hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hour","description":"Time when the notification was created or scheduled."},"read":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Read","description":"Indicates whether the notification has been read."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Indicates whether the notification's task or action has been completed."},"link":{"anyOf":[{"$ref":"#/components/schemas/NotificationLinkSchema"},{"type":"null"}],"description":"Link object containing related navigation or resource information."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Direct URL associated with the notification."},"app_client_database_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Client Database Id","description":"Identifier of the application's client database related to the notification."},"innerhtml_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Innerhtml Link","description":"HTML link content to be displayed inside the notification."},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"Identifier of the user who will receive or has received the notification."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category or classification of the notification."}},"type":"object","required":["title","description"],"title":"NotificationFieldsSchema"},"NotificationLinkSchema":{"properties":{"lease_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id"},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document"},"calendar_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calendar Type"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"NotificationLinkSchema"},"NotificationRouterSchema":{"properties":{"notification":{"$ref":"#/components/schemas/NotificationFieldsSchema","description":"All params in the notification, ex: {'notification': {\n 'title': 'New Message', 'description': 'You have a new message', 'type': 'message'}}"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"Unique identifier of the user associated with the notification if not value, this user_id in headers will be used"}},"type":"object","required":["notification"],"title":"NotificationRouterSchema"},"NotificationUpdateFieldsSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the notification is active."},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Indicates whether the notification is marked as a favorite."},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Full name of the user or entity related to the notification."},"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Internal database identifier for the notification."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Code or identifier associated with the notification."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"Action related to the notification, such as open, dismiss, or mark as read."},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo","description":"URL or path to an image associated with the notification."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type or category of the notification."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Date when the notification was created or scheduled."},"hour":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hour","description":"Time when the notification was created or scheduled."},"read":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Read","description":"Indicates whether the notification has been read."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Indicates whether the notification's task or action has been completed."},"link":{"anyOf":[{"$ref":"#/components/schemas/NotificationLinkSchema"},{"type":"null"}],"description":"Link object containing related navigation or resource information."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Direct URL associated with the notification."},"app_client_database_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Client Database Id","description":"Identifier of the application's client database related to the notification."},"innerhtml_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Innerhtml Link","description":"HTML link content to be displayed inside the notification."},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id","description":"Identifier of the user who will receive or has received the notification."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category or classification of the notification."}},"type":"object","title":"NotificationUpdateFieldsSchema"},"NotificationUpdateRouterSchema":{"properties":{"notification":{"$ref":"#/components/schemas/NotificationUpdateFieldsSchema"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"}},"type":"object","required":["notification"],"title":"NotificationUpdateRouterSchema"},"OrganizationFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","description":"Indicates whether the field can have multiple values.","default":false}},"type":"object","required":["typevalue"],"title":"OrganizationFieldConfigurationSchemas"},"OrganizationFieldSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the contact is active"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Marks the contact as a favorite"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Full name of the contact (required for creation person, contact or lead not required for organization)"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code","description":"Custom code or reference for the contact"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the linked contact record"},"contact_type":{"anyOf":[{"enum":["lead","person","organization",null]},{"type":"null"}],"title":"Contact Type","description":"Type of contact"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Timestamp when the contact was created"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Associated database name or ID"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age","description":"Age of the contact, if applicable"},"media_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source","description":"Primary media source associated with the contact"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the contact's profile image"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image","description":"Base64 or path to the contact's profile image"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]},"crisp_people_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Crisp People Id","description":"ID used by Crisp for chat integrations"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database-specific ID of the contact"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Database key or token for internal reference"},"deal_rotation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Rotation Id","description":"ID of the rotation rule for deals"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id","description":"Landlord's account ID if linked"},"last_updated_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Updated At","description":"Timestamp of the last update"},"manager":{"anyOf":[{"$ref":"#/components/schemas/ManagerSchema"},{"type":"null"}],"description":"Manager responsible for the contact"},"managers_shared":{"items":{"$ref":"#/components/schemas/ManagerSchema"},"type":"array","title":"Managers Shared","description":"List of managers who share this contact","default":[]},"media_sources":{"items":{"$ref":"#/components/schemas/routers__schemas__field__MediaSourceSchema"},"type":"array","title":"Media Sources","description":"List of media sources","default":[]},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database","description":"Database ID of the member who owns the contact"},"member_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Id","description":"Registration ID of the member"},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the contact is shared via a network group"},"network":{"anyOf":[{"$ref":"#/components/schemas/ContactNetworkSchema"},{"type":"null"}],"description":"Network-related information for the contact"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"If true, this contact is private to the creator"},"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer","description":"Indicates if this contact is a payer (e.g., in a rental deal)"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"URL of a custom image for the contact"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRouterSchema"},"type":"array","title":"Properties","description":"List of properties linked to the contact","default":[]},"review_pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending","description":"Indicates if the contact is pending review"},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key used to control revisions or updates"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj","description":"Company CNPJ (required if CPF is not provided)"},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"Personal CPF (required if CNPJ is not provided)"},"not_search_profile_picture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Search Profile Picture","description":"Skip automatic profile picture lookup"},"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","description":"Banking information related to the contact","default":[]},"pix":{"items":{"$ref":"#/components/schemas/PixSchemaSchema"},"type":"array","title":"Pix","description":"PIX keys or data for financial transactions","default":[]},"tags_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tags In Data","description":"Flag to indicate if tags are already embedded in the data","default":false},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager","description":"Indicates whether the contact can have a manager reassigned on rotations"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"persons":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Persons","default":[]},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","default":[],"examples":[[{"field_id":"address","type":"string","value":"Rua Funchal, 500"},{"field_id":"address_complement","type":"string","value":"Casa"},{"field_id":"city","type":"string","value":"São Paulo"},{"field_id":"country","type":"string","value":"Brasil"},{"field_id":"marital_status","type":"string","value":"Solteiro (a)"},{"field_id":"municipal_registration","type":"string","value":"685.931.250.233"},{"field_id":"neighborhood","type":"string","value":"Vila Olímpia"},{"field_id":"phone","type":"list","value":[{"alpha2Code":"br","number":"(11) 9123-4567","type":""}]},{"field_id":"site","type":"string","value":"imobzi.com"},{"field_id":"social_network","type":"list","value":[{"account":"facebook.com","name":"Facebook"}]},{"field_id":"state","type":"string","value":"SP"},{"field_id":"state_registration","type":"string","value":"685.931.250.233"},{"field_id":"trading_name","type":"string","value":"Trading Name"},{"field_id":"zipcode","type":"string","value":"04551-060"},{"field_id":"email","type":"list","value":"example@example.com"}]]}},"type":"object","title":"OrganizationFieldSchema"},"OrganizationFieldSchemas":{"properties":{"field_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Id"},"configuration":{"$ref":"#/components/schemas/OrganizationFieldConfigurationSchemas","description":"Configuration settings for the organization field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name","description":"Name of the text template parameter for this field."}},"type":"object","required":["configuration"],"title":"OrganizationFieldSchemas"},"OrganizationFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/OrganizationFieldConfigurationSchemas","description":"Configuration settings for the organization field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name","description":"Name of the text template parameter for this field."}},"type":"object","required":["configuration"],"title":"OrganizationFieldsSchemas"},"OrganizationRouterSchema":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationFieldSchema"}},"type":"object","required":["organization"],"title":"OrganizationRouterSchema"},"OrganizationsFieldsSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the contact is active"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Marks the contact as a favorite"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Full name of the contact (required for creation person, contact or lead not required for organization)"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code","description":"Custom code or reference for the contact"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the linked contact record"},"contact_type":{"anyOf":[{"enum":["lead","person","organization",null]},{"type":"null"}],"title":"Contact Type","description":"Type of contact"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Timestamp when the contact was created"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Associated database name or ID"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age","description":"Age of the contact, if applicable"},"media_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source","description":"Primary media source associated with the contact"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the contact's profile image"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image","description":"Base64 or path to the contact's profile image"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]},"crisp_people_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Crisp People Id","description":"ID used by Crisp for chat integrations"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database-specific ID of the contact"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Database key or token for internal reference"},"deal_rotation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Rotation Id","description":"ID of the rotation rule for deals"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id","description":"Landlord's account ID if linked"},"last_updated_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Updated At","description":"Timestamp of the last update"},"manager":{"anyOf":[{"$ref":"#/components/schemas/ManagerSchema"},{"type":"null"}],"description":"Manager responsible for the contact"},"managers_shared":{"items":{"$ref":"#/components/schemas/ManagerSchema"},"type":"array","title":"Managers Shared","description":"List of managers who share this contact","default":[]},"media_sources":{"items":{"$ref":"#/components/schemas/MediaSourceSchema-Output"},"type":"array","title":"Media Sources","description":"List of media sources","default":[]},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database","description":"Database ID of the member who owns the contact"},"member_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Id","description":"Registration ID of the member"},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the contact is shared via a network group"},"network":{"anyOf":[{"$ref":"#/components/schemas/ContactNetworkSchema"},{"type":"null"}],"description":"Network-related information for the contact"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"If true, this contact is private to the creator"},"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer","description":"Indicates if this contact is a payer (e.g., in a rental deal)"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"URL of a custom image for the contact"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRouterSchema"},"type":"array","title":"Properties","description":"List of properties linked to the contact","default":[]},"review_pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending","description":"Indicates if the contact is pending review"},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key used to control revisions or updates"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Organizations type","default":"organization","values":["organization"]},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj","description":"Company CNPJ (required if CPF is not provided)"},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"Personal CPF (required if CNPJ is not provided)"},"not_search_profile_picture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Search Profile Picture","description":"Skip automatic profile picture lookup"},"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","description":"Banking information related to the contact","default":[]},"pix":{"items":{"$ref":"#/components/schemas/PixSchemaSchema"},"type":"array","title":"Pix","description":"PIX keys or data for financial transactions","default":[]},"tags_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tags In Data","description":"Flag to indicate if tags are already embedded in the data","default":false},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager","description":"Indicates whether the contact can have a manager reassigned on rotations"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"persons":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Persons","default":[]},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","default":[],"examples":[[{"field_id":"address","type":"string","value":"Rua Funchal, 500"},{"field_id":"address_complement","type":"string","value":"Casa"},{"field_id":"city","type":"string","value":"São Paulo"},{"field_id":"country","type":"string","value":"Brasil"},{"field_id":"marital_status","type":"string","value":"Solteiro (a)"},{"field_id":"municipal_registration","type":"string","value":"685.931.250.233"},{"field_id":"neighborhood","type":"string","value":"Vila Olímpia"},{"field_id":"phone","type":"list","value":[{"alpha2Code":"br","number":"(11) 9123-4567","type":""}]},{"field_id":"site","type":"string","value":"imobzi.com"},{"field_id":"social_network","type":"list","value":[{"account":"facebook.com","name":"Facebook"}]},{"field_id":"state","type":"string","value":"SP"},{"field_id":"state_registration","type":"string","value":"685.931.250.233"},{"field_id":"trading_name","type":"string","value":"Trading Name"},{"field_id":"zipcode","type":"string","value":"04551-060"},{"field_id":"email","type":"list","value":"example@example.com"}]]}},"type":"object","title":"OrganizationsFieldsSchema"},"OrganizationsRouterSchema":{"properties":{"organization":{"$ref":"#/components/schemas/OrganizationsFieldsSchema","description":"All params in the organization, ex: {'organization': {\n 'name': 'Empresa XYZ', 'field_values': [], 'active': true}}"}},"type":"object","required":["organization"],"title":"OrganizationsRouterSchema"},"OwnerFieldsSchema":{"properties":{"email":{"items":{"type":"string"},"type":"array","title":"Email","default":[]},"code":{"type":"string","title":"Code"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"},"type":{"type":"string","title":"Type"},"phones":{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array","title":"Phones","default":[]}},"type":"object","required":["code","db_id","type"],"title":"OwnerFieldsSchema"},"PJBankCreditCardSchema":{"properties":{"name":{"type":"string","const":"pjbank_card","title":"Name","default":"pjbank_card"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"},"credential":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential"},"account":{"anyOf":[{"$ref":"#/components/schemas/FinancialContactSchema"},{"type":"null"}]},"account_bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Bank Type"},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage"},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage"},"payment_rate_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Rate Info"},"cash_payment_rate_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cash Payment Rate Info"},"payment_installment_rate_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Payment Installment Rate Info"},"maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum Installments"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"webhook_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Key"},"account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Key"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"installment_behavior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Installment Behavior"},"cash_payment_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cash Payment Description"},"payment_installment_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Installment Description"},"categories":{"anyOf":[{"$ref":"#/components/schemas/CategoriesPJBankSchema"},{"type":"null"}]},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"PJBankCreditCardSchema"},"PJBankSchema":{"properties":{"name":{"type":"string","const":"pjbank","title":"Name","default":"pjbank"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"credential":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credential"},"webhook_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Key"},"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"show_trading_name":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Trading Name"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"categories":{"anyOf":[{"$ref":"#/components/schemas/CategoriesPJBankSchema"},{"type":"null"}]},"get_conciliations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Get Conciliations"},"selected_for_payments":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Selected For Payments"},"split_receipt_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Split Receipt Account"}},"type":"object","title":"PJBankSchema"},"ParentSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"link_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Link Id"},"link_code":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Link Code"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"code":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Code"},"address":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Address","default":[]},"visit_liked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit Liked"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"ParentSchema"},"ParticipantInfoSchema":{"properties":{"participant_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Participant Id"},"participant_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Participant Type"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"ParticipantInfoSchema"},"PersonFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","description":"Indicates whether the field can have multiple values.","default":true},"typebox":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typebox","description":"Indicates whether the field uses a typebox.","default":false}},"type":"object","required":["typevalue"],"title":"PersonFieldConfigurationSchemas"},"PersonFieldSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the contact is active"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Marks the contact as a favorite"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, fullname required for create)"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code","description":"Custom code or reference for the contact"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the linked contact record"},"contact_type":{"anyOf":[{"enum":["lead","person","organization",null]},{"type":"null"}],"title":"Contact Type","description":"Type of contact"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Timestamp when the contact was created"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Associated database name or ID"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age","description":"Age of the contact, if applicable"},"media_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source","description":"Primary media source associated with the contact"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the contact's profile image"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image","description":"Base64 or path to the contact's profile image"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]},"crisp_people_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Crisp People Id","description":"ID used by Crisp for chat integrations"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database-specific ID of the contact"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Database key or token for internal reference"},"deal_rotation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Rotation Id","description":"ID of the rotation rule for deals"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id","description":"Landlord's account ID if linked"},"last_updated_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Updated At","description":"Timestamp of the last update"},"manager":{"anyOf":[{"$ref":"#/components/schemas/ManagerSchema"},{"type":"null"}],"description":"Manager responsible for the contact"},"managers_shared":{"items":{"$ref":"#/components/schemas/ManagerSchema"},"type":"array","title":"Managers Shared","description":"List of managers who share this contact","default":[]},"media_sources":{"items":{"$ref":"#/components/schemas/routers__schemas__field__MediaSourceSchema"},"type":"array","title":"Media Sources","description":"List of media sources","default":[]},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database","description":"Database ID of the member who owns the contact"},"member_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Id","description":"Registration ID of the member"},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the contact is shared via a network group"},"network":{"anyOf":[{"$ref":"#/components/schemas/ContactNetworkSchema"},{"type":"null"}],"description":"Network-related information for the contact"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"If true, this contact is private to the creator"},"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer","description":"Indicates if this contact is a payer (e.g., in a rental deal)"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"URL of a custom image for the contact"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRouterSchema"},"type":"array","title":"Properties","description":"List of properties linked to the contact","default":[]},"review_pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending","description":"Indicates if the contact is pending review"},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key used to control revisions or updates"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj","description":"Company CNPJ (required if CPF is not provided)"},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"Personal CPF (required if CNPJ is not provided)"},"not_search_profile_picture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Search Profile Picture","description":"Skip automatic profile picture lookup"},"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","description":"Banking information related to the contact","default":[]},"pix":{"items":{"$ref":"#/components/schemas/PixSchemaSchema"},"type":"array","title":"Pix","description":"PIX keys or data for financial transactions","default":[]},"tags_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tags In Data","description":"Flag to indicate if tags are already embedded in the data","default":false},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager","description":"Indicates whether the contact can have a manager reassigned on rotations"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"associated_with":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Associated With","default":[]},"cellphone":{"anyOf":[{"$ref":"#/components/schemas/PhoneSchema"},{"type":"null"}],"description":"Cellphone number of the person, ex: {\n 'cellphone': {'number': '(11) 91234-5678', 'type': '', 'alpha2Code': 'br'}}"},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","description":"For create a person, contact, organization this field is required, example: {\n \"field_id\": \"email\", \"value\": \"test@example.com\", \"type\": \"list\"}","default":[],"examples":[[{"field_id":"address","type":"string","value":"Rua Funchal, 500"},{"field_id":"address_complement","type":"string","value":"Casa"},{"field_id":"birthday","type":"date","value":"2021-10-10"},{"field_id":"city","type":"string","value":"São Paulo"},{"field_id":"country","type":"string","value":"Brasil"},{"field_id":"cpf","type":"string","value":"123.456.789-00"},{"field_id":"gender","type":"string","value":"Masculino"},{"field_id":"marital_status","type":"string","value":"Solteiro (a)"},{"field_id":"nationality","type":"string","value":"São Paulo"},{"field_id":"neighborhood","type":"string","value":"Vila Olímpia"},{"field_id":"phone","type":"list","value":[{"alpha2Code":"br","number":"(11) 9123-4567","type":""}]},{"field_id":"place_of_birth","type":"string","value":"São Paulo"},{"field_id":"profession","type":"string","value":"Estudante"},{"field_id":"rg","type":"string","value":"12.345.678-9"},{"field_id":"rg_issue_date","type":"date","value":"2025-02-11"},{"field_id":"rg_issue_organ","type":"string","value":"SSP"},{"field_id":"rg_issue_state","type":"string","value":"SP"},{"field_id":"social_network","type":"list","value":[{"account":"facebook.com","name":"Facebook"}]},{"field_id":"site","type":"string","value":"imobzi.com"},{"field_id":"state","type":"string","value":"SP"},{"field_id":"zipcode","type":"string","value":"04551-060"},{"field_id":"email","type":"list","value":"example@example.com"}]]},"firstname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, firstname required for create)"},"lastname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, lastname required for create)"},"organizations_associated":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Organizations Associated","default":[]},"persons_associated":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Persons Associated","default":[]}},"type":"object","title":"PersonFieldSchema"},"PersonFieldSchemas":{"properties":{"field_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Id"},"configuration":{"$ref":"#/components/schemas/PersonFieldConfigurationSchemas","description":"Configuration settings for the person field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name","description":"Name of the text template parameter for this field."}},"type":"object","required":["configuration"],"title":"PersonFieldSchemas"},"PersonFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/PersonFieldConfigurationSchemas","description":"Configuration settings for the person field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"text_template_parameter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Template Parameter Name","description":"Name of the text template parameter for this field."}},"type":"object","required":["configuration"],"title":"PersonFieldsSchemas"},"PersonRouterSchema":{"properties":{"person":{"$ref":"#/components/schemas/PersonFieldSchema"}},"type":"object","required":["person"],"title":"PersonRouterSchema"},"PersonsAssociatedSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"associate_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Associate Type"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"person_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Person Type"},"code":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Code"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"organization_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Organization Id"},"person_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Person Id"},"profile_image":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Profile Image"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"PersonsAssociatedSchema"},"PersonsFieldsSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the contact is active"},"favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Favorite","description":"Marks the contact as a favorite"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, fullname required for create)"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Email address of the contact"},"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code","description":"Custom code or reference for the contact"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the linked contact record"},"contact_type":{"anyOf":[{"enum":["lead","person","organization",null]},{"type":"null"}],"title":"Contact Type","description":"Type of contact"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Timestamp when the contact was created"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Associated database name or ID"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age","description":"Age of the contact, if applicable"},"media_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source","description":"Primary media source associated with the contact"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the contact's profile image"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image","description":"Base64 or path to the contact's profile image"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]},"crisp_people_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Crisp People Id","description":"ID used by Crisp for chat integrations"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database-specific ID of the contact"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key","description":"Database key or token for internal reference"},"deal_rotation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Rotation Id","description":"ID of the rotation rule for deals"},"landlord_account_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Landlord Account Id","description":"Landlord's account ID if linked"},"last_updated_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Last Updated At","description":"Timestamp of the last update"},"manager":{"anyOf":[{"$ref":"#/components/schemas/ManagerSchema"},{"type":"null"}],"description":"Manager responsible for the contact"},"managers_shared":{"items":{"$ref":"#/components/schemas/ManagerSchema"},"type":"array","title":"Managers Shared","description":"List of managers who share this contact","default":[]},"media_sources":{"items":{"$ref":"#/components/schemas/MediaSourceSchema-Output"},"type":"array","title":"Media Sources","description":"List of media sources","default":[]},"member_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Database","description":"Database ID of the member who owns the contact"},"member_register_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Id","description":"Registration ID of the member"},"network_group_member_shared":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Group Member Shared","description":"Indicates if the contact is shared via a network group"},"network":{"anyOf":[{"$ref":"#/components/schemas/ContactNetworkSchema"},{"type":"null"}],"description":"Network-related information for the contact"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private","description":"If true, this contact is private to the creator"},"payer":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payer","description":"Indicates if this contact is a payer (e.g., in a rental deal)"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"URL of a custom image for the contact"},"properties":{"items":{"$ref":"#/components/schemas/PropertyRouterSchema"},"type":"array","title":"Properties","description":"List of properties linked to the contact","default":[]},"review_pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Pending","description":"Indicates if the contact is pending review"},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key used to control revisions or updates"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Persons type","default":"person","examples":["ex"],"values":["person"]},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"cnpj":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cnpj","description":"Company CNPJ (required if CPF is not provided)"},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"Personal CPF (required if CNPJ is not provided)"},"not_search_profile_picture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Search Profile Picture","description":"Skip automatic profile picture lookup"},"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","description":"Banking information related to the contact","default":[]},"pix":{"items":{"$ref":"#/components/schemas/PixSchemaSchema"},"type":"array","title":"Pix","description":"PIX keys or data for financial transactions","default":[]},"tags_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tags In Data","description":"Flag to indicate if tags are already embedded in the data","default":false},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager","description":"Indicates whether the contact can have a manager reassigned on rotations"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"associated_with":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Associated With","default":[]},"cellphone":{"anyOf":[{"$ref":"#/components/schemas/PhoneSchema"},{"type":"null"}],"description":"Cellphone number of the person, ex: {\n 'cellphone': {'number': '(11) 91234-5678', 'type': '', 'alpha2Code': 'br'}}"},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","description":"For create a person, contact, organization this field is required, example: {\n \"field_id\": \"email\", \"value\": \"test@example.com\", \"type\": \"list\"}","default":[],"examples":[[{"field_id":"address","type":"string","value":"Rua Funchal, 500"},{"field_id":"address_complement","type":"string","value":"Casa"},{"field_id":"birthday","type":"date","value":"2021-10-10"},{"field_id":"city","type":"string","value":"São Paulo"},{"field_id":"country","type":"string","value":"Brasil"},{"field_id":"cpf","type":"string","value":"123.456.789-00"},{"field_id":"gender","type":"string","value":"Masculino"},{"field_id":"marital_status","type":"string","value":"Solteiro (a)"},{"field_id":"nationality","type":"string","value":"São Paulo"},{"field_id":"neighborhood","type":"string","value":"Vila Olímpia"},{"field_id":"phone","type":"list","value":[{"alpha2Code":"br","number":"(11) 9123-4567","type":""}]},{"field_id":"place_of_birth","type":"string","value":"São Paulo"},{"field_id":"profession","type":"string","value":"Estudante"},{"field_id":"rg","type":"string","value":"12.345.678-9"},{"field_id":"rg_issue_date","type":"date","value":"2025-02-11"},{"field_id":"rg_issue_organ","type":"string","value":"SSP"},{"field_id":"rg_issue_state","type":"string","value":"SP"},{"field_id":"social_network","type":"list","value":[{"account":"facebook.com","name":"Facebook"}]},{"field_id":"site","type":"string","value":"imobzi.com"},{"field_id":"state","type":"string","value":"SP"},{"field_id":"zipcode","type":"string","value":"04551-060"},{"field_id":"email","type":"list","value":"example@example.com"}]]},"firstname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, firstname required for create)"},"lastname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname","description":"Required only when creating a Person or Lead (Create lead, contact or person name, lastname required for create)"},"organizations_associated":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Organizations Associated","default":[]},"persons_associated":{"items":{"$ref":"#/components/schemas/PersonsAssociatedSchema"},"type":"array","title":"Persons Associated","default":[]}},"type":"object","title":"PersonsFieldsSchema"},"PersonsRouterSchema":{"properties":{"person":{"$ref":"#/components/schemas/PersonsFieldsSchema","description":"All params in the person, ex: {'person': {\n 'firstname': 'João', 'lastname': 'Silva', 'field_values': [], 'active': true}}"}},"type":"object","required":["person"],"title":"PersonsRouterSchema"},"PhoneSchema":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of phone number, e.g., mobile, home, work."},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number","description":"Phone number."},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Country code of the phone number."},"alpha2Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alpha2Code","description":"Alpha-2 code of the country."},"sector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sector","description":"Sector of the phone number."}},"type":"object","title":"PhoneSchema","description":"ContactPhone fields"},"PipelineFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"position":{"type":"integer","title":"Position","description":"Pipeline position in the list"},"stagnant_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stagnant Days"},"network_sync":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Sync"},"radar_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Radar Enabled"},"digital_real_estate_visits":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Real Estate Visits"},"digital_real_estate_allow_lease_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Real Estate Allow Lease Create"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/PipelineGroupSchema"},{"type":"null"}]},"not_expires_reserves":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Expires Reserves"},"site_reserves":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Reserves"},"checklist":{"anyOf":[{"items":{"$ref":"#/components/schemas/routers__schemas__pipeline__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist"}},"type":"object","required":["name","position"],"title":"PipelineFieldsSchema"},"PipelineFieldsUpdateSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position","description":"Pipeline position in the list"},"stagnant_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stagnant Days"},"network_sync":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Network Sync"},"radar_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Radar Enabled"},"digital_real_estate_visits":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Real Estate Visits"},"digital_real_estate_allow_lease_create":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Digital Real Estate Allow Lease Create"},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration"},"pipeline_group":{"anyOf":[{"$ref":"#/components/schemas/PipelineGroupSchema"},{"type":"null"}]},"not_expires_reserves":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Not Expires Reserves"},"site_reserves":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Reserves"},"checklist":{"anyOf":[{"items":{"$ref":"#/components/schemas/routers__schemas__pipeline__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist"}},"type":"object","title":"PipelineFieldsUpdateSchema"},"PipelineGroupFieldsSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"type":"string","title":"Name"},"pipeline_type":{"anyOf":[{"enum":["default","others","cards","listing_properties",null]},{"type":"null"}],"title":"Pipeline Type"},"range_value":{"anyOf":[{"$ref":"#/components/schemas/DealRangeValueSchema"},{"type":"null"}]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default"},"pipelines":{"items":{"$ref":"#/components/schemas/PipelineFieldsSchema"},"type":"array","title":"Pipelines"},"description_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Key"},"code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Code"},"new_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Code"},"deal_cards_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/DealCardInfoSchema"},"type":"array"},{"type":"null"}],"title":"Deal Cards Info","default":[]},"teams":{"items":{"$ref":"#/components/schemas/UserTeamSchema"},"type":"array","title":"Teams","default":[]},"has_permission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Permission"},"checklist":{"anyOf":[{"items":{"$ref":"#/components/schemas/routers__schemas__pipeline_group__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist"}},"type":"object","required":["name","pipeline_type"],"title":"PipelineGroupFieldsSchema"},"PipelineGroupRouterSchema":{"properties":{"pipeline_group":{"$ref":"#/components/schemas/PipelineGroupFieldsSchema"}},"type":"object","required":["pipeline_group"],"title":"PipelineGroupRouterSchema"},"PipelineGroupSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"PipelineGroupSchema"},"PipelineGroupUpdateRouterSchema":{"properties":{"pipeline_group":{"$ref":"#/components/schemas/PipelineGroupsFieldsUpdateSchema"}},"type":"object","required":["pipeline_group"],"title":"PipelineGroupUpdateRouterSchema"},"PipelineGroupsFieldsUpdateSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"pipeline_type":{"anyOf":[{"enum":["default","others","cards","listing_properties",null]},{"type":"null"}],"title":"Pipeline Type"},"range_value":{"anyOf":[{"$ref":"#/components/schemas/DealRangeValueSchema"},{"type":"null"}]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default"},"pipelines":{"items":{"$ref":"#/components/schemas/PipelineFieldsSchema"},"type":"array","title":"Pipelines"},"description_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description Key"},"code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Code"},"new_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Code"},"deal_cards_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/DealCardInfoSchema"},"type":"array"},{"type":"null"}],"title":"Deal Cards Info","default":[]},"teams":{"items":{"$ref":"#/components/schemas/UserTeamSchema"},"type":"array","title":"Teams","default":[]},"has_permission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Permission"},"checklist":{"anyOf":[{"items":{"$ref":"#/components/schemas/routers__schemas__pipeline_group__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist"}},"type":"object","required":["pipeline_type"],"title":"PipelineGroupsFieldsUpdateSchema"},"PipelineRouterSchema":{"properties":{"pipeline":{"anyOf":[{"$ref":"#/components/schemas/PipelineFieldsSchema"},{"type":"null"}]}},"type":"object","title":"PipelineRouterSchema"},"PipelineUpdateRouterSchema":{"properties":{"pipeline":{"anyOf":[{"$ref":"#/components/schemas/PipelineFieldsUpdateSchema"},{"type":"null"}]}},"type":"object","title":"PipelineUpdateRouterSchema"},"PixSchema":{"properties":{"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type"}},"type":"object","title":"PixSchema"},"PixSchemaSchema":{"properties":{"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default"},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"pix_key_type":{"anyOf":[{"enum":["email","cpf_cnpj","phone","key_random",null]},{"type":"null"}],"title":"Pix Key Type"}},"type":"object","required":["pix_key_type"],"title":"PixSchemaSchema","description":"ContactPix fields "},"PostSiteHighlightsProperties":{"properties":{"position":{"type":"integer","title":"Position","description":"Sort properties display in ascending order"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"}},"type":"object","title":"PostSiteHighlightsProperties"},"PostSiteHighlightsRequestSchema":{"properties":{"banner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Banner","description":"Identifies whether the highlight is a banner type"},"properties":{"items":{"$ref":"#/components/schemas/PostSiteHighlightsProperties"},"type":"array","title":"Properties"},"section_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Section Id"}},"type":"object","required":["properties"],"title":"PostSiteHighlightsRequestSchema"},"ProcessedDocumentSchema":{"properties":{"tipo":{"type":"string","title":"Tipo"},"dados_extraidos":{"additionalProperties":true,"type":"object","title":"Dados Extraidos"},"texto_bruto":{"type":"string","title":"Texto Bruto","default":""},"confidence":{"type":"number","title":"Confidence","default":0.0},"model_used":{"type":"string","title":"Model Used","default":""}},"type":"object","required":["tipo"],"title":"ProcessedDocumentSchema"},"PropertiesMostSeenSchema":{"properties":{"city":{"type":"string","title":"City"},"code":{"type":"string","title":"Code"},"cover_photo":{"type":"string","title":"Cover Photo"},"neighborhood":{"type":"string","title":"Neighborhood"},"property_type":{"type":"string","title":"Property Type"},"rental_value":{"type":"integer","title":"Rental Value"},"sale_value":{"type":"integer","title":"Sale Value"},"site_view_count":{"type":"integer","title":"Site View Count"}},"type":"object","required":["city","code","cover_photo","neighborhood","property_type","rental_value","sale_value","site_view_count"],"title":"PropertiesMostSeenSchema"},"PropertiesRouterSchema":{"properties":{"property":{"$ref":"#/components/schemas/PropertyRouterSchema","description":"Property data for creation or update."}},"type":"object","required":["property"],"title":"PropertiesRouterSchema"},"PropertyAdvertsFieldsSchema":{"properties":{"lead_integration_action":{"anyOf":[{"enum":["enabled","disabled",null]},{"type":"null"}],"title":"Lead Integration Action"},"refresh_in_adverts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Refresh In Adverts"},"properties":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Properties","default":[]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"media_source_id":{"type":"string","title":"Media Source Id"},"all_properties":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Properties"},"unlimited_plan":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unlimited Plan"},"advert_plans":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Advert Plans","default":[]},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"media_source_settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Media Source Settings"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","required":["media_source_id"],"title":"PropertyAdvertsFieldsSchema"},"PropertyAdvertsResponseSchema":{"properties":{"adverts":{"items":{"$ref":"#/components/schemas/PropertyAdvertsFieldsSchema"},"type":"array","title":"Adverts","default":[]},"networks":{"items":{"$ref":"#/components/schemas/ResponseNetWorkSchema"},"type":"array","title":"Networks","default":[]}},"type":"object","title":"PropertyAdvertsResponseSchema"},"PropertyAdvertsRouterSchema":{"properties":{"advert":{"anyOf":[{"$ref":"#/components/schemas/PropertyAdvertsFieldsSchema"},{"type":"null"}]}},"type":"object","title":"PropertyAdvertsRouterSchema"},"PropertyAdvertsUpdateFieldsSchema":{"properties":{"lead_integration_action":{"anyOf":[{"enum":["enabled","disabled",null]},{"type":"null"}],"title":"Lead Integration Action"},"refresh_in_adverts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Refresh In Adverts"},"properties":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Properties","default":[]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"media_source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Source Id"},"all_properties":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Properties"},"unlimited_plan":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unlimited Plan"},"advert_plans":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Advert Plans","default":[]},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"},"media_source_settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Media Source Settings"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"PropertyAdvertsUpdateFieldsSchema"},"PropertyAdvertsUpdateRouterSchema":{"properties":{"advert":{"anyOf":[{"$ref":"#/components/schemas/PropertyAdvertsUpdateFieldsSchema"},{"type":"null"}]}},"type":"object","title":"PropertyAdvertsUpdateRouterSchema"},"PropertyCoverPhotoSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","title":"PropertyCoverPhotoSchema"},"PropertyCreateParams":{"properties":{"address":{"type":"string","title":"Address","description":"Street name and number, for example 'Avenida das Nações Unidas, 18.801'. Put suite, block, apartment, or room details in address_complement."},"city":{"type":"string","title":"City","description":"Property city, for example 'São Paulo' or 'Curitiba'."},"state":{"type":"string","title":"State","description":"Two-letter uppercase Brazilian state code, such as SP, RJ, MG, or SC. Convert a full state name to its code, for example 'São Paulo' to SP."},"neighborhood":{"type":"string","title":"Neighborhood","description":"Property neighborhood, for example 'Vila Almeida', 'Pinheiros', or 'Ipanema'."},"property_type":{"type":"string","title":"Property type","description":"Property type from the account-specific catalog, for example 'Apartamento', 'Casa de Condomínio', or 'Chácara'. The tool accepts registered labels, normalized names, and common Portuguese or English aliases. An unknown type returns needs_user_input with the registered options."},"country":{"type":"string","title":"Country","description":"Property country. Defaults to Brasil.","default":"Brasil"},"sale_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale value","description":"Sale price as a number without a currency symbol or thousands separator. Map 'R$ 1.100.000' to 1100000 and 'R$ 850 mil' to 850000. Provide this field for a sale or purchase listing."},"rental_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rental value","description":"Monthly rental price as a number without a currency symbol. Map 'R$ 3.000' or 'três mil reais' to 3000. Provide this field for a rental listing."},"status":{"type":"string","enum":["available","pending","rented","reserved","solded","with_proposal","solded_by_third_parties","rented_by_third_parties","suspended"],"title":"Status","description":"Initial property status. Defaults to available. Values include available='disponível', pending='pendente', rented='alugado', reserved='reservado', solded='vendido', with_proposal='com proposta', solded_by_third_parties, rented_by_third_parties, and suspended.","default":"available"},"finality":{"anyOf":[{"type":"string","enum":["residential","commercial","rural"]},{"type":"null"}],"title":"Property finality","description":"Usage classification: residential, commercial, or rural. Omit it unless the user states it; the tool uses the finality associated with the resolved property type, with a legacy inference only when the type catalog is unavailable."},"interest":{"anyOf":[{"type":"string","enum":["buy","rent","vacation_rental"]},{"type":"null"}],"title":"Commercial interest","description":"Transaction hint: buy for 'venda/compra', rent for 'aluguel/locação', or vacation_rental for 'temporada'. This value is not stored as a separate commercial-interest field: vacation_rental sets vacation_rental=true, while buy or rent sets it to false unless explicitly provided."},"property_situation":{"anyOf":[{"type":"string","enum":["used","new","under_construction","off_plan","semi_new"]},{"type":"null"}],"title":"Property situation","description":"Construction situation: used='usado', new='novo', under_construction='em construção', off_plan='lançamento/na planta', or semi_new='seminovo'. Omit it when the user does not state the situation."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Internal property description. Omit it when the user provides no descriptive text."},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address complement","description":"Suite, block, apartment, or room information kept separate from address. Examples: 'Conjunto 309', 'Apto 141', or 'Bloco A - Sala 5'."},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal code","description":"Property postal code (CEP)."},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedrooms","description":"Total number of bedrooms, including suites. Map '3 quartos sendo 1 suíte' to bedroom=3 and suite=1."},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathrooms","description":"Total number of bathrooms, including powder rooms and suite bathrooms."},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suites","description":"Number of bedrooms with a private bathroom. Suites are already included in the bedroom total. Map '1 suíte' to suite=1."},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parking spaces","description":"Number of garage or parking spaces."},"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total area","description":"Total property area in square meters. Use for 'área total', 'área construída', or an unspecified area such as '85 m²'; send 85 as a number."},"useful_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable area","description":"Usable area in square meters. Use it when the user explicitly says 'área útil'; use area for an unspecified area value."},"lot_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot area","description":"Lot area in square meters for houses, land, or properties with a stated yard or garden."},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement unit","description":"Area measurement unit. The tool automatically defaults to m²; omit this field unless needed."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Property geographic latitude."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Property geographic longitude."},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation rental","description":"Whether the property is offered as a vacation rental."},"site_publish":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publish on website","description":"Whether the property is published on the website."},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publish price on website","description":"Whether the property price is displayed on the website."},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website title","description":"Property title used for website publication."},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website slug","description":"Friendly URL slug for the property website page."},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private property","description":"Whether the property is private."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Whether the property is active. Defaults to true.","default":true},"alternative_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alternative code","description":"Alternative property code."},"visit_only_realtor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit requires broker","description":"Whether property visits require a broker."},"visit_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visit time","description":"Preferred time or schedule for property visits."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage","description":"Internal property stage."},"owners":{"items":{"$ref":"#/components/schemas/PropertyOwnerMCPSchema"},"type":"array","title":"Owners","description":"Property owners. For each owner, provide at least one of contact_name, contact_email, or contact_phone so the contact can be resolved."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker name","description":"Name of the listing broker to assign. Omit user_name and user_email to assign the requesting user."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker email","description":"Email of the listing broker to assign. Prefer this over user_name for precision. Omit both fields to assign the requesting user."}},"type":"object","required":["address","city","state","neighborhood","property_type"],"title":"PropertyCreateParams"},"PropertyDealsMatchResponse":{"properties":{"count":{"type":"integer","title":"Count"}},"type":"object","required":["count"],"title":"PropertyDealsMatchResponse"},"PropertyDescriptionSchema":{"properties":{"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key"},"fields":{"items":{"type":"string"},"type":"array","title":"Fields","default":[]},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"property":{"anyOf":[{"$ref":"#/components/schemas/PropertyRouterDescriptionSchema"},{"type":"null"}]},"template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template"}},"type":"object","title":"PropertyDescriptionSchema"},"PropertyDigitalFieldsSchema":{"properties":{"available_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Available Digital Real Estate"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Area"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"condominium":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Condominium"},"checkin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkin"},"checkout":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout"},"cleaning_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cleaning Fee"},"service_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Service Fee"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"house_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Rules"},"iptu":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Iptu"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"owners":{"items":{"$ref":"#/components/schemas/OwnerFieldsSchema"},"type":"array","title":"Owners","default":[]},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type"},"rental_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rental Value"},"sale_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale Value"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Title"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation Rental"},"vacation_additional_value_guest":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Vacation Additional Value Guest"},"vacation_charge_additional_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Charge Additional Guests"},"vacation_rental_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Rental Guests"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"},"cover_photo_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cover Photo Url"},"listing_broker":{"anyOf":[{"$ref":"#/components/schemas/ListingBrokerFieldsSchema"},{"items":{"$ref":"#/components/schemas/ListingBrokerFieldsSchema"},"type":"array"},{"type":"null"}],"title":"Listing Broker"},"calendar":{"anyOf":[{"items":{"$ref":"#/components/schemas/CalendarDigitalFieldsSchema"},"type":"array"},{"type":"null"}],"title":"Calendar"},"visit_liked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit Liked"}},"type":"object","required":["db_id"],"title":"PropertyDigitalFieldsSchema"},"PropertyFeaturesCreateSchemas":{"properties":{"property_feature":{"$ref":"#/components/schemas/PropertyFeaturesSchemas","description":"All params in the property feature, ex: {'property_feature': {\n 'name': 'Piscina', 'group_name': 'Lazer', 'active': true}}"}},"type":"object","required":["property_feature"],"title":"PropertyFeaturesCreateSchemas"},"PropertyFeaturesSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name"}},"type":"object","title":"PropertyFeaturesSchema"},"PropertyFeaturesSchemas":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the property feature."},"group_name":{"type":"string","title":"Group Name","description":"Group name of the property feature."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the property feature is active.","default":true},"type_residential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Type Residential","description":"Indicates whether the property feature is for residential use."},"type_commercial":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Type Commercial","description":"Indicates whether the property feature is for commercial use."},"type_rural":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Type Rural","description":"Indicates whether the property feature is for rural use."}},"type":"object","required":["name","group_name"],"title":"PropertyFeaturesSchemas"},"PropertyFeaturesUpdateSchemas":{"properties":{"property_feature":{"$ref":"#/components/schemas/PropertyFeaturesSchemas"}},"type":"object","required":["property_feature"],"title":"PropertyFeaturesUpdateSchemas"},"PropertyFieldConfigurationSchemas":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the field, e.g., 'string', 'number', 'date', etc."},"values":{"items":{"type":"string"},"type":"array","title":"Values","description":"List of values for the field. This is required for create a new field default value []","default":[],"examples":["value1","value2","value3"]},"typevalue":{"type":"string","title":"Typevalue","description":"Type of value the field holds, e.g., 'text', 'number', 'date', etc."},"mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mask","description":"Mask format for the field, if applicable."},"custom_validate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Validate","description":"Custom validation logic for the field, if any."},"showingroup":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showingroup","description":"Indicates whether the field should be shown in the group."},"inactive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Inactive","description":"Indicates whether the field is inactive."},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Link associated with the field, if any."},"multiple":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multiple","default":true},"typebox":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typebox","default":false},"typeresidential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typeresidential"},"typerural":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typerural"},"typecommercial":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typecommercial"},"typelandlot":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Typelandlot"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"require_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Require Value"}},"type":"object","required":["typevalue"],"title":"PropertyFieldConfigurationSchemas"},"PropertyFieldSchemas":{"properties":{"field_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Id","description":"Unique identifier for the field."},"configuration":{"$ref":"#/components/schemas/PropertyFieldConfigurationSchemas","description":"Configuration settings for the property field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"subgroup_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subgroup Name","description":"Name of the subgroup this field belongs to."},"subgroup_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Subgroup Position","description":"Position of the field within the subgroup."},"show_on_website":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show On Website","description":"Indicates whether this field should be shown on the website.","default":false}},"type":"object","required":["configuration"],"title":"PropertyFieldSchemas"},"PropertyFieldsCreateSchemas":{"properties":{"property_field":{"$ref":"#/components/schemas/PropertyFieldsSchemas","description":"All params in the property field, ex: {'property-field': {\n 'name': 'Número de Quartos', 'configuration': {'type': 'integer', 'values': [], 'typevalue': 'number'}, 'default': true}}"}},"type":"object","required":["property_field"],"title":"PropertyFieldsCreateSchemas"},"PropertyFieldsSchemas":{"properties":{"field_id":{"type":"string","title":"Field Id","description":"Required 'custom_' in id for create field"},"configuration":{"$ref":"#/components/schemas/PropertyFieldConfigurationSchemas","description":"Configuration settings for the property field. ex: {\n 'configuration': {'type': 'string', 'values': [], 'typevalue': 'text'}}"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name","description":"Name of the group. It should be defined based on the field type — for example, use 'group_contact' for contact fields, 'group_lead' for lead fields, and so on."},"group_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Group Position","description":"Position of the group. Required for create a new field"},"group_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Group Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position","description":"Position of the field in the group. Required for create a new field"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"},"show_only_on_edit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Only On Edit","default":false},"request_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Request Digital Real Estate","default":false},"request_type":{"items":{"type":"string"},"type":"array","title":"Request Type","description":"List of request types for the field","default":[]},"contract_types":{"items":{"type":"string"},"type":"array","title":"Contract Types","description":"List of contract types for the field","default":[],"examples":["rental","sale"]},"lease_types":{"items":{"type":"string"},"type":"array","title":"Lease Types","description":"List of lease types for the field","default":[],"examples":["residential","commercial"]},"show_real_time":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Real Time","default":false},"url_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Link"},"url_header":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Header"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates whether this field is the default field.","default":false},"subgroup_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subgroup Name","description":"Name of the subgroup this field belongs to."},"subgroup_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Subgroup Position","description":"Position of the field within the subgroup."},"show_on_website":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show On Website","description":"Indicates whether this field should be shown on the website.","default":false}},"type":"object","required":["configuration"],"title":"PropertyFieldsSchemas"},"PropertyFieldsUpdateSchemas":{"properties":{"property_field":{"$ref":"#/components/schemas/PropertyFieldSchemas"}},"type":"object","required":["property_field"],"title":"PropertyFieldsUpdateSchemas"},"PropertyLinksSchema":{"properties":{"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"contact_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"},"link_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Type"}},"type":"object","title":"PropertyLinksSchema"},"PropertyMirrorDetails":{"properties":{"code":{"type":"string","title":"Code"},"db_id":{"type":"string","title":"Db Id"},"database":{"type":"string","title":"Database"},"address":{"type":"string","title":"Address"},"address_complement":{"type":"string","title":"Address Complement"},"neighborhood":{"type":"string","title":"Neighborhood"},"active":{"type":"boolean","title":"Active"},"property_unity":{"type":"string","title":"Property Unity"},"property_block":{"type":"string","title":"Property Block"},"status":{"type":"string","title":"Status"},"rental_value":{"type":"number","title":"Rental Value"},"sale_value":{"type":"number","title":"Sale Value"},"area":{"type":"number","title":"Area"},"measure_type":{"type":"string","title":"Measure Type"},"cover_photo":{"$ref":"#/components/schemas/PropertyCoverPhotoSchema"},"listing_brokers":{"items":{"$ref":"#/components/schemas/ListingBrokersSchema"},"type":"array","title":"Listing Brokers"}},"type":"object","required":["code","db_id","database","address","address_complement","neighborhood","active","property_unity","property_block","status","rental_value","sale_value","area","measure_type","cover_photo","listing_brokers"],"title":"PropertyMirrorDetails"},"PropertyOwnerMCPSchema":{"properties":{"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner name","description":"Name of the owner, who may be a person or organization. Provide at least one of contact_name, contact_email, or contact_phone for each owner."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner email","description":"Email address used to identify the owner. Provide at least one of contact_name, contact_email, or contact_phone for each owner."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner phone","description":"Phone number used to identify the owner. Provide at least one of contact_name, contact_email, or contact_phone for each owner."},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ownership percentage","description":"Owner's percentage share in the property. Example: 100.0."},"rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner rate","description":"Rate or commission associated with the owner."}},"type":"object","title":"PropertyOwnerMCPSchema"},"PropertyOwnerSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"phone":{"anyOf":[{"$ref":"#/components/schemas/PhoneSchema"},{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array"}],"title":"Phone","default":[]},"phones":{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array","title":"Phones","default":[]},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"landlord_account_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Landlord Account Id"},"email":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Email","default":[]},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage"},"rate":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Rate"},"bank_data":{"anyOf":[{"$ref":"#/components/schemas/BankDataSchema"},{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array"},{"type":"null"}],"title":"Bank Data"}},"type":"object","title":"PropertyOwnerSchema"},"PropertyOwnersSchema":{"properties":{"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Percentage"}},"type":"object","title":"PropertyOwnersSchema"},"PropertyPhotosSchema":{"properties":{"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"image_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Key"},"position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Position"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"PropertyPhotosSchema"},"PropertyQualitySchema":{"properties":{"issues":{"additionalProperties":{"type":"integer"},"type":"object","title":"Issues"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"score_value":{"type":"integer","title":"Score Value","default":0}},"type":"object","title":"PropertyQualitySchema"},"PropertyReserveGuaranteeSchema":{"properties":{"bail":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bail"},"surety_bond":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Surety Bond"},"guarantor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Guarantor"}},"type":"object","title":"PropertyReserveGuaranteeSchema"},"PropertyReservePostSchema":{"properties":{"reserve":{"$ref":"#/components/schemas/PropertyReserveSchema","description":"All params in the property reserve, ex: {'reserve': {\n 'start': '2023-10-01', 'end': '2023-10-10', 'property_id': 123}}"}},"type":"object","required":["reserve"],"title":"PropertyReservePostSchema"},"PropertyReserveReponsePostSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"}},"type":"object","required":["db_id"],"title":"PropertyReserveReponsePostSchema"},"PropertyReserveSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database ID (optional)"},"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start","description":"Reservation start date (required if create)"},"end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End","description":"Reservation end date (required if create)"},"user_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"User Id","description":"User ID (optional)"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Property Id","description":"Property ID associated with the reservation (required)"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Name of the user who created the reservation"},"user_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Image Url","description":"URL of the user's profile image"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description or notes about the reservation"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id","description":"ID of the associated deal, if applicable"},"deal_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Title","description":"Title of the associated deal, if applicable"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the contact linked to the reservation"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type","description":"Type of the contact (e.g., person, company)"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name","description":"Name of the contact"},"contact_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Image Url","description":"URL of the contact's profile image"},"proposal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proposal","description":"Indicates whether this reservation is linked to a proposal"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality","description":"Purpose or finality of the reservation"},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/PropertyReserveGuaranteeSchema"},{"type":"null"}],"description":"Guarantee method for the reservation"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Color code associated with the reservation (e.g., for calendar display)"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Custom code or identifier for the reservation"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the reservation"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Value","description":"Value or price associated with the reservation"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the reservation"},"property":{"anyOf":[{"$ref":"#/components/schemas/PropertyRouterSchema"},{"type":"null"}],"description":"Full property data related to the reservation"}},"type":"object","required":["property_id"],"title":"PropertyReserveSchema"},"PropertyReserveUpdatePostSchema":{"properties":{"reserve":{"$ref":"#/components/schemas/PropertyReserveUpdateSchema"}},"type":"object","required":["reserve"],"title":"PropertyReserveUpdatePostSchema"},"PropertyReserveUpdateSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Database ID (optional)"},"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start","description":"Reservation start date (required if create)"},"end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End","description":"Reservation end date (required if create)"},"user_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"User Id","description":"User ID (optional)"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Property Id"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"Name of the user who created the reservation"},"user_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Image Url","description":"URL of the user's profile image"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description or notes about the reservation"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id","description":"ID of the associated deal, if applicable"},"deal_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Title","description":"Title of the associated deal, if applicable"},"contact_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Id","description":"ID of the contact linked to the reservation"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type","description":"Type of the contact (e.g., person, company)"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name","description":"Name of the contact"},"contact_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Image Url","description":"URL of the contact's profile image"},"proposal":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proposal","description":"Indicates whether this reservation is linked to a proposal"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality","description":"Purpose or finality of the reservation"},"guarantee":{"anyOf":[{"$ref":"#/components/schemas/PropertyReserveGuaranteeSchema"},{"type":"null"}],"description":"Guarantee method for the reservation"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Color code associated with the reservation (e.g., for calendar display)"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Custom code or identifier for the reservation"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the reservation"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Value","description":"Value or price associated with the reservation"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the reservation"},"property":{"anyOf":[{"$ref":"#/components/schemas/PropertyRouterSchema"},{"type":"null"}],"description":"Full property data related to the reservation"}},"type":"object","title":"PropertyReserveUpdateSchema"},"PropertyResponse":{"properties":{"status":{"type":"string","title":"Status"},"code":{"type":"string","title":"Code"},"neighborhood":{"type":"string","title":"Neighborhood"},"deal_stage":{"type":"string","title":"Deal Stage"},"alternative_code":{"type":"string","title":"Alternative Code"},"updated_at":{"type":"string","title":"Updated At"},"bedroom":{"type":"integer","title":"Bedroom"},"site_publish":{"type":"boolean","title":"Site Publish"},"property_type":{"type":"string","title":"Property Type"},"vacation_rental":{"type":"boolean","title":"Vacation Rental"},"building_name":{"type":"string","title":"Building Name"},"city":{"type":"string","title":"City"},"bathroom":{"type":"integer","title":"Bathroom"},"area":{"type":"number","title":"Area"},"lot_area":{"type":"number","title":"Lot Area"},"zipcode":{"type":"string","title":"Zipcode"},"latitude":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Longitude"},"suite":{"type":"integer","title":"Suite"},"stage":{"type":"string","title":"Stage"},"rental_value":{"type":"number","title":"Rental Value"},"member_register_code":{"type":"string","title":"Member Register Code"},"building_parameters":{"anyOf":[{"$ref":"#/components/schemas/BuildingParametersSchema"},{"type":"null"}]},"db_id":{"type":"string","title":"Db Id"},"description":{"type":"string","title":"Description"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__property__CoverPhotoSchema"},{"type":"null"}]},"cover_photo_private":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__property__CoverPhotoSchema"},{"type":"null"}]},"finality":{"type":"string","title":"Finality"},"address":{"type":"string","title":"Address"},"active":{"type":"boolean","title":"Active"},"building":{"type":"boolean","title":"Building"},"address_complement":{"type":"string","title":"Address Complement"},"country":{"type":"string","title":"Country"},"created_at":{"type":"string","title":"Created At"},"property_situation":{"type":"string","title":"Property Situation"},"sale_value":{"type":"number","title":"Sale Value"},"listing_brokers":{"items":{"$ref":"#/components/schemas/ListingBrokersSchema"},"type":"array","title":"Listing Brokers"},"garage":{"type":"integer","title":"Garage"},"useful_area":{"type":"number","title":"Useful Area"},"key_id":{"type":"string","title":"Key Id"},"site_publish_price":{"type":"boolean","title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"available_digital_real_estate":{"type":"boolean","title":"Available Digital Real Estate"},"fiscal_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Registration Number"},"cib_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cib Code"},"quality":{"anyOf":[{"$ref":"#/components/schemas/PropertyQualitySchema"},{"type":"null"}]},"vacation_min_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Vacation Min Value"},"vacation_max_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Vacation Max Value"}},"type":"object","required":["status","code","neighborhood","deal_stage","alternative_code","updated_at","bedroom","site_publish","property_type","vacation_rental","building_name","city","bathroom","area","lot_area","zipcode","suite","stage","rental_value","member_register_code","db_id","description","finality","address","active","building","address_complement","country","created_at","property_situation","sale_value","listing_brokers","garage","useful_area","key_id","site_publish_price","available_digital_real_estate"],"title":"PropertyResponse"},"PropertyResponseGet":{"properties":{"active":{"type":"boolean","title":"Active"},"address":{"type":"string","title":"Address"},"address_complement":{"type":"string","title":"Address Complement"},"alternative_code":{"type":"string","title":"Alternative Code"},"area":{"type":"number","title":"Area"},"bathroom":{"type":"integer","title":"Bathroom"},"bedroom":{"type":"integer","title":"Bedroom"},"building":{"type":"boolean","title":"Building"},"building_name":{"type":"string","title":"Building Name"},"building_parameters":{"anyOf":[{"$ref":"#/components/schemas/BuildingParametersSchema"},{"type":"null"}]},"city":{"type":"string","title":"City"},"code":{"type":"string","title":"Code"},"country":{"type":"string","title":"Country"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__property__CoverPhotoSchema"},{"type":"null"}]},"cover_photo_private":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__property__CoverPhotoSchema"},{"type":"null"}]},"created_at":{"type":"string","title":"Created At"},"db_id":{"type":"string","title":"Db Id"},"deal_stage":{"type":"string","title":"Deal Stage"},"finality":{"type":"string","title":"Finality"},"garage":{"type":"integer","title":"Garage"},"geo_stage":{"anyOf":[{"$ref":"#/components/schemas/GeoCoordinatesSchema"},{"type":"null"}]},"key_id":{"type":"string","title":"Key Id"},"latitude":{"type":"number","title":"Latitude"},"listing_brokers":{"anyOf":[{"items":{"$ref":"#/components/schemas/ListingBrokersSchema"},"type":"array"},{"type":"null"}],"title":"Listing Brokers"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"lot_area":{"type":"number","title":"Lot Area"},"neighborhood":{"type":"string","title":"Neighborhood"},"plus_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Code"},"cib_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cib Code"},"property_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"},"property_situation":{"type":"string","title":"Property Situation"},"property_type":{"type":"string","title":"Property Type"},"rental_value":{"type":"number","title":"Rental Value"},"sale_value":{"type":"number","title":"Sale Value"},"site_publish":{"type":"boolean","title":"Site Publish"},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"stage":{"type":"string","title":"Stage"},"state":{"type":"string","title":"State"},"status":{"type":"string","title":"Status"},"suite":{"type":"integer","title":"Suite"},"updated_at":{"type":"string","title":"Updated At"},"useful_area":{"type":"number","title":"Useful Area"},"quality":{"anyOf":[{"$ref":"#/components/schemas/PropertyQualitySchema"},{"type":"null"}]}},"type":"object","required":["active","address","address_complement","alternative_code","area","bathroom","bedroom","building","building_name","city","code","country","created_at","db_id","deal_stage","finality","garage","key_id","latitude","lot_area","neighborhood","property_situation","property_type","rental_value","sale_value","site_publish","stage","state","status","suite","updated_at","useful_area"],"title":"PropertyResponseGet"},"PropertyRouterDescriptionSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"available_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Available Digital Real Estate"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"alternative_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alternative Code"},"area":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Area"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Required when creating a property"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"building_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"},"building":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Building"},"buildings":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Buildings"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"Required when creating a property"},"checkout":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout"},"platform_listing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Platform Listing Url"},"checkin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkin"},"service_fee":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Service Fee"},"house_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Rules"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/PropertyCoverPhotoSchema"},{"type":"null"}]},"cover_photo_private":{"anyOf":[{"$ref":"#/components/schemas/PropertyCoverPhotoSchema"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"exclusivity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exclusivity"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"latitude":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Longitude"},"elevators":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Elevators"},"features_values":{"items":{"$ref":"#/components/schemas/PropertyFeaturesSchema"},"type":"array","title":"Features Values","default":[]},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors"},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","default":[],"examples":[[{"field_id":"guarantor","type":"boolean","value":"True"},{"field_id":"bail","type":"boolean","value":"False"},{"field_id":"surety_bond","type":"boolean","value":"False"},{"field_id":"bond_application","type":"boolean","value":"True"},{"field_id":"credpago_guarantee","type":"boolean","value":"True"},{"field_id":"iptu","type":"float","value":"True"},{"field_id":"condominium","type":"float","value":"True"},{"field_id":"water","type":"float","value":"True"},{"field_id":"gas","type":"float","value":"True"},{"field_id":"light","type":"float","value":"True"},{"field_id":"cleaning_fee","type":"float","value":"True"},{"field_id":"value_to_fire_insurance","type":"float","value":"True"},{"field_id":"approx_fire_insurance_value","type":"float","value":"True"},{"field_id":"high_standard","type":"boolean","value":"True"},{"field_id":"with_plaque","type":"boolean","value":"True"},{"field_id":"exclusivity","type":"boolean","value":"False"},{"field_id":"private","type":"boolean","value":"False"}]]},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"links":{"items":{"$ref":"#/components/schemas/PropertyLinksSchema"},"type":"array","title":"Links","default":[]},"lot_area":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Area"},"lot_measure_front":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Measure Front"},"lot_measure_behind":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Measure Behind"},"lot_measure_right":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Measure Right"},"lot_measure_left":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Measure Left"},"lot_measure_radius":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lot Measure Radius"},"lot_measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lot Measure Type"},"new_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Code"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"nearby":{"items":{"type":"string"},"type":"array","title":"Nearby","default":[]},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood","description":"Required when creating a property"},"owners":{"items":{"$ref":"#/components/schemas/PropertyOwnersSchema"},"type":"array","title":"Owners","default":[]},"property_block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Block"},"property_dimension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Dimension"},"plus_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Code"},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type","description":"Required when creating a property"},"property_situation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Situation"},"property_base":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Base"},"photos":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array"},{"type":"null"}],"title":"Photos","default":[]},"multimidias":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array"},{"type":"null"}],"title":"Multimidias","default":[]},"sale_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Sale Value"},"rental_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Rental Value"},"weekend_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Weekend Value"},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Title"},"site_meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Meta Description"},"site_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Description"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"sun_position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Sun Position"},"send_owner_property_review":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Owner Property Review"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"site_publish":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish"},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"useful_area":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Useful Area"},"unit_floor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unit Floor"},"fiscal_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Registration Number"},"cib_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cib Code"},"units_per_floor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Units Per Floor"},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation Rental"},"vacation_rental_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Rental Guests"},"vacation_charge_additional_guests":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Vacation Charge Additional Guests"},"vacation_additional_value_guest":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Vacation Additional Value Guest"},"visit_only_realtor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit Only Realtor"},"visit_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visit Time"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"property_unity":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Property Unity"},"with_plaque":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Plaque"},"built":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Built"},"building_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Building In Data","default":false},"cover_photo_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cover Photo In Data","default":false},"cover_photo_private_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cover Photo Private In Data","default":false},"owners_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Owners In Data","default":false},"links_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Links In Data","default":false},"photos_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Photos In Data","default":false},"property_unity_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Property Unity In Data","default":false},"multimidias_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multimidias In Data","default":false},"latitude_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Latitude In Data","default":false},"longitude_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Longitude In Data","default":false},"field_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Field Values In Data","default":false},"features_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Features Values In Data","default":false},"active_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active In Data","default":false},"nearby_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nearby In Data","default":false},"built_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Built In Data","default":false},"unit_floor_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unit Floor In Data","default":false},"has_cover_photo":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Cover Photo","default":false},"has_cover_photo_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Cover Photo Private","default":false},"iptu_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Iptu Installments"},"stay_nights_by_days":{"anyOf":[{"$ref":"#/components/schemas/PropertyStayNightsByDays"},{"type":"null"}],"description":"Minimum and maximum stay for vacation rentals"}},"type":"object","title":"PropertyRouterDescriptionSchema"},"PropertyRouterSchema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"available_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Available Digital Real Estate"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"alternative_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alternative Code"},"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Area"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Required when creating a property"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"building_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"},"building":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Building"},"buildings":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Buildings"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"Required when creating a property"},"checkout":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout"},"platform_listing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Platform Listing Url"},"checkin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkin"},"service_fee":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Service Fee"},"house_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Rules"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/PropertyCoverPhotoSchema"},{"type":"null"}]},"cover_photo_private":{"anyOf":[{"$ref":"#/components/schemas/PropertyCoverPhotoSchema"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"exclusivity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exclusivity"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"elevators":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Elevators"},"features_values":{"items":{"$ref":"#/components/schemas/PropertyFeaturesSchema"},"type":"array","title":"Features Values","default":[]},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"floors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Floors"},"field_values":{"items":{"$ref":"#/components/schemas/FieldValueDefault"},"type":"array","title":"Field Values","default":[],"examples":[[{"field_id":"guarantor","type":"boolean","value":"True"},{"field_id":"bail","type":"boolean","value":"False"},{"field_id":"surety_bond","type":"boolean","value":"False"},{"field_id":"bond_application","type":"boolean","value":"True"},{"field_id":"credpago_guarantee","type":"boolean","value":"True"},{"field_id":"iptu","type":"float","value":"True"},{"field_id":"condominium","type":"float","value":"True"},{"field_id":"water","type":"float","value":"True"},{"field_id":"gas","type":"float","value":"True"},{"field_id":"light","type":"float","value":"True"},{"field_id":"cleaning_fee","type":"float","value":"True"},{"field_id":"value_to_fire_insurance","type":"float","value":"True"},{"field_id":"approx_fire_insurance_value","type":"float","value":"True"},{"field_id":"high_standard","type":"boolean","value":"True"},{"field_id":"with_plaque","type":"boolean","value":"True"},{"field_id":"exclusivity","type":"boolean","value":"False"},{"field_id":"private","type":"boolean","value":"False"}]]},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"links":{"items":{"$ref":"#/components/schemas/PropertyLinksSchema"},"type":"array","title":"Links","default":[]},"lot_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Area"},"lot_measure_front":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Measure Front"},"lot_measure_behind":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Measure Behind"},"lot_measure_right":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Measure Right"},"lot_measure_left":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Measure Left"},"lot_measure_radius":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Measure Radius"},"lot_measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lot Measure Type"},"new_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New Code"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"nearby":{"items":{"type":"string"},"type":"array","title":"Nearby","default":[]},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood","description":"Required when creating a property"},"owners":{"items":{"$ref":"#/components/schemas/PropertyOwnersSchema"},"type":"array","title":"Owners","default":[]},"property_block":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Block"},"property_dimension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Dimension"},"plus_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plus Code"},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type","description":"Required when creating a property"},"property_situation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Situation"},"property_base":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Base"},"photos":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array"},{"type":"null"}],"title":"Photos","default":[]},"multimidias":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array"},{"type":"null"}],"title":"Multimidias","default":[]},"sale_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Sale Value","description":"Either 'sale_value' or 'rental_value' is required when creating a property"},"rental_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Rental Value","description":"Either 'sale_value' or 'rental_value' is required when creating a property"},"weekend_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Weekend Value"},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Title"},"site_meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Meta Description"},"site_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Description"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"sun_position":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Sun Position"},"send_owner_property_review":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Owner Property Review"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"site_publish":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish"},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"useful_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Useful Area"},"unit_floor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unit Floor"},"fiscal_registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Registration Number"},"cib_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cib Code"},"units_per_floor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Units Per Floor"},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation Rental"},"vacation_rental_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Rental Guests"},"vacation_charge_additional_guests":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Vacation Charge Additional Guests"},"vacation_additional_value_guest":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Vacation Additional Value Guest"},"visit_only_realtor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit Only Realtor"},"visit_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visit Time"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"property_unity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Property Unity"},"with_plaque":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Plaque"},"built":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Built"},"building_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Building In Data","default":false},"cover_photo_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cover Photo In Data","default":false},"cover_photo_private_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cover Photo Private In Data","default":false},"owners_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Owners In Data","default":false},"links_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Links In Data","default":false},"photos_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Photos In Data","default":false},"property_unity_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Property Unity In Data","default":false},"multimidias_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multimidias In Data","default":false},"latitude_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Latitude In Data","default":false},"longitude_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Longitude In Data","default":false},"field_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Field Values In Data","default":false},"features_values_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Features Values In Data","default":false},"active_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active In Data","default":false},"nearby_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Nearby In Data","default":false},"built_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Built In Data","default":false},"unit_floor_in_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Unit Floor In Data","default":false},"has_cover_photo":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Cover Photo","default":false},"has_cover_photo_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Cover Photo Private","default":false},"iptu_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Iptu Installments"},"stay_nights_by_days":{"anyOf":[{"$ref":"#/components/schemas/PropertyStayNightsByDays"},{"type":"null"}],"description":"Minimum and maximum stay for vacation rentals"}},"type":"object","title":"PropertyRouterSchema"},"PropertySearchDatesSchema":{"properties":{"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date"},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date"},"value_min":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Value Min"},"value_max":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Value Max"}},"type":"object","title":"PropertySearchDatesSchema"},"PropertySearchLinkSchema":{"properties":{"contact_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Contact Id"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"link_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Type"}},"type":"object","title":"PropertySearchLinkSchema"},"PropertySearchOwnerSchema":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"PropertySearchOwnerSchema"},"PropertySearchRouterSchema":{"properties":{"search":{"anyOf":[{"$ref":"#/components/schemas/PropertySearchSchema"},{"type":"null"}],"description":"Search criteria for filtering properties."},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor received in the previous request for pagination."},"show_map":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Map","description":"Flag to indicate if map view is requested."}},"type":"object","title":"PropertySearchRouterSchema"},"PropertySearchSchema":{"properties":{"advert_not_equal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Advert Not Equal"},"without_site_highlights":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Without Site Highlights"},"order_by_code":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Order By Code"},"smart_list":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Smart List"},"search_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Value"},"fields":{"anyOf":[{},{"type":"null"}],"title":"Fields"},"custom_fields":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Custom Fields"},"owner":{"anyOf":[{"$ref":"#/components/schemas/PropertySearchOwnerSchema"},{"type":"null"}]},"link":{"anyOf":[{"$ref":"#/components/schemas/PropertySearchLinkSchema"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"interest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interest"},"vacation_rental_dates":{"anyOf":[{"$ref":"#/components/schemas/PropertySearchDatesSchema"},{"type":"null"}]},"search_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Type"},"order":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order"},"search_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Field"},"section_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Section Id"},"tv_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tv Id"},"update_last_property_seen":{"anyOf":[{},{"type":"null"}],"title":"Update Last Property Seen"}},"type":"object","title":"PropertySearchSchema"},"PropertySiteCalendarSchema":{"properties":{"initial_date":{"type":"string","title":"Initial Date"},"final_date":{"type":"string","title":"Final Date"},"observation":{"type":"string","title":"Observation"},"event_type":{"type":"string","title":"Event Type"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"}},"type":"object","required":["initial_date","final_date","observation","event_type","db_id"],"title":"PropertySiteCalendarSchema"},"PropertySiteFeatureSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"},"name":{"type":"string","title":"Name"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["db_id","name","active"],"title":"PropertySiteFeatureSchema"},"PropertySiteFieldsSchema":{"properties":{"field_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Field Id"},"name":{"type":"string","title":"Name"},"active":{"type":"boolean","title":"Active"},"group_name":{"type":"string","title":"Group Name"},"group_position":{"type":"integer","title":"Group Position"},"value":{"title":"Value"},"configuration":{"additionalProperties":true,"type":"object","title":"Configuration"},"position":{"type":"string","title":"Position"},"default":{"type":"boolean","title":"Default"},"required":{"type":"boolean","title":"Required"},"show_on_website":{"type":"boolean","title":"Show On Website"}},"type":"object","required":["field_id","name","active","group_name","group_position","value","configuration","position","default","required","show_on_website"],"title":"PropertySiteFieldsSchema"},"PropertySiteSchema":{"properties":{"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Area"},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathroom"},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedroom"},"building":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Building"},"building_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Building Name"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"cover_photo":{"anyOf":[{"$ref":"#/components/schemas/routers__schemas__property_site__CoverPhotoSchema"},{"type":"null"}]},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"exclusivity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Exclusivity"},"finality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finality"},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Garage"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"lot_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot Area"},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type"},"most_relevant":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Most Relevant"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type"},"photos":{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array","title":"Photos","default":[]},"rental_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rental Value"},"sale_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale Value"},"site_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Description"},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Price"},"site_publish_rental_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Rental Price"},"site_publish_sale_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish Sale Price"},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Title"},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Url"},"site_view_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Site View Count"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suite"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","default":[]},"useful_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Useful Area"},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation Rental"},"total_rental_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Total Rental Value"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Complement"},"available_digital_real_estate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Available Digital Real Estate"},"built":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Built"},"calendar":{"items":{"$ref":"#/components/schemas/PropertySiteCalendarSchema"},"type":"array","title":"Calendar","default":[]},"cleaning_fee":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cleaning Fee"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"features":{"anyOf":[{"additionalProperties":{"items":{"$ref":"#/components/schemas/PropertySiteFeatureSchema"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Features"},"fields":{"anyOf":[{"additionalProperties":{"items":{"items":{"$ref":"#/components/schemas/PropertySiteFieldsSchema"},"type":"array"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Fields"},"high_standard":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Standard"},"house_rules":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"House Rules"},"listing_broker":{"anyOf":[{"$ref":"#/components/schemas/RealtosSiteSchema"},{"type":"null"}]},"member_register_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Member Register Code"},"multimidias":{"items":{"$ref":"#/components/schemas/PropertyPhotosSchema"},"type":"array","title":"Multimidias","default":[]},"nearby":{"items":{"type":"string"},"type":"array","title":"Nearby","default":[]},"property_dimension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Dimension"},"real_estate":{"anyOf":[{"$ref":"#/components/schemas/RealEstateSiteSchema"},{"type":"null"}]},"service_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Service Fee"},"site_meta_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Meta Description"},"site_publish":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Site Publish"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"vacation_additional_value_guest":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Additional Value Guest"},"vacation_charge_additional_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Charge Additional Guests"},"vacation_rental_guests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Vacation Rental Guests"},"value_to_fire_insurance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Value To Fire Insurance"},"with_plaque":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"With Plaque"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"PropertySiteSchema"},"PropertyStayNightsByDays":{"properties":{"sunday":{"type":"integer","title":"Sunday","description":"Minimum number of nights to stay","default":1},"monday":{"type":"integer","title":"Monday","description":"Minimum number of nights to stay","default":1},"tuesday":{"type":"integer","title":"Tuesday","description":"Minimum number of nights to stay","default":1},"wednesday":{"type":"integer","title":"Wednesday","description":"Minimum number of nights to stay","default":1},"thursday":{"type":"integer","title":"Thursday","description":"Minimum number of nights to stay","default":1},"friday":{"type":"integer","title":"Friday","description":"Minimum number of nights to stay","default":1},"saturday":{"type":"integer","title":"Saturday","description":"Minimum number of nights to stay","default":1},"max_days":{"type":"integer","title":"Max Days","description":"Maximum number of stays","default":365}},"type":"object","title":"PropertyStayNightsByDays"},"PropertyTypesCreateSchema":{"properties":{"property_type":{"$ref":"#/components/schemas/PropertyTypesSchema","description":"All params in the property type, ex: {'property_type': {\n 'finality': 'residential', 'type': 'Apartment', 'default': true}}"}},"type":"object","required":["property_type"],"title":"PropertyTypesCreateSchema"},"PropertyTypesSchema":{"properties":{"finality":{"type":"string","title":"Finality","description":"Finality of the property type","examples":["residential","commercial"]},"type":{"type":"string","title":"Type","description":"Type of the property","examples":["Apartment","House","Office"]},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default","description":"Indicates if this is the default property type"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates if the property type is active","default":true},"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Database ID of the property type"}},"type":"object","required":["finality","type"],"title":"PropertyTypesSchema"},"PropertyTypesUpdateSchema":{"properties":{"property_type":{"$ref":"#/components/schemas/PropertyTypesSchema"}},"type":"object","required":["property_type"],"title":"PropertyTypesUpdateSchema"},"PropertyUpdateParams":{"properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"New primary property address. Blank strings are ignored."},"address_complement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address complement","description":"New suite, block, apartment, or room information."},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"New property city."},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"New two-letter uppercase Brazilian state code."},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood","description":"New property neighborhood."},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal code","description":"New property postal code (CEP)."},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"New property country."},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property type","description":"New property type from the account-specific catalog. Registered labels, normalized names, and common Portuguese or English aliases are accepted. An unknown type returns needs_user_input with the registered options."},"property_situation":{"anyOf":[{"type":"string","enum":["used","new","under_construction","off_plan","semi_new"]},{"type":"null"}],"title":"Property situation","description":"New construction situation: used, new, under_construction, off_plan, or semi_new."},"status":{"anyOf":[{"type":"string","enum":["available","pending","rented","reserved","solded","with_proposal","solded_by_third_parties","rented_by_third_parties","suspended"]},{"type":"null"}],"title":"Status","description":"New property status."},"finality":{"anyOf":[{"type":"string","enum":["residential","commercial","rural"]},{"type":"null"}],"title":"Property finality","description":"New usage classification: residential, commercial, or rural."},"interest":{"anyOf":[{"type":"string","enum":["buy","rent","vacation_rental"]},{"type":"null"}],"title":"Commercial interest","description":"Transaction hint: buy or rent sets vacation_rental=false unless that field is explicitly provided; vacation_rental sets it to true. The interest value itself is not stored as a separate field."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"New internal property description."},"sale_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sale value","description":"New sale price as a numeric value."},"rental_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rental value","description":"New monthly rental price as a numeric value."},"bedroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bedrooms","description":"New total number of bedrooms, including suites."},"bathroom":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Bathrooms","description":"New total number of bathrooms."},"suite":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Suites","description":"New number of suites."},"garage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parking spaces","description":"New number of garage or parking spaces."},"area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total area","description":"New total area."},"useful_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usable area","description":"New usable area."},"lot_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lot area","description":"New lot area."},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measurement unit","description":"New area measurement unit."},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"New geographic latitude."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"New geographic longitude."},"site_publish":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publish on website","description":"Whether to publish the property on the website."},"site_publish_price":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publish price on website","description":"Whether to display the property price on the website."},"site_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website title","description":"New property title for website publication."},"site_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website slug","description":"New friendly URL slug for the property website page."},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private property","description":"Whether the property is private."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Whether the property is active."},"vacation_rental":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vacation rental","description":"Whether the property is offered as a vacation rental."},"alternative_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alternative code","description":"New alternative property code."},"visit_only_realtor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visit requires broker","description":"Whether property visits require a broker."},"visit_time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visit time","description":"New preferred time or schedule for visits."},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage","description":"New internal property stage."},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker name","description":"Name of the new listing broker. Prefer user_email when available."},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing broker email","description":"Email of the new listing broker for precise assignment."}},"type":"object","title":"PropertyUpdateParams"},"PropertyValuesMinMax":{"properties":{"min":{"type":"integer","title":"Min"},"max":{"type":"integer","title":"Max"}},"type":"object","required":["min","max"],"title":"PropertyValuesMinMax"},"PropertyValuesRouterSchema":{"properties":{"property_status":{"items":{"type":"string","enum":["available","pending","rented","reserved","solded","with_proposal","solded_by_third_parties","rented_by_third_parties","suspended","inactive","unavailable","all"]},"type":"array","title":"Property Status","description":"List of property status values","default":[],"examples":["available","solded","rented","pending"]},"measure_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Measure Type","description":"Type of measurement for the property area"},"property_types":{"items":{"type":"string"},"type":"array","title":"Property Types","description":"List of property types","default":[],"examples":["apartment","house","commercial","land"]},"area_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Area Type","description":"Type of area measurement for the property"}},"type":"object","title":"PropertyValuesRouterSchema"},"PutSiteHighlightsRequestSchema":{"properties":{"banner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Banner","description":"Identifies whether the highlight is a banner type"},"before_position":{"type":"integer","title":"Before Position"},"current_position":{"type":"integer","title":"Current Position"},"property_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Property Id"},"section_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Section Id"}},"type":"object","required":["before_position","current_position","property_id"],"title":"PutSiteHighlightsRequestSchema"},"QueryparamsSchema":{"properties":{"availability":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Availability"},"city":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"City"},"feature":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Feature"},"neighborhood":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"items":{"additionalProperties":true,"type":"object"},"type":"array"}],"title":"Neighborhood","default":[]},"order":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order"},"property_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Type"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"}},"type":"object","title":"QueryparamsSchema"},"RealEstateSiteSchema":{"properties":{"database":{"type":"string","title":"Database"},"legal_information":{"type":"string","title":"Legal Information"},"logotype_image_url":{"type":"string","title":"Logotype Image Url"},"phone":{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array","title":"Phone"},"site":{"type":"string","title":"Site"},"social_networks":{"items":{"$ref":"#/components/schemas/SocialNetworkSchema"},"type":"array","title":"Social Networks"},"trade_mark":{"type":"string","title":"Trade Mark"}},"type":"object","required":["database","legal_information","logotype_image_url","phone","site","social_networks","trade_mark"],"title":"RealEstateSiteSchema"},"RealtorsContactPhone":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"alpha2Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alpha2Code"}},"type":"object","title":"RealtorsContactPhone"},"RealtosSiteSchema":{"properties":{"db_id":{"type":"string","title":"Db Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License"},"phones":{"anyOf":[{"items":{"$ref":"#/components/schemas/RealtorsContactPhone"},"type":"array"},{"type":"null"}],"title":"Phones"},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"}},"type":"object","required":["db_id"],"title":"RealtosSiteSchema"},"ReceiptMethodSchema":{"properties":{"account":{"anyOf":[{"$ref":"#/components/schemas/FinancialContactSchema"},{"type":"null"}]},"receipt_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receipt Type"},"integration_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Name"},"payment_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Payment Default"}},"type":"object","title":"ReceiptMethodSchema"},"ReceiptMethodsSchema":{"properties":{"bank_slip":{"anyOf":[{"$ref":"#/components/schemas/ReceiptMethodSchema"},{"type":"null"}]},"pix":{"anyOf":[{"$ref":"#/components/schemas/ReceiptMethodSchema"},{"type":"null"}]},"credit_card":{"anyOf":[{"$ref":"#/components/schemas/ReceiptMethodSchema"},{"type":"null"}]},"payment_default":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Default"}},"type":"object","title":"ReceiptMethodsSchema"},"RecurringSchema":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Id"},"freq":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Freq"},"by_day":{"items":{"type":"string"},"type":"array","title":"By Day","default":[]},"by_month":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"By Month"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"interval":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Interval","default":1},"count":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Count"},"until":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Until"},"dates":{"items":{"anyOf":[{"type":"string"},{"type":"string","format":"date"}]},"type":"array","title":"Dates","default":[]},"ids":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Ids","default":[]},"namespace":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Namespace"},"original_recurring_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Recurring Id"},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date"},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date"},"ignore_calendar_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Ignore Calendar Id"}},"type":"object","title":"RecurringSchema"},"RegionalSettingsSchema":{"properties":{"local":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"}},"type":"object","title":"RegionalSettingsSchema"},"ReportFilterSchema":{"properties":{"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field"},"condition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Condition"},"field_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Field Id"},"value_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Type"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Value"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"}},"type":"object","title":"ReportFilterSchema"},"ResponseCFAnalysis":{"properties":{"db_id":{"type":"string","title":"Db Id"},"status":{"type":"string","title":"Status"}},"type":"object","required":["db_id","status"],"title":"ResponseCFAnalysis"},"ResponseCFAnalysisFee":{"properties":{"source":{"type":"string","title":"Source"},"value":{"type":"number","title":"Value"},"organization_value":{"type":"number","title":"Organization Value"}},"type":"object","required":["source","value","organization_value"],"title":"ResponseCFAnalysisFee"},"ResponseCFAnalysisList":{"properties":{"analysis":{"items":{"$ref":"#/components/schemas/CFAnalysisFieldsSchema"},"type":"array","title":"Analysis"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["analysis","count"],"title":"ResponseCFAnalysisList"},"ResponseCalendarTypeGetSchema":{"properties":{"db_id":{"type":"string","title":"Db Id"},"name":{"type":"string","title":"Name"},"icon":{"type":"string","title":"Icon"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["db_id","name","icon","active"],"title":"ResponseCalendarTypeGetSchema"},"ResponseCalendarTypesCreateUpdateSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponseCalendarTypesCreateUpdateSchema"},"ResponseCancelInsurance":{"properties":{"dados":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Dados"},"mensagem":{"type":"string","title":"Mensagem"},"tipo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tipo"}},"type":"object","required":["mensagem"],"title":"ResponseCancelInsurance"},"ResponseChatConversations":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/ChatConversations"},"type":"array","title":"Conversations"}},"type":"object","required":["conversations"],"title":"ResponseChatConversations"},"ResponseContact":{"properties":{"contacts":{"items":{"$ref":"#/components/schemas/ContactFieldsSchema"},"type":"array","title":"Contacts","default":[]},"count":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Count"},"count_peding":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Peding"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},"type":"object","title":"ResponseContact"},"ResponseContactBankData":{"properties":{"bank_data":{"items":{"$ref":"#/components/schemas/BankDataSchema"},"type":"array","title":"Bank Data","default":[]}},"type":"object","title":"ResponseContactBankData"},"ResponseContactExists":{"properties":{"contact":{"anyOf":[{"$ref":"#/components/schemas/ContactFieldsSchema"},{"type":"null"}]},"has_permission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Permission"}},"type":"object","title":"ResponseContactExists"},"ResponseContactTagSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponseContactTagSchema"},"ResponseContractField":{"properties":{"db_id":{"type":"integer","title":"Db Id","description":"Database ID of the created contract field"}},"type":"object","required":["db_id"],"title":"ResponseContractField"},"ResponseCreateDocument":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"ResponseCreateDocument"},"ResponseCreateOrganization":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"ResponseCreateOrganization"},"ResponseCreatePerson":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"ResponseCreatePerson"},"ResponseCreateProperty":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"ResponseCreateProperty"},"ResponseDeal":{"$ref":"#/components/schemas/ResponseDealList","title":"ResponseDeal"},"ResponseDealField":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponseDealField"},"ResponseDealList":{"properties":{"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"deals":{"items":{"$ref":"#/components/schemas/DealsFieldsGetSchema"},"type":"array","title":"Deals","default":[]},"stage_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage Name"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"}},"type":"object","title":"ResponseDealList"},"ResponseDealLostReasonSchema":{"properties":{"db_id":{"type":"integer","title":"Db Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["db_id","name"],"title":"ResponseDealLostReasonSchema"},"ResponseDealRotationCreateUpdate":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"affected_deals_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Affected Deals Count"}},"type":"object","title":"ResponseDealRotationCreateUpdate"},"ResponseDealRotations":{"properties":{"rotations":{"items":{"$ref":"#/components/schemas/DealRotationResponseSchema"},"type":"array","title":"Rotations","default":[]}},"type":"object","title":"ResponseDealRotations"},"ResponseDocumentFile":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"file_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Type"},"size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Size"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"blob_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blob Key"},"cript_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cript Sha256"},"short_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Key"}},"type":"object","title":"ResponseDocumentFile"},"ResponseDocuments":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"documents":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Documents"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"}},"type":"object","title":"ResponseDocuments"},"ResponseDocumentsFee":{"properties":{"count_to":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count To"},"count_from":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count From"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"free_document":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Free Document"}},"type":"object","title":"ResponseDocumentsFee"},"ResponseFinancialCategory":{"properties":{"db_id":{"type":"string","title":"Db Id","description":"Database ID intern"}},"type":"object","required":["db_id"],"title":"ResponseFinancialCategory"},"ResponseGetBanks":{"properties":{"banks":{"items":{"$ref":"#/components/schemas/BanksFieldsSchema"},"type":"array","title":"Banks"}},"type":"object","required":["banks"],"title":"ResponseGetBanks"},"ResponseGetBanksBankId":{"properties":{"bank":{"anyOf":[{"$ref":"#/components/schemas/BanksFieldsSchema"},{"type":"null"}]}},"type":"object","title":"ResponseGetBanksBankId"},"ResponseGetCalendarSchema":{"properties":{"calendar_items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Calendar Items","default":[]},"holidays":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Holidays","default":[]},"cursor_fw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Fw"},"cursor_rw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor Rw"},"google_authorize_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Google Authorize Url"}},"type":"object","title":"ResponseGetCalendarSchema"},"ResponseGetContract":{"properties":{"contract":{"$ref":"#/components/schemas/ContractFieldsSchemaResponse"}},"type":"object","required":["contract"],"title":"ResponseGetContract"},"ResponseGetContracts":{"properties":{"contracts":{"items":{"$ref":"#/components/schemas/ContractsListFieldsSchema"},"type":"array","title":"Contracts","description":"List of contracts"},"cursor":{"type":"string","title":"Cursor","description":"Cursor for pagination"},"count":{"type":"integer","title":"Count","description":"Total count of contracts found"},"value_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Total","description":"Sum of the contract value of all contracts found"},"next_invoice_value_total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Next Invoice Value Total","description":"Sum of the next invoice value of all contracts found"}},"type":"object","required":["contracts","cursor","count"],"title":"ResponseGetContracts"},"ResponseGetDealFilterFields":{"properties":{"field":{"items":{"type":"string"},"type":"array","title":"Field","default":[]},"values":{"items":{"type":"string"},"type":"array","title":"Values","default":[]},"conditions":{"items":{"type":"string"},"type":"array","title":"Conditions","default":[]},"value_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Type"},"field_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Id"}},"type":"object","title":"ResponseGetDealFilterFields"},"ResponseGetDealFiltersSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"filters":{"items":{"$ref":"#/components/schemas/ReportFilterSchema"},"type":"array","title":"Filters","default":[]}},"type":"object","title":"ResponseGetDealFiltersSchema"},"ResponseGetFinancialTransactionMatch":{"properties":{"transactions":{"items":{"$ref":"#/components/schemas/FinancialTransactionFieldSchema"},"type":"array","title":"Transactions","description":"List of financial transactions that match the query.","default":[]}},"type":"object","title":"ResponseGetFinancialTransactionMatch"},"ResponseGetInvoice":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id","description":"Unique identifier for the invoice"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category of the invoice"},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory of the invoice"},"due_date":{"type":"string","title":"Due Date","description":"Due date of the invoice, format YYYY-MM-DD"},"paid_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid At","description":"Paid date when the invoice was paid, format YYYY-MM-DD"},"payment_authentication":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Authentication","description":"Payment authentication token for the invoice, if exist"},"status":{"type":"string","enum":["pending","paid","partially_paid","expired","deleted","canceled","all","overdue","in_process"],"title":"Status","description":"Current status of the invoice","default":"pending","examples":["pending","paid","partially_paid","expired","deleted","canceled"]},"invoice_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Url","description":"URL to access the invoice details in web, if exist"},"send_overdue_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Overdue Notification","description":"Indicate if the overdue notification should be sent, if exist"},"payment_method":{"anyOf":[{"enum":["bank_slip","credit_card","pix","cash","transference","bank_check","deposit",null]},{"type":"null"}],"title":"Payment Method","description":"Payment method used for the invoice","examples":["bank_slip","credit_card","pix","cash"]},"payments_methods_available":{"anyOf":[{"enum":["bank_slip","credit_card","pix","cash","transference","bank_check","deposit",null]},{"type":"null"}],"title":"Payments Methods Available","description":"Available payment methods for the invoice, if exist"},"payment_maximum_installments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Payment Maximum Installments","description":"Maximum number of installments allowed if payment method is credit card, if exist"},"charge_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Charge Fee Value","description":"Value of the charge fee applied to the invoice, if exist"},"difference_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Difference Value","description":"Difference value applied to the invoice when paid with a different value than the total, if exist"},"interest_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Value","description":"Interest value applied to the invoice if overdue, if exist"},"installments":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Installments"},"value":{"type":"number","title":"Value","description":"Value of the invoice, if exist"},"total_value":{"type":"number","title":"Total Value","description":"Total value of the invoice, if exist"},"bank_slip_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Slip Id","description":"Bank slip identifier the invoice, when the invoice was send bank"},"bank_slip_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Slip Url","description":"Bank slip url the invoice, when the invoice was send bank"},"bank_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Type","description":"Bank type associated with the invoice, if exist"},"reference_start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Start At","description":"Start date of the reference period for the invoice, format YYYY-MM-DD"},"reference_end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference End At","description":"End date of the reference period for the invoice, format YYYY-MM-DD"},"contact":{"$ref":"#/components/schemas/InvoiceContactSchema","description":"Contact associated with the invoice"},"property":{"anyOf":[{"$ref":"#/components/schemas/InvoicePropertySchema"},{"type":"null"}],"description":"Property associated with the invoice, if exist"},"lease":{"anyOf":[{"$ref":"#/components/schemas/InvoiceLeaseSchema"},{"type":"null"}],"description":"Lease associated with the invoice, if exist"},"contract":{"anyOf":[{"$ref":"#/components/schemas/InvoiceContractSchema"},{"type":"null"}],"description":"Contract associated with the invoice, if exist"},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode","description":"Barcode of the invoice, if exist"},"account":{"anyOf":[{"$ref":"#/components/schemas/InvoiceAccountSchema"},{"type":"null"}],"description":"Account associated with the invoice, if exist"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Creation date of the invoice, format YYYY-MM-DD"},"created_manually":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Created Manually","description":"Indicate if the invoice was created manually"},"onlendings_and_fees":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Onlendings And Fees","description":"Onlendings and fees associated with the invoice, if exist"},"onlending_split":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Onlending Split","description":"Indicate if the invoice was split onlending to landlord, only for receipt account integration PJBank"},"credit_card_percentage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Card Percentage","description":"Percentage of the credit card fee applied to the invoice, if exist"},"credit_card_installment_percentage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credit Card Installment Percentage","description":"Percentage of the credit card installment fee applied to the invoice, if exist"},"interest_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interest Charge","description":"Fixed interest charge for late payment"},"fine_charge":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fine Charge","description":"Fixed fine charge for late payment"},"interest_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Percent","description":"Interest percentage applied to overdue invoice charge fee, if exist"},"fine_percent":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fine Percent","description":"Fine percentage applied to overdue invoice charge fee, if exist"},"invoice_paid_manual":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Invoice Paid Manual","description":"Indicate if the invoice was paid manually"},"items":{"items":{"$ref":"#/components/schemas/InvoiceItemsSchema"},"type":"array","title":"Items","description":"List of items associated with the invoice, if exist","default":[]},"history":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"History","description":"History of changes made to the invoice, if exist","default":[]},"beneficiaries":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Beneficiaries","description":"List of beneficiaries associated with the invoice, if exist","default":[]}},"type":"object","required":["invoice_id","due_date","value","total_value","contact"],"title":"ResponseGetInvoice"},"ResponseGetListInvoices":{"properties":{"invoices":{"items":{"$ref":"#/components/schemas/InvoicesFieldsSchemas"},"type":"array","title":"Invoices","description":"List of invoices returned in the response","default":[]},"count":{"type":"integer","title":"Count","description":"Count of invoices returned in the response"},"next_page":{"type":"integer","title":"Next Page","description":"Next page number for pagination, if available","default":0},"total":{"type":"number","title":"Total","description":"Total value of all invoices returned in the response","default":0.0},"total_paid":{"type":"number","title":"Total Paid","description":"Total value of all paid invoices returned in the response","default":0.0},"total_pending":{"type":"number","title":"Total Pending","description":"Total value of all pending invoices returned in the response","default":0.0},"total_overdue":{"type":"number","title":"Total Overdue","description":"Total value of all overdue invoices returned in the response","default":0.0}},"type":"object","required":["count"],"title":"ResponseGetListInvoices"},"ResponseGetNeighborhoods":{"properties":{"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"neighborhoods":{"items":{"$ref":"#/components/schemas/NeighborhoodsFieldsGetSchema"},"type":"array","title":"Neighborhoods","default":[]}},"type":"object","title":"ResponseGetNeighborhoods"},"ResponseGetNotaFiscal":{"properties":{"nota_fiscal":{"anyOf":[{"$ref":"#/components/schemas/NotasFiscaisField"},{"type":"null"}]}},"type":"object","title":"ResponseGetNotaFiscal"},"ResponseGetNotasFiscal":{"properties":{"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"notas_fiscais":{"items":{"$ref":"#/components/schemas/NotasFiscaisField"},"type":"array","title":"Notas Fiscais","default":[]},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"},"sorted_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sorted By"},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total"},"total_authorized":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Authorized"},"total_pending":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Pending"}},"type":"object","title":"ResponseGetNotasFiscal"},"ResponseGetRevisions":{"properties":{"revisions":{"items":{"$ref":"#/components/schemas/RevisionBaseSchema"},"type":"array","title":"Revisions","default":[]}},"type":"object","title":"ResponseGetRevisions"},"ResponseGetSchema":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","default":""},"events":{"items":{"type":"string"},"type":"array","title":"Events","default":[]},"authorization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","default":""},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","default":""},"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","title":"ResponseGetSchema"},"ResponseGetUtils":{"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"next_useful_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Useful Date"},"date_enter_is_useful_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Date Enter Is Useful Day"},"credit_card_installments":{"items":{"type":"number"},"type":"array","title":"Credit Card Installments","default":[]},"credit_card_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage"},"credit_card_percentage_extra_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Percentage Extra Value"},"credit_card_installment_percentage_extra_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage Extra Value"},"credit_card_installment_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Credit Card Installment Percentage"},"pass_on_installments_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pass On Installments Fee Value"}},"type":"object","title":"ResponseGetUtils"},"ResponseHireInsurance":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"insurance_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Insurance Id"},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At"},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"type":"object","title":"ResponseHireInsurance"},"ResponseInsertPhoto":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Id"},"image_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Key"}},"type":"object","title":"ResponseInsertPhoto"},"ResponseInsurance":{"properties":{"value":{"type":"number","title":"Value"},"recurrent_total":{"type":"integer","title":"Recurrent Total"},"recurrent_value":{"type":"number","title":"Recurrent Value"},"start_at":{"type":"string","title":"Start At"},"end_at":{"type":"string","title":"End At"},"values_simulated":{"type":"boolean","title":"Values Simulated"},"mensagem":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mensagem"}},"type":"object","required":["value","recurrent_total","recurrent_value","start_at","end_at","values_simulated"],"title":"ResponseInsurance"},"ResponseLeadIntegration":{"properties":{"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"}},"type":"object","title":"ResponseLeadIntegration"},"ResponseLeaseField":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponseLeaseField"},"ResponseMediaSource":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponseMediaSource"},"ResponseNetWorkSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"}},"type":"object","title":"ResponseNetWorkSchema"},"ResponseNotificationSchema":{"properties":{"emails_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Emails Count"},"notifications":{"anyOf":[{"$ref":"#/components/schemas/NotificationFieldsSchema"},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","title":"ResponseNotificationSchema"},"ResponseOrganizationField":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponseOrganizationField"},"ResponsePersonField":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponsePersonField"},"ResponsePipelineGroupSchema":{"properties":{"db_id":{"type":"string","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponsePipelineGroupSchema"},"ResponsePipelineSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponsePipelineSchema"},"ResponsePostBanks":{"properties":{"db_id":{"type":"string","title":"Db Id","description":"ID intern of the bank in the database"}},"type":"object","required":["db_id"],"title":"ResponsePostBanks"},"ResponsePostCalendarSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponsePostCalendarSchema"},"ResponsePostContracts":{"properties":{"db_id":{"type":"string","title":"Db Id","description":"ID intern of the contract in database"},"code":{"type":"string","title":"Code","description":"Contract code"},"db_key":{"type":"string","title":"Db Key","description":"Contract key"}},"type":"object","required":["db_id","code","db_key"],"title":"ResponsePostContracts"},"ResponsePostInvoice":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id","description":"Unique identifier for the created invoice"}},"type":"object","required":["invoice_id"],"title":"ResponsePostInvoice"},"ResponsePostNotaFiscal":{"properties":{"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"ResponsePostNotaFiscal"},"ResponsePostNotificationSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},"type":"object","title":"ResponsePostNotificationSchema"},"ResponsePropertyAreas":{"properties":{"rental_areas":{"$ref":"#/components/schemas/PropertyValuesMinMax"},"sale_areas":{"$ref":"#/components/schemas/PropertyValuesMinMax"},"vacation_rental_areas":{"$ref":"#/components/schemas/PropertyValuesMinMax"}},"type":"object","required":["rental_areas","sale_areas","vacation_rental_areas"],"title":"ResponsePropertyAreas"},"ResponsePropertyAverageValue":{"properties":{"average_rental":{"type":"number","title":"Average Rental"},"average_sale":{"type":"number","title":"Average Sale"}},"type":"object","required":["average_rental","average_sale"],"title":"ResponsePropertyAverageValue"},"ResponsePropertyDescriptionSchema":{"properties":{"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"field":{"items":{"type":"string"},"type":"array","title":"Field","default":[]},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"ResponsePropertyDescriptionSchema"},"ResponsePropertyFeatures":{"properties":{"db_id":{"type":"string","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponsePropertyFeatures"},"ResponsePropertyField":{"properties":{"db_id":{"type":"integer","title":"Db Id"}},"type":"object","required":["db_id"],"title":"ResponsePropertyField"},"ResponsePropertyQuality":{"properties":{"issues":{"additionalProperties":{"type":"integer"},"type":"object","title":"Issues"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"score_value":{"type":"integer","title":"Score Value","default":0}},"type":"object","title":"ResponsePropertyQuality"},"ResponsePropertySearchSchema":{"properties":{"address":{"items":{"type":"string"},"type":"array","title":"Address"},"building_name":{"items":{"type":"string"},"type":"array","title":"Building Name"},"city":{"items":{"type":"string"},"type":"array","title":"City"},"neighborhood":{"items":{"type":"string"},"type":"array","title":"Neighborhood"},"unavailable_address":{"items":{"type":"string"},"type":"array","title":"Unavailable Address"}},"type":"object","required":["address","building_name","city","neighborhood","unavailable_address"],"title":"ResponsePropertySearchSchema"},"ResponsePropertyValues":{"properties":{"rental_values":{"$ref":"#/components/schemas/PropertyValuesMinMax"},"sale_values":{"$ref":"#/components/schemas/PropertyValuesMinMax"},"vacation_rental_values":{"$ref":"#/components/schemas/PropertyValuesMinMax"}},"type":"object","required":["rental_values","sale_values","vacation_rental_values"],"title":"ResponsePropertyValues"},"ResponsePutContract":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponsePutContract"},"ResponseTeams":{"properties":{"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"users":{"anyOf":[{"$ref":"#/components/schemas/ResponseUserOnTeam"},{"type":"null"}]}},"type":"object","title":"ResponseTeams"},"ResponseUpdatePhoto":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponseUpdatePhoto"},"ResponseUserBillingSchema":{"properties":{"new_deals":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Deals"},"total_commission":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Commission"},"total_rent":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Rent"},"total_sale":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Sale"},"month":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Month"},"year":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Year"},"user_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User To"},"month_prevision":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Month Prevision"}},"type":"object","title":"ResponseUserBillingSchema"},"ResponseUserOnTeam":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname"},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"ResponseUserOnTeam"},"ResponseUsers":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname"},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"ResponseUsers"},"ResponseUsersRanking":{"properties":{"user":{"anyOf":[{"$ref":"#/components/schemas/UserRankingSchema"},{"type":"null"}]},"total":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total"}},"type":"object","title":"ResponseUsersRanking"},"RevisionBaseSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"RevisionBaseSchema"},"SantanderTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"santander","title":"Name","default":"santander"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"certificate_pfx":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Pfx"},"certificate_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Certificate Password"},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"}},"type":"object","title":"SantanderTecnoSpeedSchema"},"SectionHighlightSchema":{"properties":{"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"},"properties":{"items":{"$ref":"#/components/schemas/SectionPropertiesSchema"},"type":"array","title":"Properties","default":[]},"buildings":{"items":{"$ref":"#/components/schemas/BuildingHighlightSchema"},"type":"array","title":"Buildings","default":[]}},"type":"object","title":"SectionHighlightSchema"},"SectionPropertiesSchema":{"properties":{"property":{"anyOf":[{"$ref":"#/components/schemas/PropertySiteSchema"},{"type":"null"}]},"position":{"type":"integer","title":"Position","description":"Sort properties display in ascending order"}},"type":"object","title":"SectionPropertiesSchema"},"SectionSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"background":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Background","description":"only applies to sections that already have a background"},"custom_html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Html","description":"If the section type is custom"},"financing_simulator":{"anyOf":[{"$ref":"#/components/schemas/FinancingSimulatorSchema"},{"type":"null"}],"description":"If the section type is financing_simulator"},"highlight":{"anyOf":[{"$ref":"#/components/schemas/SectionHighlightSchema"},{"type":"null"}]},"highlight_pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Highlight Pages","description":"Sets the number of pages the highlights will be divided into"},"highlight_type":{"anyOf":[{"type":"string","enum":["mosaic","main_highlight","square","columns","shorts_properties","columns_tags","buildings_section"]},{"type":"null"}],"title":"Highlight Type"},"news_type":{"anyOf":[{"type":"string","enum":["three_cards","six_cards"]},{"type":"null"}],"title":"News Type","description":"If the section type is papo_news"},"position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Position","description":"Sort section display in ascending order"},"properties_type":{"anyOf":[{"type":"string","enum":["properties","buildings"]},{"type":"null"}],"title":"Properties Type"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtitle"},"shorts_url":{"items":{"type":"string"},"type":"array","title":"Shorts Url","description":"If the section type is shorts","default":[]},"type":{"anyOf":[{"type":"string","enum":["highlights","search_tags","neighborhoods","financing_simulator","brokers","custom","shorts","papo_news","testimonials","banner"]},{"type":"null"}],"title":"Type"},"images":{"items":{"type":"string"},"type":"array","title":"Images","description":"If the section type is neighborhoods","default":[]},"testimonials":{"items":{"$ref":"#/components/schemas/TestimonialsSchema"},"type":"array","title":"Testimonials","description":"If the section type is testimonials","default":[]},"banner":{"anyOf":[{"$ref":"#/components/schemas/BannerSectionSchema"},{"type":"null"}],"description":"If the section type is banner"},"neighborhood_type":{"anyOf":[{"type":"string","enum":["all_neighborhoods","custom_neighborhoods","custom_cities","custom_property_types"]},{"type":"null"}],"title":"Neighborhood Type"},"neighborhoods_params":{"anyOf":[{"$ref":"#/components/schemas/NeighborhoodsSectionSchema"},{"type":"null"}]}},"type":"object","title":"SectionSchema"},"SendMessagingSchema":{"properties":{"messaging_type":{"type":"string","enum":["send_email","send_whatsapp"],"title":"Messaging Type"},"property_ids":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array","title":"Property Ids","description":"Required if the send type is equal to property-owner-review","default":[]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},"type":"object","required":["messaging_type"],"title":"SendMessagingSchema"},"SicoobTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"sicoob","title":"Name","default":"sicoob"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"}},"type":"object","title":"SicoobTecnoSpeedSchema"},"SicrediTecnoSpeedSchema":{"properties":{"name":{"type":"string","const":"sicredi","title":"Name","default":"sicredi"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"},"assignor":{"anyOf":[{"$ref":"#/components/schemas/AssignorSchema"},{"type":"null"}]},"account_tcs":{"anyOf":[{"$ref":"#/components/schemas/AccountTCSSchema"},{"type":"null"}]},"wallet":{"anyOf":[{"$ref":"#/components/schemas/WalletSchema"},{"type":"null"}]},"bank_fee_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Fee Value"},"bank_slip_fee":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Bank Slip Fee"},"invoice_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Invoice Number"}},"type":"object","title":"SicrediTecnoSpeedSchema"},"SignerNumberSchema":{"properties":{"number_plain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number Plain"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"alpha2Code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alpha2Code"}},"type":"object","title":"SignerNumberSchema"},"SignerSchema":{"properties":{"phones":{"items":{"$ref":"#/components/schemas/SignerNumberSchema"},"type":"array","title":"Phones"},"phone":{"anyOf":[{"$ref":"#/components/schemas/SignerNumberSchema"},{"items":{"$ref":"#/components/schemas/SignerNumberSchema"},"type":"array"},{"type":"null"}],"title":"Phone"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"SignerSchema"},"SiteStatisticResponseSchema":{"properties":{"site":{"type":"string","title":"Site"},"analytics":{"$ref":"#/components/schemas/AnalyticsSiteSchema"},"properties_most_seen":{"$ref":"#/components/schemas/PropertiesMostSeenSchema"}},"type":"object","required":["site","analytics","properties_most_seen"],"title":"SiteStatisticResponseSchema"},"SocialNetworkSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"account":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account"}},"type":"object","title":"SocialNetworkSchema"},"SplitPixSchema":{"properties":{"default":{"type":"boolean","title":"Default","description":"Indicates if this is the default split pix key"},"pix_key":{"type":"string","title":"Pix Key","description":"The pix key for the split"},"pix_key_type":{"type":"string","title":"Pix Key Type","description":"The type of the pix key, e.g., 'cpf', 'cnpj', 'email', etc."}},"type":"object","required":["default","pix_key","pix_key_type"],"title":"SplitPixSchema"},"StageHistorySchema":{"properties":{"stage":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration"}},"type":"object","title":"StageHistorySchema"},"StringValue":{"properties":{"value":{"title":"Value","description":"A string value that can be used in various contexts."}},"type":"object","required":["value"],"title":"StringValue"},"SuitorFinancialProfileFieldsSchema":{"properties":{"income_filter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Income Filter"},"source_income":{"anyOf":[{"type":"string","enum":["unreported_income","public_official_statutory","public_official_clt","businessman","autonomous","retired","rental_income","alimony","credit_card_limit","bank_transition","other"]},{"type":"null"}],"title":"Source Income"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"secondary_source_income":{"anyOf":[{"type":"string","enum":["unreported_income","public_official_statutory","public_official_clt","businessman","autonomous","retired","rental_income","alimony","credit_card_limit","bank_transition","other"]},{"type":"null"}],"title":"Secondary Source Income"},"secondary_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Secondary Value"}},"type":"object","required":["source_income"],"title":"SuitorFinancialProfileFieldsSchema"},"TTSRequestSchema":{"properties":{"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"voice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voice"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"}},"type":"object","title":"TTSRequestSchema","description":"On-demand TTS: message_id XOR text (preview). session_id is an optional backend extension that skips the index lookup."},"TestimonialsSchema":{"properties":{"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"testimonial":{"type":"string","title":"Testimonial"},"photo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Photo"},"profession":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profession"}},"type":"object","required":["testimonial"],"title":"TestimonialsSchema"},"TextTemplatesSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body"},"group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Name"},"template_default_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Default Id"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"send_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Send Email"},"system_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"System Default"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"text_template_idx":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Text Template Idx"},"user":{"anyOf":[{"$ref":"#/components/schemas/UserTextTemplatesParameters"},{"type":"null"}]},"accounts":{"items":{"type":"string"},"type":"array","title":"Accounts","default":[]},"ai_render_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ai Render Type"},"display_on_invoice":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Display On Invoice"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},"type":"object","title":"TextTemplatesSchema"},"TimelineCreateParams":{"properties":{"type":{"anyOf":[{"type":"string","enum":["note","checklist"]},{"type":"null"}],"title":"Item type","description":"Type of timeline item to create. Defaults to note. Use checklist when the user asks for a checklist and then provide title and checklist_items.","default":"note"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note content","description":"Text to add as a timeline note. Provide content when type='note'. This field is ignored when creating a checklist."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checklist title","description":"Checklist title. Provide it when type='checklist'. This field is ignored when creating a note."},"checklist_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChecklistItemParam"},"type":"array"},{"type":"null"}],"title":"Checklist items","description":"Non-empty list of checklist items. Provide it when type='checklist'; each item must have a non-empty name."},"parent_type":{"type":"string","enum":["person","organization","property","lease","deal"],"title":"Parent entity type","description":"Entity to receive the timeline item. Use person for a person, client, lead, or generic contact; organization for a company; property for an imóvel; lease for the active locação associated with a property; and deal for a negócio or cartão. The value contact is not supported."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Partial or complete contact name. Use parent_type='person' for a person or parent_type='organization' for a company."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Exact contact email address, matched case-insensitively. Use with parent_type='person' or parent_type='organization'."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Contact phone number; common formatting variations are accepted. Use with parent_type='person' or parent_type='organization'."},"contact_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Public CRM contact code, for example 289 or C-289. Use with parent_type='person' or parent_type='organization'."},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property code","description":"Complete public property code, for example AP-001. Use it with parent_type='property' or parent_type='lease'."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property address","description":"Partial or complete property address. Use it with parent_type='property' or parent_type='lease'; lease resolves the active lease for that property."},"deal_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numeric deal code","description":"Numeric code of the parent deal/card, for example 653. For write operations, send only the numeric portion and also provide pipeline_group_name."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Display name of the deal/card pipeline. Provide it when parent_type='deal' and deal_code is numeric."}},"type":"object","required":["parent_type"],"title":"TimelineCreateParams","description":"Define timeline create parameters."},"TimelineCreateSchema":{"properties":{"timeline":{"$ref":"#/components/schemas/TimelineSchema"}},"type":"object","required":["timeline"],"title":"TimelineCreateSchema"},"TimelineDeleteParams":{"properties":{"selector":{"$ref":"#/components/schemas/TimelineSelectorParams","title":"Item selector","description":"Parent entity and content or title excerpt used to identify exactly one note or checklist for permanent deletion. Add created_at when the excerpt is ambiguous."}},"type":"object","required":["selector"],"title":"TimelineDeleteParams","description":"Define timeline delete parameters."},"TimelineDetailsSchema":{"properties":{"parent_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Parent Id","description":"Identifier of the parent entity related to this record."},"parent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Type","description":"Type of the parent entity (e.g., contact, property, deal)."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the timeline entry or event."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the timeline entry."},"address":{"items":{"type":"string"},"type":"array","title":"Address","description":"Address related to the timeline entry.","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Detailed description of the event or entry."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Primary date of the event in ISO format."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"Initial date of the event or period."},"timezone":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timezone","description":"Timezone offset in minutes."},"links_timeline":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinksTimelineSchema"},"type":"array"},{"type":"string"}],"title":"Links Timeline","description":"Links associated with this timeline entry.","default":[]},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Content or message body related to the timeline entry. If users mentioned content was @user:"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the timeline entry."},"lease_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Lease Id","description":"Identifier of the associated lease."},"lease_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code","description":"Code of the associated lease."},"contract_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contract Id","description":"Identifier of the associated contract."},"contract_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Code","description":"Code of the associated contract."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date","description":"Final date of the event or period."},"location":{"anyOf":[{"$ref":"#/components/schemas/GeoLocationSchema"},{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Location","description":"Geographic location (coordinates or schema) of the event."},"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"Indicates whether the event lasts all day."},"calendar_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Calendar Id","description":"Identifier of the calendar this entry belongs to."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Indicates whether the event or task is completed."},"message_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Message Id","description":"Identifier of the related message."},"user_mail_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Mail Key","description":"Unique mail key of the user related to this entry."},"received_from":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Received From","description":"Sender(s) of the related email or message.","default":[]},"delivered_to":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Delivered To","description":"Recipient(s) of the related email or message.","default":[]},"received_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Received At","description":"Date and time when the message was received."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject","description":"Subject line of the related email or message."},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"Body content of the related email or message."},"email_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Type","description":"Type of email (e.g., received, sent)."},"email_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Error"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id","description":"Identifier of the associated deal."},"email_seen":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Email Seen","description":"Flag or timestamp indicating email read status."},"email_delivered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email Delivered","description":"Indicates whether the email was successfully delivered."},"from_rotation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"From Rotation","description":"Indicates if the deal or event originated from a rotation."},"whatsapp_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Whatsapp Status","description":"Status of the related WhatsApp message."},"whatsapp_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Whatsapp Number","description":"WhatsApp number associated with the message."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Message content of the timeline entry."},"properties":{"items":{"$ref":"#/components/schemas/TimelinePropertySchema"},"type":"array","title":"Properties","description":"List of properties related to the timeline entry.","default":[]},"parent":{"anyOf":[{"$ref":"#/components/schemas/TimelineParentSchema"},{"type":"null"}],"description":"Parent entity schema related to the timeline entry."},"contract_key":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contract Key","description":"Unique key of the associated contract."},"invoice_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Invoice Id","description":"Identifier of the associated invoice."},"visit_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Visit Id","description":"Identifier of the associated visit."},"reserve_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reserve Id","description":"Identifier of the associated reservation."},"has_change":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Change","description":"Indicates whether there were changes to the entry."},"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start","description":"Start datetime of the event."},"end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End","description":"End datetime of the event."},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id","description":"Unique identifier of the timeline entry."},"property_rent_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Rent Value","description":"Rental value of the property."},"property_sale_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Sale Value","description":"Sale value of the property."},"property_observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Observation","description":"Observation or notes about the property."},"property_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Status","description":"Current status of the property."},"cast_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cast Type","description":"Type of casting or categorization."},"association_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Association Type","description":"Type of association for this entry."},"association_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Association Id","description":"Identifier of the associated entity."},"deal_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Title","description":"Title of the associated deal."},"deal_status":{"anyOf":[{"type":"string","enum":["win","lost","in progress"]},{"type":"null"}],"title":"Deal Status","description":"Current status of the associated deal."},"deal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Description","description":"Description of the associated deal."},"deal_pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Pipeline Group Name","description":"Name of the deal's pipeline group."},"deal_lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Reason","description":"Reason why the deal was lost."},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key","description":"Unique key of the property."},"integration_lead_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Lead Hash","description":"Unique hash for the integrated lead."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address","description":"Address of the property."},"property_code":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Property Code","description":"Code(s) of the property.","default":[]},"property_id":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"string"}],"title":"Property Id","description":"Identifier(s) of the property.","default":[]},"origin_lead_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Origin Lead Id","description":"Identifier of the originating lead."},"origin_listing_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Origin Listing Id","description":"Identifier of the originating listing."},"lead_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Origin","description":"Origin source of the lead."},"title_privacy_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title Privacy Policy","description":"Title of the privacy policy."},"date_privacy_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Privacy Policy","description":"Date of acceptance of the privacy policy."},"document_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Document Id","description":"Identifier of the associated document."},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Name","description":"Name of the associated document."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"Type of the associated document."},"analysis_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Analysis Id","description":"Identifier of the associated analysis."},"analysis_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analysis Name","description":"Name of the associated analysis."},"users_mentioned":{"items":{"$ref":"#/components/schemas/UserMentionedTimelineSchema"},"type":"array","title":"Users Mentioned","description":"List of users mentioned in the timeline entry. Required for create a new note with user","default":[]},"users_mentioned_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Users Mentioned Notification","description":"Indicates whether mentioned users were notified."},"contact_key":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Key","description":"Key of the associated contact."},"revision_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Date","description":"Date of the latest revision."},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key of the latest revision."},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Icon representing the timeline entry."},"checklist_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/models_firestore__timelines__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist Items","description":"List of checklist items."},"is_checklist_template":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Checklist Template","description":"Indicates that this checklist will be a template."},"checklist_links":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checklist Links","description":"List of checklist links."},"checklist_pipeline_groups_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checklist Pipeline Groups Ids","description":"List of checklist pipeline groups."},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"},"email_address_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address From"},"email_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Date"},"email_address_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address To"},"email_subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Subject"},"email_body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Body"},"email_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Status"},"date_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Status"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"contact_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Code"},"contact_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Type"},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Name"},"deal_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Key"}},"type":"object","title":"TimelineDetailsSchema"},"TimelineGetResponseSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/TimelineSchema"},{"type":"null"}]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"links":{"items":{"$ref":"#/components/schemas/LinksTimelineSchema"},"type":"array","title":"Links","default":[]},"details":{"$ref":"#/components/schemas/TimelineDetailsSchema"}},"type":"object","required":["details"],"title":"TimelineGetResponseSchema"},"TimelineParentSchema":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Code"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","title":"TimelineParentSchema"},"TimelinePostResponseSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"},"db_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Key"}},"type":"object","title":"TimelinePostResponseSchema"},"TimelinePropertySchema":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"thumbnail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail"}},"type":"object","title":"TimelinePropertySchema"},"TimelineSchema":{"properties":{"parent_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Parent Id","description":"Identifier of the parent entity related to this record."},"parent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Type","description":"Type of the parent entity (e.g., contact, property, deal)."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the timeline entry or event."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"Title of the timeline entry."},"address":{"items":{"type":"string"},"type":"array","title":"Address","description":"Address related to the timeline entry.","default":[]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Detailed description of the event or entry."},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Primary date of the event in ISO format."},"initial_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Date","description":"Initial date of the event or period."},"timezone":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timezone","description":"Timezone offset in minutes."},"links_timeline":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinksTimelineSchema"},"type":"array"},{"type":"string"}],"title":"Links Timeline","description":"Links associated with this timeline entry.","default":[]},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Content or message body related to the timeline entry. If users mentioned content was @user:"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the timeline entry."},"lease_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Lease Id","description":"Identifier of the associated lease."},"lease_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Code","description":"Code of the associated lease."},"contract_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contract Id","description":"Identifier of the associated contract."},"contract_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Code","description":"Code of the associated contract."},"final_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Date","description":"Final date of the event or period."},"location":{"anyOf":[{"$ref":"#/components/schemas/GeoLocationSchema"},{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Location","description":"Geographic location (coordinates or schema) of the event."},"all_day":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Day","description":"Indicates whether the event lasts all day."},"calendar_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Calendar Id","description":"Identifier of the calendar this entry belongs to."},"done":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Done","description":"Indicates whether the event or task is completed."},"message_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Message Id","description":"Identifier of the related message."},"user_mail_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Mail Key","description":"Unique mail key of the user related to this entry."},"received_from":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Received From","description":"Sender(s) of the related email or message.","default":[]},"delivered_to":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Delivered To","description":"Recipient(s) of the related email or message.","default":[]},"received_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Received At","description":"Date and time when the message was received."},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject","description":"Subject line of the related email or message."},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"Body content of the related email or message."},"email_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Type","description":"Type of email (e.g., received, sent)."},"email_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Error","description":"Error message related to email delivery."},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id","description":"Identifier of the associated deal."},"email_seen":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Email Seen","description":"Flag or timestamp indicating email read status."},"email_delivered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email Delivered","description":"Indicates whether the email was successfully delivered."},"from_rotation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"From Rotation","description":"Indicates if the deal or event originated from a rotation."},"whatsapp_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Whatsapp Status","description":"Status of the related WhatsApp message."},"whatsapp_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Whatsapp Number","description":"WhatsApp number associated with the message."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Message content of the timeline entry."},"properties":{"items":{"$ref":"#/components/schemas/TimelinePropertySchema"},"type":"array","title":"Properties","description":"List of properties related to the timeline entry.","default":[]},"parent":{"anyOf":[{"$ref":"#/components/schemas/TimelineParentSchema"},{"type":"null"}],"description":"Parent entity schema related to the timeline entry."},"contract_key":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contract Key","description":"Unique key of the associated contract."},"invoice_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Invoice Id","description":"Identifier of the associated invoice."},"visit_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Visit Id","description":"Identifier of the associated visit."},"reserve_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reserve Id","description":"Identifier of the associated reservation."},"has_change":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Change","description":"Indicates whether there were changes to the entry."},"start":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start","description":"Start datetime of the event."},"end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End","description":"End datetime of the event."},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id","description":"Unique identifier of the timeline entry."},"property_rent_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Rent Value","description":"Rental value of the property."},"property_sale_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Sale Value","description":"Sale value of the property."},"property_observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Observation","description":"Observation or notes about the property."},"property_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Status","description":"Current status of the property."},"cast_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cast Type","description":"Type of casting or categorization."},"association_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Association Type","description":"Type of association for this entry."},"association_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Association Id","description":"Identifier of the associated entity."},"deal_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Title","description":"Title of the associated deal."},"deal_status":{"anyOf":[{"type":"string","enum":["win","lost","in progress"]},{"type":"null"}],"title":"Deal Status","description":"Current status of the associated deal."},"deal_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Description","description":"Description of the associated deal."},"deal_pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Pipeline Group Name","description":"Name of the deal's pipeline group."},"deal_lost_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Lost Reason","description":"Reason why the deal was lost."},"property_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Key","description":"Unique key of the property."},"integration_lead_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Lead Hash","description":"Unique hash for the integrated lead."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Address","description":"Address of the property."},"property_code":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Property Code","description":"Code(s) of the property.","default":[]},"property_id":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"string"}],"title":"Property Id","description":"Identifier(s) of the property.","default":[]},"origin_lead_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Origin Lead Id","description":"Identifier of the originating lead."},"origin_listing_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Origin Listing Id","description":"Identifier of the originating listing."},"lead_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lead Origin","description":"Origin source of the lead."},"title_privacy_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title Privacy Policy","description":"Title of the privacy policy."},"date_privacy_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Privacy Policy","description":"Date of acceptance of the privacy policy."},"document_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Document Id","description":"Identifier of the associated document."},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Name","description":"Name of the associated document."},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"Type of the associated document."},"analysis_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Analysis Id","description":"Identifier of the associated analysis."},"analysis_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analysis Name","description":"Name of the associated analysis."},"users_mentioned":{"items":{"$ref":"#/components/schemas/UserMentionedTimelineSchema"},"type":"array","title":"Users Mentioned","description":"List of users mentioned in the timeline entry. Required for create a new note with user","default":[]},"users_mentioned_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Users Mentioned Notification","description":"Indicates whether mentioned users were notified."},"contact_key":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Contact Key","description":"Key of the associated contact."},"revision_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Date","description":"Date of the latest revision."},"revision_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Key","description":"Key of the latest revision."},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Icon representing the timeline entry."},"checklist_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/models_firestore__timelines__ChecklistItem"},"type":"array"},{"type":"null"}],"title":"Checklist Items","description":"List of checklist items."},"is_checklist_template":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Checklist Template","description":"Indicates that this checklist will be a template."},"checklist_links":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checklist Links","description":"List of checklist links."},"checklist_pipeline_groups_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Checklist Pipeline Groups Ids","description":"List of checklist pipeline groups."},"private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Private"}},"type":"object","title":"TimelineSchema"},"TimelineSelectorParams":{"properties":{"search_text":{"type":"string","title":"Content or title excerpt","description":"Phrase-prefix excerpt from the note content or checklist title. The selector must resolve exactly one item; use created_at to refine ambiguous matches."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Creation date","description":"Creation date in YYYY-MM-DD format, for example 2025-01-15. The selector matches the entire calendar day and uses it to refine similar items."},"parent_type":{"type":"string","enum":["person","organization","property","lease","deal"],"title":"Parent entity type","description":"Type of entity that owns the timeline item. For lease, provide a property identifier so the tool can find its active lease."},"contact_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact name","description":"Partial or complete name of the parent person or organization."},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact email","description":"Exact email address of the parent person or organization."},"contact_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact phone","description":"Phone number of the parent person or organization."},"contact_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact code","description":"Public CRM code of the parent contact, for example 289 or C-289."},"property_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property code","description":"Complete public code of the parent property, for example AP-001."},"property_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property address","description":"Partial or complete address of the parent property."},"deal_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numeric deal code","description":"Numeric code of the parent deal/card. For update and delete operations, send only the numeric portion and also provide pipeline_group_name."},"pipeline_group_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pipeline group name","description":"Display name of the deal/card pipeline used with a numeric deal_code."}},"type":"object","required":["search_text","parent_type"],"title":"TimelineSelectorParams","description":"Define timeline selector parameters."},"TimelineUpdateParams":{"properties":{"selector":{"$ref":"#/components/schemas/TimelineSelectorParams","title":"Item selector","description":"Parent entity and content or title excerpt used to identify exactly one note or checklist. Add created_at when the excerpt is ambiguous."},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New note content","description":"Replacement text for a note. Provide non-empty content when the selected item is a note. This field does not update a checklist."},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"New checklist title","description":"Replacement checklist title. Omit it to keep the current title. This field does not update a note."},"checklist_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChecklistItemParam"},"type":"array"},{"type":"null"}],"title":"New checklist items","description":"Non-empty replacement list for all checklist items. Each item must have a non-empty name. Omit it to keep the current items; an empty list does not clear them. This field does not update a note."}},"type":"object","required":["selector"],"title":"TimelineUpdateParams","description":"Define timeline update parameters."},"TimelinesGetResponseSchema":{"properties":{"timeline_items":{"anyOf":[{"$ref":"#/components/schemas/TimelineGetResponseSchema"},{"type":"null"}]},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},"type":"object","required":["timeline_items","cursor"],"title":"TimelinesGetResponseSchema"},"UnitsGrouped":{"properties":{"total":{"type":"integer","title":"Total"},"property_block":{"type":"string","title":"Property Block"},"units_status":{"items":{"$ref":"#/components/schemas/UnitsStatus"},"type":"array","title":"Units Status"},"properties":{"items":{"$ref":"#/components/schemas/PropertyMirrorDetails"},"type":"array","title":"Properties"}},"type":"object","required":["total","property_block","units_status","properties"],"title":"UnitsGrouped"},"UnitsStatus":{"properties":{"status":{"type":"string","title":"Status"},"code":{"type":"integer","title":"Code"}},"type":"object","required":["status","code"],"title":"UnitsStatus"},"UserAddressSchema":{"properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"neighborhood":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Neighborhood"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"zipcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipcode"},"complement":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Complement"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street"}},"type":"object","title":"UserAddressSchema"},"UserArkisRoleSchema":{"properties":{"free_quota_million":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Free Quota Million"},"billing_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Mode"},"interaction_limit_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Interaction Limit Enabled"},"premium_models_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Premium Models Enabled"},"token_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Token Limit"},"voice_minutes_limit":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Voice Minutes Limit","description":"Monthly minutes of Arkis voice calls"}},"type":"object","title":"UserArkisRoleSchema"},"UserCardsDashboardRoleSchema":{"properties":{"ranking":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ranking"},"deals_done":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deals Done"}},"type":"object","title":"UserCardsDashboardRoleSchema"},"UserContractRoleSchema":{"properties":{"contract_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Management"},"contract_report":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Report"}},"type":"object","title":"UserContractRoleSchema"},"UserCreateSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Unique identifier of the database"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the user is active"},"uid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uid","description":"Unique identifier of the user"},"admin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Admin","description":"Indicates whether the user has admin privileges"},"currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Code","description":"Default currency code associated with the user"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Database name the user is associated with"},"email_verified":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email Verified","description":"Indicates whether the user's email is verified","default":false},"profile":{"anyOf":[{"$ref":"#/components/schemas/UserProfileSchema"},{"type":"null"}],"description":"Profile information of the user"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"Password for user authentication"},"permissions":{"anyOf":[{"$ref":"#/components/schemas/UserPermissionSchema"},{"type":"null"}],"description":"Permission settings for the user"},"erp_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Erp Enabled","description":"Indicates whether ERP features are enabled for the user"},"login":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Login","description":"Login username for the user"},"realtor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Realtor","description":"Indicates whether the user is a realtor"},"initialConfig":{"anyOf":[{"$ref":"#/components/schemas/UserInitialConfigSchema"},{"type":"null"}],"description":"Initial configuration settings for the user"},"deals_rotations_ids":{"items":{"type":"string"},"type":"array","title":"Deals Rotations Ids","description":"List of IDs related to deals rotations for the user","default":[],"example":[1,2,3]}},"type":"object","title":"UserCreateSchema"},"UserDatabaseConfigSchema":{"properties":{"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"admin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Admin"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Name"}},"type":"object","title":"UserDatabaseConfigSchema"},"UserFederalIncomeRoleSchema":{"properties":{"federal_income_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Federal Income Management"}},"type":"object","title":"UserFederalIncomeRoleSchema"},"UserFinanceRoleSchema":{"properties":{"accounts_and_banks":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounts And Banks"},"finances":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finances"},"transaction_type":{"items":{"type":"string"},"type":"array","title":"Transaction Type","description":"List of transaction types the user has access to.","default":[]}},"type":"object","title":"UserFinanceRoleSchema"},"UserInitialConfigSchema":{"properties":{"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"amount_people":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount People"},"other_software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Software"},"rent_management":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rent Management"},"launch_sales":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Launch Sales"},"third_party_sales":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Third Party Sales"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","title":"UserInitialConfigSchema"},"UserInvoiceRoleSchema":{"properties":{"invoice_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Management"}},"type":"object","title":"UserInvoiceRoleSchema"},"UserLandlordAccountsRoleSchema":{"properties":{"landlord_account_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landlord Account Management"}},"type":"object","title":"UserLandlordAccountsRoleSchema"},"UserLeaseRoleSchema":{"properties":{"lease_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Management"},"lease_report":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lease Report"}},"type":"object","title":"UserLeaseRoleSchema"},"UserMentionedTimelineSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname"}},"type":"object","title":"UserMentionedTimelineSchema"},"UserNotaFiscalRoleSchema":{"properties":{"nota_fiscal_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nota Fiscal Management"}},"type":"object","title":"UserNotaFiscalRoleSchema"},"UserPermissionSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database"},"adverts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Adverts"},"admin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Admin"},"property":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"building":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"contact":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"lead":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"deal":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"calendar":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"document":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"deal_rotation":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"analysis":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"reserve":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"site":{"anyOf":[{"$ref":"#/components/schemas/UserRoleSchema"},{"type":"null"}]},"nota_fiscal":{"anyOf":[{"$ref":"#/components/schemas/UserNotaFiscalRoleSchema"},{"type":"null"}]},"cards_dashboard":{"anyOf":[{"$ref":"#/components/schemas/UserCardsDashboardRoleSchema"},{"type":"null"}]},"timeline":{"anyOf":[{"$ref":"#/components/schemas/UserTimelineRoleSchema"},{"type":"null"}]},"lease":{"anyOf":[{"$ref":"#/components/schemas/UserLeaseRoleSchema"},{"type":"null"}]},"finances":{"anyOf":[{"$ref":"#/components/schemas/UserFinanceRoleSchema"},{"type":"null"}]},"contract":{"anyOf":[{"$ref":"#/components/schemas/UserContractRoleSchema"},{"type":"null"}]},"invoice":{"anyOf":[{"$ref":"#/components/schemas/UserInvoiceRoleSchema"},{"type":"null"}]},"landlord_account":{"anyOf":[{"$ref":"#/components/schemas/UserLandlordAccountsRoleSchema"},{"type":"null"}]},"federal_income":{"anyOf":[{"$ref":"#/components/schemas/UserFederalIncomeRoleSchema"},{"type":"null"}]},"arkis":{"anyOf":[{"$ref":"#/components/schemas/UserArkisRoleSchema"},{"type":"null"}]}},"type":"object","title":"UserPermissionSchema"},"UserProfileSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id","description":"Unique identifier of the user in the database."},"uid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uid","description":"Unique user identifier within the system."},"about":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"About","description":"Short biography or additional information about the user."},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Indicates whether the user account is active."},"admin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Admin","description":"Specifies if the user has administrator privileges."},"address":{"anyOf":[{"$ref":"#/components/schemas/UserAddressSchema"},{"type":"null"}],"description":"User's address information."},"birthday":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birthday","description":"User's date of birth."},"cpf":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cpf","description":"User's CPF (Brazilian taxpayer identification number)."},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"Date and time when the user account was created."},"database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Database","description":"Current database associated with the user."},"databases":{"items":{"type":"string"},"type":"array","title":"Databases","description":"List of database names the user has access to.","default":[]},"databases_config":{"items":{"$ref":"#/components/schemas/UserDatabaseConfigSchema"},"type":"array","title":"Databases Config","description":"List of database configurations for the user.","default":[]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Primary email address of the user."},"emails":{"items":{"type":"string"},"type":"array","title":"Emails","description":"List of email addresses associated with the user.","default":[]},"firstname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname","description":"User's first name."},"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname","description":"User's full name."},"function":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Function","description":"User's role or function in the organization."},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gender","description":"User's gender."},"lastname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname","description":"User's last name."},"license":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"License","description":"License number or identifier associated with the user."},"marital_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Marital Status","description":"User's marital status."},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nationality","description":"User's nationality."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Preferred display name of the user."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"Nickname or informal name of the user."},"phone":{"anyOf":[{"$ref":"#/components/schemas/PhoneSchema"},{"type":"null"}],"description":"Primary phone number of the user."},"phones":{"anyOf":[{"items":{"$ref":"#/components/schemas/PhoneSchema"},"type":"array"},{"type":"null"}],"title":"Phones","description":"List of phone numbers associated with the user."},"profession":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profession","description":"User's profession or occupation."},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url","description":"URL of the user's profile image."},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url","description":"Alternative image URL associated with the user."},"real_estate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Real Estate","description":"Real estate company or agency associated with the user."},"regional_settings":{"anyOf":[{"$ref":"#/components/schemas/RegionalSettingsSchema"},{"items":{"$ref":"#/components/schemas/RegionalSettingsSchema"},"type":"array"}],"title":"Regional Settings","description":"Regional settings for the user, including locale, language, and timezone.","default":[]},"rg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rg","description":"User's RG (Brazilian general identification number)."},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags associated with the user.","default":[]},"site":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site","description":"Website or personal page of the user."},"social_networks":{"items":{"$ref":"#/components/schemas/SocialNetworkSchema"},"type":"array","title":"Social Networks","description":"List of social networks associated with the user.","default":[]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Current status of the user (e.g., active, inactive, pending)."},"x_current_database":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X Current Database","description":"Identifier of the database currently in use by the user."},"hotscool":{"anyOf":[{"$ref":"#/components/schemas/HotscoolSchema"},{"type":"null"}],"description":"Additional Hotscool-specific configuration for the user."}},"type":"object","title":"UserProfileSchema"},"UserRankingSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"UserRankingSchema"},"UserRoleSchema":{"properties":{"other":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other"},"own":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Own"},"commission":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Commission"},"without_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Without Link"},"pending":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pending"},"hide_property_address":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hide Property Address"},"hide_property_owner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hide Property Owner"},"hide_building_address":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hide Building Address"},"hide_building_owner":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hide Building Owner"},"other_private":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Other Private"},"contents":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contents"},"pages":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pages"},"settings":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Settings"},"popups":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Popups"},"menus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Menus"},"time_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Time Limit"},"extend_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Extend Limit"},"new_reserve_after":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"New Reserve After"},"max_reserves_active":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Reserves Active"},"nota_fiscal_management":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nota Fiscal Management"},"updated_property_revision":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Updated Property Revision"},"ignore_reassign_manager":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Reassign Manager"},"share_filter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Share Filter"}},"type":"object","title":"UserRoleSchema"},"UserSchema":{"properties":{"fullname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fullname"}},"type":"object","title":"UserSchema"},"UserTeamSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id","description":"Required to update a Team"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"users":{"anyOf":[{"items":{"$ref":"#/components/schemas/UserCreateSchema"},"type":"array"},{"type":"null"}],"title":"Users"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","title":"UserTeamSchema"},"UserTextTemplatesParameters":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Db Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image Url"}},"type":"object","title":"UserTextTemplatesParameters"},"UserTimelineRoleSchema":{"properties":{"checklist":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checklist"}},"type":"object","title":"UserTimelineRoleSchema"},"VacationCalendarSchema":{"properties":{"property_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Property Id"},"night_value":{"type":"number","title":"Night Value"},"reserve_date":{"type":"string","title":"Reserve Date"},"weekend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Weekend"},"status":{"type":"string","title":"Status"},"db_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Db Id"}},"type":"object","required":["property_id","night_value","reserve_date","status","db_id"],"title":"VacationCalendarSchema"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WalletSchema":{"properties":{"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret"},"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"},"station":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Station"},"pix_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key"},"pix_key_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pix Key Type"},"portfolio_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Portfolio Code"},"contract_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Number"}},"type":"object","title":"WalletSchema"},"WebhookSchema":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","default":""},"events":{"items":{"type":"string"},"type":"array","title":"Events","default":[]},"authorization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization","default":""},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","default":true},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","default":""}},"type":"object","title":"WebhookSchema"},"WhatsAppBusinessCreateTemplateSchema":{"properties":{"phone_id":{"type":"string","title":"Phone Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"template":{"$ref":"#/components/schemas/WhatsAppBusinessTemplateSchema"}},"type":"object","required":["phone_id","account_business_id","template"],"title":"WhatsAppBusinessCreateTemplateSchema"},"WhatsAppBusinessMarkMessagesReadSchema":{"properties":{"phone_id":{"type":"string","title":"Phone Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"chat_id":{"type":"string","title":"Chat Id"},"messages_ids":{"items":{"type":"string"},"type":"array","title":"Messages Ids"}},"type":"object","required":["phone_id","account_business_id","chat_id","messages_ids"],"title":"WhatsAppBusinessMarkMessagesReadSchema"},"WhatsAppBusinessSendMessageSchema":{"properties":{"number":{"type":"string","title":"Number"},"text":{"type":"string","title":"Text"},"phone_id":{"type":"string","title":"Phone Id"},"replied_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replied Message Id"},"account_business_id":{"type":"string","title":"Account Business Id"}},"type":"object","required":["number","text","phone_id","account_business_id"],"title":"WhatsAppBusinessSendMessageSchema"},"WhatsAppBusinessSendReactionSchema":{"properties":{"number":{"type":"string","title":"Number"},"phone_id":{"type":"string","title":"Phone Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"message_id":{"type":"string","title":"Message Id"},"reaction":{"type":"string","title":"Reaction"}},"type":"object","required":["number","phone_id","account_business_id","message_id","reaction"],"title":"WhatsAppBusinessSendReactionSchema"},"WhatsAppBusinessSendTemplateSchema":{"properties":{"number":{"type":"string","title":"Number"},"phone_id":{"type":"string","title":"Phone Id"},"account_business_id":{"type":"string","title":"Account Business Id"},"template_name":{"type":"string","title":"Template Name"},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","default":""},"calendar_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calendar Key"},"body_variables":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Body Variables"},"button_variables":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Button Variables","default":[]}},"type":"object","required":["number","phone_id","account_business_id","template_name","body_variables"],"title":"WhatsAppBusinessSendTemplateSchema"},"WhatsAppBusinessTemplateSchema":{"properties":{"name":{"type":"string","title":"Name"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","default":"pt_BR"},"category":{"type":"string","enum":["UTILITY","MARKETING"],"title":"Category"},"components":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Components"}},"type":"object","required":["name","category","components"],"title":"WhatsAppBusinessTemplateSchema"},"WhatsAppSendNoteSchema":{"properties":{"number":{"type":"string","title":"Number"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"users_mentioned":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Users Mentioned","default":[]},"instance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instance"},"phone_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Id"},"message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"},"chat_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Id"},"account_business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Business Id"}},"type":"object","required":["number"],"title":"WhatsAppSendNoteSchema"},"models_firestore__timelines__ChecklistItem":{"properties":{"name":{"type":"string","title":"Name"},"checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Checked","default":false},"observation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Observation"}},"type":"object","required":["name"],"title":"ChecklistItem","description":"Checklist item"},"routers__schemas__deal_filter_fields__ResponsePostSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponsePostSchema"},"routers__schemas__field__MediaSourceSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action"}},"type":"object","title":"MediaSourceSchema","description":"ContactMediaSource fields "},"routers__schemas__media_source__MediaSourceSchema":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the media source","examples":["Google Ads"]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type of the media source","examples":["ads","social","email"]},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"},"default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Default"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings","description":"Settings for the media source"}},"type":"object","required":["name"],"title":"MediaSourceSchema"},"routers__schemas__pipeline__ChecklistItem":{"properties":{"name":{"type":"string","title":"Name"},"db_id":{"type":"string","title":"Db Id"}},"type":"object","required":["name","db_id"],"title":"ChecklistItem"},"routers__schemas__pipeline_group__ChecklistItem":{"properties":{"name":{"type":"string","title":"Name"},"db_id":{"type":"string","title":"Db Id"}},"type":"object","required":["name","db_id"],"title":"ChecklistItem"},"routers__schemas__property__CoverPhotoSchema":{"properties":{"db_id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Db Id"},"url":{"type":"string","title":"Url"}},"type":"object","required":["db_id","url"],"title":"CoverPhotoSchema"},"routers__schemas__property_site__CoverPhotoSchema":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"CoverPhotoSchema"},"routers__schemas__site_pages_configuration__CoverPhotoSchema":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"db_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"CoverPhotoSchema"},"routers__schemas__webhook__ResponsePostSchema":{"properties":{"db_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Db Id"}},"type":"object","title":"ResponsePostSchema"}},"securitySchemes":{"X-Imobzi-Secret":{"type":"apiKey","name":"X-Imobzi-Secret","in":"header","description":"The form of authenticity is simple and simply send the X-Imobzi-Secret parameter in the header of the HTTP request with your secret key.\n\n```\nX-Imobzi-Secret: \n```\n\n**Caution:** Never share your secret keys. Keep them safe and secure. Also, do not use the secret key where it can be stolen, for example, in a JavaScript code running on the browser side."}}},"tags":[{"name":"Banks","description":"List available Banks\n"},{"name":"Calendar","description":"Create, Update, Delete or List items of Calendar\n"},{"name":"Calendar Types","description":"Create, Update, Delete or List items of Calendar Types\n"},{"name":"Contacts and Leads","description":"Create, Update, Delete, or List Contacts (Person & Organization) and Leads\n"},{"name":"Contacts Tags","description":"Create, Update, Delete, or List Contacts Tag\n"},{"name":"Contact Bank","description":"Retrieve a contact bank data\n"},{"name":"Contracts","description":"Create, Update, Delete, Get or Get list contracts\n"},{"name":"Credit Financing Analysis","description":"Create, Update, Delete, List all analysis or fetch a specific one and check analysis fees.\n"},{"name":"Deals","description":"Create, Update, Delete, or List Deals\n"},{"name":"Deals Rotations","description":"Create, Update, Delete or List Deals Rotations\n"},{"name":"Deal Lost Reasons","description":"Create, Update, Delete or List Deal Lost Reasons\n"},{"name":"Deals Filters","description":"Create, Update, Delete, List Deals Filters or List Deals Filters Fields\n"},{"name":"Documents","description":"List all documents, fetch a specific document, upload a document and check document fees.\n"},{"name":"Fields Deal","description":"Create, Update, Delete, or List Deals Fields\n"},{"name":"Fields Contact","description":"Create, Update, Delete, or List Fields (Person)\n"},{"name":"Fields Contract","description":"Create, Update, Delete, or List Fields (Contract)\n"},{"name":"Fields Lease","description":"Create, Update, Delete, or List Fields (Lease)\n"},{"name":"Fields Organization","description":"Create, Update, Delete, or List Fields (Organization)\n"},{"name":"Fields Property","description":"Create, Update, Delete, or List Property Fields\n"},{"name":"Financial accounts","description":"Create, Update, Delete Financial Account or\nGet List Financial Accounts or Get unique Financial Account by account_id\n"},{"name":"Financial Tags","description":"Get list financial tags\n"},{"name":"Financial categories","description":"Create, Update, Delete Financial Category or\nGet List Financial Categories or Get unique Financial Categorie by category_id\n"},{"name":"Financial commissions","description":"Get commission report"},{"name":"Financial Landlord Account Onlending","description":"Get Financial Landlord Account Report Onlending\n"},{"name":"Financial Transactions","description":"Create, Update, Delete, Get or Get Financial Transaction List"},{"name":"Get transactions financial landlord account","description":"Retrieve get list financial landlord account, create, update, get and update financial landlord transaction\n"},{"name":"Financial landlord accounts","description":"Retrieve list financial landlord account or get a financial landlord account by landlord_account_id\n"},{"name":"Financial landlord account transactions","description":"Retrieve get list financial landlord account transactions, create, deleted, get and update financial landlord transaction\n"},{"name":"Invoices","description":"Create, Update, Get or Get list Invoices"},{"name":"Invoice send notification","description":"Send invoice notification"},{"name":"lease","description":"Create, Update, Delete, Get or Get list leases"},{"name":"Media Source","description":"List available Media Source\n"},{"name":"Neighborhoods","description":"List available Neighborhoods\n"},{"name":"Notifications","description":"Get users notifications, Send push notifications\n"},{"name":"Nota Fiscal","description":"Create, Update, Delete, Get or Get list Nota Fiscal"},{"name":"Pipeline","description":"Create, Update, Delete, or List Pipeline\n"},{"name":"Pipeline Group","description":"Create, Update, Delete, or List Pipelines Group\n"},{"name":"Property","description":"Create, Update, Delete, or List Properties\n"},{"name":"Property Adverts","description":"Create, Update, Delete, or List Adverts\n"},{"name":"Property Features","description":"List available Property Features\n"},{"name":"Property Photo","description":"Upload Property Photo\n"},{"name":"Property Reserves","description":"Create, Update, Delete or List Property reserves\n"},{"name":"Property Types","description":"List available Property Types\n"},{"name":"Reports","description":"List Reports\n"},{"name":"Site Highlights","description":"Update or List Site Highlights\n"},{"name":"Timelines","description":"Create, Update, Delete or List Timeline items\n"},{"name":"Users","description":"List available Users\n"},{"name":"User Billing","description":"List User Billing\n"},{"name":"Utils","description":"Retrieve utils by type\n"},{"name":"Teams","description":"Create, Update, Delete or List Teams\n"},{"name":"Webhook","description":"Create, Update, Delete, or List Webhooks\n"},{"name":"WhatsApp","description":"Send messages and List Chats\n"}],"x-tagGroups":[{"name":"Methods Available","tags":["Banks","Calendar","Calendar Types","Contacts and Leads","Contacts Tags","Contact Bank","Contracts","Credit Financing Analysis","Deals","Deals Rotations","Deal Lost Reasons","Deals Filters","Documents","Fields Deal","Fields Contact","Fields Organization","Fields Property","Lease Fields","Contract Fields","Financial accounts","Financial Tags","Financial categories","Financial commissions","Financial Landlord Account Onlending","Financial landlord accounts","Financial landlord account transactions","Financial Transactions","Invoices","Invoice send notification","lease","Media Source","Neighborhoods","Notifications","Nota Fiscal","Pipeline","Pipeline Group","Property","Property Adverts","Property Features","Property Photo","Property Reserves","Property Types","Reports","Site Highlights","Teams","Timelines","Users","User Billing","Utils","Webhook","WhatsApp"]}],"security":[{"X-Imobzi-Secret":[]}]}