From a77818892ab21ba4425d4d00e5d4bd7557822cc2 Mon Sep 17 00:00:00 2001 From: Renato Byrro Date: Fri, 7 Nov 2025 18:53:28 -0300 Subject: [PATCH 1/2] entrata tools --- servers/entrata_api/Makefile | 48 + servers/entrata_api/README.md | 25 + .../arcade_entrata_api/__init__.py | 0 .../arcade_entrata_api/moar/Entrata.json | 18704 ++++ .../arcade_entrata_api/moar/openapi.json | 84279 ++++++++++++++++ .../arcade_entrata_api/tools/__init__.py | 898 + .../wrapper_tools/CheckApiHealth.json | 259 + .../wrapper_tools/CreateCustomerProfile.json | 148 + .../wrapper_tools/CreateLeadEntry.json | 253 + .../wrapper_tools/CreatePropertyUnit.json | 148 + .../wrapper_tools/GetAccessibleClients.json | 148 + .../wrapper_tools/GetArCodes.json | 292 + .../wrapper_tools/GetArTransactions.json | 253 + .../wrapper_tools/GetFinancialBudgets.json | 148 + .../wrapper_tools/GetLeaseDetails.json | 253 + .../wrapper_tools/GetPropertyDetails.json | 253 + .../wrapper_tools/GetVendors.json | 253 + .../wrapper_tools/LeasingCenterCallLogs.json | 253 + .../RequestMaintenanceService.json | 253 + .../SendCommunicationMessage.json | 148 + .../wrapper_tools/SubmitApplication.json | 148 + .../wrapper_tools/SubmitArPayments.json | 430 + .../wrapper_tools/UpdatePricing.json | 148 + servers/entrata_api/pyproject.toml | 54 + servers/entrata_api/tests/__init__.py | 0 25 files changed, 107796 insertions(+) create mode 100644 servers/entrata_api/Makefile create mode 100644 servers/entrata_api/README.md create mode 100644 servers/entrata_api/arcade_entrata_api/__init__.py create mode 100644 servers/entrata_api/arcade_entrata_api/moar/Entrata.json create mode 100644 servers/entrata_api/arcade_entrata_api/moar/openapi.json create mode 100644 servers/entrata_api/arcade_entrata_api/tools/__init__.py create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/CheckApiHealth.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateCustomerProfile.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateLeadEntry.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/CreatePropertyUnit.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetAccessibleClients.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArCodes.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArTransactions.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetFinancialBudgets.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetLeaseDetails.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetPropertyDetails.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/GetVendors.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/LeasingCenterCallLogs.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/RequestMaintenanceService.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/SendCommunicationMessage.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitApplication.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitArPayments.json create mode 100644 servers/entrata_api/arcade_entrata_api/wrapper_tools/UpdatePricing.json create mode 100644 servers/entrata_api/pyproject.toml create mode 100644 servers/entrata_api/tests/__init__.py diff --git a/servers/entrata_api/Makefile b/servers/entrata_api/Makefile new file mode 100644 index 00000000..4979f644 --- /dev/null +++ b/servers/entrata_api/Makefile @@ -0,0 +1,48 @@ +.PHONY: help + +help: + @echo "🛠️ github Commands:\n" + @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +.PHONY: install +install: ## Install the uv environment and install all packages with dependencies + @echo "🚀 Creating virtual environment and installing all packages using uv" + @uv sync --active --all-extras --no-sources + @if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi + @echo "✅ All packages and dependencies installed via uv" + +.PHONY: build +build: clean-build ## Build wheel file using poetry + @echo "🚀 Creating wheel file" + uv build + +.PHONY: clean-build +clean-build: ## clean build artifacts + @echo "🗑️ Cleaning dist directory" + rm -rf dist + +.PHONY: test +test: ## Test the code with pytest + @echo "🚀 Testing code: Running pytest" + @uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml + +.PHONY: coverage +coverage: ## Generate coverage report + @echo "coverage report" + @uv run --no-sources coverage report + @echo "Generating coverage report" + @uv run --no-sources coverage html + +.PHONY: bump-version +bump-version: ## Bump the version in the pyproject.toml file by a patch version + @echo "🚀 Bumping version in pyproject.toml" + uv version --no-sources --bump patch + +.PHONY: check +check: ## Run code quality tools. + @if [ -f .pre-commit-config.yaml ]; then\ + echo "🚀 Linting code: Running pre-commit";\ + uv run --no-sources pre-commit run -a;\ + fi + @echo "🚀 Static type checking: Running mypy" + @uv run --no-sources mypy --config-file=pyproject.toml \ No newline at end of file diff --git a/servers/entrata_api/README.md b/servers/entrata_api/README.md new file mode 100644 index 00000000..9ef14ccd --- /dev/null +++ b/servers/entrata_api/README.md @@ -0,0 +1,25 @@ +
+ +
+ +
+ Python version + License + PyPI version +
+ + +
+
+ +# Arcade entrata_api Toolkit +## Features + +- The entrata_api toolkit does not have any features yet. + +## Development + +Read the docs on how to create a toolkit [here](https://docs.arcade.dev/home/build-tools/create-a-toolkit) \ No newline at end of file diff --git a/servers/entrata_api/arcade_entrata_api/__init__.py b/servers/entrata_api/arcade_entrata_api/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/servers/entrata_api/arcade_entrata_api/moar/Entrata.json b/servers/entrata_api/arcade_entrata_api/moar/Entrata.json new file mode 100644 index 00000000..90fada00 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/moar/Entrata.json @@ -0,0 +1,18704 @@ +{ + "name": "Entrata", + "spec_source": "openapi_spec", + "token_for_http_testing": "", + "package_name": "entrata_api", + "package_dir_path": "/Users/rb/arcade/starter-tools/servers/entrata_api/arcade_entrata_api", + "project_dir_path": "/Users/rb/arcade/starter-tools/servers/entrata_api", + "arcade_new_cmd_executed": true, + "api_endpoint_selection_customized": false, + "api_endpoint_for_http_testing": "", + "authorization_type": "api_key", + "auth_provider_id": "", + "where_to_provide_token": "unknown", + "token_key_name": "", + "token_value": "", + "secrets": [ + { + "arcade_key_name": "ENTRATA_API_KEY", + "service_key_name": "X-Api-Key", + "where_to_provide": "header", + "formatted_value": null + }, + { + "arcade_key_name": "ENTRATA_DOMAIN", + "service_key_name": "entrata_domain", + "where_to_provide": "path", + "formatted_value": null + } + ], + "global_base_url": null, + "global_headers": {}, + "edit_operations": [], + "uuid": "508fae8a-a437-4374-8fb0-cf155fff3054", + "api_endpoints": [ + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "check_api_health", + "description": { + "tagline": "Check the health status of the API service.", + "detailed": "Use this tool to verify the current health status of the API service. This can help in determining if the service is operational and responsive." + }, + "return_annotation": "The health status of the API service.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_domain", + "subdomain_name" + ], + "description": "The subdomain of the client organization to check the API health for.", + "endpoint_argument_name": "orgs" + }, + { + "name": "authentication_type", + "alternative_names": [ + "auth_method", + "authorization_type" + ], + "description": "The authentication method used, typically 'apikey'.", + "endpoint_argument_name": "auth.type" + }, + { + "name": "method_name", + "alternative_names": [ + "api_method_name", + "operation_name" + ], + "description": "The method name for the API operation. Use 'getStatus' to check health.", + "endpoint_argument_name": "method.name" + }, + { + "name": "response_identifier", + "alternative_names": [ + "response_correlation_id", + "request_tracker" + ], + "description": "An arbitrary string value to link the request with its corresponding response.", + "endpoint_argument_name": "requestId" + }, + { + "name": "api_method_version", + "alternative_names": [ + "method_version", + "version_identifier" + ], + "description": "Specify the version of the API method to use. The default and only supported value is 'r1'.", + "endpoint_argument_name": "method.version" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/status", + "tags": [ + "status" + ], + "summary": "API Health check", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "auth.type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "apikey" + ] + }, + "schema_required": true + }, + { + "name": "requestId", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "description": "an arbitary value to relate with response.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "schema_required": false + }, + { + "name": "method.name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getStatus" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "getStatus" + ] + }, + "schema_required": true + }, + { + "name": "method.version", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "r1" + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"This API will specify the API health status whether it is running or not.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getStatus\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n \"examples\": {\n \"getStatus\": {\n \"$ref\": \"#/components/examples/getStatusRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "submit_application", + "description": { + "tagline": "Submit an application to the specified organization.", + "detailed": "This tool is used to submit applications to a specified organization using the Entrata service. It should be called when an application needs to be sent for processing." + }, + "return_annotation": "Confirmation of application submission.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "org_subdomain" + ], + "description": "The subdomain of the client to which the application is submitted.", + "endpoint_argument_name": "orgs" + }, + { + "name": "application_data", + "alternative_names": [ + "application_details", + "application_information" + ], + "description": "JSON array containing the application details to be submitted. Include all necessary information relevant to the application.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/applications", + "tags": [ + "applications" + ], + "summary": "Applications", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Application related APIs" + }, + "description": "Application related APIs", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCompanyApplications" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "int64", + "example": 123456 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicantGeneralDetails" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "applicantId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "isTrue": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "comments": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "Test Comments" + } + }, + "required": [ + "applicationId", + "propertyId", + "applicantId", + "id" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplication" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "originatingLeadSourceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "leasingAgentId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 445655 + }, + "unitSpaceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 1234 + }, + "moveInDate": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "floorplanId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 205814 + }, + "leaseTermId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 1862 + }, + "applicationStatusId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Acceptable values are 3 (COMPLETED ) & 4 (APPLICATION_APPROVED )", + "format": "int64", + "example": 3 + } + }, + "required": [ + "propertyId", + "originatingLeadSourceId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationEmployers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value.", + "format": "int64", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value.", + "format": "int64", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer record.", + "format": "int64", + "example": 123456 + }, + "incomeTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required.", + "format": "int64", + "example": 1 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required.", + "format": "int64", + "example": 17378378 + }, + "frequencyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range which are: 3 [ weekly ], 4 [ Monthly ] and 6 [ Yearly ]", + "format": "int64", + "example": 4 + }, + "position": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "Technical Manager" + }, + "institutionName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "Entrata Inc." + }, + "institutionPhoneNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.", + "format": "string", + "example": "7544898565" + }, + "institutionStreetLine1": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "address line 1" + }, + "institutionStreetLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "address line 2" + }, + "institutionStreetLine3": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "address line 3" + }, + "institutionCity": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "City" + }, + "institutionStateCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "XYZ" + }, + "institutionProvince": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "XYZ" + }, + "institutionPostalCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "11111" + }, + "institutionCountryCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "ABC" + }, + "amount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required.", + "format": "float", + "example": 5000 + }, + "contactName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "People Ops team" + }, + "contactPhone": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.", + "format": "string", + "example": "9954809807" + }, + "contactEmail": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value", + "format": "string", + "example": "hr@example.lcl" + }, + "incomeEffectiveDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "dateStarted": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "dateEnded": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "isDelete": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n.", + "format": "integer", + "example": "1" + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationPets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value.", + "format": "int64", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value.", + "format": "int64", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided we will update the pet record", + "format": "int64", + "example": 123 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally required. Accepts integer value. If id is not provided, this parameter is required", + "format": "int64", + "example": 123456 + }, + "typeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 17378378 + }, + "name": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "breed": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "gender": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "F" + }, + "color": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "White" + }, + "weight": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "float", + "example": "30.99" + }, + "age": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": "12" + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test Description." + }, + "licenseCity": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "XYZ" + }, + "licenseNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "156" + }, + "isAssistanceAnimal": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isPetSpayedOrNeutered": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "petSpayedOrNeuteredDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "isHouseBroken": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "specialProvisions": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test" + }, + "isDelete": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vehicleTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Indicates the type of vehicle. Possible values are 1, 2, or 3 where 1 = Primary, 2 = Secondary, and 3 = Other.", + "format": "int64", + "example": 2 + } + }, + "required": [ + "vehicleTypeId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts application id which needs to be updated.", + "format": "int64", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts the property id.", + "format": "int64", + "example": 123456 + }, + "applicationStatusId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accept the status id.", + "format": "int64", + "example": 3 + }, + "floorplanId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accept the associated floorplan id or the floorplan which ne eds to be associated with the application.", + "format": "int64", + "example": 1235 + }, + "unitSpaceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accept the associated unit space id or the unit space which needs to be associated with the application.", + "format": "int64", + "example": 1442 + }, + "leaseTermId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts the lease length.", + "format": "int64", + "example": 4 + }, + "leasingAgentId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts the associated leasing agent or the leasing agent wh ich needs to be updated.", + "format": "int64", + "example": 147896 + }, + "moveInDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts the move-in date. In ISO format as well.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "originatingLeadSourceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts the lead source id.", + "format": "int64", + "example": 8521 + }, + "id": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants id.", + "format": "int64", + "example": 7893 + }, + "firstName": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants first name.", + "format": "string", + "example": "ABC" + }, + "lastName": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This node accepts applicants last name.", + "format": "string", + "example": "ABC" + }, + "maternalName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts applicants maternal name.", + "format": "string", + "example": "ABC" + }, + "preferredName": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This node accepts applicants preferred name.", + "format": "string", + "example": "ABC" + }, + "birthDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts applicants birth date. Supports ISO format.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "customerRelationshipTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts customer relationship id.", + "format": "int64", + "example": "1264" + }, + "email": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants email.", + "format": "string", + "example": "test@gmail.com" + }, + "phoneNumberTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number type id. This is condition al mandatory node, if phoneNumber is provided then phoneNumberTypeId is required.", + "format": "int64", + "example": "3" + }, + "phoneNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number. This is conditional manda tory node, if value for phoneNumberTypeId is provided then this node is required.", + "format": "int64", + "example": "(123)-111-1111" + }, + "addressTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts address type id.", + "format": "int64", + "example": "11" + }, + "addressLine1": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "addressLine1" + }, + "addressLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "addressLine2" + }, + "addressLine3": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "addressLine3" + }, + "city": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "City" + }, + "postalCode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": "12345" + }, + "stateCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "CA" + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Application related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCompanyApplications\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicantGeneralDetails\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicantId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isTrue\": {\n \"type\": \"integer\",\n \"enum\": [\n 0,\n 1\n ]\n },\n \"comments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Comments\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\",\n \"applicantId\",\n \"id\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplication\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"originatingLeadSourceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 445655,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 205814,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1862,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationStatusId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. Acceptable values are 3 (COMPLETED ) & 4 (APPLICATION_APPROVED )\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"originatingLeadSourceId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationAddOns\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationEmployers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer record.\"\n },\n \"incomeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If \\\"id\\\" is not provided, this parame ter is required.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 17378378,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If \\\"id\\\" is not provided, this parame ter is required.\"\n },\n \"frequencyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 4,\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range which are: 3 [ weekly ], 4 [ Monthly ] and 6 [ Yearly ]\"\n },\n \"position\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Technical Manager\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Entrata Inc.\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionPhoneNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"7544898565\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.\"\n },\n \"institutionStreetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 1\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStreetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 2\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStreetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 3\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionCity\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"City\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionProvince\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionPostalCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"11111\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionCountryCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required.\"\n },\n \"contactName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"People Ops team\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"9954809807\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.\"\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"hr@example.lcl\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"incomeEffectiveDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.\"\n },\n \"dateStarted\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.\"\n },\n \"dateEnded\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded.\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationPets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided we will update the pet record\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required. Accepts integer value. If id is not provided, this parameter is required\"\n },\n \"typeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 17378378,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"breed\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"gender\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"F\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"color\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"White\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"weight\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"30.99\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"age\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Description.\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"licenseCity\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"licenseNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"156\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isAssistanceAnimal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPetSpayedOrNeutered\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"petSpayedOrNeuteredDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isHouseBroken\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"specialProvisions\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vehicleTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. Indicates the type of vehicle. Possible values are 1, 2, or 3 where 1 = Primary, 2 = Secondary, and 3 = Other.\"\n }\n },\n \"required\": [\n \"vehicleTypeId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node accepts application id which needs to be updated.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node accepts the property id.\"\n },\n \"applicationStatusId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the status id.\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1235,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the associated floorplan id or the floorplan which ne eds to be associated with the application.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1442,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the associated unit space id or the unit space which needs to be associated with the application.\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 4,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the lease length.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 147896,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the associated leasing agent or the leasing agent wh ich needs to be updated.\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the move-in date. In ISO format as well.\"\n },\n \"originatingLeadSourceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 8521,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the lead source id.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 7893,\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants id.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants first name.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts applicants last name.\"\n },\n \"maternalName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants maternal name.\"\n },\n \"preferredName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts applicants preferred name.\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants birth date. Supports ISO format.\"\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1264\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts customer relationship id.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"test@gmail.com\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants email.\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants phone number type id. This is condition al mandatory node, if phoneNumber is provided then phoneNumberTypeId is required.\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"(123)-111-1111\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants phone number. This is conditional manda tory node, if value for phoneNumberTypeId is provided then this node is required.\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"11\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts address type id.\"\n },\n \"addressLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine1\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine2\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine3\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"City\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CA\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCompanyApplications\": {\n \"$ref\": \"#/components/examples/getCompanyApplicationsRequest\"\n },\n \"sendApplicantGeneralDetails\": {\n \"$ref\": \"#/components/examples/sendApplicantGeneralDetailsRequest\"\n },\n \"sendApplication\": {\n \"$ref\": \"#/components/examples/sendApplicationRequest\"\n },\n \"sendApplicationAddOns\": {\n \"$ref\": \"#/components/examples/sendApplicationAddOnsRequest\"\n },\n \"sendApplicationEmployers\": {\n \"$ref\": \"#/components/examples/sendApplicationEmployersRequest\"\n },\n \"sendApplicationPets\": {\n \"$ref\": \"#/components/examples/sendApplicationPetsRequest\"\n },\n \"sendApplicationVehicles\": {\n \"$ref\": \"#/components/examples/sendApplicationVehiclesRequest\"\n },\n \"updateApplication\": {\n \"$ref\": \"#/components/examples/updateApplicationRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_accessible_clients", + "description": { + "tagline": "Retrieve accessible client information for a given organization.", + "detailed": "Use this tool to get information about clients accessible to an organization. Call it when you need to retrieve details about clients linked to the organization using the `rsync` value for `orgs`." + }, + "return_annotation": "Information about accessible clients for the organization.", + "arguments": [ + { + "name": "organization_subdomain", + "alternative_names": [ + "client_subdomain", + "subdomain_identifier" + ], + "description": "The subdomain of the client organization. Use 'rsync' as the value to access relevant client information.", + "endpoint_argument_name": "orgs" + }, + { + "name": "request_body_data", + "alternative_names": [ + "request_body_content", + "body_payload" + ], + "description": "An array of JSON objects to include in the request body for additional data required by the API.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/appinfo", + "tags": [ + "appinfo" + ], + "summary": "App info related APIs", + "description": "Please use `rsync` as the orgs value when calling the getAccessibleClients API.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleClients" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleServices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAccessibleClients\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAccessibleServices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAccessibleClients\": {\n \"$ref\": \"#/components/examples/getAccessibleClientsRequest\"\n },\n \"getAccessibleServices\": {\n \"$ref\": \"#/components/examples/getAccessibleServicesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_ar_codes", + "description": { + "tagline": "Retrieve AR codes for a management company.", + "detailed": "Fetches all AR codes associated with a specific management company, useful for property management and financial operations." + }, + "return_annotation": "List of AR codes for the specified management company.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "management_company_subdomain" + ], + "description": "Client subdomain, used to specify the management company.", + "endpoint_argument_name": "orgs" + }, + { + "name": "authentication_type", + "alternative_names": [ + "auth_type", + "authorization_method" + ], + "description": "Specify the authentication type, expected value is 'apikey'.", + "endpoint_argument_name": "auth.type" + }, + { + "name": "ar_codes_method_name", + "alternative_names": [ + "ar_codes_method", + "method_name_for_ar_codes" + ], + "description": "Must be set to 'getArCodes' to specify the API method for retrieving AR codes.", + "endpoint_argument_name": "method.name" + }, + { + "name": "response_identifier", + "alternative_names": [ + "response_id", + "tracking_id" + ], + "description": "An arbitrary string value used to relate the request with the response.", + "endpoint_argument_name": "requestId" + }, + { + "name": "api_method_version", + "alternative_names": [ + "method_version", + "version" + ], + "description": "Specifies the version of the API method to use. Supported value is 'r1'.", + "endpoint_argument_name": "method.version" + }, + { + "name": "property_id", + "alternative_names": [ + "property_identifier", + "single_property_id" + ], + "description": "Optional. Provide a valid property ID for which AR codes are required.", + "endpoint_argument_name": "method.params.propertyId" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/arcodes", + "tags": [ + "arcodes" + ], + "summary": "Charge codes", + "description": "Returns all AR codes for a specified management company.", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "auth.type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "apikey" + ] + }, + "schema_required": true + }, + { + "name": "requestId", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "description": "an arbitary value to relate with response.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "schema_required": false + }, + { + "name": "method.name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArCodes" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "getArCodes" + ] + }, + "schema_required": true + }, + { + "name": "method.version", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "r1" + ] + }, + "schema_required": false + }, + { + "name": "method.params.propertyId", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid." + }, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid.", + "format": "int64", + "example": 123456 + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Returns all AR codes for a specified management company.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArCodes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid propertyid.\"\n }\n }\n }\n }\n }\n }\n },\n \"examples\": {\n \"getArCodes\": {\n \"$ref\": \"#/components/examples/getArCodesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "submit_ar_payments", + "description": { + "tagline": "Submits accounts receivable payments for processing.", + "detailed": "Use this tool to submit accounts receivable payments to Entrata for processing. It confirms the successful submission of payment data." + }, + "return_annotation": "Confirms the submission of accounts receivable payments.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "company_subdomain" + ], + "description": "The subdomain of the client organization using the Entrata service.", + "endpoint_argument_name": "orgs" + }, + { + "name": "authentication_type", + "alternative_names": [ + "auth_method", + "authorization_type" + ], + "description": "Set the type of authentication. Accepted value: 'apikey'.", + "endpoint_argument_name": "auth.type" + }, + { + "name": "method_name_for_ar_payments", + "alternative_names": [ + "ar_payment_method_name", + "payment_method_action" + ], + "description": "Specifies the method name for accounts receivable payments. Use 'getArPayments' to retrieve AR payments.", + "endpoint_argument_name": "method.name" + }, + { + "name": "response_correlation_id", + "alternative_names": [ + "response_tracking_id", + "response_reference_id" + ], + "description": "An arbitrary value used to correlate and track the response.", + "endpoint_argument_name": "requestId" + }, + { + "name": "api_version", + "alternative_names": [ + "version_number", + "api_version_code" + ], + "description": "Specify the version of the API to use, options: ['r1'].", + "endpoint_argument_name": "method.version" + }, + { + "name": "ar_payment_ids", + "alternative_names": [ + "accounts_receivable_ids", + "payment_identifiers" + ], + "description": "Optional. Comma-separated list of accounts receivable payment IDs for processing.", + "endpoint_argument_name": "method.params.arPaymentIds" + }, + { + "name": "payment_status_type_identifiers", + "alternative_names": [ + "payment_status_ids", + "status_type_ids" + ], + "description": "Optional. Comma-separated IDs representing payment status types.", + "endpoint_argument_name": "method.params.paymentStatusTypeIds" + }, + { + "name": "from_date", + "alternative_names": [ + "start_date", + "begin_date" + ], + "description": "Optional. Accepts a single date value that represents the starting point for the query in YYYY-MM-DD format.", + "endpoint_argument_name": "method.params.fromDate" + }, + { + "name": "to_date", + "alternative_names": [ + "end_date", + "completion_date" + ], + "description": "Optional field specifying the end date for the request. Accepts a single date value.", + "endpoint_argument_name": "method.params.toDate" + }, + { + "name": "include_allocations", + "alternative_names": [ + "allocations_details", + "payment_allocations" + ], + "description": "Optional. Set to 1 to include allocations details of payment; 0 otherwise.", + "endpoint_argument_name": "method.params.isIncludeAllocations" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/arpayments", + "tags": [ + "arpayments" + ], + "summary": "arPayments", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "auth.type", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "apikey" + ] + }, + "schema_required": true + }, + { + "name": "requestId", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "description": "an arbitary value to relate with response.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "schema_required": false + }, + { + "name": "method.name", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArPayments" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "getArPayments" + ] + }, + "schema_required": true + }, + { + "name": "method.version", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "description": "", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "enum": [ + "r1" + ] + }, + "schema_required": false + }, + { + "name": "method.params.arPaymentIds", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids." + }, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids.", + "format": "string", + "example": 123456 + }, + "schema_required": false + }, + { + "name": "method.params.paymentStatusTypeIds", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids." + }, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids.", + "format": "string", + "example": 123456 + }, + "schema_required": false + }, + { + "name": "method.params.fromDate", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. From date." + }, + "description": "This is an optional field. This field accepts single value. From date.", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "This is an optional field. This field accepts single value. From date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "schema_required": false + }, + { + "name": "method.params.toDate", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. To date" + }, + "description": "This is an optional field. This field accepts single value. To date", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "string", + "description": "This is an optional field. This field accepts single value. To date", + "format": "date", + "example": "MM/DD/YYYY" + }, + "schema_required": false + }, + { + "name": "method.params.isIncludeAllocations", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment" + }, + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment", + "required": false, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Retrieves AR payments details with reference to a Payment ID and for a selected date range.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArPayments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"arPaymentIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids.\"\n },\n \"paymentStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From date.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. To date\"\n },\n \"isIncludeAllocations\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node should include allocations details of payment\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n \"examples\": {\n \"getArPayments\": {\n \"$ref\": \"#/components/examples/getArPaymentsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": true, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_ar_transactions", + "description": { + "tagline": "Fetches accounts receivable transactions for an organization.", + "detailed": "Use this tool to retrieve accounts receivable transactions by providing the organization identifier." + }, + "return_annotation": "Provides a list of accounts receivable transactions.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "client_org_identifier" + ], + "description": "The unique subdomain identifying the client organization for which the accounts receivable transactions are being fetched.", + "endpoint_argument_name": "orgs" + }, + { + "name": "ar_transactions_request_body", + "alternative_names": [ + "ar_transactions_parameters", + "ar_transactions_payload" + ], + "description": "Specify the array of transaction-related API request data in JSON format.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "page_index", + "pagination_page_no" + ], + "description": "The page number to retrieve for paginated responses.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "results_per_page", + "entries_per_page" + ], + "description": "Specifies the number of items returned in the response for each page of pagination.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "pagination_links", + "send_pagination_links" + ], + "description": "Set to 1 to include pagination links in the response body, 0 to exclude.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/artransactions", + "tags": [ + "artransactions" + ], + "summary": "This API is to get the information of transactions and payments.", + "description": "## Note: \n **Pagination supported APIs**: `getArInvoices`, `getLeaseArTransactions`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arTansactions related APIs" + }, + "description": "arTansactions related APIs", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "int64", + "example": 123456 + }, + "leaseIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds", + "format": "string", + "example": 123456 + }, + "arInvoiceId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. arInvoiceId", + "format": "int64", + "example": 123456 + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. From date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. To date", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. PropertyId", + "format": "int64", + "example": 123456 + }, + "leaseIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds", + "format": "int64", + "example": "1234,5678" + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.", + "format": "int64", + "example": "3,4" + }, + "transactionTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12", + "format": "int64", + "example": "12345,4567" + }, + "arCodeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds", + "format": "int64", + "example": "12345,4567" + }, + "showFullLedger": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeOtherIncomeLeases": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeReversals": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be t rue(1).", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "transactionFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will return transactions starting from the provided date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "transactionToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will return transaction till the provided date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "ledgerIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList.", + "format": "int64", + "example": "12345,4567" + }, + "residentFriendlyMode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. PropertyId", + "format": "int64", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. leaseId", + "format": "int64", + "example": "1234" + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.", + "format": "int64", + "example": "3,4" + }, + "arCodeIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds", + "format": "string", + "example": "1234,5678" + }, + "showFullLedger": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeReversals": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be true(1).", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "residentFriendlyMode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull ledger history as displayed under resident portal", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeOtherIncomeLeases": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includePaymentsOnly": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This parameter is used to retrieve payments transactions in the response", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "transactionFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. transactionFromDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "transactionToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. transactionToDate", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactionReversals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "TransactionId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This ID represents the \"reference_id\" provided in the sendLeaseArTrans actions response or the \"TransactionID\" provided in getMitsLeaseArTran sactions.", + "format": "int64", + "example": 1234 + }, + "TransactionAmount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. The amount for which the original charge was posted. If the Original c harge was a negative charge, a credit, please send this amount as nega tive as well.", + "format": "float", + "example": "100.50" + }, + "PropertyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "ReverseDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. If a date is sent in this parameter, we will set this value as postDate for the reversed transactions.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "Description": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. We highly recommend that you provide a detailed description of the reason for which the charged is reversed.", + "format": "string", + "example": "Test Description" + } + }, + "required": [ + "TransactionId", + "TransactionAmount" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "transactionId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Unique Transaction ID of client system", + "format": "int64", + "example": 1234 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Lease ID", + "format": "integer", + "example": "2342" + }, + "arCodeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Ar Code ID", + "format": "int64", + "example": 11 + }, + "transactionAmount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Transaction Amount", + "format": "float", + "example": "1000.00" + }, + "transactionDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. transactionDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "arPostMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Charge Posting Month", + "format": "string", + "example": "MM/YYYY" + } + }, + "required": [ + "transactionId", + "leaseId", + "arCodeId", + "transactionAmount", + "transactionDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arTansactions related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArInvoices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. leaseIds\"\n },\n \"arInvoiceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value. arInvoiceId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From date.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. To date\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. leaseIds\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.\"\n },\n \"transactionTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12\"\n },\n \"arCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. arCodeIds\"\n },\n \"showFullLedger\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.\"\n },\n \"includeReversals\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \\\"showFullLedger\\\" must be t rue(1).\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will return transactions starting from the provided date.\"\n },\n \"transactionToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will return transaction till the provided date.\"\n },\n \"ledgerIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. leaseId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.\"\n },\n \"arCodeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. arCodeIds\"\n },\n \"showFullLedger\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.\"\n },\n \"includeReversals\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \\\"showFullLedger\\\" must be true(1).\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull ledger history as displayed under resident portal\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.\"\n },\n \"includePaymentsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to retrieve payments transactions in the response\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionFromDate\"\n },\n \"transactionToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionToDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseArTransactionReversals\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"TransactionId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. This ID represents the \\\"reference_id\\\" provided in the sendLeaseArTrans actions response or the \\\"TransactionID\\\" provided in getMitsLeaseArTran sactions.\"\n },\n \"TransactionAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"100.50\",\n \"description\": \"This is a required field. This field accepts single value. The amount for which the original charge was posted. If the Original c harge was a negative charge, a credit, please send this amount as nega tive as well.\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"ReverseDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is an optional parameter. If a date is sent in this parameter, we will set this value as postDate for the reversed transactions.\"\n },\n \"Description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Description\",\n \"description\": \"This is an optional field. This field accepts single value. This is an optional parameter. We highly recommend that you provide a detailed description of the reason for which the charged is reversed.\"\n }\n },\n \"required\": [\n \"TransactionId\",\n \"TransactionAmount\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"transactionId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Unique Transaction ID of client system\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"2342\",\n \"description\": \"This is a required field. This field accepts single value. Lease ID\"\n },\n \"arCodeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 11,\n \"description\": \"This is a required field. This field accepts single value. Ar Code ID\"\n },\n \"transactionAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"1000.00\",\n \"description\": \"This is a required field. This field accepts single value. Transaction Amount\"\n },\n \"transactionDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. transactionDate\"\n },\n \"arPostMonth\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Charge Posting Month\"\n }\n },\n \"required\": [\n \"transactionId\",\n \"leaseId\",\n \"arCodeId\",\n \"transactionAmount\",\n \"transactionDate\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getArInvoices\": {\n \"$ref\": \"#/components/examples/getArInvoicesRequest\"\n },\n \"getLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/getLeaseArTransactionsRequest\"\n },\n \"getMitsLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/getMitsLeaseArTransactionsRequest\"\n },\n \"sendLeaseArTransactionReversals\": {\n \"$ref\": \"#/components/examples/sendLeaseArTransactionReversalsRequest\"\n },\n \"sendLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/sendLeaseArTransactionsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "send_communication_message", + "description": { + "tagline": "Send communication messages via the Entrata Communications API.", + "detailed": "This tool sends communication messages using the Entrata Communications API. It should be called when a user wants to send a message to a specified organization. The tool performs a POST request to the specified endpoint to deliver the message and receives a confirmation of the communication being sent." + }, + "return_annotation": "Confirmation of communication message sent", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "client_org" + ], + "description": "The subdomain of the client organization where the communication message will be sent.", + "endpoint_argument_name": "orgs" + }, + { + "name": "communication_messages_payload", + "alternative_names": [ + "communication_data", + "message_details" + ], + "description": "JSON array containing details for arPayment-related communications.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/communications", + "tags": [ + "communications" + ], + "summary": "Communications", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "description": "arPayment related APIs", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferencePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferences" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "customerIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. Customer Ids", + "format": "string", + "example": "1234,2342" + }, + "recipientTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Possible values are 1 = Lead 2 = Resident", + "format": "int64", + "example": 11 + } + }, + "required": [ + "propertyId", + "customerIds", + "arCodeId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMarketingPreferencePickList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMarketingPreferences\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,2342\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. Customer Ids\"\n },\n \"recipientTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 11,\n \"description\": \"This is a required field. This field accepts single value. Possible values are 1 = Lead 2 = Resident\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"customerIds\",\n \"arCodeId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getMarketingPreferencePickList\": {\n \"$ref\": \"#/components/examples/getMarketingPreferencePickListRequest\"\n },\n \"getMarketingPreferences\": {\n \"$ref\": \"#/components/examples/getMarketingPreferencesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_customer_profile", + "description": { + "tagline": "Create a new customer profile in the Entrata system.", + "detailed": "Use this tool to add a new customer profile to the Entrata database for a specific organization. Useful for handling customer onboarding processes." + }, + "return_annotation": "Confirmation of customer profile creation.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "subdomain" + ], + "description": "The unique subdomain of the client organization in the Entrata system.", + "endpoint_argument_name": "orgs" + }, + { + "name": "customer_payment_info", + "alternative_names": [ + "customer_payment_data", + "customer_payment_details" + ], + "description": "A JSON array containing AR payment-related information for the customer profile creation.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/customers", + "tags": [ + "customers" + ], + "summary": "Customers", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "description": "arPayment related APIs", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "int64", + "example": 123456 + }, + "customerIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Customer Ids", + "format": "string", + "example": "1234,5678,9865" + }, + "leaseStatusTypeIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Lease Status types", + "format": "string", + "example": "1,2" + }, + "isAgreedToTermsOnly": { + "type": "boolean", + "example": "1" + }, + "companyIdentificationTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. company Identification type IDs", + "format": "int64", + "example": 123456 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Property id", + "format": "int64", + "example": 123456 + }, + "isApproved": { + "type": "boolean" + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials from this date", + "format": "date", + "example": "MM/DD/YYY" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials until this date", + "format": "date", + "example": "MM/DD/YYY" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTestimonialPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "searchCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id. This is system ID associated with each property.", + "format": "int64", + "example": 123456 + }, + "search": { + "type": "string", + "description": "This is a required field. This field accepts single value. Search string accepts phone number, name, building, unit, secondary number.", + "format": "string", + "example": "Thornberry" + } + }, + "required": [ + "propertyId", + "search" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "CustomerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Customer Id.", + "format": "int64", + "example": 123456 + }, + "TestimonialTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. The following are valid testimonial type ids: 1 Resident testimonial 2 Employee testimonial 3 Client testimonial 4 Vacancy 5 Apartmentr atings.com 6 Yelp.com 7 atlanta.citysearch.com", + "format": "int64", + "example": 123456 + }, + "Name": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Name of a person who submitted the testi monial.", + "format": "string", + "example": "Bryan Murfy" + }, + "Title": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Title of testimonial.", + "format": "string", + "example": "So far a great experience" + }, + "Review": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Review content.", + "format": "string", + "example": "This is a nice community that makes you feel like you are a valued memeber." + }, + "RecommendToFriend": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Do you recommend this property to any friend?.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "AuthorizeToShowOnCorporateSites": { + "type": "boolean", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Do you authorize property manager to dis play your testimonial on its portal and affiliate websites?.", + "example": "1" + }, + "RatingTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. The following are valid testimonial rating types ids: 1 Parking 2 No ise 3 Grounds 5 Construction 6 Maintenance 7 Staff 8 Overall", + "format": "int64", + "example": "1" + }, + "Rating": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of TestimonialRatings. Rating value.", + "format": "int64", + "example": "3" + }, + "AutoApproveForProspectPortal": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on prospect portal.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "AutoApproveForVacancy": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on vacany.com", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "PropertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "int64", + "example": 123456 + }, + "TestimonialDatetime": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Testimonial submission date.", + "format": "date", + "example": "MM/DD/YYY" + }, + "TransmissionVendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Transmission Vendor Id", + "format": "int64", + "example": 123456 + }, + "Email": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Email will be required if CustomerId is not provided. Child element of Testimonial. Email of a person who submitted the testimonial.", + "format": "string", + "example": "br@mycomp.com" + }, + "PropertyResponse": { + "type": "string", + "description": "This is an optional field. This field accepts single value. The property`s response to the review.", + "format": "string", + "example": "Property Response..." + } + }, + "required": [ + "TestimonialTypeId", + "Title", + "Review", + "AuthorizeToShowOnCorporateSites", + "RatingTypeId", + "Rating", + "PropertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This should be the unique ID of the customer to be updated and they mu st be in at least an applicant or higher lease status.", + "format": "int64", + "example": 31025784 + }, + "firstName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Ephraim" + }, + "lastName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Kassulke" + }, + "namePrefix": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Ms." + }, + "middleName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Emie" + }, + "maidenName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "MaidenName" + }, + "nameSuffix": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "III" + }, + "email": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Carson87@example.org" + }, + "birthDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY/MM/DD" + }, + "taxNumberTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 9 + }, + "taxNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": "844-588-2283" + }, + "addressTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 8 + }, + "streetLine1": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "3927 Austen Groves" + }, + "streetLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "43853 Thompson Rapids" + }, + "streetLine3": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "085 Weber Streets" + }, + "city": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Streichtown" + }, + "country": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "US" + }, + "state": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "CA" + }, + "postalCode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 22222 + }, + "phoneNumberTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 2 + }, + "isPrimary": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 1 + }, + "phoneNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": "1231231234" + }, + "companyIdentificationTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 5587 + }, + "identificationValue": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "688" + }, + "idExpirationDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY/MM/DD" + }, + "StateCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "GN" + }, + "countryCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. \"countryCode\" is accepted under \"companyIdentificationValue\" node.", + "format": "string", + "example": "Guinea" + } + }, + "required": [ + "id" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "transmissionVendorId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 12 + }, + "testimonialId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 12345 + }, + "isPublished": { + "type": "boolean", + "description": "This is a required field. This field accepts single value.", + "example": "1" + } + }, + "required": [ + "propertyId", + "transmissionVendorId", + "isPublished" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyResponse" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": 123456 + }, + "testimonialId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 12345 + }, + "reviewResponse": { + "type": "string", + "description": "Test Review Response", + "format": "string", + "example": 12345 + }, + "isPublish": { + "type": "boolean", + "description": "This is a required field. This field accepts single value.", + "example": "1" + } + }, + "required": [ + "propertyId", + "testimonialId", + "isPublish" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678,9865\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Customer Ids\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Lease Status types\"\n },\n \"isAgreedToTermsOnly\": {\n \"type\": \"boolean\",\n \"example\": \"1\"\n },\n \"companyIdentificationTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. company Identification type IDs\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Property id\"\n },\n \"isApproved\": {\n \"type\": \"boolean\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will fetch the testimonials from this date\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will fetch the testimonials until this date\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTestimonialPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"searchCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id. This is system ID associated with each property.\"\n },\n \"search\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Thornberry\",\n \"description\": \"This is a required field. This field accepts single value. Search string accepts phone number, name, building, unit, secondary number.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"search\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"CustomerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Customer Id.\"\n },\n \"TestimonialTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. The following are valid testimonial type ids: 1 Resident testimonial 2 Employee testimonial 3 Client testimonial 4 Vacancy 5 Apartmentr atings.com 6 Yelp.com 7 atlanta.citysearch.com\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Bryan Murfy\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Name of a person who submitted the testi monial.\"\n },\n \"Title\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"So far a great experience\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Title of testimonial.\"\n },\n \"Review\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"This is a nice community that makes you feel like you are a valued memeber.\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Review content.\"\n },\n \"RecommendToFriend\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Do you recommend this property to any friend?.\"\n },\n \"AuthorizeToShowOnCorporateSites\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Do you authorize property manager to dis play your testimonial on its portal and affiliate websites?.\"\n },\n \"RatingTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value. The following are valid testimonial rating types ids: 1 Parking 2 No ise 3 Grounds 5 Construction 6 Maintenance 7 Staff 8 Overall\"\n },\n \"Rating\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3\",\n \"description\": \"This is a required field. This field accepts single value. Child element of TestimonialRatings. Rating value.\"\n },\n \"AutoApproveForProspectPortal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on prospect portal.\"\n },\n \"AutoApproveForVacancy\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on vacany.com\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"TestimonialDatetime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. Testimonial submission date.\"\n },\n \"TransmissionVendorId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Transmission Vendor Id\"\n },\n \"Email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"br@mycomp.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email will be required if CustomerId is not provided. Child element of Testimonial. Email of a person who submitted the testimonial.\"\n },\n \"PropertyResponse\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Property Response...\",\n \"description\": \"This is an optional field. This field accepts single value. The property`s response to the review.\"\n }\n },\n \"required\": [\n \"TestimonialTypeId\",\n \"Title\",\n \"Review\",\n \"AuthorizeToShowOnCorporateSites\",\n \"RatingTypeId\",\n \"Rating\",\n \"PropertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 31025784,\n \"description\": \"This is a required field. This field accepts single value. This should be the unique ID of the customer to be updated and they mu st be in at least an applicant or higher lease status.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Ephraim\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Kassulke\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"namePrefix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Ms.\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"middleName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Emie\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maidenName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MaidenName\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"nameSuffix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"III\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Carson87@example.org\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY/MM/DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"taxNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 9,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"taxNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"844-588-2283\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"3927 Austen Groves\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"43853 Thompson Rapids\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"085 Weber Streets\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Streichtown\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"country\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"US\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"state\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CA\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 22222,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPrimary\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1231231234\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"companyIdentificationTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 5587,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"identificationValue\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"688\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"idExpirationDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY/MM/DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"StateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"GN\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Guinea\",\n \"description\": \"This is an optional field. This field accepts single value. \\\"countryCode\\\" is accepted under \\\"companyIdentificationValue\\\" node.\"\n }\n },\n \"required\": [\n \"id\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"transmissionVendorId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"testimonialId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPublished\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"transmissionVendorId\",\n \"isPublished\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updatePropertyResponse\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"testimonialId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"reviewResponse\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \"Test Review Response\"\n },\n \"isPublish\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"testimonialId\",\n \"isPublish\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCustomers\": {\n \"$ref\": \"#/components/examples/getCustomersRequest\"\n },\n \"getCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/getCustomerTestimonialsRequest\"\n },\n \"getTestimonialPickLists\": {\n \"$ref\": \"#/components/examples/getTestimonialPickListsRequest\"\n },\n \"searchCustomers\": {\n \"$ref\": \"#/components/examples/searchCustomersRequest\"\n },\n \"sendCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/sendCustomerTestimonialsRequest\"\n },\n \"updateCustomers\": {\n \"$ref\": \"#/components/examples/updateCustomersRequest\"\n },\n \"updateCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/updateCustomerTestimonialsRequest\"\n },\n \"updatePropertyResponse\": {\n \"$ref\": \"#/components/examples/updatePropertyResponseRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_financial_budgets", + "description": { + "tagline": "Fetch financial budgets for organizations.", + "detailed": "Use this tool to retrieve financial budget data for specified organizations through the Entrata service. Supports pagination for large data sets." + }, + "return_annotation": "Financial budgets data for specified organizations.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "org_subdomain" + ], + "description": "The subdomain of the client organization for which to fetch financial budgets.", + "endpoint_argument_name": "orgs" + }, + { + "name": "ar_payment_requests", + "alternative_names": [ + "account_receivable_requests", + "payment_data_requests" + ], + "description": "A list of JSON objects representing AR payment related data for processing. Each JSON object should contain details as required by the specific AR payment APIs.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/financial", + "tags": [ + "financial" + ], + "summary": "Financial", + "description": "## Note: \n **Pagination supported APIs**: `getBudgets`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "description": "arPayment related APIs", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getApCodes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "int64", + "example": "1234,5678" + }, + "apCodeTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. Currently supporting only job cost (3)", + "format": "int64", + "example": "1,2,3" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBankAccounts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "bankAccountTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Bank Account Type Identification Number", + "format": "int64", + "example": "1234,5678" + }, + "isCreditCardAccount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgetActuals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "int64", + "example": "123456" + }, + "glTreeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": "1234" + }, + "budgetId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "int64", + "example": "1234" + }, + "postMonthFrom": { + "type": "string", + "description": "This is a required field. This field accepts single value. MM/YYYY", + "format": "string", + "example": "MM/YYYY" + }, + "postMonthTo": { + "type": "string", + "description": "This is a required field. This field accepts single value. MM/YYYY", + "format": "string", + "example": "MM/YYYY" + }, + "glBookTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. glBookTypeIds", + "format": "int64", + "example": "12345,4567" + }, + "budgetStatusTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. budgetStatusTypeId", + "format": "int64", + "example": "1234" + }, + "accountingMethod": { + "type": "string", + "description": "This is a required field. This field accepts single value. accountingMethod", + "format": "string", + "example": "Cash" + } + }, + "required": [ + "propertyId", + "glTreeId", + "budgetId", + "postMonthFrom", + "postMonthTo" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. propertyIds", + "format": "string", + "example": "12345,4567" + }, + "budgetIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetIds", + "format": "string", + "example": "12345,4567" + }, + "budgetStatusTypeIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetStatusTypeIds", + "format": "string", + "example": "1,2,4" + }, + "fiscalYears": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. fiscalYears", + "format": "string", + "example": "YYYY,YYYY" + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Property Id", + "format": "integer", + "example": "123456" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "123456,112233" + }, + "glAccountFrom": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 1234 + }, + "glAccountTo": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 1234 + }, + "postMonthFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If no post month is provided, then the default post month of the prope rty will be used. If multiple properties are passed then the post mon th of any property would be used randomly.", + "format": "date", + "example": "MM/YYYY" + }, + "postMonthTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/YYYY" + }, + "postDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "postDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "isCashBook": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isDetailed": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "glTreeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "int64", + "example": 1234 + }, + "glBookTypeIds": { + "type": "integer", + "description": " This is an optional field. This field accepts comma seperated multiple values.", + "format": "int64", + "example": "1,2,3" + }, + "transactionDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "transactionDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "excludeApTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag will filter off any ap transactions from the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "excludeArTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag will filter off any Ar Transactions from the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "excludeExportedTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If passed as true (1) the API will not return any transaction that was previously marked exported using the markGlTransactionsExported API. Transaction exported under a different export format in Entrata wil l still qualify to be returned until specifically marked exported over the markGlTransactionsExported API.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "glTreeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Tree Id", + "format": "int64", + "example": 1234 + }, + "glBranchId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Branch Id", + "format": "int64", + "example": 1234 + }, + "glGroupTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Group Type Id", + "format": "int64", + "example": 1 + }, + "glTreeTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id", + "format": "int64", + "example": 1 + }, + "accountNumbers": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "date", + "example": "1234,5678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "glTreeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Tree Id", + "format": "int64", + "example": 1234 + }, + "glBranchId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Branch Id", + "format": "int64", + "example": 1234 + }, + "glGroupTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Group Type Id", + "format": "int64", + "example": 1 + }, + "glTreeTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id", + "format": "int64", + "example": 1 + }, + "accountNumbers": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "date", + "example": "1234,5678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCategories" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. This is the glAccount Id associated with job category", + "format": "integer", + "example": "12345,4567" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCostBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.", + "format": "integer", + "example": "12345,4567" + }, + "jobIds": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.", + "format": "integer", + "example": "12345,4567" + }, + "jobStatusIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept job status Id.", + "format": "integer", + "example": "12345,4567" + }, + "apCodeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept apCode Id", + "format": "integer", + "example": "12345,4567" + }, + "jobPhaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accept job Phase Id", + "format": "integer", + "example": 123 + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node should accept the propertyId.", + "format": "integer", + "example": 123456 + }, + "jobCategoryIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the jobCategoryIds", + "format": "integer", + "example": "6" + }, + "jobStatusIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the job statusIds.", + "format": "integer", + "example": "4" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTransactionTagLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markGlTransactionsExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glDetailId": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "[\"123456\",\"67890\"]" + } + }, + "required": [ + "glDetailId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "budgetName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "budgets name 1" + }, + "fiscalYear": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": "YYYY" + }, + "fiscalStartMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts fiscal start month in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "fiscalEndMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts fiscal end month in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts GL account id.", + "format": "integer", + "example": 123 + }, + "budgetMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "float", + "example": "10.00" + } + }, + "required": [ + "propertyId", + "budgetName", + "fiscalYear", + "fiscalStartMonth", + "fiscalEndMonth", + "id", + "budgetMonth", + "amount" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendJournalEntries" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "glAccountId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "glHeaderTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If the value for glHeaderTypeId is not provided take default as Standard", + "format": "integer", + "example": 1 + }, + "reference": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Enter Journal Entries" + }, + "accountingMethod": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If not provided, the accounting method of \"Both\" is used.", + "format": "string", + "example": "cash" + }, + "glBookId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "postDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If not provided then the default date will be the current date. The pa st date is acceptable", + "format": "date", + "example": "MM/DD/YYYY" + }, + "postMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If not provided then the default will be the current post month. Past post month is acceptable", + "format": "date", + "example": "MM/YYYY" + }, + "isReverse": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. By default value will be false.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "reversePostMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Conditionally required. Based on \"isReverse\" flag.", + "format": "date", + "example": "MM/YYYY" + }, + "routingTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 1234 + }, + "notes": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test Note" + }, + "defaultPropertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "defaultPropertyBuildingId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "defaultGlDimensionId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "memo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test Memo" + }, + "debitAmount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditional Required. If the Credit amount is passed then this should be 0.", + "format": "integer", + "example": "100.00" + }, + "creditAmount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditional Required. If Debit amount is passed this should be 0", + "format": "integer", + "example": "10.00" + }, + "unitSpaceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 123 + }, + "propertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 1234 + }, + "propertyBuildingId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 1234 + }, + "glDimensionId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 123 + }, + "defaultJobPhaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 1233 + }, + "defaultApContractId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 23 + }, + "jobPhaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 23 + }, + "apContractId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 123 + }, + "apCodeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 123 + } + }, + "required": [ + "propertyId", + "glAccountId", + "glBookId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "month": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "float", + "example": "122.88" + } + }, + "required": [ + "propertyId", + "id", + "month", + "amount" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getApCodes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glAccountIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"apCodeTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Currently supporting only job cost (3)\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBankAccounts\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"bankAccountTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts single value. Bank Account Type Identification Number\"\n },\n \"isCreditCardAccount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBudgetActuals\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"123456\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"budgetId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postMonthFrom\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. MM/YYYY\"\n },\n \"postMonthTo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. MM/YYYY\"\n },\n \"glBookTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. glBookTypeIds\"\n },\n \"budgetStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. budgetStatusTypeId\"\n },\n \"accountingMethod\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Cash\",\n \"description\": \"This is a required field. This field accepts single value. accountingMethod\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"glTreeId\",\n \"budgetId\",\n \"postMonthFrom\",\n \"postMonthTo\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. propertyIds\"\n },\n \"budgetIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. budgetIds\"\n },\n \"budgetStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. budgetStatusTypeIds\"\n },\n \"fiscalYears\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"YYYY,YYYY\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. fiscalYears\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. Property Id\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,112233\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n },\n \"glAccountFrom\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glAccountTo\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postMonthFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If no post month is provided, then the default post month of the prope rty will be used. If multiple properties are passed then the post mon th of any property would be used randomly.\"\n },\n \"postMonthTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isCashBook\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isDetailed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glBookTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1,2,3\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"transactionDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the actual system created date of the transaction.\"\n },\n \"transactionDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the actual system created date of the transaction.\"\n },\n \"excludeApTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag will filter off any ap transactions from the response.\"\n },\n \"excludeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag will filter off any Ar Transactions from the response.\"\n },\n \"excludeExportedTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If passed as true (1) the API will not return any transaction that was previously marked exported using the markGlTransactionsExported API. Transaction exported under a different export format in Entrata wil l still qualify to be returned until specifically marked exported over the markGlTransactionsExported API.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTrees\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Property Id\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Id\"\n },\n \"glBranchId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Branch Id\"\n },\n \"glGroupTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Group Type Id\"\n },\n \"glTreeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Type Id\"\n },\n \"accountNumbers\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTrees\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Id\"\n },\n \"glBranchId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Branch Id\"\n },\n \"glGroupTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Group Type Id\"\n },\n \"glTreeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Type Id\"\n },\n \"accountNumbers\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobCategories\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glAccountIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This is the glAccount Id associated with job category\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobCostBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.\"\n },\n \"jobIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.\"\n },\n \"jobStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept job status Id.\"\n },\n \"apCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept apCode Id\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept job Phase Id\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobs\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the propertyId.\"\n },\n \"jobCategoryIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"6\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept the jobCategoryIds\"\n },\n \"jobStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept the job statusIds.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTransactionTagLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"markGlTransactionsExported\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glDetailId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"[\\\"123456\\\",\\\"67890\\\"]\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"glDetailId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"budgetName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"budgets name 1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"fiscalYear\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"fiscalStartMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts fiscal start month in MM/YYYY format.\"\n },\n \"fiscalEndMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts fiscal end month in MM/YYYY format.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. This node accepts GL account id.\"\n },\n \"budgetMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"10.00\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"budgetName\",\n \"fiscalYear\",\n \"fiscalStartMonth\",\n \"fiscalEndMonth\",\n \"id\",\n \"budgetMonth\",\n \"amount\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendJournalEntries\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"glHeaderTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. If the value for glHeaderTypeId is not provided take default as Standard\"\n },\n \"reference\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Enter Journal Entries\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"accountingMethod\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"cash\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided, the accounting method of \\\"Both\\\" is used.\"\n },\n \"glBookId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided then the default date will be the current date. The pa st date is acceptable\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided then the default will be the current post month. Past post month is acceptable\"\n },\n \"isReverse\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. By default value will be false.\"\n },\n \"reversePostMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required. Based on \\\"isReverse\\\" flag.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"notes\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultPropertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultPropertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultGlDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"memo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Memo\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"debitAmount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"100.00\",\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required. If the Credit amount is passed then this should be 0.\"\n },\n \"creditAmount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"10.00\",\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required. If Debit amount is passed this should be 0\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"glDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"defaultJobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1233,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"defaultApContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 23,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 23,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"glAccountId\",\n \"glBookId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"month\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"122.88\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"id\",\n \"month\",\n \"amount\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getApCodes\": {\n \"$ref\": \"#/components/examples/getApCodesRequest\"\n },\n \"getBankAccounts\": {\n \"$ref\": \"#/components/examples/getBankAccountsRequest\"\n },\n \"getBudgetActuals\": {\n \"$ref\": \"#/components/examples/getBudgetActualsRequest\"\n },\n \"getBudgets\": {\n \"$ref\": \"#/components/examples/getBudgetsRequest\"\n },\n \"getFinancialPickListRequest_r1\": {\n \"$ref\": \"#/components/examples/getFinancialPickListRequest_r1\"\n },\n \"getFinancialPickListRequest_r2\": {\n \"$ref\": \"#/components/examples/getFinancialPickListRequest_r2\"\n },\n \"getGlTransactionsRequest\": {\n \"$ref\": \"#/components/examples/getGlTransactionsRequest\"\n },\n \"getGlTreesRequest_r1\": {\n \"$ref\": \"#/components/examples/getGlTreesRequest_r1\"\n },\n \"getGlTreesRequest_r2\": {\n \"$ref\": \"#/components/examples/getGlTreesRequest_r2\"\n },\n \"getJobCategoriesRequest\": {\n \"$ref\": \"#/components/examples/getJobCategoriesRequest\"\n },\n \"getJobCostBudgetsRequest\": {\n \"$ref\": \"#/components/examples/getJobCostBudgetsRequest\"\n },\n \"getJobsRequest\": {\n \"$ref\": \"#/components/examples/getJobsRequest\"\n },\n \"getTransactionTagListsRequest\": {\n \"$ref\": \"#/components/examples/getTransactionTagListsRequest\"\n },\n \"markGlTransactionsExported\": {\n \"$ref\": \"#/components/examples/markGlTransactionsExportedRequest\"\n },\n \"sendBudgets\": {\n \"$ref\": \"#/components/examples/sendBudgetsRequest\"\n },\n \"sendJournalEntries\": {\n \"$ref\": \"#/components/examples/sendJournalEntriesRequest\"\n },\n \"updateBudgets\": {\n \"$ref\": \"#/components/examples/updateBudgetsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_lead_entry", + "description": { + "tagline": "Create a new lead entry in the Entrata system.", + "detailed": "Use this tool to submit a new lead's information to the Entrata system for a specified organization. This action is suitable when new leads need to be captured and stored in the system for follow-up or record-keeping." + }, + "return_annotation": "Confirmation of the lead entry creation.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "client_org_subdomain" + ], + "description": "The subdomain associated with the client organization in Entrata.", + "endpoint_argument_name": "orgs" + }, + { + "name": "lead_information", + "alternative_names": [ + "lead_data", + "new_lead_details" + ], + "description": "An array of JSON objects representing the new lead's details to be added. Each JSON object should contain properties relevant to the lead, such as name, contact information, and any other required fields.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "pagination_page", + "page_index" + ], + "description": "The page number for paginated responses. Use this to specify which page to retrieve when dealing with paginated data.", + "endpoint_argument_name": "page_no" + }, + { + "name": "number_of_items_per_page", + "alternative_names": [ + "items_per_page", + "page_item_limit" + ], + "description": "Specify the number of items to be returned per page in the paginated response.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "pagination_links_enabled", + "return_pagination_links" + ], + "description": "Flag to include pagination links in the response body. Use '1' to enable and '0' to disable.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/leads", + "tags": [ + "leads" + ], + "summary": "Lead related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getLeadEvents, getLeads, getMitsLeads, getQuotes`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leadId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123 + }, + "name": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Accepts combination of Firstname & Lastname to filter leads depending on inputs.", + "format": "string", + "example": "ABC" + }, + "telephone": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Accepts Primary/Work/Home/Mobile number as input.", + "format": "integer", + "example": "1234567890" + }, + "email": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "example@email.com" + }, + "leadStatusIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "psProductIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "includeDemographics": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. In the response, events will not be returned unless we pass specific E vent Type Id(s) in this node. Accepts comma-separated values with lim it 5.", + "format": "integer", + "example": "1,2,3" + }, + "eventDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeadEvents" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditionally required, If eventTypeIds and eventDates are not passed then applicationId is required.", + "format": "integer", + "example": 1234 + }, + "eventTypeIds": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "1,2,3" + }, + "eventDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "applyQuote" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "generateQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.", + "format": "integer", + "example": 1234 + }, + "adjustmentsAndProvisionIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. adjustmentsAndProvisionIds", + "format": "string", + "example": "123,234" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyIds", + "format": "string", + "example": "123456,4533" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 1234 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leadId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Application Id referring PSI system", + "format": "integer", + "example": 123 + }, + "name": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This field accepts a combination of Firstname & Lastname. If either of one is provided, leads matching with given input will be returned in the response.", + "format": "string", + "example": "ABC" + }, + "telephone": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This field accepts Primary/Mobile/Home/Work number of prospect in any format", + "format": "integer", + "example": "1234567890" + }, + "email": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This field accepts email address of prospect.", + "format": "string", + "example": "example@email.com" + }, + "leadStatusIds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. leadStatusIds - comma seperated", + "format": "integer", + "example": "1,2,3" + }, + "psProductIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. psProductIds - comma seperated", + "format": "integer", + "example": "1,2,3" + }, + "eventTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. eventTypeIds - comma seperated", + "format": "integer", + "example": "10,15" + }, + "sendUnitSpaces": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. sendUnitSpaces", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "fromDateTime": { + "type": "string", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field.If name or telephone or email or leadId is provided then fromDate is not required.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDateTime": { + "type": "string", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field. If name or telephone or emai l or leadId is provided then toDate is not required.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. eventDateFrom", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateTo": { + "type": "string", + "description": " This is an optional field. This field accepts single value. eventDateTo", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.", + "format": "integer", + "example": 123 + }, + "leaseStartDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY, YYYY-MM-DD, MM/DD/YY", + "format": "date", + "example": "MM/DD/YYYY" + }, + "quoteId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123 + }, + "includeExpiredQuotes": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If pass value \"1\" then expired quotes should get returned in the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is a required field. This field accepts a single integer value fo r Property ID.", + "format": "integer", + "example": 123456 + }, + "subtypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\"", + "format": "integer", + "example": 123 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "doNotSendConfirmationEmail": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Allows restricting the guest card confirmation emails to prospect/prop erty if set to 1.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isWaitList": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. When sent as 1, Units will be listed in waitlist.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "LastUpdateDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. LastUpdateDate", + "format": "date", + "example": "MM/DD/YYYYT HH:MM:SS" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. PropertyId", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. ApplicationId", + "format": "integer", + "example": 123 + } + }, + "required": [ + "propertyId", + "applicationId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accepts the property Id value.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accept the Application_Id(Lead_Id), can be obtained from getLeads API.", + "format": "integer", + "example": 123 + }, + "eventId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Accepts the value for Event Id.", + "format": "integer", + "example": 123 + }, + "typeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accepts the Event Type Id value under this node.", + "format": "integer", + "example": 123 + }, + "eventResultId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Value for event result id should be fetched from getLeadPickLists API. Depending on the Events this node should be considered mandatory.", + "format": "integer", + "example": 123 + }, + "subtypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\". And under event type \"Tour\":- 524:\"Self-Gui ded Tour\"", + "format": "integer", + "example": 123 + }, + "date": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is the event date. During cloning, all the lead event dates will be set to the current date.", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId", + "applicationId", + "typeId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leadId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts combination of Firstname & Lastname to filter leads depending on inputs.\"\n },\n \"telephone\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234567890\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts Primary/Work/Home/Mobile number as input.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"example@email.com\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leadStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"psProductIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"includeDemographics\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.\"\n },\n \"createdOnDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.\"\n },\n \"createdOnDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. In the response, events will not be returned unless we pass specific E vent Type Id(s) in this node. Accepts comma-separated values with lim it 5.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeadEvents\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required, If eventTypeIds and eventDates are not passed then applicationId is required.\"\n },\n \"eventTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"applyQuote\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"generateQuotes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This will fetch quotes associated with the property.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.\"\n },\n \"adjustmentsAndProvisionIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123,234\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. adjustmentsAndProvisionIds\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,4533\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. propertyIds\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leadId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Application Id referring PSI system\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts a combination of Firstname & Lastname. If either of one is provided, leads matching with given input will be returned in the response.\"\n },\n \"telephone\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234567890\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts Primary/Mobile/Home/Work number of prospect in any format\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"example@email.com\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts email address of prospect.\"\n },\n \"leadStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. leadStatusIds - comma seperated\"\n },\n \"psProductIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. psProductIds - comma seperated\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"10,15\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. eventTypeIds - comma seperated\"\n },\n \"sendUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. sendUnitSpaces\"\n },\n \"fromDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. This is an conditionally mandatory field.If name or telephone or email or leadId is provided then fromDate is not required.\"\n },\n \"toDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. This is an conditionally mandatory field. If name or telephone or emai l or leadId is provided then toDate is not required.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. eventDateFrom\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. eventDateTo\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getQuotes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This will fetch quotes associated with the property.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.\"\n },\n \"leaseStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY, YYYY-MM-DD, MM/DD/YY\"\n },\n \"quoteId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeExpiredQuotes\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If pass value \\\"1\\\" then expired quotes should get returned in the response.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is a required field. This field accepts a single integer value fo r Property ID.\"\n },\n \"subtypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \\\"Appointment\\\":- 453:\\\"Leasing Appointments\\\", 560:\\\"Self-Guided Tour\\\", 454:\\\" Tour\\\", 525:\\\"Virtual Tour\\\"\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendMitsLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"doNotSendConfirmationEmail\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Allows restricting the guest card confirmation emails to prospect/prop erty if set to 1.\"\n },\n \"isWaitList\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. When sent as 1, Units will be listed in waitlist.\"\n },\n \"LastUpdateDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYYT HH:MM:SS\",\n \"description\": \"This is a required field. This field accepts single value. LastUpdateDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. ApplicationId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"applicationId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts the property Id value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. Accept the Application_Id(Lead_Id), can be obtained from getLeads API.\"\n },\n \"eventId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Accepts the value for Event Id.\"\n },\n \"typeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. Accepts the Event Type Id value under this node.\"\n },\n \"eventResultId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Value for event result id should be fetched from getLeadPickLists API. Depending on the Events this node should be considered mandatory.\"\n },\n \"subtypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \\\"Appointment\\\":- 453:\\\"Leasing Appointments\\\", 560:\\\"Self-Guided Tour\\\", 454:\\\" Tour\\\", 525:\\\"Virtual Tour\\\". And under event type \\\"Tour\\\":- 524:\\\"Self-Gui ded Tour\\\"\"\n },\n \"date\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the event date. During cloning, all the lead event dates will be set to the current date.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"applicationId\",\n \"typeId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getLeads\": {\n \"$ref\": \"#/components/examples/getLeadsRequest\"\n },\n \"getLeadEvents\": {\n \"$ref\": \"#/components/examples/getLeadEventsRequest\"\n },\n \"applyQuote\": {\n \"$ref\": \"#/components/examples/applyQuoteRequest\"\n },\n \"generateQuotes\": {\n \"$ref\": \"#/components/examples/generateQuotesRequest\"\n },\n \"getLeadPickLists_r1\": {\n \"$ref\": \"#/components/examples/getLeadPickListsRequest_r1\"\n },\n \"getLeadPickLists_r2\": {\n \"$ref\": \"#/components/examples/getLeadPickListsRequest_r2\"\n },\n \"getMitsLeads\": {\n \"$ref\": \"#/components/examples/getMitsLeadsRequest\"\n },\n \"getQuotes\": {\n \"$ref\": \"#/components/examples/getQuotesRequest\"\n },\n \"sendLeads\": {\n \"$ref\": \"#/components/examples/sendLeadsRequest\"\n },\n \"sendMitsLeads\": {\n \"$ref\": \"#/components/examples/sendMitsLeadsRequest\"\n },\n \"updateLeads\": {\n \"$ref\": \"#/components/examples/updateLeadsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_lease_details", + "description": { + "tagline": "Retrieve detailed information about leases.", + "detailed": "Use this tool to get detailed information about leases, including lease activities, details, documents, parcels, and more. It supports pagination for handling large datasets." + }, + "return_annotation": "Detailed information about leases.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "tenant_subdomain" + ], + "description": "The subdomain representing the client organization. Required to specify which client's data to retrieve.", + "endpoint_argument_name": "orgs" + }, + { + "name": "lease_documents_upload", + "alternative_names": [ + "upload_lease_files", + "lease_documents_form" + ], + "description": "Upload lease documents using a form file upload (multipart/form-data).", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "pagination_page", + "results_page" + ], + "description": "The page number to retrieve in a paginated response. Use this to navigate through pages of lease details.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "results_per_page", + "entries_per_page" + ], + "description": "The number of items to return per page in the response. Supports paginated data retrieval.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "pagination_links_enabled", + "pagination_links_included" + ], + "description": "Set to 1 to include pagination links in the response. Use 0 to exclude them. This helps manage paginated data effectively.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/leases", + "tags": [ + "leases" + ], + "summary": "Leases related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getLeaseActivities, getLeaseDetails(r2), getLeaseDocumentsList, getParcelAlerts, getLeases(r1), getLease(r2)`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n" + }, + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "cancelLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123 + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getEvictedLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Provide a valid propertyId.", + "format": "integer", + "example": 123456 + }, + "evictionStartDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateFrom.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "evictionStartDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateTo", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getExpiringLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Date from which leases are required", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. Date upto which leases are required", + "format": "date", + "example": "MM/DD/YYYY" + }, + "isMonthToMonth": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Is Month To Month", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isWaitList": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If this parameter is enabled then we will show leases with lease type status notice and the property setting HIDE_NOTICE_RESIDENTS_FROM_RENE WALS should be disabled for this, else we will return error.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "toDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "createdOnDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "example": "1,2,3" + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + } + }, + "required": [ + "leaseId", + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "includeAddOns": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeCharge": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "includeAddOns": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeCharge": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocuments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Lease Id - Required if externalLeaseId is not provided", + "format": "integer", + "example": 123456 + }, + "externalLeaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. The remote primary key which is associated to lease. Required if leas eId is not provided.", + "format": "integer", + "example": 123456 + }, + "documentIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "fileTypesCode": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files", + "format": "string", + "example": "LA" + }, + "addedOnFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If provided, this will return the documents which have AddedOn dates o n or after the date provided.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "showDeletedFile": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocumentsList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "externalLeaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is the remote primary key that is associated to lease.", + "format": "integer", + "example": 123456 + }, + "documentIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "fileTypesCode": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files", + "format": "string", + "example": "LA" + }, + "showDeletedFile": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "leaseIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "eventTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "scheduledArCodeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "unitNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "12" + }, + "buildingName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "eventDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "leaseExpiringDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "leaseExpiringDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "includeOtherIncomeLeases": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "residentFriendlyMode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeLeaseHistory": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeArTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "applicationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "leaseIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "scheduledArCodeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "unitNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "12" + }, + "buildingName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "leaseExpiringDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "leaseExpiringDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "includeOtherIncomeLeases": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "residentFriendlyMode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeLeaseHistory": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeArTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsCollections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "includeEvictions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Include Evictions leases", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. From Date", + "format": "date", + "example": "MM/DD/YYYY" + }, + "transactionFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. transactionFromDate", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. customerId", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "leaseIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "eventTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "scheduledArCodeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,56744" + }, + "unitNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "12" + }, + "buildingName": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "eventDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "eventDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "leaseExpiringDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "leaseExpiringDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveOutDateTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "includeOtherIncomeLeases": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "residentFriendlyMode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeLeaseHistory": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeArTransactions": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getParcelAlerts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "isActive": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentersInsurancePolicies" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds", + "format": "integer", + "example": "1" + }, + "lastUpdatedOn": { + "type": "string", + "description": "This is an optional field. This field accepts single value. lastUpdatedOn", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveInLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": " This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveOutLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "moveOutTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. moveOutTypeId", + "format": "integer", + "example": 1234 + }, + "moveOutReasonId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. moveOutReasonId", + "format": "integer", + "example": 1234 + }, + "noticeDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. noticeDate", + "format": "date", + "example": "YYYY-MM-DD" + }, + "moveOutDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. moveOutDate", + "format": "date", + "example": "YYYY-MM-DD" + }, + "unitAvailableOnDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate", + "format": "date", + "example": "YYYY-MM-DD" + }, + "endContinuingScheduledCharges": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. endContinuingScheduledCharges", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "postAcceleratedRent": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. postAcceleratedRent", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "refundMethodId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. refundMethodId", + "format": "integer", + "example": 1234 + }, + "makeReadyEndDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "streetLine1": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line1", + "format": "string", + "example": "ABC" + }, + "streetLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line2", + "format": "string", + "example": "ABC" + }, + "streetLine3": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line3", + "format": "string", + "example": "ABC" + }, + "city": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Forwarding address`s city", + "format": "string", + "example": "ABC" + }, + "stateCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Forwarding Address`s stateCode", + "format": "string", + "example": "AK" + }, + "postalCode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Forwarding Address`s Postal Code", + "format": "integer", + "example": 99501 + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "onNoticeLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "moveOutTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. moveOutTypeId", + "format": "integer", + "example": 1234 + }, + "moveOutReasonId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. moveOutReasonId", + "format": "integer", + "example": 1234 + }, + "noticeDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. noticeDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "moveOutDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. moveOutDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "unitAvailableOnDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "makeReadyEndDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "submitRefundDetails": { + "type": "integer", + "description": "This is a required field. This field accepts single value. submitRefundDetails", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "refundMethodId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"refundMet hodId\" is required.", + "format": "integer", + "example": 1234 + }, + "streetLine1": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 1\" is required.", + "format": "string", + "example": "ABC" + }, + "streetLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 2\" is required.", + "format": "string", + "example": "ABC" + }, + "streetLine3": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 3\" is required.", + "format": "string", + "example": "ABC" + }, + "city": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"city\" is required.", + "format": "string", + "example": "ABC" + }, + "stateCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"stateCode\" is required.", + "format": "string", + "example": "AK" + }, + "postalCode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"postalCod \" is required.", + "format": "integer", + "example": 99501 + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate", + "makeReadyEndDate", + "submitRefundDetails" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "eventTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Acceptable values are: 8,335,4,436,5,6,15,56. 4 for \"Call-Outgoing\" , 5 for \"Text-Incoming\", 6 for \"Text-Outgoing\", 8 for \"Notes\", 335 fo r \"Lease Retrieved By Collections Agency\", 436 for \"Hazard Notes\", 15 for \"Scheduled Follow-Up\", 56 for \"Delinquency Notes\".", + "format": "integer", + "example": 8 + }, + "eventDateTime": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "09/2/2018 03:57:00 PST" + }, + "comment": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.", + "format": "string", + "example": "ABC" + }, + "hazardEndDate": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This would give end date for the hazard note.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "hazardNote": { + "type": "string", + "description": "This is a required field. This field accepts single value. This would add note when creating hazard event.", + "format": "string", + "example": "ABC" + }, + "leaseIntervalId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 1234 + }, + "leasingAgentId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.", + "format": "integer", + "example": 1234 + }, + "eventResultId": { + "type": "integer", + "description": "his is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.", + "format": "integer", + "example": 5 + }, + "customerIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "1234,5678" + }, + "scheduleDateTime": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.", + "format": "date", + "example": "06/18/2022 11:30:45" + } + }, + "required": [ + "propertyId", + "leaseId", + "eventTypeId", + "eventDateTime", + "hazardNote" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "leaseStartDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. leaseStartDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "leaseEndDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. leaseEndDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "moveInDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. moveInDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "leaseTermId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseTermId", + "format": "integer", + "example": 123456 + }, + "floorplanId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. floorplanId", + "format": "integer", + "example": 8 + }, + "unitSpaceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. unitSpaceId", + "format": "integer", + "example": 8 + }, + "spaceConfigurationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"spaceConfigurationId\" is required.", + "format": "integer", + "example": 8 + }, + "leaseStartWindowId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"leaseStartWindowId\" is required.", + "format": "integer", + "example": 8 + }, + "firstName": { + "type": "string", + "description": "This is a required field. This field accepts single value. firstName", + "format": "string", + "example": "ABC" + }, + "middleName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. middleName", + "format": "string", + "example": "ABC" + }, + "lastName": { + "type": "string", + "description": "This is a required field. This field accepts single value. lastName", + "format": "string", + "example": "ABC" + }, + "customerRelationshipTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId", + "format": "integer", + "example": 8 + }, + "emailAddress": { + "type": "string", + "description": "This is an optional field. This field accepts single value. emailAddress", + "format": "string", + "example": "ABC" + }, + "birthDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. birthDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "phoneNumberTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. phoneNumberTypeId", + "format": "integer", + "example": 8 + }, + "phoneNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Primary phoneNumber", + "format": "integer", + "example": 8 + }, + "addressTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. addressTypeId", + "format": "integer", + "example": 8 + }, + "streetLine1": { + "type": "string", + "description": "This is a required field. This field accepts single value. Address streetLine1", + "format": "string", + "example": "ABC" + }, + "streetLine2": { + "type": "string", + "description": "This is an optional field. This field accepts single value. streetLine2", + "format": "string", + "example": "ABC" + }, + "city": { + "type": "string", + "description": "This is a required field. This field accepts single value. city", + "format": "string", + "example": "city1" + }, + "stateCode": { + "type": "string", + "description": "This is a required field. This field accepts single value. stateCode", + "format": "string", + "example": "AZ" + }, + "postalCode": { + "type": "integer", + "description": "This is a required field. This field accepts single value. postalCode", + "format": "integer", + "example": "05559" + } + }, + "required": [ + "propertyId", + "leaseStartDate", + "leaseEndDate", + "moveInDate", + "leaseTermId", + "floorplanId", + "unitSpaceId", + "firstName", + "lastName", + "customerRelationshipTypeId", + "phoneNumberTypeId", + "phoneNumber", + "addressTypeId", + "streetLine1", + "city", + "stateCode", + "postalCode" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Insurance policy id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. customerId", + "format": "integer", + "example": 123456 + }, + "provider": { + "type": "string", + "description": "This is a required field. This field accepts single value. provider", + "format": "string", + "example": "ABC" + }, + "policyNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value. policyNumber", + "format": "string", + "example": "ABC" + }, + "startDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. startDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. endDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "liability": { + "type": "integer", + "description": "This is a required field. This field accepts single value. liability", + "format": "integer", + "example": 12350000 + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "id": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Insurance policy id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "customerIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. customerIds", + "format": "string", + "example": "12345,6789" + }, + "provider": { + "type": "string", + "description": "This is a required field. This field accepts single value. provider", + "format": "string", + "example": "ABC" + }, + "policyNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value. policyNumber", + "format": "string", + "example": "ABC" + }, + "startDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. startDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. endDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "liability": { + "type": "integer", + "description": "This is a required field. This field accepts single value. liability", + "format": "integer", + "example": 12350000 + }, + "personalContents": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. personalContents", + "format": "integer", + "example": 12350000 + }, + "deductible": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. deductible", + "format": "integer", + "example": 12350000 + }, + "isCancelled": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "15" + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRoommateGroups" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "roommateGroups": { + "type": "object", + "properties": { + "roommateGroup": { + "type": "array", + "items": { + "type": "object", + "properties": { + "invitorApplicationId": { + "type": "integer", + "description": "Required field unless inviteeApplicationId is provided. This field accepts single value.", + "example": 12345678 + }, + "inviteeApplicationId": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "array", + "description": "Required field. This field accepts multiple values.", + "items": { + "type": "integer" + } + }, + { + "type": "string", + "description": "Can be empty string", + "example": "" + } + ] + } + } + } + } + }, + "required": [ + "roommateGroup" + ] + } + }, + "required": [ + "roommateGroups" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendScheduledCharges" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "chargeTimingId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. chargeTimingId", + "format": "integer", + "example": 307 + }, + "chargeCodeTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. chargeCodeTypeId", + "format": "integer", + "example": 123456 + }, + "chargeCodeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. chargeCodeId", + "format": "integer", + "example": 2 + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. amount", + "format": "float", + "example": 5000 + }, + "startDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. startDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "leaseIntervalId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. leaseIntervalId", + "format": "integer", + "example": 123456 + } + }, + "required": [ + "propertyId", + "leaseId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "startDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accepts the single property Id that is associated with a lease.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accepts a single lease id for updating the lease details.", + "format": "integer", + "example": 123456 + }, + "unitSpaceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single", + "format": "integer", + "example": 12345 + }, + "moveInDate": { + "type": "string", + "description": "This is a optional field. This field accepts single value. moveInDate (YYYY-MM-DD)", + "format": "date", + "example": "YYYY-MM-DD" + }, + "occupants": { + "type": "object", + "description": "Optional object containing occupant details", + "properties": { + "occupant": { + "type": "array", + "description": "List of occupants", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "This is a required field. This field accepts single value. firstName", + "format": "string", + "example": "ABC" + }, + "lastName": { + "type": "string", + "description": "This is a required field. This field accepts single value. lastName", + "format": "string", + "example": "ABC" + } + } + } + } + } + }, + "customerRelationshipTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId", + "format": "integer", + "example": 8 + } + }, + "required": [ + "propertyId", + "leaseId", + "firstName", + "lastName", + "customerRelationshipTypeId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. scheduledChargeid", + "format": "integer", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. amount", + "format": "float", + "example": 5000 + }, + "isDeleted": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. scheduledChargeid", + "format": "integer", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. leaseId", + "format": "integer", + "example": 123456 + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. amount", + "format": "float", + "example": 5000 + }, + "isDeleted": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"description\": \"## Note: \\n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\\n\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"cancelLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getEvictedLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Provide a valid propertyId.\"\n },\n \"evictionStartDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid evictionStartDateFrom.\"\n },\n \"evictionStartDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid evictionStartDateTo\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getExpiringLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Date from which leases are required\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Date upto which leases are required\"\n },\n \"isMonthToMonth\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Is Month To Month\"\n },\n \"isWaitList\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this parameter is enabled then we will show leases with lease type status notice and the property setting HIDE_NOTICE_RESIDENTS_FROM_RENE WALS should be disabled for this, else we will return error.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseActivities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseId\",\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"createdOnDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeAddOns\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeCharge\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"includeAddOns\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeCharge\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseDocuments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Lease Id - Required if externalLeaseId is not provided\"\n },\n \"externalLeaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. The remote primary key which is associated to lease. Required if leas eId is not provided.\"\n },\n \"documentIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fileTypesCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"LA\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. System code for file files\"\n },\n \"addedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If provided, this will return the documents which have AddedOn dates o n or after the date provided.\"\n },\n \"showDeletedFile\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseDocumentsList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"externalLeaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. This is the remote primary key that is associated to lease.\"\n },\n \"documentIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fileTypesCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"LA\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. System code for file files\"\n },\n \"showDeletedFile\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeasePickList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsCollections\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeEvictions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Include Evictions leases\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From Date\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionFromDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. customerId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getParcelAlerts\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isActive\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getRentersInsurancePolicies\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. leaseStatusTypeIds\"\n },\n \"lastUpdatedOn\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. lastUpdatedOn\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"moveInLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"moveOutLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"moveOutTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutTypeId\"\n },\n \"moveOutReasonId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutReasonId\"\n },\n \"noticeDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. noticeDate\"\n },\n \"moveOutDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveOutDate\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. unitAvailableOnDate\"\n },\n \"endContinuingScheduledCharges\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. endContinuingScheduledCharges\"\n },\n \"postAcceleratedRent\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. postAcceleratedRent\"\n },\n \"refundMethodId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \" This is an optional field. This field accepts single value. refundMethodId\"\n },\n \"makeReadyEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. According to Property Preference \\\"Require Make Ready Work Order on Mov e-out,...\\\" the makeReadyEndDate is conditional mandatory.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line1\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line2\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line3\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding address`s city\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AK\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address`s stateCode\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 99501,\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address`s Postal Code\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"moveOutTypeId\",\n \"moveOutReasonId\",\n \"moveOutDate\",\n \"unitAvailableOnDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"onNoticeLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"moveOutTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutTypeId\"\n },\n \"moveOutReasonId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutReasonId\"\n },\n \"noticeDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. noticeDate (YYYY-MM-DD)\"\n },\n \"moveOutDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveOutDate (YYYY-MM-DD)\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. unitAvailableOnDate (YYYY-MM-DD)\"\n },\n \"makeReadyEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. According to Property Preference \\\"Require Make Ready Work Order on Mov e-out,...\\\" the makeReadyEndDate is conditional mandatory.\"\n },\n \"submitRefundDetails\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value. submitRefundDetails\"\n },\n \"refundMethodId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"refundMet hodId\\\" is required.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 1\\\" is required.\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 2\\\" is required.\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 3\\\" is required.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"city\\\" is required.\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AK\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"stateCode\\\" is required.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 99501,\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"postalCod \\\" is required.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"moveOutTypeId\",\n \"moveOutReasonId\",\n \"moveOutDate\",\n \"unitAvailableOnDate\",\n \"makeReadyEndDate\",\n \"submitRefundDetails\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseActivities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"eventTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. Acceptable values are: 8,335,4,436,5,6,15,56. 4 for \\\"Call-Outgoing\\\" , 5 for \\\"Text-Incoming\\\", 6 for \\\"Text-Outgoing\\\", 8 for \\\"Notes\\\", 335 fo r \\\"Lease Retrieved By Collections Agency\\\", 436 for \\\"Hazard Notes\\\", 15 for \\\"Scheduled Follow-Up\\\", 56 for \\\"Delinquency Notes\\\".\"\n },\n \"eventDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"09/2/2018 03:57:00 PST\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"comment\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.\"\n },\n \"hazardEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. This would give end date for the hazard note.\"\n },\n \"hazardNote\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. This would add note when creating hazard event.\"\n },\n \"leaseIntervalId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.\"\n },\n \"eventResultId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"his is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduleDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/18/2022 11:30:45\",\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"eventTypeId\",\n \"eventDateTime\",\n \"hazardNote\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. leaseStartDate (YYYY-MM-DD)\"\n },\n \"leaseEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. leaseEndDate (YYYY-MM-DD)\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveInDate (YYYY-MM-DD)\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseTermId\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. floorplanId\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. unitSpaceId\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value. If the provided property is of type \\\"Student\\\", only then \\\"spaceConfigurationId\\\" is required.\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value. If the provided property is of type \\\"Student\\\", only then \\\"leaseStartWindowId\\\" is required.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. firstName\"\n },\n \"middleName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. middleName\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. lastName\"\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. customerRelationshipTypeId\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. emailAddress\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. birthDate (YYYY-MM-DD)\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. phoneNumberTypeId\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. Primary phoneNumber\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. addressTypeId\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Address streetLine1\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. streetLine2\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"city1\",\n \"description\": \"This is a required field. This field accepts single value. city\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AZ\",\n \"description\": \"This is a required field. This field accepts single value. stateCode\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"05559\",\n \"description\": \"This is a required field. This field accepts single value. postalCode\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseStartDate\",\n \"leaseEndDate\",\n \"moveInDate\",\n \"leaseTermId\",\n \"floorplanId\",\n \"unitSpaceId\",\n \"firstName\",\n \"lastName\",\n \"customerRelationshipTypeId\",\n \"phoneNumberTypeId\",\n \"phoneNumber\",\n \"addressTypeId\",\n \"streetLine1\",\n \"city\",\n \"stateCode\",\n \"postalCode\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Insurance policy id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. customerId\"\n },\n \"provider\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. provider\"\n },\n \"policyNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. policyNumber\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. endDate\"\n },\n \"liability\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is a required field. This field accepts single value. liability\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"customerId\",\n \"provider\",\n \"policyNumber\",\n \"startDate\",\n \"endDate\",\n \"liability\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Insurance policy id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,6789\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. customerIds\"\n },\n \"provider\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. provider\"\n },\n \"policyNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. policyNumber\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. endDate\"\n },\n \"liability\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is a required field. This field accepts single value. liability\"\n },\n \"personalContents\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is an optional field. This field accepts single value. personalContents\"\n },\n \"deductible\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is an optional field. This field accepts single value. deductible\"\n },\n \"isCancelled\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"customerId\",\n \"provider\",\n \"policyNumber\",\n \"startDate\",\n \"endDate\",\n \"liability\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response.\",\n \"example\": \"15\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendRoommateGroups\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"roommateGroups\"\n ],\n \"properties\": {\n \"roommateGroups\": {\n \"type\": \"object\",\n \"required\": [\n \"roommateGroup\"\n ],\n \"properties\": {\n \"roommateGroup\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"invitorApplicationId\": {\n \"type\": \"integer\",\n \"description\": \"Required field unless inviteeApplicationId is provided. This field accepts single value.\",\n \"example\": 12345678\n },\n \"inviteeApplicationId\": {\n \"oneOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\"\n },\n \"description\": \"Required field. This field accepts multiple values.\",\n \"example\": [\n 12345678,\n 55555555,\n 88888888\n ]\n },\n {\n \"type\": \"string\",\n \"description\": \"Can be empty string\",\n \"example\": \"\"\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendScheduledCharges\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 307,\n \"description\": \"This is a required field. This field accepts single value. chargeTimingId\"\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. chargeCodeTypeId\"\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. chargeCodeId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"leaseIntervalId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. leaseIntervalId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"amount\",\n \"startDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts the single property Id that is associated with a lease.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts a single lease id for updating the lease details.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a optional field. This field accepts single value. moveInDate (YYYY-MM-DD)\"\n },\n \"occupants\": {\n \"type\": \"object\",\n \"description\": \"Optional object containing occupant details\",\n \"properties\": {\n \"occupant\": {\n \"type\": \"array\",\n \"description\": \"List of occupants\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. firstName\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. lastName\"\n }\n }\n }\n }\n }\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. customerRelationshipTypeId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"firstName\",\n \"lastName\",\n \"customerRelationshipTypeId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. scheduledChargeid\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"isDeleted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This field support value 0 and 1.\"\n }\n },\n \"required\": [\n \"id\",\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. scheduledChargeid\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"isDeleted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This field support value 0 and 1.\"\n }\n },\n \"required\": [\n \"id\",\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"cancelLease\": {\n \"$ref\": \"#/components/examples/cancelLeaseRequest\"\n },\n \"getEvictedLeases\": {\n \"$ref\": \"#/components/examples/getEvictedLeasesRequest\"\n },\n \"getExpiringLeases\": {\n \"$ref\": \"#/components/examples/getExpiringLeasesRequest\"\n },\n \"getLeaseActivities\": {\n \"$ref\": \"#/components/examples/getLeaseActivitiesRequest\"\n },\n \"getLeaseDetails_r1\": {\n \"$ref\": \"#/components/examples/getLeaseDetailsRequest_r1\"\n },\n \"getLeaseDetails_r2\": {\n \"$ref\": \"#/components/examples/getLeaseDetailsRequest_r2\"\n },\n \"getLeaseDocuments\": {\n \"$ref\": \"#/components/examples/getLeaseDocumentsRequest\"\n },\n \"getLeaseDocumentsList\": {\n \"$ref\": \"#/components/examples/getLeaseDocumentsListRequest\"\n },\n \"getLeasePickList\": {\n \"$ref\": \"#/components/examples/getLeasePickListRequest\"\n },\n \"getLeases_r1\": {\n \"$ref\": \"#/components/examples/getLeasesRequest_r1\"\n },\n \"getLeases_r2\": {\n \"$ref\": \"#/components/examples/getLeasesRequest_r2\"\n },\n \"getMitsCollections\": {\n \"$ref\": \"#/components/examples/getMitsCollectionsRequest\"\n },\n \"getMitsLeases\": {\n \"$ref\": \"#/components/examples/getMitsLeasesRequest\"\n },\n \"getParcelAlerts\": {\n \"$ref\": \"#/components/examples/getParcelAlertsRequest\"\n },\n \"getRentersInsurancePolicies\": {\n \"$ref\": \"#/components/examples/getRentersInsurancePoliciesRequest\"\n },\n \"moveInLease\": {\n \"$ref\": \"#/components/examples/moveInLeaseRequest\"\n },\n \"moveOutLease\": {\n \"$ref\": \"#/components/examples/moveOutLeaseRequest\"\n },\n \"onNoticeLease\": {\n \"$ref\": \"#/components/examples/onNoticeLeaseRequest\"\n },\n \"sendLeaseActivities\": {\n \"$ref\": \"#/components/examples/sendLeaseActivitiesRequest\"\n },\n \"sendLeases\": {\n \"$ref\": \"#/components/examples/sendLeasesRequest\"\n },\n \"sendRentersInsurancePolicies_r1\": {\n \"$ref\": \"#/components/examples/sendRentersInsurancePoliciesRequest_r1\"\n },\n \"sendRentersInsurancePolicies_r2\": {\n \"$ref\": \"#/components/examples/sendRentersInsurancePoliciesRequest_r2\"\n },\n \"sendRoommateGroups\": {\n \"$ref\": \"#/components/examples/sendRoommateGroups_r2_Request\"\n },\n \"sendScheduledCharges\": {\n \"$ref\": \"#/components/examples/sendScheduledChargesRequest\"\n },\n \"updateLease\": {\n \"$ref\": \"#/components/examples/updateLeaseRequest\"\n },\n \"updateScheduledCharges_r1\": {\n \"$ref\": \"#/components/examples/updateScheduledChargesRequest_r1\"\n },\n \"updateScheduledCharges_r2\": {\n \"$ref\": \"#/components/examples/updateScheduledChargesRequest_r2\"\n }\n }\n },\n \"multipart/form-data\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"requestContentType\",\n \"requestBody\",\n \"file1\"\n ],\n \"properties\": {\n \"requestContentType\": {\n \"type\": \"string\",\n \"description\": \"This is required field. This field specify the content of requestBody field. This field accept fixed value as `application/json`.\",\n \"enum\": [\n \"application/json\"\n ],\n \"example\": \"application/json\"\n },\n \"requestBody\": {\n \"type\": \"object\",\n \"description\": \"This is required field. This field accept the details of lease, and ducuments being uploaded.\",\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"properties\": {\n \"auth\": {\n \"type\": \"object\",\n \"required\": [\n \"type\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"method\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseDocuments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"files\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. This is the conditionally required, if applicationId and applicantId is not provided.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a optional field. This field accepts single value. This is the conditionally required, if leaseId and applicantId is not provided.\"\n },\n \"applicantId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required, if leaseId and applicationId is not provided.\"\n },\n \"files\": {\n \"type\": \"object\",\n \"required\": [\n \"file\"\n ],\n \"properties\": {\n \"file\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"fileName\"\n ],\n \"properties\": {\n \"fileName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This will be the name of the file being uploaded.\",\n \"example\": \"lease.pdf\"\n },\n \"leaseFileType\": {\n \"type\": \"string\",\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required if fileTypeId is not provided. This will be the type of the file being uploaded.\",\n \"example\": \"POI\"\n },\n \"fileTypeId\": {\n \"type\": \"integer\",\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required if leaseFileType is not provided.\",\n \"example\": 12345\n },\n \"isShowInResidentPortal\": {\n \"type\": \"integer\",\n \"description\": \"This is a optional field. This will specify the visibility of uploaded document in the resident portal.\",\n \"example\": 1,\n \"enum\": [\n 0,\n 1\n ]\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"description\": \"This is a optional field. This will accepts comma separated multiple values. If provided this file will attach to the mentioned customers. if skipped, the file will be attached to all the customers of the lease.\",\n \"example\": \"1234,5678\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"file1\": {\n \"type\": \"string\",\n \"description\": \"This is required field. This will accept the file being uploaded to the lease. This should match and can repeate the field as per the files mentioned in the requestBody.\",\n \"format\": \"binary\"\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "leasing_center_call_logs", + "description": { + "tagline": "Retrieve leasing center call logs for analysis.", + "detailed": "Use this tool to access call logs from the leasing center, supporting pagination for detailed data retrieval." + }, + "return_annotation": "Retrieves call logs from the leasing center.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "client_domain" + ], + "description": "The subdomain of the client organization. This is required to identify the client's data for retrieving call logs.", + "endpoint_argument_name": "orgs" + }, + { + "name": "request_body_payload", + "alternative_names": [ + "request_body_data", + "payload" + ], + "description": "An array of JSON objects to be included in the request. Typically used for specifying additional data or filters for the API call.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "pagination_page_number", + "current_page" + ], + "description": "The page number to retrieve in a paginated response from the leasing center call logs.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "page_size", + "num_items_per_page" + ], + "description": "Number of items to return per page in the response. Use for pagination.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "pagination_links_included", + "send_pagination_links" + ], + "description": "Set to 1 to include pagination links in the response; set to 0 to exclude them.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/leasingcenter", + "tags": [ + "leasingcenter" + ], + "summary": "Leasing Center related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getCallLogs`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCallLogs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id`s.", + "format": "integer", + "example": "123456,5678" + }, + "callSourceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supported values (1, 2, 7)", + "format": "integer", + "example": 3 + }, + "callTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "3,8" + }, + "callResultIds": { + "type": "integer", + "description": " This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "8,1" + }, + "answerStatus": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. Supports only 1 (ANSWERED) & 2 (UNANSWERED)", + "format": "integer", + "example": 1 + }, + "voiceMailTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supported values are 1 (VOICE_MESSAGE) or 2 (UNPLAYED_VOICE_MESSAGE) o r 3 (NO_VOICE_MESSAGE).", + "format": "integer", + "example": 2 + }, + "callAnalyzed": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supports 1 (ANALYZED) or 0 (NON_ANALYZED)", + "format": "integer", + "example": 1 + }, + "callState": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supports 1 (NON-ARCHIVED) or 2 (ARCHIVED).", + "format": "integer", + "example": 2 + }, + "startDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasingCenterPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCallLogs\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"123456,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id`s.\"\n },\n \"callSourceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. Supported values (1, 2, 7)\"\n },\n \"callTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"3,8\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"callResultIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"8,1\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"answerStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \" This is an optional field. This field accepts single value. Supports only 1 (ANSWERED) & 2 (UNANSWERED)\"\n },\n \"voiceMailTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supported values are 1 (VOICE_MESSAGE) or 2 (UNPLAYED_VOICE_MESSAGE) o r 3 (NO_VOICE_MESSAGE).\"\n },\n \"callAnalyzed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1 (ANALYZED) or 0 (NON_ANALYZED)\"\n },\n \"callState\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1 (NON-ARCHIVED) or 2 (ARCHIVED).\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeasingCenterPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCallLogs\": {\n \"$ref\": \"#/components/examples/getCallLogsRequest\"\n },\n \"getLeasingCenterPickLists\": {\n \"$ref\": \"#/components/examples/getLeasingCenterPickListsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "request_maintenance_service", + "description": { + "tagline": "Request maintenance services for an organization.", + "detailed": "This tool calls the Entrata API to request maintenance services for a specified organization. It should be used when an entity needs to initiate a new maintenance service order." + }, + "return_annotation": "Confirmation of maintenance service request.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "tenant_subdomain" + ], + "description": "The unique subdomain identifier for the client organization requesting the service.", + "endpoint_argument_name": "orgs" + }, + { + "name": "maintenance_request_details", + "alternative_names": [ + "maintenance_order_info", + "service_request_payload" + ], + "description": "The JSON array containing details required to initiate a maintenance request. Include all necessary fields as per Entrata's API requirements.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "page_index", + "pagination_page" + ], + "description": "The page number for paginated responses. Use to retrieve a specific page in a paginated series.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "results_limit", + "max_items_returned" + ], + "description": "Specifies the number of items to return per page in the response.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "pagination_links_included", + "send_pagination_links" + ], + "description": "Set to 1 to include pagination links in the response body, otherwise set to 0.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/maintenance", + "tags": [ + "maintenance" + ], + "summary": "Maintenance related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getInspections`, `getInspectionTemplates`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "unitSpaceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "statusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "inspectionFormId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 1234 + }, + "inspectionTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supported values are 1( ROUTINE ), 2(MOVE_IN), 3(MOVE_OUT)", + "format": "integer", + "example": 2 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspectionTemplates" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.", + "format": "string", + "example": "123456,678" + }, + "showDisabled": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. The node accepts a boolean value and default value for this node is \"0\".", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrderPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.", + "format": "string", + "example": "123456,678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "workOrderId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "propertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. propertyUnitId", + "format": "integer", + "example": 123456 + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. vendorId", + "format": "integer", + "example": 123456 + }, + "leaseStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds", + "format": "integer", + "example": "1,2,3" + }, + "workOrderTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. workOrderTypeIds", + "format": "integer", + "example": "1,2,3" + }, + "buildingName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. buildingName", + "format": "string", + "example": "ABC" + }, + "unitNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Unit number", + "format": "string", + "example": "ABC" + }, + "maintenancePriorityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. maintenancePriorityId", + "format": "integer", + "example": 123456 + }, + "maintenanceCategoryId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. maintenanceCategoryId", + "format": "integer", + "example": 3 + }, + "maintenanceProblemId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. maintenanceProblemId", + "format": "integer", + "example": 123456 + }, + "includeChildWorkOrders": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. includeChildWorkOrders", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDeletedWorkOrders": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "createdOnFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. createdOnFromDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. createdOnToDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "lastUpdatedOnFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "lastUpdatedOnToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "completedOnFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. completedOnFromDate", + "format": "date", + "example": "MM/DD/YYYY" + }, + "completedOnToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. completedOnToDate", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Customer Id", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Lease ID", + "format": "integer", + "example": 123456 + }, + "unitNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Unit mumber", + "format": "string", + "example": "5" + }, + "customerFirstName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Customer First Name", + "format": "string", + "example": "ABC" + }, + "customerLastName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Customer Last Name", + "format": "string", + "example": "ABC" + }, + "mainPhoneNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Main contact phone number", + "format": "integer", + "example": 123456789 + }, + "altPhoneNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Alternate contact phone number", + "format": "integer", + "example": 12121212 + }, + "emailAddress": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Email Address", + "format": "string", + "example": "chris@sam.com" + }, + "permissionToEnter": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Permission to enter", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "maintenanceLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance location", + "format": "integer", + "example": 123456 + }, + "maintenanceCategoryId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance Category Id", + "format": "integer", + "example": 123456 + }, + "maintenanceProblemId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance problem", + "format": "integer", + "example": 123456 + }, + "subMaintenanceProblemId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. SubMaintenance problem", + "format": "integer", + "example": 123456 + }, + "maintenancePriorityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Maintenance Priority", + "format": "integer", + "example": 123456 + }, + "problemDescription": { + "type": "string", + "description": "This is a required field. This field accepts single value. Problem Description", + "format": "string", + "example": "ABC" + }, + "petsDescription": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Pets Description is required if the lease has pets or if permission t o enter is denied so that a reason why entry is not permitted can be e xplained or a pet warning given.", + "format": "string", + "example": "ABC" + }, + "buildingName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. buildingName", + "format": "string", + "example": "ABC" + }, + "assignedTo": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. assignedTo", + "format": "integer", + "example": 4553 + }, + "scheduledStartDateTime": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledStartDateTime", + "format": "date", + "example": "2017-06-24 13:00:00 PST" + }, + "scheduledEndDateTime": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledEndDateTime", + "format": "date", + "example": "2017-06-24 11:00:00 PST" + }, + "dueDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.", + "format": "date", + "example": "06/15/2017 12:45:56" + }, + "isFloatingWorkOrder": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "priorityOrderNum": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Negative numbers not allowed. This parameter is not applicable to mos t clients and should not be used without first checking with Entrata.", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId", + "mainPhoneNumber", + "permissionToEnter", + "maintenanceLocationId", + "maintenanceCategoryId", + "maintenanceProblemId", + "problemDescription" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "workOrderId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "maintenanceStatusTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "maintenancePriorityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 100 + }, + "maintenanceLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance location", + "format": "integer", + "example": 123456 + }, + "maintenanceCategoryId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance Category Id", + "format": "integer", + "example": 123456 + }, + "maintenanceProblemId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance problem", + "format": "integer", + "example": 123456 + }, + "subMaintenanceProblemId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. SubMaintenance problem", + "format": "integer", + "example": 123456 + }, + "mainPhoneNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Main contact phone number", + "format": "integer", + "example": 123456789 + }, + "altPhoneNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Alternate contact phone number", + "format": "integer", + "example": 12121212 + }, + "emailAddress": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Email Address", + "format": "string", + "example": "chris@sam.com" + }, + "problemDescription": { + "type": "string", + "description": "This is a required field. This field accepts single value. Problem Description", + "format": "string", + "example": "ABC" + }, + "petsDescription": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.", + "format": "string", + "example": "ABC" + }, + "completedDateTime": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "2017-06-24 13:00:00 PST" + }, + "closingComments": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "scheduledStartDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledStartDate", + "format": "date", + "example": "2017-06-24 13:00:00 PST" + }, + "scheduledEndDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledEndDate", + "format": "date", + "example": "2017-06-24 11:00:00 PST" + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. vendorId", + "format": "integer", + "example": 123456 + }, + "parentWorkOrderId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. parentWorkOrderId", + "format": "integer", + "example": 123456 + }, + "assignedTo": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. assignedTo", + "format": "integer", + "example": 4553 + }, + "dueDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.", + "format": "date", + "example": "06/15/2017 12:45:56" + }, + "unitAvailableOnDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.", + "format": "date", + "example": "2017-04-02" + }, + "priorityOrderNum": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed.", + "format": "integer", + "example": 12345 + }, + "permissionToEnter": { + "type": "integer", + "description": "This is a optional field. This field accepts single value. Permission to enter", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "workOrderId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "leaseId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "customerId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "maintenanceStatusTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123456 + }, + "maintenancePriorityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 100 + }, + "maintenanceLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance location", + "format": "integer", + "example": 123456 + }, + "maintenanceCategoryId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance Category Id", + "format": "integer", + "example": 123456 + }, + "maintenanceProblemId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Maintenance problem", + "format": "integer", + "example": 123456 + }, + "subMaintenanceProblemId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. SubMaintenance problem", + "format": "integer", + "example": 123456 + }, + "mainPhoneNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Main contact phone number", + "format": "integer", + "example": 123456789 + }, + "altPhoneNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Alternate contact phone number", + "format": "integer", + "example": 12121212 + }, + "emailAddress": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Email Address", + "format": "string", + "example": "chris@sam.com" + }, + "problemDescription": { + "type": "string", + "description": "This is a required field. This field accepts single value. Problem Description", + "format": "string", + "example": "ABC" + }, + "petsDescription": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.", + "format": "string", + "example": "ABC" + }, + "completedDateTime": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "2017-06-24 13:00:00 PST" + }, + "closingComments": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "scheduledStartDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledStartDate", + "format": "date", + "example": "2017-06-24 13:00:00 PST" + }, + "scheduledEndDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. scheduledEndDate", + "format": "date", + "example": "2017-06-24 11:00:00 PST" + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. vendorId", + "format": "integer", + "example": 123456 + }, + "parentWorkOrderId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. parentWorkOrderId", + "format": "integer", + "example": 123456 + }, + "assignedTo": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. assignedTo", + "format": "integer", + "example": 4553 + }, + "dueDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.", + "format": "date", + "example": "06/15/2017 12:45:56" + }, + "unitAvailableOnDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.", + "format": "date", + "example": "2017-04-02" + }, + "priorityOrderNum": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed.", + "format": "integer", + "example": 12345 + }, + "permissionToEnter": { + "type": "integer", + "description": "This is a optional field. This field accepts single value. Permission to enter", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getInspections\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"statusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"inspectionFormId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"inspectionTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supported values are 1( ROUTINE ), 2(MOVE_IN), 3(MOVE_OUT)\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getInspectionTemplates\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.\"\n },\n \"showDisabled\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. The node accepts a boolean value and default value for this node is \\\"0\\\".\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWorkOrderPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. propertyUnitId\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. leaseStatusTypeIds\"\n },\n \"workOrderTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. workOrderTypeIds\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. buildingName\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Unit number\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. maintenancePriorityId\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. maintenanceCategoryId\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. maintenanceProblemId\"\n },\n \"includeChildWorkOrders\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. includeChildWorkOrders\"\n },\n \"includeDeletedWorkOrders\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not.\"\n },\n \"createdOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. createdOnFromDate\"\n },\n \"createdOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. createdOnToDate\"\n },\n \"lastUpdatedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.\"\n },\n \"lastUpdatedOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.\"\n },\n \"completedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. completedOnFromDate\"\n },\n \"completedOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. completedOnToDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Customer Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Lease ID\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"5\",\n \"description\": \"This is an optional field. This field accepts single value. Unit mumber\"\n },\n \"customerFirstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Customer First Name\"\n },\n \"customerLastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Customer Last Name\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value. Permission to enter\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Maintenance Priority\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description is required if the lease has pets or if permission t o enter is denied so that a reason why entry is not permitted can be e xplained or a pet warning given.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. buildingName\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"scheduledStartDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDateTime\"\n },\n \"scheduledEndDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDateTime\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"isFloatingWorkOrder\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Negative numbers not allowed. This parameter is not applicable to mos t clients and should not be used without first checking with Entrata.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"mainPhoneNumber\",\n \"permissionToEnter\",\n \"maintenanceLocationId\",\n \"maintenanceCategoryId\",\n \"maintenanceProblemId\",\n \"problemDescription\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"maintenanceStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.\"\n },\n \"completedDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"closingComments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"scheduledStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDate\"\n },\n \"scheduledEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDate\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"parentWorkOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. parentWorkOrderId\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-04-02\",\n \"description\": \"This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Negative numbers not allowed.\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a optional field. This field accepts single value. Permission to enter\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"workOrderId\",\n \"maintenanceProblemId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"maintenanceStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.\"\n },\n \"completedDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"closingComments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"scheduledStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDate\"\n },\n \"scheduledEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDate\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"parentWorkOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. parentWorkOrderId\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-04-02\",\n \"description\": \"This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Negative numbers not allowed.\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a optional field. This field accepts single value. Permission to enter\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"workOrderId\",\n \"maintenanceProblemId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getInspections\": {\n \"$ref\": \"#/components/examples/getInspectionsRequest\"\n },\n \"getInspectionTemplates\": {\n \"$ref\": \"#/components/examples/getInspectionTemplatesRequest\"\n },\n \"getWorkOrderPickLists\": {\n \"$ref\": \"#/components/examples/getWorkOrderPickListsRequest\"\n },\n \"getWorkOrders\": {\n \"$ref\": \"#/components/examples/getWorkOrdersRequest\"\n },\n \"sendWorkOrders\": {\n \"$ref\": \"#/components/examples/sendWorkOrdersRequest\"\n },\n \"updateWorkOrders_r1\": {\n \"$ref\": \"#/components/examples/updateWorkOrdersRequest_r1\"\n },\n \"updateWorkOrders_r2\": {\n \"$ref\": \"#/components/examples/updateWorkOrdersRequest_r2\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "update_pricing", + "description": { + "tagline": "Update pricing information for a specified organization.", + "detailed": "Use this tool to adjust the pricing details for an organization. This is typically called when changes in pricing need to be implemented for specific organizational needs or market conditions." + }, + "return_annotation": "Confirmation of pricing update success or failure.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "subdomain_name" + ], + "description": "The subdomain associated with the client organization for which pricing is being updated.", + "endpoint_argument_name": "orgs" + }, + { + "name": "pricing_update_details", + "alternative_names": [ + "pricing_data", + "update_information" + ], + "description": "A JSON array containing the details for pricing updates. Each element should include specifics like product ID, new price, and effective date.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/pricing", + "tags": [ + "pricing" + ], + "summary": "Pricing related APIs", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPricingPicklists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyFees" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. propertyId", + "example": "12345" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.", + "format": "integer", + "example": 4 + }, + "pricingLevelReferenceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.", + "format": "integer", + "example": 123456 + }, + "chargeUsageId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance", + "format": "integer", + "example": 1 + }, + "chargeUsageReferenceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0.", + "format": "integer", + "example": 0 + }, + "isRenewal": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent.", + "format": "integer", + "example": 0 + }, + "chargeTimingId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed", + "format": "integer", + "example": 307 + }, + "chargeCodeTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit", + "format": "integer", + "example": 2 + }, + "chargeCodeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.", + "format": "integer", + "example": 123456 + }, + "leaseTermMonths": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms.", + "format": "integer", + "example": 12 + }, + "leaseStartRangeStart": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit`s available on the date [if available on a date is in future]. If sending \"isRenewal\" as true this value should always be sent as 0", + "format": "integer", + "example": 0 + }, + "leaseStartRangeEnd": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending \"isRenewal\" as true this value should always be sent as 0", + "format": "integer", + "example": 10000 + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Rate Amount.", + "format": "float", + "example": 1840 + }, + "leaseTermName": { + "type": "string", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory.", + "format": "string", + "example": "chris@sam.com" + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeUsageReferenceId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "leaseTermName" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "example": 1381146 + }, + "pricing": { + "type": "array", + "description": "Array of pricing objects", + "items": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.", + "format": "integer", + "example": 3 + }, + "pricingLevelReferenceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId.", + "format": "integer", + "example": 639824 + }, + "chargeUsageId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance", + "format": "integer", + "example": 1 + }, + "isRenewal": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent.", + "format": "integer", + "example": 0 + }, + "chargeTimingId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing].", + "format": "integer", + "example": 303 + }, + "chargeCodeTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit", + "format": "integer", + "example": 2 + }, + "chargeCodeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.", + "format": "integer", + "example": 224711 + }, + "leaseTermMonths": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing for different terms.", + "format": "integer", + "example": 13 + }, + "leaseTermId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Lease term identifier.", + "format": "integer", + "example": 33549 + }, + "leaseStartWindowId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Lease start window identifier.", + "format": "integer", + "example": 240891 + }, + "spaceConfigurationId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Space configuration identifier.", + "format": "integer", + "example": 2 + }, + "leaseTermName": { + "type": "string", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is mandatory.", + "example": "Lease Term 2" + }, + "leaseStartRangeStart": { + "type": "integer", + "description": "This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRenewal' as true this value should always be sent as 0", + "format": "integer", + "example": 2 + }, + "leaseStartRangeEnd": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0", + "format": "integer", + "example": 4 + }, + "amount": { + "type": "string", + "description": "This is a required field. This field accepts single value. Rate Amount.", + "example": "40.00" + }, + "isFullUpdate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Indicates if this is a full update operation.", + "example": "1" + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "leaseTermName", + "amount" + ] + } + } + }, + "required": [ + "propertyId", + "pricing" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgetedRent" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 4 + }, + "pricingLevelId": { + "type": "integer", + "description": " This is a required field. This field accepts single value. Pricing level has two possible values, 3 for Unit type and 4 for Unit space.", + "format": "integer", + "example": 123456 + }, + "pricingLevelReferenceId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 3 then pricingLevelReferenceId needs to be unit type id a nd if pricingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.", + "format": "integer", + "example": 1 + }, + "amenityAmount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Amenity rate amount.", + "format": "float", + "example": 20 + }, + "amount": { + "type": "integer", + "description": "This is a required field. This field accepts single value. amount", + "format": "float", + "example": 20 + } + }, + "required": [ + "propertyId", + "pricingLevelId", + "pricingLevelReferenceId", + "amount" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPricingPicklists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyFees\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"example\": \"12345\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"insertPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4,\n \"description\": \"This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.\"\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.\"\n },\n \"chargeUsageId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance\"\n },\n \"chargeUsageReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0.\"\n },\n \"isRenewal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is an optional field. This field accepts single value. Just to specify if it is renewal rent.\"\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 307,\n \"description\": \"This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed\"\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit\"\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.\"\n },\n \"leaseTermMonths\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12,\n \"description\": \"This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms.\"\n },\n \"leaseStartRangeStart\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit`s available on the date [if available on a date is in future]. If sending \\\"isRenewal\\\" as true this value should always be sent as 0\"\n },\n \"leaseStartRangeEnd\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 10000,\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending \\\"isRenewal\\\" as true this value should always be sent as 0\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1840,\n \"description\": \"This is a required field. This field accepts single value. Rate Amount.\"\n },\n \"leaseTermName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory.\"\n }\n },\n \"required\": [\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"chargeUsageId\",\n \"chargeUsageReferenceId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"amount\",\n \"leaseTermName\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"insertPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\",\n \"example\": 1381146\n },\n \"pricing\": {\n \"type\": \"array\",\n \"description\": \"Array of pricing objects\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.\",\n \"example\": 3\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId.\",\n \"example\": 639824\n },\n \"chargeUsageId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance\",\n \"example\": 1\n },\n \"isRenewal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Just to specify if it is renewal rent.\",\n \"example\": 0\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing].\",\n \"example\": 303\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit\",\n \"example\": 2\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.\",\n \"example\": 224711\n },\n \"leaseTermMonths\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing for different terms.\",\n \"example\": 13\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Lease term identifier.\",\n \"example\": 33549\n },\n \"leaseStartWindowId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Lease start window identifier.\",\n \"example\": 240891\n },\n \"spaceConfigurationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Space configuration identifier.\",\n \"example\": 2\n },\n \"leaseTermName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is mandatory.\",\n \"example\": \"Lease Term 2\"\n },\n \"leaseStartRangeStart\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRenewal' as true this value should always be sent as 0\",\n \"example\": 2\n },\n \"leaseStartRangeEnd\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0\",\n \"example\": 4\n },\n \"amount\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. Rate Amount.\",\n \"example\": \"40.00\"\n },\n \"isFullUpdate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value. Indicates if this is a full update operation.\",\n \"example\": \"1\"\n }\n },\n \"required\": [\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"chargeUsageId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"leaseTermName\",\n \"amount\"\n ]\n }\n }\n },\n \"required\": [\n \"propertyId\",\n \"pricing\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendBudgetedRent\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Pricing level has two possible values, 3 for Unit type and 4 for Unit space.\"\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 3 then pricingLevelReferenceId needs to be unit type id a nd if pricingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.\"\n },\n \"amenityAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 20,\n \"description\": \"This is an optional field. This field accepts single value. Amenity rate amount.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 20,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"amount\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getPricingPicklists\": {\n \"$ref\": \"#/components/examples/getPricingPicklistsRequest\"\n },\n \"getPropertyFees\": {\n \"$ref\": \"#/components/examples/getPropertyFeesRequest\"\n },\n \"insertPricing\": {\n \"$ref\": \"#/components/examples/insertPricingRequest\"\n },\n \"insertPricing_r2\": {\n \"$ref\": \"#/components/examples/insertPricingRequest_r2\"\n },\n \"sendBudgetedRent\": {\n \"$ref\": \"#/components/examples/sendBudgetedRentRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_property_details", + "description": { + "tagline": "Retrieve details of properties for a specific organization.", + "detailed": "This tool accesses property details for a specific organization using the Entrata API. It should be called when detailed property information is needed, such as for property management or listings." + }, + "return_annotation": "Details of properties for the specified organization.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "client_domain" + ], + "description": "The subdomain representing the specific client or organization for which property details are requested.", + "endpoint_argument_name": "orgs" + }, + { + "name": "property_request_body", + "alternative_names": [ + "property_details_payload", + "property_info_data" + ], + "description": "The JSON array containing the request details for fetching property information. This should include any necessary filters or criteria.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "pagination_page", + "result_page_number" + ], + "description": "The current page number to retrieve in a paginated response.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "results_per_page", + "entries_per_page" + ], + "description": "Number of items to return per page in the response.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "send_pagination_links", + "pagination_links_in_response" + ], + "description": "Set to 1 to include pagination links in the response; 0 to exclude them.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/properties", + "tags": [ + "properties" + ], + "summary": "Properties related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getAmenityReservations, getPropertyMedia, getReservableAmenities`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenityReservations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 12345 + }, + "amenityIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1234,5678" + }, + "amenityReservationStatusTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "fromDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 7 da y range is allowed per request and that range includes the fromDate an d toDate in it.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 7 day range is allowed per request and that range includes the fromDate and toDate in it.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "calendarEventCategoryIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. Calendar Event type ids. Possible id: 1-General, 2-Resident, 3-Leasing , 4-Maintenance If no Id`s are passed only Resident and Leasing cat egories are considered by default.", + "format": "integer", + "example": "1,2" + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 123456 + }, + "fromDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 60 d ay range is allowed per request and that range includes the fromDate and toDate in it.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 60 day range is allowed per request and that range includes the fromDate and toDate in it.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "tourType": { + "type": "string", + "description": "This is a required field. This field accepts single value. tour type: SELF_GUIDED, VIRTUAL_GUIDED,AGENT_GUIDED", + "format": "string", + "example": "SELF_GUIDED" + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getFloorPlans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 12345 + }, + "propertyFloorPlanIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyFloorPlanIds.", + "format": "string", + "example": "456789,123222" + }, + "usePropertyPreferences": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Checks for the property settings manipulate floorplan data and honour those settings.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledFloorplans": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided value is 1, then user should get disabled floorplans along with the enabled one.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPetTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. List of comma seperated propertyIds", + "format": "string", + "example": "456789,123222" + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getProperties" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. PropertyIds", + "format": "string", + "example": "12345,5678" + }, + "propertyLookupCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "ABC" + }, + "showAllStatus": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Show all properties with any status.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAnnouncements" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties", + "format": "string", + "example": "12345,5678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties", + "format": "string", + "example": "12345,5678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getReservableAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "amenityIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,655" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWebsites" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values. PropertyIds", + "format": "integer", + "example": "12345,5678" + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendFloorplans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts the property id on which the floorplan will get added.", + "format": "integer", + "example": 12345 + }, + "name": { + "type": "string", + "description": "This is a required field. This field accepts single value. This node accepts the name of the floorplan.", + "format": "string", + "example": "ABC" + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts the description of the floorplan", + "format": "string", + "example": "description" + }, + "seoTitle": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts the seoTitle of the floorplan", + "format": "string", + "example": "seo title" + }, + "seoDescription": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts the seoDescription of the floorplan", + "format": "string", + "example": "seo description" + }, + "seoKeywords": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node accepts the seoKeywords of the floorplan", + "format": "string", + "example": "seo keyword" + }, + "isPublished": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0, whether the floorplan needs to be published or not.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isDisabledVirtualMoveIn": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "minSquareFeet": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts the minimum square feet value of the floorplan.", + "format": "float", + "example": 200 + }, + "maxSquareFeet": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts the maximun square feet value of the floorplan.", + "format": "float", + "example": 1000 + }, + "numberOfBedRooms": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts a total number of bedrooms.", + "format": "float", + "example": 1 + }, + "numberOfBathRooms": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node accepts a total number of bathrooms.", + "format": "float", + "example": 1 + }, + "isFeatured": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "categoryId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "name": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Furniture A" + }, + "showOnWebsite": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isMarketed": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "hasInventory": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "availabilityStatusId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "FurnitureTesting" + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "123456" + }, + "mediaTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "6" + }, + "mediaSubTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "24" + }, + "referenceIds": { + "type": "string", + "description": "This is an optional field. This field accepts single value. reference id for mediaType", + "example": "987654" + } + }, + "required": [ + "propertyId", + "mediaTypeId", + "mediaSubTypeId" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyMedia" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "123456" + }, + "media": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "allOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the media", + "example": "100001" + }, + "mediaTypeId": { + "type": "string", + "description": "Type identifier for the media", + "example": "6" + }, + "mediaTypeName": { + "type": "string", + "description": "Name of the media type", + "example": "unit_floorplan_medias" + }, + "mediaSubTypeId": { + "type": "string", + "description": "Sub-type identifier for the media", + "example": "24" + }, + "mediaSubTypeName": { + "type": "string", + "description": "Name of the media sub-type", + "example": "ABC" + }, + "referenceId": { + "type": "string", + "description": "Reference identifier", + "example": "987654" + }, + "mediaProvider": { + "type": "string", + "description": "Provider of the media", + "example": "XYZ" + }, + "mediaUrl": { + "type": "string", + "description": "URL of the media", + "example": "https://www.example.com/demo1" + }, + "mediaAltText": { + "type": "string", + "description": "Alternative text for the media", + "example": "business_demo1" + }, + "name": { + "type": "string", + "description": "Name of the media", + "example": "demo_name1" + }, + "description": { + "type": "string", + "description": "Description of the media", + "example": "demo_description1" + }, + "caption": { + "type": "string", + "description": "Caption for the media", + "example": "demo_caption1" + }, + "height": { + "type": "string", + "description": "Height of the media", + "example": "800" + }, + "width": { + "type": "string", + "description": "Width of the media", + "example": "600" + }, + "mediaFormat": { + "type": "string", + "description": "Format of the media", + "example": "jpeg" + } + }, + "required": [ + "id", + "mediaTypeId", + "mediaTypeName", + "mediaSubTypeId", + "mediaSubTypeName", + "referenceId", + "mediaProvider", + "mediaUrl" + ] + } + ] + } + } + }, + "required": [ + "propertyId", + "media" + ] + } + }, + "required": [ + "name", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyMedia" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "999999" + }, + "media": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "allOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the media", + "example": "100001" + }, + "mediaTypeId": { + "type": "string", + "description": "Type identifier for the media", + "example": "6" + }, + "mediaTypeName": { + "type": "string", + "description": "Name of the media type", + "example": "unit_floorplan_medias" + }, + "mediaSubTypeId": { + "type": "string", + "description": "Sub-type identifier for the media", + "example": "24" + }, + "mediaSubTypeName": { + "type": "string", + "description": "Name of the media sub-type", + "example": "ABC" + }, + "referenceId": { + "type": "string", + "description": "Reference identifier", + "example": "987654" + }, + "mediaProvider": { + "type": "string", + "description": "Provider of the media", + "example": "XYZ" + }, + "mediaUrl": { + "type": "string", + "description": "URL of the media", + "example": "https://www.example.com/demo1" + }, + "mediaAltText": { + "type": "string", + "description": "Alternative text for the media", + "example": "business_demo1" + }, + "name": { + "type": "string", + "description": "Name of the media", + "example": "demo_name1" + }, + "description": { + "type": "string", + "description": "Description of the media", + "example": "demo_description1" + }, + "caption": { + "type": "string", + "description": "Caption for the media", + "example": "demo_caption1" + }, + "height": { + "type": "string", + "description": "Height of the media", + "example": "800" + }, + "width": { + "type": "string", + "description": "Width of the media", + "example": "600" + }, + "mediaFormat": { + "type": "string", + "description": "Format of the media", + "example": "jpeg" + } + }, + "required": [ + "id", + "mediaTypeId", + "mediaTypeName", + "mediaSubTypeId", + "mediaSubTypeName", + "referenceId", + "mediaProvider", + "mediaUrl" + ] + } + ] + } + } + }, + "required": [ + "propertyId", + "media" + ] + } + }, + "required": [ + "name", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "1002" + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "deletePropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "Required. The unique identifier for the property.", + "example": "999999" + }, + "id": { + "type": "string", + "description": "Required. The unique identifier for the media.", + "example": "555555" + } + }, + "required": [ + "propertyId", + "id" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPhoneNumber" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "array", + "description": "Array of property IDs", + "items": { + "type": "integer" + } + }, + "switchCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "46545" + }, + "ref": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "http://google.com" + } + } + } + }, + "required": [ + "name", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAmenityReservations\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"amenityIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"amenityReservationStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 7 da y range is allowed per request and that range includes the fromDate an d toDate in it.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 7 day range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"calendarEventCategoryIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Calendar Event type ids. Possible id: 1-General, 2-Resident, 3-Leasing , 4-Maintenance If no Id`s are passed only Resident and Leasing cat egories are considered by default.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"fromDate\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 60 d ay range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 60 day range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"tourType\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"SELF_GUIDED\",\n \"description\": \"This is a required field. This field accepts single value. tour type: SELF_GUIDED, VIRTUAL_GUIDED,AGENT_GUIDED\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"fromDate\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getFloorPlans\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"propertyFloorPlanIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"456789,123222\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. propertyFloorPlanIds.\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Checks for the property settings manipulate floorplan data and honour those settings.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value is 1, then user should get disabled floorplans along with the enabled one.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPetTypes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"456789,123222\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. List of comma seperated propertyIds\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getProperties\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. PropertyIds\"\n },\n \"propertyLookupCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showAllStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Show all properties with any status.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyAddOns\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyAnnouncements\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getRentableItems\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getReservableAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"amenityIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,655\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWebsites\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. PropertyIds\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendFloorplans\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This node accepts the property id on which the floorplan will get added.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. This node accepts the name of the floorplan.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"description\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the description of the floorplan\"\n },\n \"seoTitle\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo title\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoTitle of the floorplan\"\n },\n \"seoDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo description\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoDescription of the floorplan\"\n },\n \"seoKeywords\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo keyword\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoKeywords of the floorplan\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0, whether the floorplan needs to be published or not.\"\n },\n \"isDisabledVirtualMoveIn\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0.\"\n },\n \"minSquareFeet\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 200,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the minimum square feet value of the floorplan.\"\n },\n \"maxSquareFeet\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1000,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the maximun square feet value of the floorplan.\"\n },\n \"numberOfBedRooms\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This node accepts a total number of bedrooms.\"\n },\n \"numberOfBathRooms\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This node accepts a total number of bathrooms.\"\n },\n \"isFeatured\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"name\",\n \"numberOfBedRooms\",\n \"numberOfBathRooms\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendRentableItems\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"categoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showOnWebsite\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isMarketed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"hasInventory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"availabilityStatusId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FurnitureTesting\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"name\",\n \"numberOfBedRooms\",\n \"numberOfBathRooms\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyMedia\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"mediaTypeId\",\n \"mediaSubTypeId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"123456\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"6\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"24\"\n },\n \"referenceIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value. reference id for mediaType\",\n \"example\": \"987654\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPropertyMedia\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"media\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. The unique identifier for the property.\",\n \"example\": \"123456\"\n },\n \"media\": {\n \"type\": \"array\",\n \"items\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"mediaTypeId\",\n \"mediaTypeName\",\n \"mediaSubTypeId\",\n \"mediaSubTypeName\",\n \"referenceId\",\n \"mediaProvider\",\n \"mediaUrl\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier for the media\",\n \"example\": \"100001\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"Type identifier for the media\",\n \"example\": \"6\"\n },\n \"mediaTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media type\",\n \"example\": \"unit_floorplan_medias\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"Sub-type identifier for the media\",\n \"example\": \"24\"\n },\n \"mediaSubTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media sub-type\",\n \"example\": \"ABC\"\n },\n \"referenceId\": {\n \"type\": \"string\",\n \"description\": \"Reference identifier\",\n \"example\": \"987654\"\n },\n \"mediaProvider\": {\n \"type\": \"string\",\n \"description\": \"Provider of the media\",\n \"example\": \"XYZ\"\n },\n \"mediaUrl\": {\n \"type\": \"string\",\n \"description\": \"URL of the media\",\n \"example\": \"https://www.example.com/demo1\"\n },\n \"mediaAltText\": {\n \"type\": \"string\",\n \"description\": \"Alternative text for the media\",\n \"example\": \"business_demo1\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the media\",\n \"example\": \"demo_name1\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the media\",\n \"example\": \"demo_description1\"\n },\n \"caption\": {\n \"type\": \"string\",\n \"description\": \"Caption for the media\",\n \"example\": \"demo_caption1\"\n },\n \"height\": {\n \"type\": \"string\",\n \"description\": \"Height of the media\",\n \"example\": \"800\"\n },\n \"width\": {\n \"type\": \"string\",\n \"description\": \"Width of the media\",\n \"example\": \"600\"\n },\n \"mediaFormat\": {\n \"type\": \"string\",\n \"description\": \"Format of the media\",\n \"example\": \"jpeg\"\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updatePropertyMedia\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"media\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. The unique identifier for the property.\",\n \"example\": \"999999\"\n },\n \"media\": {\n \"type\": \"array\",\n \"items\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"mediaTypeId\",\n \"mediaTypeName\",\n \"mediaSubTypeId\",\n \"mediaSubTypeName\",\n \"referenceId\",\n \"mediaProvider\",\n \"mediaUrl\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier for the media\",\n \"example\": \"100001\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"Type identifier for the media\",\n \"example\": \"6\"\n },\n \"mediaTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media type\",\n \"example\": \"unit_floorplan_medias\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"Sub-type identifier for the media\",\n \"example\": \"24\"\n },\n \"mediaSubTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media sub-type\",\n \"example\": \"ABC\"\n },\n \"referenceId\": {\n \"type\": \"string\",\n \"description\": \"Reference identifier\",\n \"example\": \"987654\"\n },\n \"mediaProvider\": {\n \"type\": \"string\",\n \"description\": \"Provider of the media\",\n \"example\": \"XYZ\"\n },\n \"mediaUrl\": {\n \"type\": \"string\",\n \"description\": \"URL of the media\",\n \"example\": \"https://www.example.com/demo1\"\n },\n \"mediaAltText\": {\n \"type\": \"string\",\n \"description\": \"Alternative text for the media\",\n \"example\": \"business_demo1\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the media\",\n \"example\": \"demo_name1\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the media\",\n \"example\": \"demo_description1\"\n },\n \"caption\": {\n \"type\": \"string\",\n \"description\": \"Caption for the media\",\n \"example\": \"demo_caption1\"\n },\n \"height\": {\n \"type\": \"string\",\n \"description\": \"Height of the media\",\n \"example\": \"800\"\n },\n \"width\": {\n \"type\": \"string\",\n \"description\": \"Width of the media\",\n \"example\": \"600\"\n },\n \"mediaFormat\": {\n \"type\": \"string\",\n \"description\": \"Format of the media\",\n \"example\": \"jpeg\"\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response.\",\n \"example\": \"1002\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"deletePropertyMedia\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"id\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. The unique identifier for the property.\",\n \"example\": \"999999\"\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Required. The unique identifier for the media.\",\n \"example\": \"555555\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPhoneNumber\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\"\n },\n \"description\": \"Array of property IDs\",\n \"example\": [\n 123456,\n 789\n ]\n },\n \"switchCode\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value.\",\n \"example\": \"46545\"\n },\n \"ref\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value.\",\n \"example\": \"http://google.com\"\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAmenityReservations\": {\n \"$ref\": \"#/components/examples/getAmenityReservationsRequest\"\n },\n \"getCalendarAvailability_r1\": {\n \"$ref\": \"#/components/examples/getCalendarAvailabilityRequest_r1\"\n },\n \"getCalendarAvailability_r2\": {\n \"$ref\": \"#/components/examples/getCalendarAvailabilityRequest_r2\"\n },\n \"getFloorPlans\": {\n \"$ref\": \"#/components/examples/getFloorPlansRequest\"\n },\n \"getPetTypes\": {\n \"$ref\": \"#/components/examples/getPetTypesRequest\"\n },\n \"getProperties\": {\n \"$ref\": \"#/components/examples/getPropertiesRequest\"\n },\n \"getPropertyAddOns\": {\n \"$ref\": \"#/components/examples/getPropertyAddOnsRequest\"\n },\n \"getPropertyAnnouncements\": {\n \"$ref\": \"#/components/examples/getPropertyAnnouncementsRequest\"\n },\n \"getPropertyPickLists_r1\": {\n \"$ref\": \"#/components/examples/getPropertyPickListsRequest_r1\"\n },\n \"getPropertyPickLists_r2\": {\n \"$ref\": \"#/components/examples/getPropertyPickListsRequest_r2\"\n },\n \"getRentableItems\": {\n \"$ref\": \"#/components/examples/getRentableItemsRequest\"\n },\n \"getReservableAmenities\": {\n \"$ref\": \"#/components/examples/getReservableAmenitiesRequest\"\n },\n \"getWebsites\": {\n \"$ref\": \"#/components/examples/getWebsitesRequest\"\n },\n \"sendFloorplans\": {\n \"$ref\": \"#/components/examples/sendFloorplansRequest\"\n },\n \"sendRentableItems\": {\n \"$ref\": \"#/components/examples/sendRentableItemsRequest\"\n },\n \"getPropertyMedia\": {\n \"$ref\": \"#/components/examples/getPropertyMediaRequest\"\n },\n \"sendPropertyMedia\": {\n \"$ref\": \"#/components/examples/sendPropertyMediaRequest\"\n },\n \"updatePropertyMedia\": {\n \"$ref\": \"#/components/examples/updatePropertyMediaRequest\"\n },\n \"deletePropertyMedia\": {\n \"$ref\": \"#/components/examples/deletePropertyMediaRequest\"\n },\n \"getPhoneNumber\": {\n \"$ref\": \"#/components/examples/getPhoneNumberRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "create_property_unit", + "description": { + "tagline": "Add a new property unit to the system.", + "detailed": "This tool creates a new property unit within the specified organization. It should be called when there is a need to register or add information about a new unit in a property management system." + }, + "return_annotation": "Confirms creation of a property unit.", + "arguments": [ + { + "name": "client_subdomain", + "alternative_names": [ + "organization_subdomain", + "tenant_subdomain" + ], + "description": "The subdomain of the client organization where the property unit should be added.", + "endpoint_argument_name": "orgs" + }, + { + "name": "property_unit_details", + "alternative_names": [ + "unit_information", + "property_unit_data" + ], + "description": "A JSON array containing the details of the property unit to be created, such as unit identifier, size, and location.", + "endpoint_argument_name": "requestBody" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/propertyunits", + "tags": [ + "propertyunits" + ], + "summary": "Property Units related APIs", + "description": "", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 12345 + }, + "unitNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Unit Number", + "format": "integer", + "example": 1 + }, + "chargeCodeTypeIds": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "1,2,3" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values. PSI Property Identification number", + "format": "string", + "example": "12345,5678" + }, + "availableUnitsOnly": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for getting available units only", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "usePropertyPreferences": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing preferences on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledFloorplans": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledUnits": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "showUnitSpaces": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing Unit Spaces on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "description": "This is a required field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "12345,5678" + }, + "availableUnitsOnly": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "usePropertyPreferences": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If enabled then the Entrata setting \"Max Available Units per Floor P lan\" will be honored and the available units returned will be reduced. Also requires using the availableUnitsOnly parameter as true (1).", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledFloorplans": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledUnits": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyIds" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property ID for getting Specials", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property ID for getting Specials", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r3" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property ID for getting Specials", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response", + "example": "15" + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getSpecials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r4" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for getting Specials", + "example": "1234567" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitsAvailabilityAndPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Property Id", + "format": "integer", + "example": 12345 + }, + "floorplanId": { + "type": "integer", + "description": " This is an optional field. This field accepts single value. Floorplan Id", + "format": "integer", + "example": 12345 + }, + "unitTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Unit Type Id", + "format": "integer", + "example": 12345 + }, + "propertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Property Unit Id", + "format": "integer", + "example": 12345 + }, + "availableUnitsOnly": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "unavailableUnitsOnly": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "skipPricing": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "showChildProperties": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledFloorplans": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeDisabledUnits": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "showUnitSpaces": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. showUnitSpaces", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "useSpaceConfiguration": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "allowLeaseExpirationOverride": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If \"1\" is sent then we should override any lease expiration limits aff ecting available units returned/ If \"0\" or node is missing then do cur rent default functionality", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "moveInStartDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "moveInEndDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing.", + "format": "date", + "example": "MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This field accepts a single integer value for Property ID", + "format": "integer", + "example": 12345 + }, + "name": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This accepts name of the amenity", + "format": "string", + "example": "Furniture A" + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This accepts description of the amenity.", + "format": "string", + "example": "Furniture A" + }, + "isPublished": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0 ,whether amenity needs to be published or not .", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "unitSpaceId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This accepts unit space id for the amenity.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "unitNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value. This node should accept the unitNumber.", + "format": "string", + "example": 20 + }, + "unitPrefix": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNunber prefix", + "format": "string", + "example": "CC" + }, + "unitSuffix": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNumber suffix", + "format": "string", + "example": "BB" + }, + "spaceNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accept the spaceNumber on added unit.", + "format": "integer", + "example": 1 + }, + "maxOccupants": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accepts the maxOccupants of the property units", + "format": "integer", + "example": 3 + }, + "maxPets": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accepts the maxPets of the property units", + "format": "integer", + "example": 11 + }, + "numberOfBedRooms": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accepts the beds number of the property units", + "format": "integer", + "example": 2 + }, + "numberOfBathRooms": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accepts the bathRooms of the property units", + "format": "integer", + "example": 2 + }, + "squareFeet": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accept the squareFeet of the property units", + "format": "integer", + "example": 2000 + }, + "note": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node should accept the note added for the property units", + "format": "string", + "example": "Testing property" + }, + "unitGenderId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node should accept the Id of the gender. The unitGenderId should be get from getPropertyPickLists.", + "format": "integer", + "example": "1" + } + }, + "required": [ + "unitNumber" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. Property ID for insert Specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "properties": { + "specialGroupName": { + "type": "string", + "description": "This is a required field. This accepts the Special Group name.", + "example": "Test Insert Special API" + }, + "internalDescription": { + "type": "string", + "description": "This is an optional field. Internal description not visible to residents.", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "This is an optional field. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "This is an optional field. Determines if special is eligible to be used.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "This is an optional field. Determines if special will be shown in advertising.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised from.", + "example": "04/01/2025" + }, + "endDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised to.", + "example": "04/30/2025" + }, + "hideEndDate": { + "type": "string", + "description": "This is an optional field. Determines if special end date will be advertised.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "This is an optional field. Description shown to residents.", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "This is an optional field. Terms and conditions for specials.", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "This is an optional field. Determines if special is manual only.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. Start of move-in date range.", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. End of move-in date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "This is an optional field. Start of renewal date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "This is an optional field. End of renewal date range.", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "This is an optional field. Allows setting limits on specials.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "This is an optional field. Limits number of specials given.", + "example": "10" + }, + "couponCode": { + "type": "string", + "description": "This is an optional field. Promotional code required during application.", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "This is an optional field. Source of promo code.", + "example": "56789" + }, + "incentiveLimit": { + "type": "string", + "description": "This is an optional field. Number of incentives resident receives.", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "This is an optional field. If specials incentive count matches limit.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "12345" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "456789" + } + }, + "required": [ + "leaseTermId", + "leaseStartWindowId" + ] + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "This is an optional field. Comma separated recipient IDs.", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "This is an optional field. Special trigger type for prospects.", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "This is an optional field. Special trigger type for renewals.", + "example": "22" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "This is an optional field. Comma separated space configuration IDs.", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialTypeId": { + "type": "string", + "description": "This is a required field. Special type identifier.", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "This is a required field. Name of the special.", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "This is an optional field. Value of gift type special.", + "example": "0.00" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "arCodeId": { + "type": "string", + "description": "This is an optional field. AR code identifier.", + "example": "123456" + }, + "arTriggerId": { + "type": "string", + "description": "This is an optional field. AR trigger identifier.", + "example": "111" + }, + "arCodeTypeId": { + "type": "string", + "description": "This is an optional field. AR code type identifier.", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "This is an optional field. Customer relationship identifier.", + "example": "" + }, + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "This is a required field. Integer representation of lease term.", + "example": "1" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "999999" + }, + "windowStartDate": { + "type": "string", + "description": "This is an optional field. Start date for lease window.", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "This is an optional field. End date for lease window.", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "This is a required field. AR formula identifier.", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "This is an optional field. Month when special starts.", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "This is a required field. Rate amount.", + "example": "100.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "This is an optional field. Increment for percent base formula.", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "This is an optional field. Additional formula information.", + "example": "0" + }, + "spaceConfigurationId": { + "type": "string", + "description": "This is an optional field. Space configuration identifier.", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "This is a required field. Display within Entrata.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "This is a required field. Display on website.", + "enum": [ + "0", + "1" + ], + "example": "1" + } + }, + "required": [ + "leaseTermId", + "leaseTermMonth", + "leaseStartWindowId", + "arFormulaId", + "rateAmount", + "showInEntrata", + "showOnWebsite" + ] + } + } + }, + "required": [ + "specialTypeId", + "specialName" + ] + } + } + }, + "required": [ + "specialGroupName" + ] + } + }, + "required": [ + "propertyId", + "specialGroup" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. This node should accept the amenity id which needs to be updated", + "format": "integer", + "example": 12345 + }, + "name": { + "type": "string", + "description": "This is a required field. This field accepts single value. This node should accept the amenity name.", + "format": "string", + "example": "property amenity" + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This node should accept the amenity description.", + "format": "string", + "example": "Test amenity" + }, + "isPublished": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isFeatured": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "showOnQuote": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node indicates if the amenities are visible on quotes or not. Th is flag is supported only for property and unit space amenities.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "hideDescription": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "videoUrl": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4" + }, + "defaultAmenityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 3 + }, + "amenityId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 2 + } + }, + "required": [ + "propertyId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response" + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for updating specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "properties": { + "specialGroupId": { + "type": "string", + "description": "Required. The ID of the special group to update", + "example": "55555" + }, + "specialGroupName": { + "type": "string", + "description": "Required. Name of the special group", + "example": "Test Update Special API" + }, + "internalDescription": { + "type": "string", + "description": "Optional. Internal description not visible to residents", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "Optional. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "Optional. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "Optional. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "Optional. Determines if special is eligible to be used", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "Optional. Determines if special will be shown in advertising", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "Optional. Date special will be advertised from", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "Optional. Date special will be advertised to", + "example": "MM/DD/YYYY" + }, + "hideEndDate": { + "type": "string", + "description": "Optional. Determines if special end date will be advertised", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "Optional. Description shown to residents", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "Optional. Terms and conditions for the specials", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "Optional. Determines if special is manual only", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "Optional. Start of move-in date range", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "Optional. End of move-in date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "Optional. Start of renewal date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "Optional. End of renewal date range", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "Optional. Allows setting limits on specials", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "Optional. Number of specials to be given", + "example": "12" + }, + "couponCode": { + "type": "string", + "description": "Optional. Promotional code for special", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "Optional. Source ID for promo code", + "example": "123456" + }, + "incentiveLimit": { + "type": "string", + "description": "Optional. Number of incentives resident can receive", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "Optional. If specials incentive count matches limit", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special group. otherwise do not pass this field.", + "example": 1 + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "leaseTermId": { + "type": "string", + "example": "55555" + }, + "leaseStartWindowId": { + "type": "string", + "example": "456789" + } + } + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "Optional. Comma-separated recipient IDs", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "Optional. Prospect trigger type ID", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "Optional. Renewal trigger type ID", + "example": "27" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "Optional. Comma-separated space configuration IDs", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialId": { + "type": "string", + "description": "Required. ID of the special", + "example": "1234567" + }, + "specialTypeId": { + "type": "string", + "description": "Required. Type ID of the special", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "Required. Name of the special", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "Optional. Value for gift type specials", + "example": "0.00" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special. otherwise do not pass this field.", + "example": 1 + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "arCodeId": { + "type": "string", + "description": "Optional. AR code identifier", + "example": "444444" + }, + "arTriggerId": { + "type": "string", + "description": "Optional. AR trigger identifier", + "example": "201" + }, + "arCodeTypeId": { + "type": "string", + "description": "Optional. AR code type identifier", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "Optional. Customer relationship identifier", + "example": "0" + }, + "leaseTermId": { + "type": "string", + "description": "Optional. Lease term identifier", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "Optional. Integer representation of lease term", + "example": "6" + }, + "leaseStartWindowId": { + "type": "string", + "description": "Optional. Lease start window identifier", + "example": "456789" + }, + "windowStartDate": { + "type": "string", + "description": "Optional. Start date for lease window", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "Optional. End date for lease window", + "example": "MM/DD/YYYY" + }, + "effectiveDate": { + "type": "string", + "description": "Optional. Date rate becomes effective", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "Optional. AR formula identifier", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "Optional. Month when special starts", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "Optional. Rate amount", + "example": "40.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "Optional. Increment for percent base formula", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "Optional. Additional formula information", + "example": "" + }, + "spaceConfigurationId": { + "type": "string", + "description": "Optional. Space configuration identifier", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "Optional. Display within Entrata", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "Optional. Display on website", + "enum": [ + "0", + "1" + ], + "example": "1" + } + } + } + } + }, + "required": [ + "specialId", + "specialTypeId", + "specialName" + ] + } + } + }, + "required": [ + "specialGroupId", + "specialGroupName" + ] + } + }, + "required": [ + "propertyId", + "specialGroup" + ] + } + }, + "required": [ + "name", + "version", + "params" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"unitNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Unit Number\"\n },\n \"chargeCodeTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. PSI Property Identification number\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for getting available units only\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing preferences on result.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.\"\n },\n \"showUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Unit Spaces on result.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If enabled then the Entrata setting \\\"Max Available Units per Floor P lan\\\" will be honored and the available units returned will be reduced. Also requires using the availableUnitsOnly parameter as true (1).\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r3\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response\",\n \"example\": \"15\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getSpecials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r4\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. Property ID for getting Specials\",\n \"example\": \"1234567\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getUnitsAvailabilityAndPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Floorplan Id\"\n },\n \"unitTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Unit Type Id\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Property Unit Id\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units\"\n },\n \"unavailableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response.\"\n },\n \"skipPricing\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)\"\n },\n \"showChildProperties\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.\"\n },\n \"showUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. showUnitSpaces\"\n },\n \"useSpaceConfiguration\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration.\"\n },\n \"allowLeaseExpirationOverride\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If \\\"1\\\" is sent then we should override any lease expiration limits aff ecting available units returned/ If \\\"0\\\" or node is missing then do cur rent default functionality\"\n },\n \"moveInStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing.\"\n },\n \"moveInEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getUnitTypes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This field accepts a single integer value for Property ID\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value. This accepts name of the amenity\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value. This accepts description of the amenity.\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0 ,whether amenity needs to be published or not .\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This accepts unit space id for the amenity.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 20,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the unitNumber.\"\n },\n \"unitPrefix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CC\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the unitNunber prefix\"\n },\n \"unitSuffix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"BB\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the unitNumber suffix\"\n },\n \"spaceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the spaceNumber on added unit.\"\n },\n \"maxOccupants\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the maxOccupants of the property units\"\n },\n \"maxPets\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 11,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the maxPets of the property units\"\n },\n \"numberOfBedRooms\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the beds number of the property units\"\n },\n \"numberOfBathRooms\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the bathRooms of the property units\"\n },\n \"squareFeet\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2000,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the squareFeet of the property units\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Testing property\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the note added for the property units\"\n },\n \"unitGenderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the Id of the gender. The unitGenderId should be get from getPropertyPickLists.\"\n }\n },\n \"required\": [\n \"unitNumber\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendSpecialGroup\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"specialGroup\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Property ID for insert Specials\",\n \"example\": \"123456\"\n },\n \"specialGroup\": {\n \"type\": \"object\",\n \"required\": [\n \"specialGroupName\"\n ],\n \"properties\": {\n \"specialGroupName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This accepts the Special Group name.\",\n \"example\": \"Test Insert Special API\"\n },\n \"internalDescription\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Internal description not visible to residents.\",\n \"example\": \"Internal Desc\"\n },\n \"floorPlanIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated floor plan IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitTypeIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated unit type IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitSpaceIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated unit space IDs.\",\n \"example\": \"1,2,3\"\n },\n \"isActive\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special is eligible to be used.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"isWebVisible\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special will be shown in advertising.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Date special will be advertised from.\",\n \"example\": \"04/01/2025\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Date special will be advertised to.\",\n \"example\": \"04/30/2025\"\n },\n \"hideEndDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special end date will be advertised.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"marketingDescription\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Description shown to residents.\",\n \"example\": \"Marketing Desc\"\n },\n \"termsAndConditions\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Terms and conditions for specials.\",\n \"example\": \"Terms & conditions\"\n },\n \"isAdvertised\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special is manual only.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start of move-in date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End of move-in date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateFrom\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start of renewal date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateTo\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End of renewal date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"limitQuantity\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Allows setting limits on specials.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"quantityBudgeted\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Limits number of specials given.\",\n \"example\": \"10\"\n },\n \"couponCode\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Promotional code required during application.\",\n \"example\": \"PROMO123\"\n },\n \"leadSourceId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Source of promo code.\",\n \"example\": \"56789\"\n },\n \"incentiveLimit\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Number of incentives resident receives.\",\n \"example\": \"1\"\n },\n \"isSelectable\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. If specials incentive count matches limit.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"leaseTermDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseTermId\",\n \"leaseStartWindowId\"\n ],\n \"properties\": {\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease term identifier.\",\n \"example\": \"12345\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease start window identifier.\",\n \"example\": \"456789\"\n }\n }\n }\n },\n \"specialRecipientDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"specialRecipientIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated recipient IDs.\",\n \"example\": \"2,3\"\n },\n \"specialTriggerTypeIdProspect\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Special trigger type for prospects.\",\n \"example\": \"11\"\n },\n \"specialTriggerTypeIdRenewal\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Special trigger type for renewals.\",\n \"example\": \"22\"\n }\n }\n },\n \"specialGroupSpaceConfigurationIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated space configuration IDs.\",\n \"example\": \"2,3\"\n },\n \"specials\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"specialTypeId\",\n \"specialName\"\n ],\n \"properties\": {\n \"specialTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Special type identifier.\",\n \"example\": \"1\"\n },\n \"specialName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Name of the special.\",\n \"example\": \"conccession1\"\n },\n \"giftValue\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Value of gift type special.\",\n \"example\": \"0.00\"\n },\n \"rates\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseTermId\",\n \"leaseTermMonth\",\n \"leaseStartWindowId\",\n \"arFormulaId\",\n \"rateAmount\",\n \"showInEntrata\",\n \"showOnWebsite\"\n ],\n \"properties\": {\n \"arCodeId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR code identifier.\",\n \"example\": \"123456\"\n },\n \"arTriggerId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR trigger identifier.\",\n \"example\": \"111\"\n },\n \"arCodeTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR code type identifier.\",\n \"example\": \"2\"\n },\n \"customerRelationshipId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Customer relationship identifier.\",\n \"example\": \"\"\n },\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease term identifier.\",\n \"example\": \"55555\"\n },\n \"leaseTermMonth\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Integer representation of lease term.\",\n \"example\": \"1\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease start window identifier.\",\n \"example\": \"999999\"\n },\n \"windowStartDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start date for lease window.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"windowEndDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End date for lease window.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"arFormulaId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. AR formula identifier.\",\n \"example\": \"1\"\n },\n \"rateIntervalStart\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Month when special starts.\",\n \"example\": \"\"\n },\n \"rateAmount\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Rate amount.\",\n \"example\": \"100.00\"\n },\n \"rateIncreaseIncrement\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Increment for percent base formula.\",\n \"example\": \"\"\n },\n \"arFormulaReferenceId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Additional formula information.\",\n \"example\": \"0\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Space configuration identifier.\",\n \"example\": \"2\"\n },\n \"showInEntrata\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Display within Entrata.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"showOnWebsite\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Display on website.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the amenity id which needs to be updated\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"property amenity\",\n \"description\": \"This is a required field. This field accepts single value. This node should accept the amenity name.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test amenity\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the amenity description.\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isFeatured\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showOnQuote\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node indicates if the amenities are visible on quotes or not. Th is flag is supported only for property and unit space amenities.\"\n },\n \"hideDescription\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"videoUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultAmenityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"amenityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateSpecialGroup\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"specialGroup\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. Property ID for updating specials\",\n \"example\": \"123456\"\n },\n \"specialGroup\": {\n \"type\": \"object\",\n \"required\": [\n \"specialGroupId\",\n \"specialGroupName\"\n ],\n \"properties\": {\n \"specialGroupId\": {\n \"type\": \"string\",\n \"description\": \"Required. The ID of the special group to update\",\n \"example\": \"55555\"\n },\n \"specialGroupName\": {\n \"type\": \"string\",\n \"description\": \"Required. Name of the special group\",\n \"example\": \"Test Update Special API\"\n },\n \"internalDescription\": {\n \"type\": \"string\",\n \"description\": \"Optional. Internal description not visible to residents\",\n \"example\": \"Internal Desc\"\n },\n \"floorPlanIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated floor plan IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitTypeIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated unit type IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitSpaceIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated unit space IDs.\",\n \"example\": \"1,2,3\"\n },\n \"isActive\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special is eligible to be used\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"isWebVisible\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special will be shown in advertising\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date special will be advertised from\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date special will be advertised to\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"hideEndDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special end date will be advertised\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"marketingDescription\": {\n \"type\": \"string\",\n \"description\": \"Optional. Description shown to residents\",\n \"example\": \"Marketing Desc\"\n },\n \"termsAndConditions\": {\n \"type\": \"string\",\n \"description\": \"Optional. Terms and conditions for the specials\",\n \"example\": \"Terms & conditions\"\n },\n \"isAdvertised\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special is manual only\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start of move-in date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"description\": \"Optional. End of move-in date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateFrom\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start of renewal date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateTo\": {\n \"type\": \"string\",\n \"description\": \"Optional. End of renewal date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"limitQuantity\": {\n \"type\": \"string\",\n \"description\": \"Optional. Allows setting limits on specials\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"quantityBudgeted\": {\n \"type\": \"string\",\n \"description\": \"Optional. Number of specials to be given\",\n \"example\": \"12\"\n },\n \"couponCode\": {\n \"type\": \"string\",\n \"description\": \"Optional. Promotional code for special\",\n \"example\": \"PROMO123\"\n },\n \"leadSourceId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Source ID for promo code\",\n \"example\": \"123456\"\n },\n \"incentiveLimit\": {\n \"type\": \"string\",\n \"description\": \"Optional. Number of incentives resident can receive\",\n \"example\": \"1\"\n },\n \"isSelectable\": {\n \"type\": \"string\",\n \"description\": \"Optional. If specials incentive count matches limit\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"description\": \"Optional. pass this field if only wants to delete the special group. otherwise do not pass this field.\",\n \"example\": 1\n },\n \"leaseTermDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"leaseTermId\": {\n \"type\": \"string\",\n \"example\": \"55555\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"example\": \"456789\"\n }\n }\n }\n },\n \"specialRecipientDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"specialRecipientIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma-separated recipient IDs\",\n \"example\": \"2,3\"\n },\n \"specialTriggerTypeIdProspect\": {\n \"type\": \"string\",\n \"description\": \"Optional. Prospect trigger type ID\",\n \"example\": \"11\"\n },\n \"specialTriggerTypeIdRenewal\": {\n \"type\": \"string\",\n \"description\": \"Optional. Renewal trigger type ID\",\n \"example\": \"27\"\n }\n }\n },\n \"specialGroupSpaceConfigurationIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma-separated space configuration IDs\",\n \"example\": \"2,3\"\n },\n \"specials\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"specialId\",\n \"specialTypeId\",\n \"specialName\"\n ],\n \"properties\": {\n \"specialId\": {\n \"type\": \"string\",\n \"description\": \"Required. ID of the special\",\n \"example\": \"1234567\"\n },\n \"specialTypeId\": {\n \"type\": \"string\",\n \"description\": \"Required. Type ID of the special\",\n \"example\": \"1\"\n },\n \"specialName\": {\n \"type\": \"string\",\n \"description\": \"Required. Name of the special\",\n \"example\": \"conccession1\"\n },\n \"giftValue\": {\n \"type\": \"string\",\n \"description\": \"Optional. Value for gift type specials\",\n \"example\": \"0.00\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"description\": \"Optional. pass this field if only wants to delete the special. otherwise do not pass this field.\",\n \"example\": 1\n },\n \"rates\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"arCodeId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR code identifier\",\n \"example\": \"444444\"\n },\n \"arTriggerId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR trigger identifier\",\n \"example\": \"201\"\n },\n \"arCodeTypeId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR code type identifier\",\n \"example\": \"2\"\n },\n \"customerRelationshipId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Customer relationship identifier\",\n \"example\": \"0\"\n },\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Lease term identifier\",\n \"example\": \"55555\"\n },\n \"leaseTermMonth\": {\n \"type\": \"string\",\n \"description\": \"Optional. Integer representation of lease term\",\n \"example\": \"6\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Lease start window identifier\",\n \"example\": \"456789\"\n },\n \"windowStartDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start date for lease window\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"windowEndDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. End date for lease window\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"effectiveDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date rate becomes effective\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"arFormulaId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR formula identifier\",\n \"example\": \"1\"\n },\n \"rateIntervalStart\": {\n \"type\": \"string\",\n \"description\": \"Optional. Month when special starts\",\n \"example\": \"\"\n },\n \"rateAmount\": {\n \"type\": \"string\",\n \"description\": \"Optional. Rate amount\",\n \"example\": \"40.00\"\n },\n \"rateIncreaseIncrement\": {\n \"type\": \"string\",\n \"description\": \"Optional. Increment for percent base formula\",\n \"example\": \"\"\n },\n \"arFormulaReferenceId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Additional formula information\",\n \"example\": \"\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Space configuration identifier\",\n \"example\": \"2\"\n },\n \"showInEntrata\": {\n \"type\": \"string\",\n \"description\": \"Optional. Display within Entrata\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"showOnWebsite\": {\n \"type\": \"string\",\n \"description\": \"Optional. Display on website\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAmenities\": {\n \"$ref\": \"#/components/examples/getAmenitiesRequest\"\n },\n \"getMitsPropertyUnits\": {\n \"$ref\": \"#/components/examples/getMitsPropertyUnitsRequest\"\n },\n \"getPropertyUnits\": {\n \"$ref\": \"#/components/examples/getPropertyUnitsRequest\"\n },\n \"getSpecials_r1\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r1\"\n },\n \"getSpecials_r2\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r2\"\n },\n \"getSpecials_r3\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r3\"\n },\n \"getSpecials_r4\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r4\"\n },\n \"getUnitsAvailabilityAndPricing\": {\n \"$ref\": \"#/components/examples/getUnitsAvailabilityAndPricingRequest\"\n },\n \"getUnitTypes\": {\n \"$ref\": \"#/components/examples/getUnitTypesRequest\"\n },\n \"sendAmenities\": {\n \"$ref\": \"#/components/examples/sendAmenitiesRequest\"\n },\n \"sendPropertyUnits\": {\n \"$ref\": \"#/components/examples/sendPropertyUnitsRequest\"\n },\n \"sendSpecialGroup\": {\n \"$ref\": \"#/components/examples/sendSpecialGroupRequest\"\n },\n \"updateAmenities\": {\n \"$ref\": \"#/components/examples/updateAmenitiesRequest\"\n },\n \"updateSpecialGroup\": {\n \"$ref\": \"#/components/examples/updateSpecialGroupRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + }, + { + "name": "", + "selected_for_wrapping": false, + "spec_built": true, + "wrap_finished": true, + "should_skip": false, + "skip_reason": null, + "wrapper_tool": { + "name": "get_vendors", + "description": { + "tagline": "Retrieve a list of vendors for a given organization.", + "detailed": "This tool fetches vendor information from Entrata for a specified organization. Use it to obtain a comprehensive list of vendors associated with an organization ID." + }, + "return_annotation": "List of vendors for the specified organization.", + "arguments": [ + { + "name": "organization_subdomain", + "alternative_names": [ + "client_subdomain", + "org_subdomain" + ], + "description": "The subdomain representing the organization to retrieve vendors for.", + "endpoint_argument_name": "orgs" + }, + { + "name": "vendor_request_body", + "alternative_names": [ + "vendor_request_payload", + "vendor_data_request" + ], + "description": "Provide the request body as a JSON array for fetching vendor data. This should include any necessary parameters required by the API to process the vendor data request.", + "endpoint_argument_name": "requestBody" + }, + { + "name": "page_number", + "alternative_names": [ + "current_page", + "pagination_page" + ], + "description": "The page number for pagination of the vendor list.", + "endpoint_argument_name": "page_no" + }, + { + "name": "items_per_page", + "alternative_names": [ + "maximum_items_per_request", + "query_item_count" + ], + "description": "The number of items to return per page in the response for pagination.", + "endpoint_argument_name": "per_page" + }, + { + "name": "include_pagination_links", + "alternative_names": [ + "enable_pagination_links", + "send_pagination_info" + ], + "description": "Set to 1 to include pagination links in the response body, 0 to exclude.", + "endpoint_argument_name": "X-Send-Pagination-Links" + } + ] + }, + "method": "POST", + "path": "/{orgs}/v1/vendors", + "tags": [ + "vendors" + ], + "summary": "Vendors related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getInvoices(r2)`, `getPoReceivingRecords`, `getPurchaseOrders`.\n", + "requires_security": true, + "oauth_scopes": [], + "security_schemes": [ + "apiKeyAuth" + ], + "parameters": { + "query": [ + { + "name": "page_no", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "description": "The page number of paginated respons.", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32" + }, + "schema_required": false + }, + { + "name": "per_page", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "description": "The number of items returned in the respnose", + "required": false, + "deprecated": false, + "default": null, + "location": "query", + "content_type": null, + "json_schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + }, + "schema_required": false + } + ], + "path": [ + { + "name": "orgs", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "description": "Client subdomain.", + "required": true, + "deprecated": false, + "default": null, + "location": "path", + "content_type": null, + "json_schema": { + "type": "string" + }, + "schema_required": false + } + ], + "header": [ + { + "name": "X-Send-Pagination-Links", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "description": "Send Pagination Links in Response Body.", + "required": false, + "deprecated": false, + "default": null, + "location": "header", + "content_type": null, + "json_schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "schema_required": false + } + ], + "cookie": [], + "body": [ + { + "name": "requestBody", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "description": "", + "required": true, + "deprecated": false, + "default": null, + "location": "body", + "content_type": "application/json", + "json_schema": { + "type": "array", + "items": { + "type": "object", + "properties": {}, + "oneOf": [ + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,4564" + }, + "invoiceNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "propertyIds": { + "type": "string", + "description": " This is an optional field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "12345,4564" + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "paidInvoiceFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "paidInvoiceToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "postMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "includeVoidedPayments": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeExported": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "customerRefunds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,4564" + }, + "invoiceNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "vendorIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": 12345 + }, + "propertyIds": { + "type": "string", + "description": " This is an optional field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "12345,4564" + }, + "fromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "toDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "paidInvoiceFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or after the given date.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "paidInvoiceToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "postMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "includeVoidedPayments": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "voidedPaymentFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "voidedPaymentToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "YYYY-MM-DD" + }, + "includeExported": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "customerRefunds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "invoiceTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPoReceivingRecords" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If \"vendorId\" is provided then \"vendorCode\" and \"purchaseOrderNumbers\" are not required.", + "format": "integer", + "example": 12345 + }, + "vendorCode": { + "type": "string", + "description": " This is an optional field. This field accepts single value. If \"vendorCode\" is provided then \"vendorId\" and \"purchaseOrderNumbers\" are not required.", + "format": "string", + "example": 12345 + }, + "purchaseOrderNumbers": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. If \"purchaseOrderNumbers\" is provided then \"vendorId\" and \"vendorCode\" are not required.", + "format": "integer", + "example": 12345 + }, + "propertyIds": { + "type": "string", + "description": " This is an optional field. This field accepts comma seperated multiple values.", + "format": "string", + "example": "12345,4564" + }, + "poFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year", + "format": "date", + "example": "MM/DD/YYYY" + }, + "poToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year", + "format": "date", + "example": "MM/DD/YYYY" + }, + "receivedFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year", + "format": "date", + "example": "MM/DD/YYYY" + }, + "receivedToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year", + "format": "date", + "example": "MM/DD/YYYY" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "12345,4567" + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "vendorCode": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "poNumber": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "poNumbers": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1234,5678" + }, + "receivedFromDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "receivedToDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnFrom": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "createdOnTo": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "poStatusIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "poTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + }, + "purchaseOrderApprovalTypeIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "1,2,3" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTaxFormData" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "startDate": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "generateForPropertyOwner": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then payer will render property info & If provided as \"1\" then Payer node will render the property owners info", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "ownerIds": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": 12345 + }, + "isForIndirectOwner": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided false, it will return data only for direct owners. If prov ided true, it will return data for both direct & indirect owners.", + "format": "integer", + "enum": [ + 0, + 1 + ] + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorLocations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. List of comma separated propertyIds", + "format": "integer", + "example": "12345,56334" + }, + "showAllStatus": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Boolean parameter to retrieve all vendors irrespective of status.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "includeIntercompanyVendors": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then \"Standard\" types of Vendors will be rendered a nd if provided as \"1\" then \"Standard\" and \"Intercompany\" types of Vend ors will be returned.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "vendorId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorId", + "format": "integer", + "example": 12345 + }, + "vendorName": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorName", + "format": "string", + "example": "Vendor_Name" + }, + "vendorCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorCode", + "format": "string", + "example": "123456" + }, + "lastModifiedOn": { + "type": "string", + "description": " This is an optional field. This field accepts single value. Returns results based on the LastModifiedOn date of the vendor or any of its locations, contacts, remittances or legal entities.", + "format": "date", + "example": "MM/DD/YYYY" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorIds": { + "type": "integer", + "description": "This is an optional field. This field accepts comma seperated multiple values. Once passing this parameter web service will return Vendor details for those Vendor Ids. Conditional mandatory, If vendorIds are provided t hen vendorsCodes is not required.", + "format": "integer", + "example": "12345,56334" + }, + "vendorCodes": { + "type": "string", + "description": "This is an optional field. This field accepts comma seperated multiple values. Conditional mandatory, If \"vendorsCodes\" are provided then \"vendorIds \" are not required.", + "format": "string", + "example": "1234,5678" + } + } + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markInvoicesExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "lineItemId": { + "type": "integer", + "description": "This is a required field. This field accepts comma seperated multiple values.", + "format": "integer", + "example": "17,18,19" + } + }, + "required": [ + "lineItemId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ApPayeeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Id of a vendor who generated the invoice.", + "format": "integer", + "example": 12345 + }, + "ApPayeeLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Location Id of a vendor who generated the invoice.", + "format": "integer", + "example": 12345 + }, + "InvoiceTotal": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Total amount of invoice.", + "format": "float", + "example": 2000 + }, + "InvoiceNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice Number.", + "format": "string", + "example": "TESTINVOICE123" + }, + "InvoiceDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice date. Must be of format MM/DD/YYYY.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "IsConsolidated": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApHeader.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "IsOnHold": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApHeader.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "PropertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "example": 12345 + }, + "GlAccountId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "example": 12345 + }, + "Description": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of ApDetail.", + "format": "string", + "example": "Test Desc" + }, + "Quantity": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "example": 5 + }, + "Rate": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of ApDetail.", + "format": "float", + "example": 400 + }, + "IsWaive1099": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "FileData": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of File. Base64 encoded file data.", + "format": "string", + "example": "FileData" + }, + "Note": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test Note" + }, + "DueDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "IsPaused": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApBatch.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "InvoiceImageUrl": { + "type": "string", + "description": "This is an optional field. This field accepts single value. InvoiceImageUrl accepts valid URL only.", + "format": "string", + "example": "https://InvoiceImageUrl" + }, + "IsPosted": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. IsPosted allows inserting posted invoices.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "PropertyBuildingId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "example": 17672 + }, + "PropertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of ApDetail.", + "format": "integer", + "example": 3981490 + } + }, + "required": [ + "ApPayeeId", + "ApPayeeLocationId", + "InvoiceTotal", + "InvoiceDate", + "PropertyId", + "GlAccountId", + "Description", + "Rate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "invoiceTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Supports 1=\"Standard\", 8 = \"Catalog\" and 17 = \"Standard-Job/Contract\" types. By default type \"Standard\" is inserted.", + "format": "integer", + "example": 1 + }, + "apPayeeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Id of a vendor who generated the invoice.", + "format": "integer", + "example": 1234 + }, + "apPayeeLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor who generated the invoice.", + "format": "integer", + "example": 1234 + }, + "routingTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apHeader. This is conditionally required, depends upo n the \"Require Routing Tags on Invoices\" setting.", + "format": "integer", + "example": 12345 + }, + "invoiceNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice Number.", + "format": "string", + "example": "TESTINVOICE123" + }, + "postMonth": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "invoiceDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice date. Must be of format MM/DD/YYYY.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "dueDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/DD/YYYY format.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "shipping": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount.", + "format": "float", + "example": 10 + }, + "discount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the discount amount.", + "format": "float", + "example": 10 + }, + "salesTax": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.", + "format": "float", + "example": 10 + }, + "invoiceTotal": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Total amount of invoice.", + "format": "float", + "example": 2000 + }, + "note": { + "type": "string", + "description": " This is an optional field. This field accepts single value. This field will be used to specify the additional details of the invoice.", + "format": "string", + "example": "Test Note" + }, + "invoiceImageUrl": { + "type": "string", + "description": "This is an optional field. This field accepts single value. If this node is provided, it should be a valid URL.", + "format": "string", + "example": "Invoice Image URL" + }, + "isConsolidated": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isOnHold": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "propertyId": { + "type": "integer", + "description": " This is a required field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "glAccountId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "propertyBuildingId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 17672 + }, + "propertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 3981490 + }, + "description": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "string", + "example": "Test Desc" + }, + "quantity": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 5 + }, + "rate": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "float", + "example": 40 + }, + "unitOfMeasureId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Only valid for Catalog type invoices.", + "format": "integer", + "example": 1234 + }, + "isWaive1099": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "poDetailId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts \"Line Item Id\" of Purchase Order.", + "format": "integer", + "example": 400 + }, + "receivingRecordId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Conditional Required(Node is mandatory only if the poDetailId value is provided in request). This node accepts \"Receiving Record Id\" of Purc hase Order Line Item for the \"Catalog\" type.", + "format": "integer", + "example": 400 + }, + "invoicePaymentId": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment.", + "format": "string", + "example": "1234" + }, + "paymentAmount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under apDetail.", + "format": "float", + "example": 400 + }, + "fileData": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of file. Base64 encoded file data.", + "format": "string", + "example": "FileData" + }, + "isPaused": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apBatch. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isPosted": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node specifies whether the invoice is posted or unposted. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "paymentTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment.", + "format": "integer", + "example": 400 + }, + "paymentNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.", + "format": "string", + "example": "paymentNumber_001" + }, + "paymentDate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments. Must be of for mat MM/DD/YYYY.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "paymentMemo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.", + "format": "string", + "example": "paymentMemo01" + }, + "customTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This node accepts custom Tag Id of the invoice. If customTagId is not provided, then PO`s custom Tag Id would gets associates to invoice thr ough poDetailId node", + "format": "integer", + "example": 180 + }, + "apCodeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType", + "format": "integer", + "example": 400 + }, + "apContractId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType", + "format": "integer", + "example": 400 + } + }, + "required": [ + "apPayeeId", + "apPayeeLocationId", + "invoiceNumber", + "invoiceDate", + "invoiceTotal", + "propertyId", + "glAccountId", + "description", + "rate", + "apCodeId", + "apContractId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "poTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively).", + "format": "integer", + "example": 12345 + }, + "apPayeeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively).", + "format": "integer", + "example": 12345 + }, + "apPayeeLocationId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor.", + "format": "integer", + "example": 12345 + }, + "apPayeeAccountId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apHeader. If not passed in the request, the system d efault account will be used.", + "format": "integer", + "example": 12345 + }, + "postMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts date in MM/YYYY format.", + "format": "date", + "example": "MM/YYYY" + }, + "postDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. Child element of apHeader.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "routingTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apHeader.", + "format": "integer", + "example": 12345 + }, + "headerMemo": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Child element of apHeader.", + "format": "string", + "example": "header memo" + }, + "shipping": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount.", + "format": "float", + "example": 10 + }, + "discount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the discount amount.", + "format": "float", + "example": 10 + }, + "salesTax": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.", + "format": "float", + "example": 10 + }, + "glAccountId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.This is required if po type is standard.", + "format": "integer", + "example": 12345 + }, + "apCodeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.", + "format": "integer", + "example": 12345 + }, + "jobPhaseId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.", + "format": "integer", + "example": 12345 + }, + "apContractId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is child element of apDetails.", + "format": "integer", + "example": 12345 + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "quantity": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "rate": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Child element of apDetail.", + "format": "float", + "example": 10 + }, + "glDimensionId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Custom Tags.", + "format": "integer", + "example": 384 + }, + "companyDepartmentId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "propertyUnitId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "propertyBuildingId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Child element of apDetail.", + "format": "integer", + "example": 12345 + }, + "isConfidential": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "isTaxable": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "description": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "format": "string", + "example": "Test Desc" + } + }, + "required": [ + "poTypeId", + "apPayeeId", + "apPayeeLocationId", + "postMonth", + "postDate", + "propertyId", + "quantity", + "rate" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "businessName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "Vendor name" + }, + "nameOnTaxReturn": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "Legal entity name" + }, + "remittanceName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "header" + }, + "apPaymentTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "nameOnAccount": { + "type": "string", + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)", + "format": "string", + "example": "header" + }, + "routingNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck). Must be numeric wi th 9 digits long.", + "format": "integer", + "example": 12345 + }, + "accountNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)", + "format": "integer", + "example": 12345 + }, + "contact": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "header" + }, + "firstName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "First name" + }, + "lastName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "last name" + }, + "name": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts the location name", + "format": "string", + "example": "name" + }, + "isPrimary": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "enum": [ + 0, + 1 + ] + }, + "utilityBillReceiptTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value", + "format": "integer", + "example": 1 + }, + "externalId": { + "type": "string", + "description": "This is a required field. This field accepts single value. externalId", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID" + } + }, + "required": [ + "businessName", + "nameOnTaxReturn", + "remittanceName", + "apPaymentTypeId", + "nameOnAccount", + "routingNumber", + "accountNumber", + "contact", + "firstName", + "lastName", + "name", + "isPrimary", + "externalId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "This is a required field. This field accepts single value. Accepts apHeader id,apDetail id", + "format": "integer", + "example": 12345 + }, + "invoicePaymentId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "paymentAmount": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "float", + "example": 100 + }, + "paymentTypeId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 2 + }, + "paymentNumber": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "65565" + }, + "paymentDate": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "postMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "date", + "example": "MM/YYYY" + }, + "isOnHold": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Update an invoice that is on hold, and take it off hold, and vice vers a, Allowed values ( 0, 1 )", + "format": "integer", + "example": 1 + }, + "routingTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. Update the routing tag on an invoice, to another valid routing tag. Al low for not posted and off hold invoice.", + "format": "integer", + "example": 12345 + } + }, + "required": [ + "id", + "invoicePaymentId", + "paymentAmount", + "paymentTypeId", + "paymentNumber", + "paymentDate", + "postMonth" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "description": "This is a required field. This field accepts single value.", + "format": "integer", + "example": 12345 + }, + "nameOnTaxReturn": { + "type": "string", + "description": "This is a required field. This field accepts single value", + "format": "string", + "example": "Legal entity name" + }, + "name": { + "type": "string", + "description": "This is a required field. This field accepts single value. Accepts locations name.", + "format": "string", + "example": "name" + }, + "legalEntityName": { + "type": "string", + "description": "This is a required field. This field accepts single value. required if new location is inserted", + "format": "string", + "example": "name" + }, + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. attribute compliance_status_id is required to make the property compli ant/non compliant, Accept integer value 2( for non-compliant) or 5 (fo r compliant) only.", + "format": "integer", + "example": 12345 + }, + "remittanceName": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "format": "string", + "example": "header" + }, + "nameOnAccount": { + "type": "string", + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )", + "format": "string", + "example": "header" + }, + "routingNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )", + "format": "integer", + "example": 12345 + }, + "accountNumber": { + "type": "integer", + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )", + "format": "integer", + "example": 12345 + }, + "externalId": { + "type": "string", + "description": "This is a required field. This field accepts single value. externalId", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID" + }, + "defaultRoutingTagId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value.", + "format": "integer", + "example": 123 + } + }, + "required": [ + "vendorId", + "nameOnTaxReturn", + "name", + "legalEntityName", + "propertyId", + "remittanceName", + "nameOnAccount", + "routingNumber", + "accountNumber", + "externalId" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + }, + { + "type": "object", + "properties": { + "auth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + }, + "required": [ + "type" + ] + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "voidApPayments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "paymentId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentNumber, paymentBankAccountId, paymenttypeId, paymentAmount are not provided.", + "format": "integer", + "example": 12345 + }, + "paymentNumber": { + "type": "string", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentId is no t provided then this node is required.", + "format": "string", + "example": "123456" + }, + "paymentBankAccountId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.", + "format": "integer", + "example": 12345 + }, + "paymentTypeId": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.", + "format": "integer", + "example": 2 + }, + "paymentAmount": { + "type": "integer", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.", + "format": "float", + "example": 100 + }, + "voidDate": { + "type": "string", + "description": "This is a required field. This field accepts single value. Supported date format: MM/DD/YYY, M/D/YYYY, YYYY-MM-DD.", + "format": "date", + "example": "MM/DD/YYYY" + }, + "postMonth": { + "type": "string", + "description": "This is a required field. This field accepts single value. Supported Format: MM/YYYY", + "format": "date", + "example": "MM/YYYY" + }, + "note": { + "type": "string", + "description": "This is a required field. This field accepts single value. Memo for the payment", + "format": "string", + "example": "Test Note" + } + }, + "required": [ + "voidDate", + "postMonth", + "note" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "auth", + "method" + ] + } + ] + } + }, + "schema_required": false + } + ] + }, + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ids\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4564\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"invoiceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"paidInvoiceFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date.\"\n },\n \"paidInvoiceToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeVoidedPayments\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Returns voided payment details if provided as 1\"\n },\n \"includeExported\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerRefunds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ids\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4564\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"invoiceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.\"\n },\n \"paidInvoiceFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or after the given date.\"\n },\n \"paidInvoiceToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeVoidedPayments\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Returns voided payment details if provided as 1\"\n },\n \"voidedPaymentFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"voidedPaymentToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeExported\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerRefunds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"invoiceTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPoReceivingRecords\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. If \\\"vendorId\\\" is provided then \\\"vendorCode\\\" and \\\"purchaseOrderNumbers\\\" are not required.\"\n },\n \"vendorCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. If \\\"vendorCode\\\" is provided then \\\"vendorId\\\" and \\\"purchaseOrderNumbers\\\" are not required.\"\n },\n \"purchaseOrderNumbers\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If \\\"purchaseOrderNumbers\\\" is provided then \\\"vendorId\\\" and \\\"vendorCode\\\" are not required.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"poFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year\"\n },\n \"poToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year\"\n },\n \"receivedFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year\"\n },\n \"receivedToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPurchaseOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poNumbers\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"receivedFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"receivedToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"poTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"purchaseOrderApprovalTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTaxFormData\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"generateForPropertyOwner\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as \\\"0\\\" then payer will render property info & If provided as \\\"1\\\" then Payer node will render the property owners info\"\n },\n \"ownerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isForIndirectOwner\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided false, it will return data only for direct owners. If prov ided true, it will return data for both direct & indirect owners.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendorLocations\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56334\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. List of comma separated propertyIds\"\n },\n \"showAllStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Boolean parameter to retrieve all vendors irrespective of status.\"\n },\n \"includeIntercompanyVendors\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as \\\"0\\\" then \\\"Standard\\\" types of Vendors will be rendered a nd if provided as \\\"1\\\" then \\\"Standard\\\" and \\\"Intercompany\\\" types of Vend ors will be returned.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorId\"\n },\n \"vendorName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Vendor_Name\",\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorName\"\n },\n \"vendorCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorCode\"\n },\n \"lastModifiedOn\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. Returns results based on the LastModifiedOn date of the vendor or any of its locations, contacts, remittances or legal entities.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendorPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56334\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Once passing this parameter web service will return Vendor details for those Vendor Ids. Conditional mandatory, If vendorIds are provided t hen vendorsCodes is not required.\"\n },\n \"vendorCodes\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Conditional mandatory, If \\\"vendorsCodes\\\" are provided then \\\"vendorIds \\\" are not required.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"markInvoicesExported\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"lineItemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"17,18,19\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"lineItemId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ApPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Id of a vendor who generated the invoice.\"\n },\n \"ApPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Location Id of a vendor who generated the invoice.\"\n },\n \"InvoiceTotal\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 2000,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Total amount of invoice.\"\n },\n \"InvoiceNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"TESTINVOICE123\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Invoice Number.\"\n },\n \"InvoiceDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Invoice date. Must be of format MM/DD/YYYY.\"\n },\n \"IsConsolidated\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApHeader.\"\n },\n \"IsOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApHeader.\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"GlAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"IsWaive1099\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"FileData\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FileData\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of File. Base64 encoded file data.\"\n },\n \"Note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"DueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"IsPaused\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApBatch.\"\n },\n \"InvoiceImageUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"https://InvoiceImageUrl\",\n \"description\": \"This is an optional field. This field accepts single value. InvoiceImageUrl accepts valid URL only.\"\n },\n \"IsPosted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. IsPosted allows inserting posted invoices.\"\n },\n \"PropertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 17672,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"PropertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3981490,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n }\n },\n \"required\": [\n \"ApPayeeId\",\n \"ApPayeeLocationId\",\n \"InvoiceTotal\",\n \"InvoiceDate\",\n \"PropertyId\",\n \"GlAccountId\",\n \"Description\",\n \"Rate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"invoiceTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1=\\\"Standard\\\", 8 = \\\"Catalog\\\" and 17 = \\\"Standard-Job/Contract\\\" types. By default type \\\"Standard\\\" is inserted.\"\n },\n \"apPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Id of a vendor who generated the invoice.\"\n },\n \"apPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor who generated the invoice.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. This is conditionally required, depends upo n the \\\"Require Routing Tags on Invoices\\\" setting.\"\n },\n \"invoiceNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"TESTINVOICE123\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Invoice Number.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts date in MM/YYYY format.\"\n },\n \"invoiceDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Invoice date. Must be of format MM/DD/YYYY.\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts date in MM/DD/YYYY format.\"\n },\n \"shipping\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the shipping amount.\"\n },\n \"discount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the discount amount.\"\n },\n \"salesTax\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.\"\n },\n \"invoiceTotal\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 2000,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Total amount of invoice.\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \" This is an optional field. This field accepts single value. This field will be used to specify the additional details of the invoice.\"\n },\n \"invoiceImageUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Invoice Image URL\",\n \"description\": \"This is an optional field. This field accepts single value. If this node is provided, it should be a valid URL.\"\n },\n \"isConsolidated\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 17672,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3981490,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 40,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"unitOfMeasureId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Only valid for Catalog type invoices.\"\n },\n \"isWaive1099\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"poDetailId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts \\\"Line Item Id\\\" of Purchase Order.\"\n },\n \"receivingRecordId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required(Node is mandatory only if the poDetailId value is provided in request). This node accepts \\\"Receiving Record Id\\\" of Purc hase Order Line Item for the \\\"Catalog\\\" type.\"\n },\n \"invoicePaymentId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under apDetail.\"\n },\n \"fileData\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FileData\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of file. Base64 encoded file data.\"\n },\n \"isPaused\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apBatch. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isPosted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node specifies whether the invoice is posted or unposted. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"paymentNumber_001\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.\"\n },\n \"paymentDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments. Must be of for mat MM/DD/YYYY.\"\n },\n \"paymentMemo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"paymentMemo01\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.\"\n },\n \"customTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 180,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts custom Tag Id of the invoice. If customTagId is not provided, then PO`s custom Tag Id would gets associates to invoice thr ough poDetailId node\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. The required node in case of jobCost invoiceType\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. The required node in case of jobCost invoiceType\"\n }\n },\n \"required\": [\n \"apPayeeId\",\n \"apPayeeLocationId\",\n \"invoiceNumber\",\n \"invoiceDate\",\n \"invoiceTotal\",\n \"propertyId\",\n \"glAccountId\",\n \"description\",\n \"rate\",\n \"apCodeId\",\n \"apContractId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPurchaseOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"poTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\\\"Standard\\\" and \\\"Standard-Job/ Contract\\\" respectively).\"\n },\n \"apPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\\\"Standard\\\" and \\\"Standard-Job/ Contract\\\" respectively).\"\n },\n \"apPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor.\"\n },\n \"apPayeeAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. If not passed in the request, the system d efault account will be used.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts date in MM/YYYY format.\"\n },\n \"postDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader.\"\n },\n \"headerMemo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header memo\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader.\"\n },\n \"shipping\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the shipping amount.\"\n },\n \"discount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the discount amount.\"\n },\n \"salesTax\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.This is required if po type is standard.\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"glDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 384,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Custom Tags.\"\n },\n \"companyDepartmentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"isConfidential\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isTaxable\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"poTypeId\",\n \"apPayeeId\",\n \"apPayeeLocationId\",\n \"postMonth\",\n \"postDate\",\n \"propertyId\",\n \"quantity\",\n \"rate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"businessName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Vendor name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnTaxReturn\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Legal entity name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"remittanceName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"apPaymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnAccount\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)\"\n },\n \"routingNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck). Must be numeric wi th 9 digits long.\"\n },\n \"accountNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)\"\n },\n \"contact\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"First name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"last name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. Accepts the location name\"\n },\n \"isPrimary\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"utilityBillReceiptTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"externalId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"API_VENDOR_EXTRNL_ID\",\n \"description\": \"This is a required field. This field accepts single value. externalId\"\n }\n },\n \"required\": [\n \"businessName\",\n \"nameOnTaxReturn\",\n \"remittanceName\",\n \"apPaymentTypeId\",\n \"nameOnAccount\",\n \"routingNumber\",\n \"accountNumber\",\n \"contact\",\n \"firstName\",\n \"lastName\",\n \"name\",\n \"isPrimary\",\n \"externalId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateInvoices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Accepts apHeader id,apDetail id\"\n },\n \"invoicePaymentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 100,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"65565\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Update an invoice that is on hold, and take it off hold, and vice vers a, Allowed values ( 0, 1 )\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Update the routing tag on an invoice, to another valid routing tag. Al low for not posted and off hold invoice.\"\n }\n },\n \"required\": [\n \"id\",\n \"invoicePaymentId\",\n \"paymentAmount\",\n \"paymentTypeId\",\n \"paymentNumber\",\n \"paymentDate\",\n \"postMonth\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnTaxReturn\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Legal entity name\",\n \"description\": \"This is a required field. This field accepts single value\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. Accepts locations name.\"\n },\n \"legalEntityName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. required if new location is inserted\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. attribute compliance_status_id is required to make the property compli ant/non compliant, Accept integer value 2( for non-compliant) or 5 (fo r compliant) only.\"\n },\n \"remittanceName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnAccount\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"routingNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"accountNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"externalId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"API_VENDOR_EXTRNL_ID\",\n \"description\": \"This is a required field. This field accepts single value. externalId\"\n },\n \"defaultRoutingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"vendorId\",\n \"nameOnTaxReturn\",\n \"name\",\n \"legalEntityName\",\n \"propertyId\",\n \"remittanceName\",\n \"nameOnAccount\",\n \"routingNumber\",\n \"accountNumber\",\n \"externalId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"voidApPayments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"paymentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentNumber, paymentBankAccountId, paymenttypeId, paymentAmount are not provided.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentId is no t provided then this node is required.\"\n },\n \"paymentBankAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"voidDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Supported date format: MM/DD/YYY, M/D/YYYY, YYYY-MM-DD.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Supported Format: MM/YYYY\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is a required field. This field accepts single value. Memo for the payment\"\n }\n },\n \"required\": [\n \"voidDate\",\n \"postMonth\",\n \"note\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getInvoices_r1\": {\n \"$ref\": \"#/components/examples/getInvoicesRequest_r1\"\n },\n \"getInvoices_r2\": {\n \"$ref\": \"#/components/examples/getInvoicesRequest_r2\"\n },\n \"getPoReceivingRecords\": {\n \"$ref\": \"#/components/examples/getPoReceivingRecordsRequest\"\n },\n \"getPurchaseOrders\": {\n \"$ref\": \"#/components/examples/getPurchaseOrdersRequest\"\n },\n \"getTaxFormData\": {\n \"$ref\": \"#/components/examples/getTaxFormDataRequest\"\n },\n \"getVendorLocations\": {\n \"$ref\": \"#/components/examples/getVendorLocationsRequest\"\n },\n \"getVendorPickLists\": {\n \"$ref\": \"#/components/examples/getVendorPickListsRequest\"\n },\n \"getVendors\": {\n \"$ref\": \"#/components/examples/getVendorsRequest\"\n },\n \"markInvoicesExported\": {\n \"$ref\": \"#/components/examples/markInvoicesExportedRequest\"\n },\n \"sendInvoices_r1\": {\n \"$ref\": \"#/components/examples/sendInvoicesRequest_r1\"\n },\n \"sendInvoices_r2\": {\n \"$ref\": \"#/components/examples/sendInvoicesRequest_r2\"\n },\n \"sendPurchaseOrders\": {\n \"$ref\": \"#/components/examples/sendPurchaseOrdersRequest\"\n },\n \"sendVendors\": {\n \"$ref\": \"#/components/examples/sendVendorsRequest\"\n },\n \"updateInvoices\": {\n \"$ref\": \"#/components/examples/updateInvoicesRequest\"\n },\n \"updateVendors\": {\n \"$ref\": \"#/components/examples/updateVendorsRequest\"\n },\n \"voidApPayments\": {\n \"$ref\": \"#/components/examples/voidApPaymentsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false, + "use_flatten_mode": false, + "base_url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs", + "original_servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ] + } + ], + "security_scheme_key_selected": null, + "security_scheme_selected": {} +} \ No newline at end of file diff --git a/servers/entrata_api/arcade_entrata_api/moar/openapi.json b/servers/entrata_api/arcade_entrata_api/moar/openapi.json new file mode 100644 index 00000000..9cefa351 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/moar/openapi.json @@ -0,0 +1,84279 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Entrata APIs", + "description": "The Entrata API retrieves property data for marketing, leasing, residents, and more. Our API is organized around RPC protocols, and authenticates users by API key. Additionally, users can only access the API when companies explicitly provide access per user.\n\n### Time Zones\nPlease note that unless stated otherwise, all dates and times used in the API are assumed to be in Mountain Time (MST or MDT).\n\n### Languages\nThe `Accept-Language` request header parameter can be used to request that the values returned in the response be translated into the language and locale that is desired, provided that the language is active and enabled for the client. Possible values are:\n- English: en-US, en-CA, en-GB, en-IE\n- Spanish: es-MX, es-PE, es-US, es-ES, es-CL \n- Hindi: hi-IN\n- Chinese: zh-CN\n- French: fr-FR\n\n### Throttling\nTo maintain a reliable API, Entrata implements rate limits, which restrict the number of API calls you can make within a minute, an hour, and a day. Each API service has its own set of limits, which are detailed in its response headers. Before building your integration, please familiarize yourself with these limits to avoid issues as you scale your usage with more properties or larger clients.\n", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://apis.entrata.com/ext/orgs", + "description": "US Server" + }, + { + "url": "https://apis.entrata.global/ext/orgs", + "description": "EU Server" + } + ], + "security": [ + { + "apiKeyAuth": {} + } + ], + "paths": { + "/{orgs}/v1/status": { + "post": { + "tags": [ + "status" + ], + "summary": "API Health check", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "This API will specify the API health status whether it is running or not.", + "content": { + "application/json": { + "schema": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getStatus" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "examples": { + "getStatus": { + "$ref": "#/components/examples/getStatusRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/APIHealthSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 4, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/applications": { + "post": { + "tags": [ + "applications" + ], + "summary": "Applications", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "Application related APIs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCompanyApplications" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicantGeneralDetails" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicantId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "isTrue": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "comments": { + "type": "string", + "format": "string", + "example": "Test Comments", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId", + "applicantId", + "id" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplication" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "originatingLeadSourceId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leasingAgentId": { + "type": "integer", + "format": "int64", + "example": 445655, + "description": "This is a required field. This field accepts single value." + }, + "unitSpaceId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value." + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "floorplanId": { + "type": "integer", + "format": "int64", + "example": 205814, + "description": "This is a required field. This field accepts single value." + }, + "leaseTermId": { + "type": "integer", + "format": "int64", + "example": 1862, + "description": "This is a required field. This field accepts single value." + }, + "applicationStatusId": { + "type": "integer", + "format": "int64", + "example": 3, + "description": "This is an optional field. This field accepts single value. Acceptable values are 3 (COMPLETED ) & 4 (APPLICATION_APPROVED )" + } + }, + "required": [ + "propertyId", + "originatingLeadSourceId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationEmployers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer record." + }, + "incomeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required." + }, + "customerId": { + "type": "integer", + "format": "int64", + "example": 17378378, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required." + }, + "frequencyId": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range which are: 3 [ weekly ], 4 [ Monthly ] and 6 [ Yearly ]" + }, + "position": { + "type": "string", + "format": "string", + "example": "Technical Manager", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionName": { + "type": "string", + "format": "string", + "example": "Entrata Inc.", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionPhoneNumber": { + "type": "string", + "format": "string", + "example": "7544898565", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number." + }, + "institutionStreetLine1": { + "type": "string", + "format": "string", + "example": "address line 1", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStreetLine2": { + "type": "string", + "format": "string", + "example": "address line 2", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStreetLine3": { + "type": "string", + "format": "string", + "example": "address line 3", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionCity": { + "type": "string", + "format": "string", + "example": "City", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStateCode": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionProvince": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionPostalCode": { + "type": "string", + "format": "string", + "example": "11111", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionCountryCode": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required." + }, + "contactName": { + "type": "string", + "format": "string", + "example": "People Ops team", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "contactPhone": { + "type": "string", + "format": "string", + "example": "9954809807", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number." + }, + "contactEmail": { + "type": "string", + "format": "string", + "example": "hr@example.lcl", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "incomeEffectiveDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format." + }, + "dateStarted": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format." + }, + "dateEnded": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded." + }, + "isDelete": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationPets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123, + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided we will update the pet record" + }, + "customerId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Conditionally required. Accepts integer value. If id is not provided, this parameter is required" + }, + "typeId": { + "type": "integer", + "format": "int64", + "example": 17378378, + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "breed": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "gender": { + "type": "string", + "format": "string", + "example": "F", + "description": "This is an optional field. This field accepts single value." + }, + "color": { + "type": "string", + "format": "string", + "example": "White", + "description": "This is an optional field. This field accepts single value." + }, + "weight": { + "type": "integer", + "format": "float", + "example": "30.99", + "description": "This is an optional field. This field accepts single value." + }, + "age": { + "type": "integer", + "format": "int64", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Description.", + "description": "This is an optional field. This field accepts single value." + }, + "licenseCity": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value." + }, + "licenseNumber": { + "type": "string", + "format": "string", + "example": "156", + "description": "This is an optional field. This field accepts single value." + }, + "isAssistanceAnimal": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isPetSpayedOrNeutered": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "petSpayedOrNeuteredDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "isHouseBroken": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "specialProvisions": { + "type": "string", + "format": "string", + "example": "Test", + "description": "This is an optional field. This field accepts single value." + }, + "isDelete": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vehicleTypeId": { + "type": "integer", + "format": "int64", + "example": 2, + "description": "This is a required field. This field accepts single value. Indicates the type of vehicle. Possible values are 1, 2, or 3 where 1 = Primary, 2 = Secondary, and 3 = Other." + } + }, + "required": [ + "vehicleTypeId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node accepts application id which needs to be updated." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node accepts the property id." + }, + "applicationStatusId": { + "type": "integer", + "format": "int64", + "example": 3, + "description": "This is an optional field. This field accepts single value. This node accept the status id." + }, + "floorplanId": { + "type": "integer", + "format": "int64", + "example": 1235, + "description": "This is an optional field. This field accepts single value. This node accept the associated floorplan id or the floorplan which ne eds to be associated with the application." + }, + "unitSpaceId": { + "type": "integer", + "format": "int64", + "example": 1442, + "description": "This is an optional field. This field accepts single value. This node accept the associated unit space id or the unit space which needs to be associated with the application." + }, + "leaseTermId": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "This is an optional field. This field accepts single value. This node accepts the lease length." + }, + "leasingAgentId": { + "type": "integer", + "format": "int64", + "example": 147896, + "description": "This is an optional field. This field accepts single value. This node accepts the associated leasing agent or the leasing agent wh ich needs to be updated." + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This node accepts the move-in date. In ISO format as well." + }, + "originatingLeadSourceId": { + "type": "integer", + "format": "int64", + "example": 8521, + "description": "This is an optional field. This field accepts single value. This node accepts the lead source id." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 7893, + "description": " This is an optional field. This field accepts single value. This node accepts the applicants id." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants first name." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts applicants last name." + }, + "maternalName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This node accepts applicants maternal name." + }, + "preferredName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts applicants preferred name." + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This node accepts applicants birth date. Supports ISO format." + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "int64", + "example": "1264", + "description": "This is an optional field. This field accepts single value. This node accepts customer relationship id." + }, + "email": { + "type": "string", + "format": "string", + "example": "test@gmail.com", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants email." + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "int64", + "example": "3", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number type id. This is condition al mandatory node, if phoneNumber is provided then phoneNumberTypeId is required." + }, + "phoneNumber": { + "type": "integer", + "format": "int64", + "example": "(123)-111-1111", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number. This is conditional manda tory node, if value for phoneNumberTypeId is provided then this node is required." + }, + "addressTypeId": { + "type": "integer", + "format": "int64", + "example": "11", + "description": "This is an optional field. This field accepts single value. This node accepts address type id." + }, + "addressLine1": { + "type": "string", + "format": "string", + "example": "addressLine1", + "description": "This is an optional field. This field accepts single value." + }, + "addressLine2": { + "type": "string", + "format": "string", + "example": "addressLine2", + "description": "This is an optional field. This field accepts single value." + }, + "addressLine3": { + "type": "string", + "format": "string", + "example": "addressLine3", + "description": "This is an optional field. This field accepts single value." + }, + "city": { + "type": "string", + "format": "string", + "example": "City", + "description": "This is an optional field. This field accepts single value." + }, + "postalCode": { + "type": "integer", + "format": "int64", + "example": "12345", + "description": "This is an optional field. This field accepts single value." + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "CA", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getCompanyApplications": { + "$ref": "#/components/examples/getCompanyApplicationsRequest" + }, + "sendApplicantGeneralDetails": { + "$ref": "#/components/examples/sendApplicantGeneralDetailsRequest" + }, + "sendApplication": { + "$ref": "#/components/examples/sendApplicationRequest" + }, + "sendApplicationAddOns": { + "$ref": "#/components/examples/sendApplicationAddOnsRequest" + }, + "sendApplicationEmployers": { + "$ref": "#/components/examples/sendApplicationEmployersRequest" + }, + "sendApplicationPets": { + "$ref": "#/components/examples/sendApplicationPetsRequest" + }, + "sendApplicationVehicles": { + "$ref": "#/components/examples/sendApplicationVehiclesRequest" + }, + "updateApplication": { + "$ref": "#/components/examples/updateApplicationRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/ApplicationsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 119, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/appinfo": { + "post": { + "tags": [ + "appinfo" + ], + "summary": "App info related APIs", + "description": "Please use `rsync` as the orgs value when calling the getAccessibleClients API.", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleClients" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleServices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getAccessibleClients": { + "$ref": "#/components/examples/getAccessibleClientsRequest" + }, + "getAccessibleServices": { + "$ref": "#/components/examples/getAccessibleServicesRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/AppinfoSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 8, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/arcodes": { + "post": { + "tags": [ + "arcodes" + ], + "summary": "Charge codes", + "description": "Returns all AR codes for a specified management company.", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "Returns all AR codes for a specified management company.", + "content": { + "application/json": { + "schema": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArCodes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid." + } + } + } + } + } + } + }, + "examples": { + "getArCodes": { + "$ref": "#/components/examples/getArCodesRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/ArcodesSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 5, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/arpayments": { + "post": { + "tags": [ + "arpayments" + ], + "summary": "arPayments", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "Retrieves AR payments details with reference to a Payment ID and for a selected date range.", + "content": { + "application/json": { + "schema": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArPayments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "arPaymentIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids." + }, + "paymentStatusTypeIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From date." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. To date" + }, + "isIncludeAllocations": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment" + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + "examples": { + "getArPayments": { + "$ref": "#/components/examples/getArPaymentsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/ArPaymentsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 9, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/artransactions": { + "post": { + "tags": [ + "artransactions" + ], + "summary": "This API is to get the information of transactions and payments.", + "description": "## Note: \n **Pagination supported APIs**: `getArInvoices`, `getLeaseArTransactions`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "description": "arTansactions related APIs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds" + }, + "arInvoiceId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is an optional field. This field accepts single value. arInvoiceId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From date." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. To date" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "leaseIds": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "int64", + "example": "3,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled." + }, + "transactionTypeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12" + }, + "arCodeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds" + }, + "showFullLedger": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response." + }, + "includeReversals": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be t rue(1)." + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This will return transactions starting from the provided date." + }, + "transactionToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This will return transaction till the provided date." + }, + "ledgerIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "leaseId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is an optional field. This field accepts single value. leaseId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "int64", + "example": "3,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled." + }, + "arCodeIds": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds" + }, + "showFullLedger": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items." + }, + "includeReversals": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be true(1)." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull ledger history as displayed under resident portal" + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response." + }, + "includePaymentsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to retrieve payments transactions in the response" + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionFromDate" + }, + "transactionToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionToDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactionReversals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "TransactionId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value. This ID represents the \"reference_id\" provided in the sendLeaseArTrans actions response or the \"TransactionID\" provided in getMitsLeaseArTran sactions." + }, + "TransactionAmount": { + "type": "integer", + "format": "float", + "example": "100.50", + "description": "This is a required field. This field accepts single value. The amount for which the original charge was posted. If the Original c harge was a negative charge, a credit, please send this amount as nega tive as well." + }, + "PropertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "ReverseDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. If a date is sent in this parameter, we will set this value as postDate for the reversed transactions." + }, + "Description": { + "type": "string", + "format": "string", + "example": "Test Description", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. We highly recommend that you provide a detailed description of the reason for which the charged is reversed." + } + }, + "required": [ + "TransactionId", + "TransactionAmount" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "transactionId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value. Unique Transaction ID of client system" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": "2342", + "description": "This is a required field. This field accepts single value. Lease ID" + }, + "arCodeId": { + "type": "integer", + "format": "int64", + "example": 11, + "description": "This is a required field. This field accepts single value. Ar Code ID" + }, + "transactionAmount": { + "type": "integer", + "format": "float", + "example": "1000.00", + "description": "This is a required field. This field accepts single value. Transaction Amount" + }, + "transactionDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. transactionDate" + }, + "arPostMonth": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Charge Posting Month" + } + }, + "required": [ + "transactionId", + "leaseId", + "arCodeId", + "transactionAmount", + "transactionDate" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getArInvoices": { + "$ref": "#/components/examples/getArInvoicesRequest" + }, + "getLeaseArTransactions": { + "$ref": "#/components/examples/getLeaseArTransactionsRequest" + }, + "getMitsLeaseArTransactions": { + "$ref": "#/components/examples/getMitsLeaseArTransactionsRequest" + }, + "sendLeaseArTransactionReversals": { + "$ref": "#/components/examples/sendLeaseArTransactionReversalsRequest" + }, + "sendLeaseArTransactions": { + "$ref": "#/components/examples/sendLeaseArTransactionsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/ArTransactionsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 59, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/communications": { + "post": { + "tags": [ + "communications" + ], + "summary": "Communications", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "arPayment related APIs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferencePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferences" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,2342", + "description": "This is a required field. This field accepts comma seperated multiple values. Customer Ids" + }, + "recipientTypeId": { + "type": "integer", + "format": "int64", + "example": 11, + "description": "This is a required field. This field accepts single value. Possible values are 1 = Lead 2 = Resident" + } + }, + "required": [ + "propertyId", + "customerIds", + "arCodeId" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getMarketingPreferencePickList": { + "$ref": "#/components/examples/getMarketingPreferencePickListRequest" + }, + "getMarketingPreferences": { + "$ref": "#/components/examples/getMarketingPreferencesRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/CommunicationsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 11, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/customers": { + "post": { + "tags": [ + "customers" + ], + "summary": "Customers", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "arPayment related APIs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,5678,9865", + "description": "This is an optional field. This field accepts comma seperated multiple values. Customer Ids" + }, + "leaseStatusTypeIds": { + "type": "string", + "format": "string", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values. Lease Status types" + }, + "isAgreedToTermsOnly": { + "type": "boolean", + "example": "1" + }, + "companyIdentificationTypeIds": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. company Identification type IDs" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Property id" + }, + "isApproved": { + "type": "boolean" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials from this date" + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials until this date" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTestimonialPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "searchCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id. This is system ID associated with each property." + }, + "search": { + "type": "string", + "format": "string", + "example": "Thornberry", + "description": "This is a required field. This field accepts single value. Search string accepts phone number, name, building, unit, secondary number." + } + }, + "required": [ + "propertyId", + "search" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "CustomerId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Customer Id." + }, + "TestimonialTypeId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. The following are valid testimonial type ids: 1 Resident testimonial 2 Employee testimonial 3 Client testimonial 4 Vacancy 5 Apartmentr atings.com 6 Yelp.com 7 atlanta.citysearch.com" + }, + "Name": { + "type": "string", + "format": "string", + "example": "Bryan Murfy", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Name of a person who submitted the testi monial." + }, + "Title": { + "type": "string", + "format": "string", + "example": "So far a great experience", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Title of testimonial." + }, + "Review": { + "type": "string", + "format": "string", + "example": "This is a nice community that makes you feel like you are a valued memeber.", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Review content." + }, + "RecommendToFriend": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Do you recommend this property to any friend?." + }, + "AuthorizeToShowOnCorporateSites": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Do you authorize property manager to dis play your testimonial on its portal and affiliate websites?." + }, + "RatingTypeId": { + "type": "integer", + "format": "int64", + "example": "1", + "description": "This is a required field. This field accepts single value. The following are valid testimonial rating types ids: 1 Parking 2 No ise 3 Grounds 5 Construction 6 Maintenance 7 Staff 8 Overall" + }, + "Rating": { + "type": "integer", + "format": "int64", + "example": "3", + "description": "This is a required field. This field accepts single value. Child element of TestimonialRatings. Rating value." + }, + "AutoApproveForProspectPortal": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on prospect portal." + }, + "AutoApproveForVacancy": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on vacany.com" + }, + "PropertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "TestimonialDatetime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. Testimonial submission date." + }, + "TransmissionVendorId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Transmission Vendor Id" + }, + "Email": { + "type": "string", + "format": "string", + "example": "br@mycomp.com", + "description": "This is an optional field. This field accepts single value. Email will be required if CustomerId is not provided. Child element of Testimonial. Email of a person who submitted the testimonial." + }, + "PropertyResponse": { + "type": "string", + "format": "string", + "example": "Property Response...", + "description": "This is an optional field. This field accepts single value. The property`s response to the review." + } + }, + "required": [ + "TestimonialTypeId", + "Title", + "Review", + "AuthorizeToShowOnCorporateSites", + "RatingTypeId", + "Rating", + "PropertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 31025784, + "description": "This is a required field. This field accepts single value. This should be the unique ID of the customer to be updated and they mu st be in at least an applicant or higher lease status." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "Ephraim", + "description": "This is an optional field. This field accepts single value." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "Kassulke", + "description": "This is an optional field. This field accepts single value." + }, + "namePrefix": { + "type": "string", + "format": "string", + "example": "Ms.", + "description": "This is an optional field. This field accepts single value." + }, + "middleName": { + "type": "string", + "format": "string", + "example": "Emie", + "description": "This is an optional field. This field accepts single value." + }, + "maidenName": { + "type": "string", + "format": "string", + "example": "MaidenName", + "description": "This is an optional field. This field accepts single value." + }, + "nameSuffix": { + "type": "string", + "format": "string", + "example": "III", + "description": "This is an optional field. This field accepts single value." + }, + "email": { + "type": "string", + "format": "string", + "example": "Carson87@example.org", + "description": "This is an optional field. This field accepts single value." + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "YYYY/MM/DD", + "description": "This is an optional field. This field accepts single value." + }, + "taxNumberTypeId": { + "type": "integer", + "format": "int64", + "example": 9, + "description": "This is an optional field. This field accepts single value." + }, + "taxNumber": { + "type": "integer", + "format": "int64", + "example": "844-588-2283", + "description": "This is an optional field. This field accepts single value." + }, + "addressTypeId": { + "type": "integer", + "format": "int64", + "example": 8, + "description": "This is an optional field. This field accepts single value." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "3927 Austen Groves", + "description": "This is an optional field. This field accepts single value." + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "43853 Thompson Rapids", + "description": "This is an optional field. This field accepts single value." + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "085 Weber Streets", + "description": "This is an optional field. This field accepts single value." + }, + "city": { + "type": "string", + "format": "string", + "example": "Streichtown", + "description": "This is an optional field. This field accepts single value." + }, + "country": { + "type": "string", + "format": "string", + "example": "US", + "description": "This is an optional field. This field accepts single value." + }, + "state": { + "type": "string", + "format": "string", + "example": "CA", + "description": "This is an optional field. This field accepts single value." + }, + "postalCode": { + "type": "integer", + "format": "int64", + "example": 22222, + "description": "This is an optional field. This field accepts single value." + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "int64", + "example": 2, + "description": "This is an optional field. This field accepts single value." + }, + "isPrimary": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value." + }, + "phoneNumber": { + "type": "integer", + "format": "int64", + "example": "1231231234", + "description": "This is an optional field. This field accepts single value." + }, + "companyIdentificationTypeId": { + "type": "integer", + "format": "int64", + "example": 5587, + "description": "This is an optional field. This field accepts single value." + }, + "identificationValue": { + "type": "string", + "format": "string", + "example": "688", + "description": "This is an optional field. This field accepts single value." + }, + "idExpirationDate": { + "type": "string", + "format": "date", + "example": "YYYY/MM/DD", + "description": "This is an optional field. This field accepts single value." + }, + "StateCode": { + "type": "string", + "format": "string", + "example": "GN", + "description": "This is an optional field. This field accepts single value." + }, + "countryCode": { + "type": "string", + "format": "string", + "example": "Guinea", + "description": "This is an optional field. This field accepts single value. \"countryCode\" is accepted under \"companyIdentificationValue\" node." + } + }, + "required": [ + "id" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "transmissionVendorId": { + "type": "integer", + "format": "int64", + "example": 12, + "description": "This is a required field. This field accepts single value." + }, + "testimonialId": { + "type": "integer", + "format": "int64", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "isPublished": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "transmissionVendorId", + "isPublished" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyResponse" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "testimonialId": { + "type": "integer", + "format": "int64", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "reviewResponse": { + "type": "string", + "format": "string", + "example": 12345, + "description": "Test Review Response" + }, + "isPublish": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "testimonialId", + "isPublish" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getCustomers": { + "$ref": "#/components/examples/getCustomersRequest" + }, + "getCustomerTestimonials": { + "$ref": "#/components/examples/getCustomerTestimonialsRequest" + }, + "getTestimonialPickLists": { + "$ref": "#/components/examples/getTestimonialPickListsRequest" + }, + "searchCustomers": { + "$ref": "#/components/examples/searchCustomersRequest" + }, + "sendCustomerTestimonials": { + "$ref": "#/components/examples/sendCustomerTestimonialsRequest" + }, + "updateCustomers": { + "$ref": "#/components/examples/updateCustomersRequest" + }, + "updateCustomerTestimonials": { + "$ref": "#/components/examples/updateCustomerTestimonialsRequest" + }, + "updatePropertyResponse": { + "$ref": "#/components/examples/updatePropertyResponseRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/CustomersSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 94, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/financial": { + "post": { + "tags": [ + "financial" + ], + "summary": "Financial", + "description": "## Note: \n **Pagination supported APIs**: `getBudgets`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "description": "arPayment related APIs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getApCodes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "apCodeTypeIds": { + "type": "integer", + "format": "int64", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. Currently supporting only job cost (3)" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBankAccounts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "bankAccountTypeId": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts single value. Bank Account Type Identification Number" + }, + "isCreditCardAccount": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgetActuals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": "123456", + "description": "This is a required field. This field accepts single value. propertyId" + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is a required field. This field accepts single value." + }, + "budgetId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is a required field. This field accepts single value." + }, + "postMonthFrom": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. MM/YYYY" + }, + "postMonthTo": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. MM/YYYY" + }, + "glBookTypeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. glBookTypeIds" + }, + "budgetStatusTypeId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is an optional field. This field accepts single value. budgetStatusTypeId" + }, + "accountingMethod": { + "type": "string", + "format": "string", + "example": "Cash", + "description": "This is a required field. This field accepts single value. accountingMethod" + } + }, + "required": [ + "propertyId", + "glTreeId", + "budgetId", + "postMonthFrom", + "postMonthTo" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. propertyIds" + }, + "budgetIds": { + "type": "string", + "format": "string", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetIds" + }, + "budgetStatusTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetStatusTypeIds" + }, + "fiscalYears": { + "type": "string", + "format": "string", + "example": "YYYY,YYYY", + "description": "This is an optional field. This field accepts comma seperated multiple values. fiscalYears" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": "123456", + "description": "This is an optional field. This field accepts single value. Property Id" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,112233", + "description": "This is a required field. This field accepts comma seperated multiple values." + }, + "glAccountFrom": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "glAccountTo": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "postMonthFrom": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. If no post month is provided, then the default post month of the prope rty will be used. If multiple properties are passed then the post mon th of any property would be used randomly." + }, + "postMonthTo": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "postDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "postDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "isCashBook": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isDetailed": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "glBookTypeIds": { + "type": "integer", + "format": "int64", + "example": "1,2,3", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "transactionDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction." + }, + "transactionDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction." + }, + "excludeApTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag will filter off any ap transactions from the response." + }, + "excludeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag will filter off any Ar Transactions from the response." + }, + "excludeExportedTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If passed as true (1) the API will not return any transaction that was previously marked exported using the markGlTransactionsExported API. Transaction exported under a different export format in Entrata wil l still qualify to be returned until specifically marked exported over the markGlTransactionsExported API." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Property Id" + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Tree Id" + }, + "glBranchId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Branch Id" + }, + "glGroupTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Group Type Id" + }, + "glTreeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id" + }, + "accountNumbers": { + "type": "string", + "format": "date", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Tree Id" + }, + "glBranchId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Branch Id" + }, + "glGroupTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Group Type Id" + }, + "glTreeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id" + }, + "accountNumbers": { + "type": "string", + "format": "date", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCategories" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This is the glAccount Id associated with job category" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCostBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id." + }, + "jobIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id." + }, + "jobStatusIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept job status Id." + }, + "apCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept apCode Id" + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node should accept job Phase Id" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node should accept the propertyId." + }, + "jobCategoryIds": { + "type": "integer", + "format": "integer", + "example": "6", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the jobCategoryIds" + }, + "jobStatusIds": { + "type": "integer", + "format": "integer", + "example": "4", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the job statusIds." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTransactionTagLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markGlTransactionsExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glDetailId": { + "type": "integer", + "format": "integer", + "example": "[\"123456\",\"67890\"]", + "description": "This is a required field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "glDetailId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "budgetName": { + "type": "string", + "format": "string", + "example": "budgets name 1", + "description": "This is a required field. This field accepts single value." + }, + "fiscalYear": { + "type": "integer", + "format": "integer", + "example": "YYYY", + "description": "This is a required field. This field accepts single value." + }, + "fiscalStartMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts fiscal start month in MM/YYYY format." + }, + "fiscalEndMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts fiscal end month in MM/YYYY format." + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. This node accepts GL account id." + }, + "budgetMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format." + }, + "amount": { + "type": "integer", + "format": "float", + "example": "10.00", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "budgetName", + "fiscalYear", + "fiscalStartMonth", + "fiscalEndMonth", + "id", + "budgetMonth", + "amount" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendJournalEntries" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "glHeaderTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. If the value for glHeaderTypeId is not provided take default as Standard" + }, + "reference": { + "type": "string", + "format": "string", + "example": "Enter Journal Entries", + "description": "This is an optional field. This field accepts single value." + }, + "accountingMethod": { + "type": "string", + "format": "string", + "example": "cash", + "description": "This is an optional field. This field accepts single value. If not provided, the accounting method of \"Both\" is used." + }, + "glBookId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "postDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If not provided then the default date will be the current date. The pa st date is acceptable" + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. If not provided then the default will be the current post month. Past post month is acceptable" + }, + "isReverse": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. By default value will be false." + }, + "reversePostMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Conditionally required. Based on \"isReverse\" flag." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "notes": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is an optional field. This field accepts single value." + }, + "defaultPropertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "defaultPropertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "defaultGlDimensionId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "memo": { + "type": "string", + "format": "string", + "example": "Test Memo", + "description": "This is an optional field. This field accepts single value." + }, + "debitAmount": { + "type": "integer", + "format": "integer", + "example": "100.00", + "description": "This is an optional field. This field accepts single value. Conditional Required. If the Credit amount is passed then this should be 0." + }, + "creditAmount": { + "type": "integer", + "format": "integer", + "example": "10.00", + "description": "This is an optional field. This field accepts single value. Conditional Required. If Debit amount is passed this should be 0" + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value" + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value" + }, + "glDimensionId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "defaultJobPhaseId": { + "type": "integer", + "format": "integer", + "example": 1233, + "description": "This is an optional field. This field accepts single value" + }, + "defaultApContractId": { + "type": "integer", + "format": "integer", + "example": 23, + "description": "This is an optional field. This field accepts single value" + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 23, + "description": "This is an optional field. This field accepts single value" + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + } + }, + "required": [ + "propertyId", + "glAccountId", + "glBookId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "month": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format." + }, + "amount": { + "type": "integer", + "format": "float", + "example": "122.88", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "id", + "month", + "amount" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getApCodes": { + "$ref": "#/components/examples/getApCodesRequest" + }, + "getBankAccounts": { + "$ref": "#/components/examples/getBankAccountsRequest" + }, + "getBudgetActuals": { + "$ref": "#/components/examples/getBudgetActualsRequest" + }, + "getBudgets": { + "$ref": "#/components/examples/getBudgetsRequest" + }, + "getFinancialPickListRequest_r1": { + "$ref": "#/components/examples/getFinancialPickListRequest_r1" + }, + "getFinancialPickListRequest_r2": { + "$ref": "#/components/examples/getFinancialPickListRequest_r2" + }, + "getGlTransactionsRequest": { + "$ref": "#/components/examples/getGlTransactionsRequest" + }, + "getGlTreesRequest_r1": { + "$ref": "#/components/examples/getGlTreesRequest_r1" + }, + "getGlTreesRequest_r2": { + "$ref": "#/components/examples/getGlTreesRequest_r2" + }, + "getJobCategoriesRequest": { + "$ref": "#/components/examples/getJobCategoriesRequest" + }, + "getJobCostBudgetsRequest": { + "$ref": "#/components/examples/getJobCostBudgetsRequest" + }, + "getJobsRequest": { + "$ref": "#/components/examples/getJobsRequest" + }, + "getTransactionTagListsRequest": { + "$ref": "#/components/examples/getTransactionTagListsRequest" + }, + "markGlTransactionsExported": { + "$ref": "#/components/examples/markGlTransactionsExportedRequest" + }, + "sendBudgets": { + "$ref": "#/components/examples/sendBudgetsRequest" + }, + "sendJournalEntries": { + "$ref": "#/components/examples/sendJournalEntriesRequest" + }, + "updateBudgets": { + "$ref": "#/components/examples/updateBudgetsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/FinancialSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 161, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/leads": { + "post": { + "tags": [ + "leads" + ], + "summary": "Lead related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getLeadEvents, getLeads, getMitsLeads, getQuotes`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leadId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Accepts combination of Firstname & Lastname to filter leads depending on inputs." + }, + "telephone": { + "type": "integer", + "format": "integer", + "example": "1234567890", + "description": "This is an optional field. This field accepts single value. Accepts Primary/Work/Home/Mobile number as input." + }, + "email": { + "type": "string", + "format": "string", + "example": "example@email.com", + "description": "This is an optional field. This field accepts single value." + }, + "leadStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "psProductIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "includeDemographics": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range." + }, + "createdOnDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range." + }, + "createdOnDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. In the response, events will not be returned unless we pass specific E vent Type Id(s) in this node. Accepts comma-separated values with lim it 5." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY" + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeadEvents" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Conditionally required, If eventTypeIds and eventDates are not passed then applicationId is required." + }, + "eventTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "applyQuote" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "generateQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application." + }, + "adjustmentsAndProvisionIds": { + "type": "string", + "format": "string", + "example": "123,234", + "description": "This is an optional field. This field accepts comma seperated multiple values. adjustmentsAndProvisionIds" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,4533", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyIds" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. propertyId" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leadId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Application Id referring PSI system" + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This field accepts a combination of Firstname & Lastname. If either of one is provided, leads matching with given input will be returned in the response." + }, + "telephone": { + "type": "integer", + "format": "integer", + "example": "1234567890", + "description": "This is an optional field. This field accepts single value. This field accepts Primary/Mobile/Home/Work number of prospect in any format" + }, + "email": { + "type": "string", + "format": "string", + "example": "example@email.com", + "description": "This is an optional field. This field accepts single value. This field accepts email address of prospect." + }, + "leadStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. leadStatusIds - comma seperated" + }, + "psProductIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. psProductIds - comma seperated" + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "10,15", + "description": "This is an optional field. This field accepts comma seperated multiple values. eventTypeIds - comma seperated" + }, + "sendUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. sendUnitSpaces" + }, + "fromDateTime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field.If name or telephone or email or leadId is provided then fromDate is not required." + }, + "toDateTime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field. If name or telephone or emai l or leadId is provided then toDate is not required." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. eventDateFrom" + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. eventDateTo" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application." + }, + "leaseStartDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY, YYYY-MM-DD, MM/DD/YY" + }, + "quoteId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + }, + "includeExpiredQuotes": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If pass value \"1\" then expired quotes should get returned in the response." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is a required field. This field accepts a single integer value fo r Property ID." + }, + "subtypeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\"" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "doNotSendConfirmationEmail": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Allows restricting the guest card confirmation emails to prospect/prop erty if set to 1." + }, + "isWaitList": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. When sent as 1, Units will be listed in waitlist." + }, + "LastUpdateDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYYT HH:MM:SS", + "description": "This is a required field. This field accepts single value. LastUpdateDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. ApplicationId" + } + }, + "required": [ + "propertyId", + "applicationId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts the property Id value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. Accept the Application_Id(Lead_Id), can be obtained from getLeads API." + }, + "eventId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Accepts the value for Event Id." + }, + "typeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. Accepts the Event Type Id value under this node." + }, + "eventResultId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Value for event result id should be fetched from getLeadPickLists API. Depending on the Events this node should be considered mandatory." + }, + "subtypeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\". And under event type \"Tour\":- 524:\"Self-Gui ded Tour\"" + }, + "date": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the event date. During cloning, all the lead event dates will be set to the current date." + } + }, + "required": [ + "propertyId", + "applicationId", + "typeId" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getLeads": { + "$ref": "#/components/examples/getLeadsRequest" + }, + "getLeadEvents": { + "$ref": "#/components/examples/getLeadEventsRequest" + }, + "applyQuote": { + "$ref": "#/components/examples/applyQuoteRequest" + }, + "generateQuotes": { + "$ref": "#/components/examples/generateQuotesRequest" + }, + "getLeadPickLists_r1": { + "$ref": "#/components/examples/getLeadPickListsRequest_r1" + }, + "getLeadPickLists_r2": { + "$ref": "#/components/examples/getLeadPickListsRequest_r2" + }, + "getMitsLeads": { + "$ref": "#/components/examples/getMitsLeadsRequest" + }, + "getQuotes": { + "$ref": "#/components/examples/getQuotesRequest" + }, + "sendLeads": { + "$ref": "#/components/examples/sendLeadsRequest" + }, + "sendMitsLeads": { + "$ref": "#/components/examples/sendMitsLeadsRequest" + }, + "updateLeads": { + "$ref": "#/components/examples/updateLeadsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/LeadsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 106, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/leases": { + "post": { + "tags": [ + "leases" + ], + "summary": "Leases related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getLeaseActivities, getLeaseDetails(r2), getLeaseDocumentsList, getParcelAlerts, getLeases(r1), getLease(r2)`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "cancelLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getEvictedLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Provide a valid propertyId." + }, + "evictionStartDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateFrom." + }, + "evictionStartDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateTo" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getExpiringLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Date from which leases are required" + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Date upto which leases are required" + }, + "isMonthToMonth": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Is Month To Month" + }, + "isWaitList": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this parameter is enabled then we will show leases with lease type status notice and the property setting HIDE_NOTICE_RESIDENTS_FROM_RENE WALS should be disabled for this, else we will return error." + } + }, + "required": [ + "propertyId", + "toDate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "leaseId", + "propertyId" + ], + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "createdOnDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventTypeIds": { + "type": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "includeAddOns": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "includeCharge": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "includeAddOns": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "includeCharge": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocuments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Lease Id - Required if externalLeaseId is not provided" + }, + "externalLeaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. The remote primary key which is associated to lease. Required if leas eId is not provided." + }, + "documentIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "fileTypesCode": { + "type": "string", + "format": "string", + "example": "LA", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files" + }, + "addedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If provided, this will return the documents which have AddedOn dates o n or after the date provided." + }, + "showDeletedFile": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocumentsList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "externalLeaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. This is the remote primary key that is associated to lease." + }, + "documentIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "fileTypesCode": { + "type": "string", + "format": "string", + "example": "LA", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files" + }, + "showDeletedFile": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsCollections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "includeEvictions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Include Evictions leases" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From Date" + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionFromDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. customerId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getParcelAlerts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "isActive": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentersInsurancePolicies" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. lastUpdatedOn" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveInLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveOutLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "moveOutTypeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutTypeId" + }, + "moveOutReasonId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutReasonId" + }, + "noticeDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. noticeDate" + }, + "moveOutDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveOutDate" + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate" + }, + "endContinuingScheduledCharges": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. endContinuingScheduledCharges" + }, + "postAcceleratedRent": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. postAcceleratedRent" + }, + "refundMethodId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": " This is an optional field. This field accepts single value. refundMethodId" + }, + "makeReadyEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line1" + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line2" + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line3" + }, + "city": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding address`s city" + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AK", + "description": "This is an optional field. This field accepts single value. Forwarding Address`s stateCode" + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": 99501, + "description": "This is an optional field. This field accepts single value. Forwarding Address`s Postal Code" + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "onNoticeLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "moveOutTypeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutTypeId" + }, + "moveOutReasonId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutReasonId" + }, + "noticeDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. noticeDate (YYYY-MM-DD)" + }, + "moveOutDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveOutDate (YYYY-MM-DD)" + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate (YYYY-MM-DD)" + }, + "makeReadyEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory." + }, + "submitRefundDetails": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value. submitRefundDetails" + }, + "refundMethodId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"refundMet hodId\" is required." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 1\" is required." + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 2\" is required." + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 3\" is required." + }, + "city": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"city\" is required." + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AK", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"stateCode\" is required." + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": 99501, + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"postalCod \" is required." + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate", + "makeReadyEndDate", + "submitRefundDetails" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "eventTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. Acceptable values are: 8,335,4,436,5,6,15,56. 4 for \"Call-Outgoing\" , 5 for \"Text-Incoming\", 6 for \"Text-Outgoing\", 8 for \"Notes\", 335 fo r \"Lease Retrieved By Collections Agency\", 436 for \"Hazard Notes\", 15 for \"Scheduled Follow-Up\", 56 for \"Delinquency Notes\"." + }, + "eventDateTime": { + "type": "string", + "format": "date", + "example": "09/2/2018 03:57:00 PST", + "description": "This is a required field. This field accepts single value." + }, + "comment": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6." + }, + "hazardEndDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. This would give end date for the hazard note." + }, + "hazardNote": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. This would add note when creating hazard event." + }, + "leaseIntervalId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "leasingAgentId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15." + }, + "eventResultId": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "his is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6." + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduleDateTime": { + "type": "string", + "format": "date", + "example": "06/18/2022 11:30:45", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15." + } + }, + "required": [ + "propertyId", + "leaseId", + "eventTypeId", + "eventDateTime", + "hazardNote" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseStartDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. leaseStartDate (YYYY-MM-DD)" + }, + "leaseEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. leaseEndDate (YYYY-MM-DD)" + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveInDate (YYYY-MM-DD)" + }, + "leaseTermId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseTermId" + }, + "floorplanId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. floorplanId" + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. unitSpaceId" + }, + "spaceConfigurationId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"spaceConfigurationId\" is required." + }, + "leaseStartWindowId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"leaseStartWindowId\" is required." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. firstName" + }, + "middleName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. middleName" + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. lastName" + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. emailAddress" + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. birthDate (YYYY-MM-DD)" + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. phoneNumberTypeId" + }, + "phoneNumber": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. Primary phoneNumber" + }, + "addressTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. addressTypeId" + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Address streetLine1" + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. streetLine2" + }, + "city": { + "type": "string", + "format": "string", + "example": "city1", + "description": "This is a required field. This field accepts single value. city" + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AZ", + "description": "This is a required field. This field accepts single value. stateCode" + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": "05559", + "description": "This is a required field. This field accepts single value. postalCode" + } + }, + "required": [ + "propertyId", + "leaseStartDate", + "leaseEndDate", + "moveInDate", + "leaseTermId", + "floorplanId", + "unitSpaceId", + "firstName", + "lastName", + "customerRelationshipTypeId", + "phoneNumberTypeId", + "phoneNumber", + "addressTypeId", + "streetLine1", + "city", + "stateCode", + "postalCode" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Insurance policy id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. customerId" + }, + "provider": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. provider" + }, + "policyNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. policyNumber" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. endDate" + }, + "liability": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is a required field. This field accepts single value. liability" + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Insurance policy id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "12345,6789", + "description": "This is a required field. This field accepts comma seperated multiple values. customerIds" + }, + "provider": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. provider" + }, + "policyNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. policyNumber" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. endDate" + }, + "liability": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is a required field. This field accepts single value. liability" + }, + "personalContents": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is an optional field. This field accepts single value. personalContents" + }, + "deductible": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is an optional field. This field accepts single value. deductible" + }, + "isCancelled": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "15" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRoommateGroups" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "required": [ + "roommateGroups" + ], + "properties": { + "roommateGroups": { + "type": "object", + "required": [ + "roommateGroup" + ], + "properties": { + "roommateGroup": { + "type": "array", + "items": { + "type": "object", + "properties": { + "invitorApplicationId": { + "type": "integer", + "description": "Required field unless inviteeApplicationId is provided. This field accepts single value.", + "example": 12345678 + }, + "inviteeApplicationId": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Required field. This field accepts multiple values.", + "example": [ + 12345678, + 55555555, + 88888888 + ] + }, + { + "type": "string", + "description": "Can be empty string", + "example": "" + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendScheduledCharges" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "example": 307, + "description": "This is a required field. This field accepts single value. chargeTimingId" + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. chargeCodeTypeId" + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value. chargeCodeId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "leaseIntervalId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. leaseIntervalId" + } + }, + "required": [ + "propertyId", + "leaseId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "startDate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts the single property Id that is associated with a lease." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts a single lease id for updating the lease details." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single" + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a optional field. This field accepts single value. moveInDate (YYYY-MM-DD)" + }, + "occupants": { + "type": "object", + "description": "Optional object containing occupant details", + "properties": { + "occupant": { + "type": "array", + "description": "List of occupants", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. firstName" + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. lastName" + } + } + } + } + } + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId" + } + }, + "required": [ + "propertyId", + "leaseId", + "firstName", + "lastName", + "customerRelationshipTypeId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. scheduledChargeid" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "isDeleted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1." + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. scheduledChargeid" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "isDeleted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1." + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "cancelLease": { + "$ref": "#/components/examples/cancelLeaseRequest" + }, + "getEvictedLeases": { + "$ref": "#/components/examples/getEvictedLeasesRequest" + }, + "getExpiringLeases": { + "$ref": "#/components/examples/getExpiringLeasesRequest" + }, + "getLeaseActivities": { + "$ref": "#/components/examples/getLeaseActivitiesRequest" + }, + "getLeaseDetails_r1": { + "$ref": "#/components/examples/getLeaseDetailsRequest_r1" + }, + "getLeaseDetails_r2": { + "$ref": "#/components/examples/getLeaseDetailsRequest_r2" + }, + "getLeaseDocuments": { + "$ref": "#/components/examples/getLeaseDocumentsRequest" + }, + "getLeaseDocumentsList": { + "$ref": "#/components/examples/getLeaseDocumentsListRequest" + }, + "getLeasePickList": { + "$ref": "#/components/examples/getLeasePickListRequest" + }, + "getLeases_r1": { + "$ref": "#/components/examples/getLeasesRequest_r1" + }, + "getLeases_r2": { + "$ref": "#/components/examples/getLeasesRequest_r2" + }, + "getMitsCollections": { + "$ref": "#/components/examples/getMitsCollectionsRequest" + }, + "getMitsLeases": { + "$ref": "#/components/examples/getMitsLeasesRequest" + }, + "getParcelAlerts": { + "$ref": "#/components/examples/getParcelAlertsRequest" + }, + "getRentersInsurancePolicies": { + "$ref": "#/components/examples/getRentersInsurancePoliciesRequest" + }, + "moveInLease": { + "$ref": "#/components/examples/moveInLeaseRequest" + }, + "moveOutLease": { + "$ref": "#/components/examples/moveOutLeaseRequest" + }, + "onNoticeLease": { + "$ref": "#/components/examples/onNoticeLeaseRequest" + }, + "sendLeaseActivities": { + "$ref": "#/components/examples/sendLeaseActivitiesRequest" + }, + "sendLeases": { + "$ref": "#/components/examples/sendLeasesRequest" + }, + "sendRentersInsurancePolicies_r1": { + "$ref": "#/components/examples/sendRentersInsurancePoliciesRequest_r1" + }, + "sendRentersInsurancePolicies_r2": { + "$ref": "#/components/examples/sendRentersInsurancePoliciesRequest_r2" + }, + "sendRoommateGroups": { + "$ref": "#/components/examples/sendRoommateGroups_r2_Request" + }, + "sendScheduledCharges": { + "$ref": "#/components/examples/sendScheduledChargesRequest" + }, + "updateLease": { + "$ref": "#/components/examples/updateLeaseRequest" + }, + "updateScheduledCharges_r1": { + "$ref": "#/components/examples/updateScheduledChargesRequest_r1" + }, + "updateScheduledCharges_r2": { + "$ref": "#/components/examples/updateScheduledChargesRequest_r2" + } + } + }, + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "requestContentType", + "requestBody", + "file1" + ], + "properties": { + "requestContentType": { + "type": "string", + "description": "This is required field. This field specify the content of requestBody field. This field accept fixed value as `application/json`.", + "enum": [ + "application/json" + ], + "example": "application/json" + }, + "requestBody": { + "type": "object", + "description": "This is required field. This field accept the details of lease, and ducuments being uploaded.", + "required": [ + "auth", + "method" + ], + "properties": { + "auth": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "method": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseDocuments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "files" + ], + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. This is the conditionally required, if applicationId and applicantId is not provided." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a optional field. This field accepts single value. This is the conditionally required, if leaseId and applicantId is not provided." + }, + "applicantId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a optional field. This field accepts single value. This is conditionally required, if leaseId and applicationId is not provided." + }, + "files": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "array", + "items": { + "type": "object", + "required": [ + "fileName" + ], + "properties": { + "fileName": { + "type": "string", + "description": "This is a required field. This will be the name of the file being uploaded.", + "example": "lease.pdf" + }, + "leaseFileType": { + "type": "string", + "description": "This is a optional field. This field accepts single value. This is conditionally required if fileTypeId is not provided. This will be the type of the file being uploaded.", + "example": "POI" + }, + "fileTypeId": { + "type": "integer", + "description": "This is a optional field. This field accepts single value. This is conditionally required if leaseFileType is not provided.", + "example": 12345 + }, + "isShowInResidentPortal": { + "type": "integer", + "description": "This is a optional field. This will specify the visibility of uploaded document in the resident portal.", + "example": 1, + "enum": [ + 0, + 1 + ] + }, + "customerIds": { + "type": "string", + "description": "This is a optional field. This will accepts comma separated multiple values. If provided this file will attach to the mentioned customers. if skipped, the file will be attached to all the customers of the lease.", + "example": "1234,5678" + } + } + } + } + } + } + } + } + } + } + } + }, + "file1": { + "type": "string", + "description": "This is required field. This will accept the file being uploaded to the lease. This should match and can repeate the field as per the files mentioned in the requestBody.", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/LeasesSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 336, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/leasingcenter": { + "post": { + "tags": [ + "leasingcenter" + ], + "summary": "Leasing Center related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getCallLogs`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCallLogs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "123456,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id`s." + }, + "callSourceId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. Supported values (1, 2, 7)" + }, + "callTypeIds": { + "type": "integer", + "format": "integer", + "example": "3,8", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "callResultIds": { + "type": "integer", + "format": "integer", + "example": "8,1", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "answerStatus": { + "type": "integer", + "format": "integer", + "example": 1, + "description": " This is an optional field. This field accepts single value. Supports only 1 (ANSWERED) & 2 (UNANSWERED)" + }, + "voiceMailTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supported values are 1 (VOICE_MESSAGE) or 2 (UNPLAYED_VOICE_MESSAGE) o r 3 (NO_VOICE_MESSAGE)." + }, + "callAnalyzed": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Supports 1 (ANALYZED) or 0 (NON_ANALYZED)" + }, + "callState": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supports 1 (NON-ARCHIVED) or 2 (ARCHIVED)." + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasingCenterPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getCallLogs": { + "$ref": "#/components/examples/getCallLogsRequest" + }, + "getLeasingCenterPickLists": { + "$ref": "#/components/examples/getLeasingCenterPickListsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/LeasingCenterSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 18, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/maintenance": { + "post": { + "tags": [ + "maintenance" + ], + "summary": "Maintenance related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getInspections`, `getInspectionTemplates`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "statusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "inspectionFormId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "inspectionTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supported values are 1( ROUTINE ), 2(MOVE_IN), 3(MOVE_OUT)" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspectionTemplates" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,678", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value." + }, + "showDisabled": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. The node accepts a boolean value and default value for this node is \"0\"." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrderPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,678", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. propertyUnitId" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds" + }, + "workOrderTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. workOrderTypeIds" + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. buildingName" + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Unit number" + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. maintenancePriorityId" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. maintenanceCategoryId" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. maintenanceProblemId" + }, + "includeChildWorkOrders": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. includeChildWorkOrders" + }, + "includeDeletedWorkOrders": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not." + }, + "createdOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. createdOnFromDate" + }, + "createdOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. createdOnToDate" + }, + "lastUpdatedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter." + }, + "lastUpdatedOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter." + }, + "completedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. completedOnFromDate" + }, + "completedOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. completedOnToDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Customer Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Lease ID" + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "5", + "description": "This is an optional field. This field accepts single value. Unit mumber" + }, + "customerFirstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Customer First Name" + }, + "customerLastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Customer Last Name" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value. Permission to enter" + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Maintenance Priority" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description is required if the lease has pets or if permission t o enter is denied so that a reason why entry is not permitted can be e xplained or a pet warning given." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. buildingName" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "scheduledStartDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDateTime" + }, + "scheduledEndDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDateTime" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "isFloatingWorkOrder": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Negative numbers not allowed. This parameter is not applicable to mos t clients and should not be used without first checking with Entrata." + } + }, + "required": [ + "propertyId", + "mainPhoneNumber", + "permissionToEnter", + "maintenanceLocationId", + "maintenanceCategoryId", + "maintenanceProblemId", + "problemDescription" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "maintenanceStatusTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 100, + "description": "This is an optional field. This field accepts single value." + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given." + }, + "completedDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value." + }, + "closingComments": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "scheduledStartDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDate" + }, + "scheduledEndDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDate" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "parentWorkOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. parentWorkOrderId" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "2017-04-02", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed." + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a optional field. This field accepts single value. Permission to enter" + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "maintenanceStatusTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 100, + "description": "This is an optional field. This field accepts single value." + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given." + }, + "completedDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value." + }, + "closingComments": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "scheduledStartDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDate" + }, + "scheduledEndDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDate" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "parentWorkOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. parentWorkOrderId" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "2017-04-02", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed." + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a optional field. This field accepts single value. Permission to enter" + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getInspections": { + "$ref": "#/components/examples/getInspectionsRequest" + }, + "getInspectionTemplates": { + "$ref": "#/components/examples/getInspectionTemplatesRequest" + }, + "getWorkOrderPickLists": { + "$ref": "#/components/examples/getWorkOrderPickListsRequest" + }, + "getWorkOrders": { + "$ref": "#/components/examples/getWorkOrdersRequest" + }, + "sendWorkOrders": { + "$ref": "#/components/examples/sendWorkOrdersRequest" + }, + "updateWorkOrders_r1": { + "$ref": "#/components/examples/updateWorkOrdersRequest_r1" + }, + "updateWorkOrders_r2": { + "$ref": "#/components/examples/updateWorkOrdersRequest_r2" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/MaintenanceSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 134, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/pricing": { + "post": { + "tags": [ + "pricing" + ], + "summary": "Pricing related APIs", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPricingPicklists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyFees" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId" + ], + "properties": { + "propertyId": { + "type": "string", + "example": "12345", + "description": "This is a required field. This field accepts single value. propertyId" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "format": "integer", + "example": 4, + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space." + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id." + }, + "chargeUsageId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance" + }, + "chargeUsageReferenceId": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0." + }, + "isRenewal": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent." + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "example": 307, + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed" + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit" + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use." + }, + "leaseTermMonths": { + "type": "integer", + "format": "integer", + "example": 12, + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms." + }, + "leaseStartRangeStart": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit`s available on the date [if available on a date is in future]. If sending \"isRenewal\" as true this value should always be sent as 0" + }, + "leaseStartRangeEnd": { + "type": "integer", + "format": "integer", + "example": 10000, + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending \"isRenewal\" as true this value should always be sent as 0" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 1840, + "description": "This is a required field. This field accepts single value. Rate Amount." + }, + "leaseTermName": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory." + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeUsageReferenceId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "leaseTermName" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "example": 1381146 + }, + "pricing": { + "type": "array", + "description": "Array of pricing objects", + "items": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.", + "example": 3 + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId.", + "example": 639824 + }, + "chargeUsageId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance", + "example": 1 + }, + "isRenewal": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent.", + "example": 0 + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing].", + "example": 303 + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit", + "example": 2 + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.", + "example": 224711 + }, + "leaseTermMonths": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing for different terms.", + "example": 13 + }, + "leaseTermId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Lease term identifier.", + "example": 33549 + }, + "leaseStartWindowId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Lease start window identifier.", + "example": 240891 + }, + "spaceConfigurationId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Space configuration identifier.", + "example": 2 + }, + "leaseTermName": { + "type": "string", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is mandatory.", + "example": "Lease Term 2" + }, + "leaseStartRangeStart": { + "type": "integer", + "format": "integer", + "description": "This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRenewal' as true this value should always be sent as 0", + "example": 2 + }, + "leaseStartRangeEnd": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0", + "example": 4 + }, + "amount": { + "type": "string", + "description": "This is a required field. This field accepts single value. Rate Amount.", + "example": "40.00" + }, + "isFullUpdate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Indicates if this is a full update operation.", + "example": "1" + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "leaseTermName", + "amount" + ] + } + } + }, + "required": [ + "propertyId", + "pricing" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgetedRent" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 4, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "pricingLevelId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is a required field. This field accepts single value. Pricing level has two possible values, 3 for Unit type and 4 for Unit space." + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 3 then pricingLevelReferenceId needs to be unit type id a nd if pricingLevelId = 4 then pricingLevelReferenceId needs to be unit space id." + }, + "amenityAmount": { + "type": "integer", + "format": "float", + "example": 20, + "description": "This is an optional field. This field accepts single value. Amenity rate amount." + }, + "amount": { + "type": "integer", + "format": "float", + "example": 20, + "description": "This is a required field. This field accepts single value. amount" + } + }, + "required": [ + "propertyId", + "pricingLevelId", + "pricingLevelReferenceId", + "amount" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getPricingPicklists": { + "$ref": "#/components/examples/getPricingPicklistsRequest" + }, + "getPropertyFees": { + "$ref": "#/components/examples/getPropertyFeesRequest" + }, + "insertPricing": { + "$ref": "#/components/examples/insertPricingRequest" + }, + "insertPricing_r2": { + "$ref": "#/components/examples/insertPricingRequest_r2" + }, + "sendBudgetedRent": { + "$ref": "#/components/examples/sendBudgetedRentRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/PricingSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 55, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/properties": { + "post": { + "tags": [ + "properties" + ], + "summary": "Properties related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getAmenityReservations, getPropertyMedia, getReservableAmenities`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenityReservations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "amenityIds": { + "type": "integer", + "format": "integer", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "amenityReservationStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 7 da y range is allowed per request and that range includes the fromDate an d toDate in it." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 7 day range is allowed per request and that range includes the fromDate and toDate in it." + }, + "calendarEventCategoryIds": { + "type": "integer", + "format": "integer", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values. Calendar Event type ids. Possible id: 1-General, 2-Resident, 3-Leasing , 4-Maintenance If no Id`s are passed only Resident and Leasing cat egories are considered by default." + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 60 d ay range is allowed per request and that range includes the fromDate and toDate in it." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 60 day range is allowed per request and that range includes the fromDate and toDate in it." + }, + "tourType": { + "type": "string", + "format": "string", + "example": "SELF_GUIDED", + "description": "This is a required field. This field accepts single value. tour type: SELF_GUIDED, VIRTUAL_GUIDED,AGENT_GUIDED" + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getFloorPlans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "propertyFloorPlanIds": { + "type": "string", + "format": "string", + "example": "456789,123222", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyFloorPlanIds." + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Checks for the property settings manipulate floorplan data and honour those settings." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value is 1, then user should get disabled floorplans along with the enabled one." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPetTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "456789,123222", + "description": "This is a required field. This field accepts comma seperated multiple values. List of comma seperated propertyIds" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getProperties" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. PropertyIds" + }, + "propertyLookupCode": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "showAllStatus": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Show all properties with any status." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAnnouncements" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getReservableAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "amenityIds": { + "type": "integer", + "format": "integer", + "example": "12345,655", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWebsites" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. PropertyIds" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendFloorplans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This node accepts the property id on which the floorplan will get added." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. This node accepts the name of the floorplan." + }, + "description": { + "type": "string", + "format": "string", + "example": "description", + "description": "This is an optional field. This field accepts single value. This node accepts the description of the floorplan" + }, + "seoTitle": { + "type": "string", + "format": "string", + "example": "seo title", + "description": "This is an optional field. This field accepts single value. This node accepts the seoTitle of the floorplan" + }, + "seoDescription": { + "type": "string", + "format": "string", + "example": "seo description", + "description": "This is an optional field. This field accepts single value. This node accepts the seoDescription of the floorplan" + }, + "seoKeywords": { + "type": "string", + "format": "string", + "example": "seo keyword", + "description": "This is an optional field. This field accepts single value. This node accepts the seoKeywords of the floorplan" + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0, whether the floorplan needs to be published or not." + }, + "isDisabledVirtualMoveIn": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0." + }, + "minSquareFeet": { + "type": "integer", + "format": "float", + "example": 200, + "description": "This is an optional field. This field accepts single value. This node accepts the minimum square feet value of the floorplan." + }, + "maxSquareFeet": { + "type": "integer", + "format": "float", + "example": 1000, + "description": "This is an optional field. This field accepts single value. This node accepts the maximun square feet value of the floorplan." + }, + "numberOfBedRooms": { + "type": "integer", + "format": "float", + "example": 1, + "description": "This is a required field. This field accepts single value. This node accepts a total number of bedrooms." + }, + "numberOfBathRooms": { + "type": "integer", + "format": "float", + "example": 1, + "description": "This is a required field. This field accepts single value. This node accepts a total number of bathrooms." + }, + "isFeatured": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0." + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "categoryId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value." + }, + "showOnWebsite": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isMarketed": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "hasInventory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "availabilityStatusId": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "description": { + "type": "string", + "format": "string", + "example": "FurnitureTesting", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "mediaTypeId", + "mediaSubTypeId" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "123456" + }, + "mediaTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "6" + }, + "mediaSubTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "24" + }, + "referenceIds": { + "type": "string", + "description": "This is an optional field. This field accepts single value. reference id for mediaType", + "example": "987654" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyMedia" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "media" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "123456" + }, + "media": { + "type": "array", + "items": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "mediaTypeId", + "mediaTypeName", + "mediaSubTypeId", + "mediaSubTypeName", + "referenceId", + "mediaProvider", + "mediaUrl" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the media", + "example": "100001" + }, + "mediaTypeId": { + "type": "string", + "description": "Type identifier for the media", + "example": "6" + }, + "mediaTypeName": { + "type": "string", + "description": "Name of the media type", + "example": "unit_floorplan_medias" + }, + "mediaSubTypeId": { + "type": "string", + "description": "Sub-type identifier for the media", + "example": "24" + }, + "mediaSubTypeName": { + "type": "string", + "description": "Name of the media sub-type", + "example": "ABC" + }, + "referenceId": { + "type": "string", + "description": "Reference identifier", + "example": "987654" + }, + "mediaProvider": { + "type": "string", + "description": "Provider of the media", + "example": "XYZ" + }, + "mediaUrl": { + "type": "string", + "description": "URL of the media", + "example": "https://www.example.com/demo1" + }, + "mediaAltText": { + "type": "string", + "description": "Alternative text for the media", + "example": "business_demo1" + }, + "name": { + "type": "string", + "description": "Name of the media", + "example": "demo_name1" + }, + "description": { + "type": "string", + "description": "Description of the media", + "example": "demo_description1" + }, + "caption": { + "type": "string", + "description": "Caption for the media", + "example": "demo_caption1" + }, + "height": { + "type": "string", + "description": "Height of the media", + "example": "800" + }, + "width": { + "type": "string", + "description": "Width of the media", + "example": "600" + }, + "mediaFormat": { + "type": "string", + "description": "Format of the media", + "example": "jpeg" + } + } + } + ] + } + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyMedia" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "media" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "999999" + }, + "media": { + "type": "array", + "items": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "mediaTypeId", + "mediaTypeName", + "mediaSubTypeId", + "mediaSubTypeName", + "referenceId", + "mediaProvider", + "mediaUrl" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the media", + "example": "100001" + }, + "mediaTypeId": { + "type": "string", + "description": "Type identifier for the media", + "example": "6" + }, + "mediaTypeName": { + "type": "string", + "description": "Name of the media type", + "example": "unit_floorplan_medias" + }, + "mediaSubTypeId": { + "type": "string", + "description": "Sub-type identifier for the media", + "example": "24" + }, + "mediaSubTypeName": { + "type": "string", + "description": "Name of the media sub-type", + "example": "ABC" + }, + "referenceId": { + "type": "string", + "description": "Reference identifier", + "example": "987654" + }, + "mediaProvider": { + "type": "string", + "description": "Provider of the media", + "example": "XYZ" + }, + "mediaUrl": { + "type": "string", + "description": "URL of the media", + "example": "https://www.example.com/demo1" + }, + "mediaAltText": { + "type": "string", + "description": "Alternative text for the media", + "example": "business_demo1" + }, + "name": { + "type": "string", + "description": "Name of the media", + "example": "demo_name1" + }, + "description": { + "type": "string", + "description": "Description of the media", + "example": "demo_description1" + }, + "caption": { + "type": "string", + "description": "Caption for the media", + "example": "demo_caption1" + }, + "height": { + "type": "string", + "description": "Height of the media", + "example": "800" + }, + "width": { + "type": "string", + "description": "Width of the media", + "example": "600" + }, + "mediaFormat": { + "type": "string", + "description": "Format of the media", + "example": "jpeg" + } + } + } + ] + } + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "1002" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "deletePropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "id" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. The unique identifier for the property.", + "example": "999999" + }, + "id": { + "type": "string", + "description": "Required. The unique identifier for the media.", + "example": "555555" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPhoneNumber" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Array of property IDs", + "example": [ + 123456, + 789 + ] + }, + "switchCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "46545" + }, + "ref": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "http://google.com" + } + } + } + } + } + } + } + ] + } + }, + "examples": { + "getAmenityReservations": { + "$ref": "#/components/examples/getAmenityReservationsRequest" + }, + "getCalendarAvailability_r1": { + "$ref": "#/components/examples/getCalendarAvailabilityRequest_r1" + }, + "getCalendarAvailability_r2": { + "$ref": "#/components/examples/getCalendarAvailabilityRequest_r2" + }, + "getFloorPlans": { + "$ref": "#/components/examples/getFloorPlansRequest" + }, + "getPetTypes": { + "$ref": "#/components/examples/getPetTypesRequest" + }, + "getProperties": { + "$ref": "#/components/examples/getPropertiesRequest" + }, + "getPropertyAddOns": { + "$ref": "#/components/examples/getPropertyAddOnsRequest" + }, + "getPropertyAnnouncements": { + "$ref": "#/components/examples/getPropertyAnnouncementsRequest" + }, + "getPropertyPickLists_r1": { + "$ref": "#/components/examples/getPropertyPickListsRequest_r1" + }, + "getPropertyPickLists_r2": { + "$ref": "#/components/examples/getPropertyPickListsRequest_r2" + }, + "getRentableItems": { + "$ref": "#/components/examples/getRentableItemsRequest" + }, + "getReservableAmenities": { + "$ref": "#/components/examples/getReservableAmenitiesRequest" + }, + "getWebsites": { + "$ref": "#/components/examples/getWebsitesRequest" + }, + "sendFloorplans": { + "$ref": "#/components/examples/sendFloorplansRequest" + }, + "sendRentableItems": { + "$ref": "#/components/examples/sendRentableItemsRequest" + }, + "getPropertyMedia": { + "$ref": "#/components/examples/getPropertyMediaRequest" + }, + "sendPropertyMedia": { + "$ref": "#/components/examples/sendPropertyMediaRequest" + }, + "updatePropertyMedia": { + "$ref": "#/components/examples/updatePropertyMediaRequest" + }, + "deletePropertyMedia": { + "$ref": "#/components/examples/deletePropertyMediaRequest" + }, + "getPhoneNumber": { + "$ref": "#/components/examples/getPhoneNumberRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/PropertiesSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 166, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/propertyunits": { + "post": { + "tags": [ + "propertyunits" + ], + "summary": "Property Units related APIs", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "unitNumber": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Unit Number" + }, + "chargeCodeTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. PSI Property Identification number" + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for getting available units only" + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing preferences on result." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result." + }, + "showUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Unit Spaces on result." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values." + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If enabled then the Entrata setting \"Max Available Units per Floor P lan\" will be honored and the available units returned will be reduced. Also requires using the availableUnitsOnly parameter as true (1)." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r3" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response", + "example": "15" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getSpecials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r4" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for getting Specials", + "example": "1234567" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitsAvailabilityAndPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "floorplanId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Floorplan Id" + }, + "unitTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Unit Type Id" + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Property Unit Id" + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units" + }, + "unavailableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response." + }, + "skipPricing": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)" + }, + "showChildProperties": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result." + }, + "showUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. showUnitSpaces" + }, + "useSpaceConfiguration": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration." + }, + "allowLeaseExpirationOverride": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If \"1\" is sent then we should override any lease expiration limits aff ecting available units returned/ If \"0\" or node is missing then do cur rent default functionality" + }, + "moveInStartDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing." + }, + "moveInEndDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This field accepts a single integer value for Property ID" + }, + "name": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value. This accepts name of the amenity" + }, + "description": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value. This accepts description of the amenity." + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0 ,whether amenity needs to be published or not ." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This accepts unit space id for the amenity." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "unitNumber": { + "type": "string", + "format": "string", + "example": 20, + "description": "This is a required field. This field accepts single value. This node should accept the unitNumber." + }, + "unitPrefix": { + "type": "string", + "format": "string", + "example": "CC", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNunber prefix" + }, + "unitSuffix": { + "type": "string", + "format": "string", + "example": "BB", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNumber suffix" + }, + "spaceNumber": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. This node should accept the spaceNumber on added unit." + }, + "maxOccupants": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. This node should accepts the maxOccupants of the property units" + }, + "maxPets": { + "type": "integer", + "format": "integer", + "example": 11, + "description": "This is an optional field. This field accepts single value. This node should accepts the maxPets of the property units" + }, + "numberOfBedRooms": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This node should accepts the beds number of the property units" + }, + "numberOfBathRooms": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This node should accepts the bathRooms of the property units" + }, + "squareFeet": { + "type": "integer", + "format": "integer", + "example": 2000, + "description": "This is an optional field. This field accepts single value. This node should accept the squareFeet of the property units" + }, + "note": { + "type": "string", + "format": "string", + "example": "Testing property", + "description": "This is an optional field. This field accepts single value. This node should accept the note added for the property units" + }, + "unitGenderId": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. This node should accept the Id of the gender. The unitGenderId should be get from getPropertyPickLists." + } + }, + "required": [ + "unitNumber" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "specialGroup" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. Property ID for insert Specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "required": [ + "specialGroupName" + ], + "properties": { + "specialGroupName": { + "type": "string", + "description": "This is a required field. This accepts the Special Group name.", + "example": "Test Insert Special API" + }, + "internalDescription": { + "type": "string", + "description": "This is an optional field. Internal description not visible to residents.", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "This is an optional field. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "This is an optional field. Determines if special is eligible to be used.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "This is an optional field. Determines if special will be shown in advertising.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised from.", + "example": "04/01/2025" + }, + "endDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised to.", + "example": "04/30/2025" + }, + "hideEndDate": { + "type": "string", + "description": "This is an optional field. Determines if special end date will be advertised.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "This is an optional field. Description shown to residents.", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "This is an optional field. Terms and conditions for specials.", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "This is an optional field. Determines if special is manual only.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. Start of move-in date range.", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. End of move-in date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "This is an optional field. Start of renewal date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "This is an optional field. End of renewal date range.", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "This is an optional field. Allows setting limits on specials.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "This is an optional field. Limits number of specials given.", + "example": "10" + }, + "couponCode": { + "type": "string", + "description": "This is an optional field. Promotional code required during application.", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "This is an optional field. Source of promo code.", + "example": "56789" + }, + "incentiveLimit": { + "type": "string", + "description": "This is an optional field. Number of incentives resident receives.", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "This is an optional field. If specials incentive count matches limit.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseStartWindowId" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "12345" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "456789" + } + } + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "This is an optional field. Comma separated recipient IDs.", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "This is an optional field. Special trigger type for prospects.", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "This is an optional field. Special trigger type for renewals.", + "example": "22" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "This is an optional field. Comma separated space configuration IDs.", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "required": [ + "specialTypeId", + "specialName" + ], + "properties": { + "specialTypeId": { + "type": "string", + "description": "This is a required field. Special type identifier.", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "This is a required field. Name of the special.", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "This is an optional field. Value of gift type special.", + "example": "0.00" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermMonth", + "leaseStartWindowId", + "arFormulaId", + "rateAmount", + "showInEntrata", + "showOnWebsite" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "This is an optional field. AR code identifier.", + "example": "123456" + }, + "arTriggerId": { + "type": "string", + "description": "This is an optional field. AR trigger identifier.", + "example": "111" + }, + "arCodeTypeId": { + "type": "string", + "description": "This is an optional field. AR code type identifier.", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "This is an optional field. Customer relationship identifier.", + "example": "" + }, + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "This is a required field. Integer representation of lease term.", + "example": "1" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "999999" + }, + "windowStartDate": { + "type": "string", + "description": "This is an optional field. Start date for lease window.", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "This is an optional field. End date for lease window.", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "This is a required field. AR formula identifier.", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "This is an optional field. Month when special starts.", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "This is a required field. Rate amount.", + "example": "100.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "This is an optional field. Increment for percent base formula.", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "This is an optional field. Additional formula information.", + "example": "0" + }, + "spaceConfigurationId": { + "type": "string", + "description": "This is an optional field. Space configuration identifier.", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "This is a required field. Display within Entrata.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "This is a required field. Display on website.", + "enum": [ + "0", + "1" + ], + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This node should accept the amenity id which needs to be updated" + }, + "name": { + "type": "string", + "format": "string", + "example": "property amenity", + "description": "This is a required field. This field accepts single value. This node should accept the amenity name." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test amenity", + "description": "This is an optional field. This field accepts single value. This node should accept the amenity description." + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isFeatured": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "showOnQuote": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node indicates if the amenities are visible on quotes or not. Th is flag is supported only for property and unit space amenities." + }, + "hideDescription": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "videoUrl": { + "type": "string", + "format": "string", + "example": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4", + "description": "This is an optional field. This field accepts single value." + }, + "defaultAmenityId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value." + }, + "amenityId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "specialGroup" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for updating specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "required": [ + "specialGroupId", + "specialGroupName" + ], + "properties": { + "specialGroupId": { + "type": "string", + "description": "Required. The ID of the special group to update", + "example": "55555" + }, + "specialGroupName": { + "type": "string", + "description": "Required. Name of the special group", + "example": "Test Update Special API" + }, + "internalDescription": { + "type": "string", + "description": "Optional. Internal description not visible to residents", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "Optional. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "Optional. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "Optional. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "Optional. Determines if special is eligible to be used", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "Optional. Determines if special will be shown in advertising", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "Optional. Date special will be advertised from", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "Optional. Date special will be advertised to", + "example": "MM/DD/YYYY" + }, + "hideEndDate": { + "type": "string", + "description": "Optional. Determines if special end date will be advertised", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "Optional. Description shown to residents", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "Optional. Terms and conditions for the specials", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "Optional. Determines if special is manual only", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "Optional. Start of move-in date range", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "Optional. End of move-in date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "Optional. Start of renewal date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "Optional. End of renewal date range", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "Optional. Allows setting limits on specials", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "Optional. Number of specials to be given", + "example": "12" + }, + "couponCode": { + "type": "string", + "description": "Optional. Promotional code for special", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "Optional. Source ID for promo code", + "example": "123456" + }, + "incentiveLimit": { + "type": "string", + "description": "Optional. Number of incentives resident can receive", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "Optional. If specials incentive count matches limit", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special group. otherwise do not pass this field.", + "example": 1 + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "leaseTermId": { + "type": "string", + "example": "55555" + }, + "leaseStartWindowId": { + "type": "string", + "example": "456789" + } + } + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "Optional. Comma-separated recipient IDs", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "Optional. Prospect trigger type ID", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "Optional. Renewal trigger type ID", + "example": "27" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "Optional. Comma-separated space configuration IDs", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "required": [ + "specialId", + "specialTypeId", + "specialName" + ], + "properties": { + "specialId": { + "type": "string", + "description": "Required. ID of the special", + "example": "1234567" + }, + "specialTypeId": { + "type": "string", + "description": "Required. Type ID of the special", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "Required. Name of the special", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "Optional. Value for gift type specials", + "example": "0.00" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special. otherwise do not pass this field.", + "example": 1 + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "arCodeId": { + "type": "string", + "description": "Optional. AR code identifier", + "example": "444444" + }, + "arTriggerId": { + "type": "string", + "description": "Optional. AR trigger identifier", + "example": "201" + }, + "arCodeTypeId": { + "type": "string", + "description": "Optional. AR code type identifier", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "Optional. Customer relationship identifier", + "example": "0" + }, + "leaseTermId": { + "type": "string", + "description": "Optional. Lease term identifier", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "Optional. Integer representation of lease term", + "example": "6" + }, + "leaseStartWindowId": { + "type": "string", + "description": "Optional. Lease start window identifier", + "example": "456789" + }, + "windowStartDate": { + "type": "string", + "description": "Optional. Start date for lease window", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "Optional. End date for lease window", + "example": "MM/DD/YYYY" + }, + "effectiveDate": { + "type": "string", + "description": "Optional. Date rate becomes effective", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "Optional. AR formula identifier", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "Optional. Month when special starts", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "Optional. Rate amount", + "example": "40.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "Optional. Increment for percent base formula", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "Optional. Additional formula information", + "example": "" + }, + "spaceConfigurationId": { + "type": "string", + "description": "Optional. Space configuration identifier", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "Optional. Display within Entrata", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "Optional. Display on website", + "enum": [ + "0", + "1" + ], + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + ] + } + }, + "examples": { + "getAmenities": { + "$ref": "#/components/examples/getAmenitiesRequest" + }, + "getMitsPropertyUnits": { + "$ref": "#/components/examples/getMitsPropertyUnitsRequest" + }, + "getPropertyUnits": { + "$ref": "#/components/examples/getPropertyUnitsRequest" + }, + "getSpecials_r1": { + "$ref": "#/components/examples/getSpecialsRequest_r1" + }, + "getSpecials_r2": { + "$ref": "#/components/examples/getSpecialsRequest_r2" + }, + "getSpecials_r3": { + "$ref": "#/components/examples/getSpecialsRequest_r3" + }, + "getSpecials_r4": { + "$ref": "#/components/examples/getSpecialsRequest_r4" + }, + "getUnitsAvailabilityAndPricing": { + "$ref": "#/components/examples/getUnitsAvailabilityAndPricingRequest" + }, + "getUnitTypes": { + "$ref": "#/components/examples/getUnitTypesRequest" + }, + "sendAmenities": { + "$ref": "#/components/examples/sendAmenitiesRequest" + }, + "sendPropertyUnits": { + "$ref": "#/components/examples/sendPropertyUnitsRequest" + }, + "sendSpecialGroup": { + "$ref": "#/components/examples/sendSpecialGroupRequest" + }, + "updateAmenities": { + "$ref": "#/components/examples/updateAmenitiesRequest" + }, + "updateSpecialGroup": { + "$ref": "#/components/examples/updateSpecialGroupRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/PropertyUnitsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 221, + "x-moar-complexity-skipped": false + } + }, + "/{orgs}/v1/vendors": { + "post": { + "tags": [ + "vendors" + ], + "summary": "Vendors related APIs", + "description": "## Note: \n **Pagination supported APIs**: `getInvoices(r2)`, `getPoReceivingRecords`, `getPurchaseOrders`.\n", + "parameters": [ + { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "format": "integer", + "example": "12345,4564", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "invoiceNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "paidInvoiceFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date." + }, + "paidInvoiceToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeVoidedPayments": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1" + }, + "includeExported": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "customerRefunds": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "format": "integer", + "example": "12345,4564", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "invoiceNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorIds": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice." + }, + "paidInvoiceFromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or after the given date." + }, + "paidInvoiceToDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "includeVoidedPayments": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1" + }, + "voidedPaymentFromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "voidedPaymentToDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "includeExported": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "customerRefunds": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "invoiceTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPoReceivingRecords" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. If \"vendorId\" is provided then \"vendorCode\" and \"purchaseOrderNumbers\" are not required." + }, + "vendorCode": { + "type": "string", + "format": "string", + "example": 12345, + "description": " This is an optional field. This field accepts single value. If \"vendorCode\" is provided then \"vendorId\" and \"purchaseOrderNumbers\" are not required." + }, + "purchaseOrderNumbers": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts comma seperated multiple values. If \"purchaseOrderNumbers\" is provided then \"vendorId\" and \"vendorCode\" are not required." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "poFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year" + }, + "poToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year" + }, + "receivedFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year" + }, + "receivedToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year" + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorCode": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "poNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "poNumbers": { + "type": "integer", + "format": "integer", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "receivedFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "receivedToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "poStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "poTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "purchaseOrderApprovalTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTaxFormData" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "generateForPropertyOwner": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then payer will render property info & If provided as \"1\" then Payer node will render the property owners info" + }, + "ownerIds": { + "type": "string", + "format": "string", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "isForIndirectOwner": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided false, it will return data only for direct owners. If prov ided true, it will return data for both direct & indirect owners." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorLocations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,56334", + "description": "This is an optional field. This field accepts comma seperated multiple values. List of comma separated propertyIds" + }, + "showAllStatus": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Boolean parameter to retrieve all vendors irrespective of status." + }, + "includeIntercompanyVendors": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then \"Standard\" types of Vendors will be rendered a nd if provided as \"1\" then \"Standard\" and \"Intercompany\" types of Vend ors will be returned." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorId" + }, + "vendorName": { + "type": "string", + "format": "string", + "example": "Vendor_Name", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorName" + }, + "vendorCode": { + "type": "string", + "format": "string", + "example": "123456", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorCode" + }, + "lastModifiedOn": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. Returns results based on the LastModifiedOn date of the vendor or any of its locations, contacts, remittances or legal entities." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorIds": { + "type": "integer", + "format": "integer", + "example": "12345,56334", + "description": "This is an optional field. This field accepts comma seperated multiple values. Once passing this parameter web service will return Vendor details for those Vendor Ids. Conditional mandatory, If vendorIds are provided t hen vendorsCodes is not required." + }, + "vendorCodes": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Conditional mandatory, If \"vendorsCodes\" are provided then \"vendorIds \" are not required." + } + } + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markInvoicesExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "lineItemId": { + "type": "integer", + "format": "integer", + "example": "17,18,19", + "description": "This is a required field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "lineItemId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ApPayeeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Id of a vendor who generated the invoice." + }, + "ApPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Location Id of a vendor who generated the invoice." + }, + "InvoiceTotal": { + "type": "integer", + "format": "float", + "example": 2000, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Total amount of invoice." + }, + "InvoiceNumber": { + "type": "string", + "format": "string", + "example": "TESTINVOICE123", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice Number." + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice date. Must be of format MM/DD/YYYY." + }, + "IsConsolidated": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApHeader." + }, + "IsOnHold": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApHeader." + }, + "PropertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "GlAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "Description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "Quantity": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "Rate": { + "type": "integer", + "format": "float", + "example": 400, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "IsWaive1099": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "FileData": { + "type": "string", + "format": "string", + "example": "FileData", + "description": "This is an optional field. This field accepts single value. Child element of File. Base64 encoded file data." + }, + "Note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is an optional field. This field accepts single value." + }, + "DueDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "IsPaused": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApBatch." + }, + "InvoiceImageUrl": { + "type": "string", + "format": "string", + "example": "https://InvoiceImageUrl", + "description": "This is an optional field. This field accepts single value. InvoiceImageUrl accepts valid URL only." + }, + "IsPosted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. IsPosted allows inserting posted invoices." + }, + "PropertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 17672, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "PropertyUnitId": { + "type": "integer", + "format": "integer", + "example": 3981490, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + } + }, + "required": [ + "ApPayeeId", + "ApPayeeLocationId", + "InvoiceTotal", + "InvoiceDate", + "PropertyId", + "GlAccountId", + "Description", + "Rate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "invoiceTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Supports 1=\"Standard\", 8 = \"Catalog\" and 17 = \"Standard-Job/Contract\" types. By default type \"Standard\" is inserted." + }, + "apPayeeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Id of a vendor who generated the invoice." + }, + "apPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor who generated the invoice." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader. This is conditionally required, depends upo n the \"Require Routing Tags on Invoices\" setting." + }, + "invoiceNumber": { + "type": "string", + "format": "string", + "example": "TESTINVOICE123", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice Number." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/YYYY format." + }, + "invoiceDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice date. Must be of format MM/DD/YYYY." + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/DD/YYYY format." + }, + "shipping": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount." + }, + "discount": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the discount amount." + }, + "salesTax": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice." + }, + "invoiceTotal": { + "type": "integer", + "format": "float", + "example": 2000, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Total amount of invoice." + }, + "note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": " This is an optional field. This field accepts single value. This field will be used to specify the additional details of the invoice." + }, + "invoiceImageUrl": { + "type": "string", + "format": "string", + "example": "Invoice Image URL", + "description": "This is an optional field. This field accepts single value. If this node is provided, it should be a valid URL." + }, + "isConsolidated": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only." + }, + "isOnHold": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only." + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is a required field. This field accepts single value. Child element of apDetail." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 17672, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 3981490, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "quantity": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "rate": { + "type": "integer", + "format": "float", + "example": 40, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "unitOfMeasureId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Only valid for Catalog type invoices." + }, + "isWaive1099": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Accepts \"0\" or \"1\" Only." + }, + "poDetailId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. This node accepts \"Line Item Id\" of Purchase Order." + }, + "receivingRecordId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. Conditional Required(Node is mandatory only if the poDetailId value is provided in request). This node accepts \"Receiving Record Id\" of Purc hase Order Line Item for the \"Catalog\" type." + }, + "invoicePaymentId": { + "type": "string", + "format": "string", + "example": "1234", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 400, + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under apDetail." + }, + "fileData": { + "type": "string", + "format": "string", + "example": "FileData", + "description": "This is an optional field. This field accepts single value. Child element of file. Base64 encoded file data." + }, + "isPaused": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apBatch. Accepts \"0\" or \"1\" Only." + }, + "isPosted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node specifies whether the invoice is posted or unposted. Accepts \"0\" or \"1\" Only." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "paymentNumber_001", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments." + }, + "paymentDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments. Must be of for mat MM/DD/YYYY." + }, + "paymentMemo": { + "type": "string", + "format": "string", + "example": "paymentMemo01", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments." + }, + "customTagId": { + "type": "integer", + "format": "integer", + "example": 180, + "description": "This is an optional field. This field accepts single value. This node accepts custom Tag Id of the invoice. If customTagId is not provided, then PO`s custom Tag Id would gets associates to invoice thr ough poDetailId node" + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType" + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType" + } + }, + "required": [ + "apPayeeId", + "apPayeeLocationId", + "invoiceNumber", + "invoiceDate", + "invoiceTotal", + "propertyId", + "glAccountId", + "description", + "rate", + "apCodeId", + "apContractId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "poTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively)." + }, + "apPayeeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively)." + }, + "apPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor." + }, + "apPayeeAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader. If not passed in the request, the system d efault account will be used." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts date in MM/YYYY format." + }, + "postDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of apHeader." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader." + }, + "headerMemo": { + "type": "string", + "format": "string", + "example": "header memo", + "description": "This is an optional field. This field accepts single value. Child element of apHeader." + }, + "shipping": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount." + }, + "discount": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the discount amount." + }, + "salesTax": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail.This is required if po type is standard." + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing." + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing." + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails." + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "quantity": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "rate": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "glDimensionId": { + "type": "integer", + "format": "integer", + "example": 384, + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Custom Tags." + }, + "companyDepartmentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "isConfidential": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only." + }, + "isTaxable": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "poTypeId", + "apPayeeId", + "apPayeeLocationId", + "postMonth", + "postDate", + "propertyId", + "quantity", + "rate" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "businessName": { + "type": "string", + "format": "string", + "example": "Vendor name", + "description": "This is a required field. This field accepts single value." + }, + "nameOnTaxReturn": { + "type": "string", + "format": "string", + "example": "Legal entity name", + "description": "This is a required field. This field accepts single value." + }, + "remittanceName": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "apPaymentTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "nameOnAccount": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)" + }, + "routingNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck). Must be numeric wi th 9 digits long." + }, + "accountNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)" + }, + "contact": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "First name", + "description": "This is a required field. This field accepts single value." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "last name", + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. Accepts the location name" + }, + "isPrimary": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "utilityBillReceiptTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value" + }, + "externalId": { + "type": "string", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID", + "description": "This is a required field. This field accepts single value. externalId" + } + }, + "required": [ + "businessName", + "nameOnTaxReturn", + "remittanceName", + "apPaymentTypeId", + "nameOnAccount", + "routingNumber", + "accountNumber", + "contact", + "firstName", + "lastName", + "name", + "isPrimary", + "externalId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Accepts apHeader id,apDetail id" + }, + "invoicePaymentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 100, + "description": "This is a required field. This field accepts single value." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "65565", + "description": "This is a required field. This field accepts single value." + }, + "paymentDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "isOnHold": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Update an invoice that is on hold, and take it off hold, and vice vers a, Allowed values ( 0, 1 )" + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Update the routing tag on an invoice, to another valid routing tag. Al low for not posted and off hold invoice." + } + }, + "required": [ + "id", + "invoicePaymentId", + "paymentAmount", + "paymentTypeId", + "paymentNumber", + "paymentDate", + "postMonth" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "nameOnTaxReturn": { + "type": "string", + "format": "string", + "example": "Legal entity name", + "description": "This is a required field. This field accepts single value" + }, + "name": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. Accepts locations name." + }, + "legalEntityName": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. required if new location is inserted" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. attribute compliance_status_id is required to make the property compli ant/non compliant, Accept integer value 2( for non-compliant) or 5 (fo r compliant) only." + }, + "remittanceName": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "nameOnAccount": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "routingNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "accountNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "externalId": { + "type": "string", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID", + "description": "This is a required field. This field accepts single value. externalId" + }, + "defaultRoutingTagId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "vendorId", + "nameOnTaxReturn", + "name", + "legalEntityName", + "propertyId", + "remittanceName", + "nameOnAccount", + "routingNumber", + "accountNumber", + "externalId" + ] + } + } + } + } + }, + { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "voidApPayments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "paymentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentNumber, paymentBankAccountId, paymenttypeId, paymentAmount are not provided." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "123456", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentId is no t provided then this node is required." + }, + "paymentBankAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 100, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "voidDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Supported date format: MM/DD/YYY, M/D/YYYY, YYYY-MM-DD." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Supported Format: MM/YYYY" + }, + "note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is a required field. This field accepts single value. Memo for the payment" + } + }, + "required": [ + "voidDate", + "postMonth", + "note" + ] + } + } + } + } + } + ] + } + }, + "examples": { + "getInvoices_r1": { + "$ref": "#/components/examples/getInvoicesRequest_r1" + }, + "getInvoices_r2": { + "$ref": "#/components/examples/getInvoicesRequest_r2" + }, + "getPoReceivingRecords": { + "$ref": "#/components/examples/getPoReceivingRecordsRequest" + }, + "getPurchaseOrders": { + "$ref": "#/components/examples/getPurchaseOrdersRequest" + }, + "getTaxFormData": { + "$ref": "#/components/examples/getTaxFormDataRequest" + }, + "getVendorLocations": { + "$ref": "#/components/examples/getVendorLocationsRequest" + }, + "getVendorPickLists": { + "$ref": "#/components/examples/getVendorPickListsRequest" + }, + "getVendors": { + "$ref": "#/components/examples/getVendorsRequest" + }, + "markInvoicesExported": { + "$ref": "#/components/examples/markInvoicesExportedRequest" + }, + "sendInvoices_r1": { + "$ref": "#/components/examples/sendInvoicesRequest_r1" + }, + "sendInvoices_r2": { + "$ref": "#/components/examples/sendInvoicesRequest_r2" + }, + "sendPurchaseOrders": { + "$ref": "#/components/examples/sendPurchaseOrdersRequest" + }, + "sendVendors": { + "$ref": "#/components/examples/sendVendorsRequest" + }, + "updateInvoices": { + "$ref": "#/components/examples/updateInvoicesRequest" + }, + "updateVendors": { + "$ref": "#/components/examples/updateVendorsRequest" + }, + "voidApPayments": { + "$ref": "#/components/examples/voidApPaymentsRequest" + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/VendorsSuccess" + }, + "400": { + "$ref": "#/components/responses/GeneralFailure" + } + }, + "x-moar-primitive-count": 255, + "x-moar-complexity-skipped": false + } + } + }, + "components": { + "schemas": { + "requestBody": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1", + "r2", + "r3" + ] + }, + "params": { + "type": "object", + "description": "the service request parameters if any. Replace dummy values from examples with actual values." + } + } + } + } + }, + "getStatusSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "an arbitary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "example": 200 + }, + "result": { + "required": [ + "status", + "message" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "example": "Success" + }, + "message": { + "type": "string", + "example": "Api is available and running." + } + } + } + } + } + } + }, + "getCompanyApplicationsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "12345" + }, + "code": { + "type": "integer", + "description": "Successful response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "companyApplications" + ], + "properties": { + "companyApplications": { + "type": "object", + "required": [ + "companyApplication" + ], + "properties": { + "companyApplication": { + "type": "array", + "items": { + "type": "object", + "required": [ + "companyApplicationId", + "companyApplicationName", + "applicationQuestions" + ], + "properties": { + "companyApplicationId": { + "type": "string", + "description": "The unique identifier for the company application.", + "example": "app123" + }, + "companyApplicationName": { + "type": "string", + "description": "The name of the company application.", + "example": "Policy Documents" + }, + "applicationQuestions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "applicationQuestion" + ], + "properties": { + "applicationQuestion": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "question" + ], + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier for the application question.", + "example": 1 + }, + "question": { + "type": "string", + "description": "The application question text.", + "example": "Have you ever been sued for rent?" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendApplicantGeneralDetailsSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "req98765" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "array", + "items": { + "type": "object", + "required": [ + "status", + "message", + "applicantId" + ], + "properties": { + "status": { + "type": "string", + "description": "The status of the response.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the general details were updated successfully.", + "example": "General details updated successfully" + }, + "applicantId": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "20456006" + } + } + } + } + } + } + } + }, + "sendApplicationSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "req12345" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "required": [ + "status", + "message", + "applicantId" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the response.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "A message indicating the application was inserted successfully.", + "example": "Application inserted successfully." + }, + "applicantId": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "17889726" + }, + "applicantIds": { + "type": "string", + "description": "A comma-separated list of applicant IDs.", + "example": "20238176, 20238177" + } + } + } + } + } + } + }, + "sendApplicationAddOnsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "addOns" + ], + "properties": { + "addOns": { + "type": "object", + "required": [ + "addOn" + ], + "properties": { + "addOn": { + "type": "array", + "items": { + "type": "object", + "required": [ + "status", + "message", + "id", + "addOnId", + "node" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the add-on.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message related to the add-on.", + "example": "Addons saved successfully." + }, + "id": { + "type": "integer", + "description": "ID of the add-on.", + "example": 1304385 + }, + "addOnId": { + "type": "string", + "description": "Unique identifier for the add-on.", + "example": "7162511" + }, + "node": { + "type": "integer", + "description": "Node number associated with the add-on.", + "example": 1 + } + } + } + } + } + } + } + } + } + } + } + }, + "sendApplicationEmployersSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "employers" + ], + "properties": { + "employers": { + "type": "object", + "required": [ + "employers" + ], + "properties": { + "employers": { + "type": "array", + "items": { + "type": "object", + "required": [ + "status", + "message", + "id", + "customerId", + "incomeTypeId", + "node" + ], + "properties": { + "status": { + "type": "string", + "description": "Success", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Customer employers saved successfully.", + "example": "Customer employers saved successfully." + }, + "id": { + "type": "integer", + "description": "Employer ID.", + "example": 2042046 + }, + "customerId": { + "type": "integer", + "description": "Customer ID.", + "example": 6959803 + }, + "incomeTypeId": { + "type": "integer", + "description": "Income type ID.", + "example": 4 + }, + "node": { + "type": "integer", + "description": "Node number.", + "example": 1 + } + } + } + } + } + } + } + } + } + } + } + }, + "sendApplicationPetsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "pets" + ], + "properties": { + "pets": { + "type": "object", + "required": [ + "pet" + ], + "properties": { + "pet": { + "type": "array", + "items": { + "type": "object", + "required": [ + "status", + "message", + "id", + "customerId", + "typeId", + "node" + ], + "properties": { + "status": { + "type": "string", + "description": "Success", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Customer pets saved successfully.", + "example": "Customer pets saved successfully." + }, + "id": { + "type": "integer", + "description": "Pet ID.", + "example": 205354 + }, + "customerId": { + "type": "integer", + "description": "Customer ID.", + "example": 31674581 + }, + "typeId": { + "type": "integer", + "description": "Type ID.", + "example": 15288 + }, + "node": { + "type": "integer", + "description": "Node number.", + "example": 1 + } + } + } + } + } + } + } + } + } + } + } + }, + "sendApplicationVehiclesSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "vehicles" + ], + "properties": { + "vehicles": { + "type": "object", + "required": [ + "vehicle" + ], + "properties": { + "vehicle": { + "type": "array", + "items": { + "type": "object", + "required": [ + "status", + "message", + "id", + "customerId", + "vehicleTypeId", + "node" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the vehicle operation.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the vehicle operation result.", + "example": "Vehicle saved successfully." + }, + "id": { + "type": "integer", + "description": "Vehicle ID.", + "example": 56853778 + }, + "customerId": { + "type": "integer", + "description": "Customer ID.", + "example": 28138538 + }, + "vehicleTypeId": { + "type": "integer", + "description": "Type ID of the vehicle.", + "example": 2 + }, + "node": { + "type": "integer", + "description": "Node number associated with the vehicle.", + "example": 1 + } + } + } + } + } + } + } + } + } + } + } + }, + "updateApplicationSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "application" + ], + "properties": { + "application": { + "type": "object", + "required": [ + "status", + "message", + "applicationId", + "applicantIds" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the application.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the application update result.", + "example": "Application updated successfully." + }, + "applicationId": { + "type": "integer", + "description": "Unique ID of the application.", + "example": 123456 + }, + "applicantIds": { + "type": "string", + "description": "Comma-separated list of applicant IDs.", + "example": "7893,7894" + } + } + } + } + } + } + } + } + }, + "getAccessibleClientsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The ID of the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "The status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result of the request", + "required": [ + "orgs" + ], + "properties": { + "orgs": { + "type": "array", + "description": "List of organizations", + "items": { + "type": "object", + "required": [ + "subdomain", + "id", + "name" + ], + "properties": { + "subdomain": { + "type": "string", + "description": "The subdomain of the organization", + "example": "demoold" + }, + "id": { + "type": "integer", + "description": "The unique identifier of the organization", + "example": "235" + }, + "name": { + "type": "string", + "description": "The name of the organization", + "example": "Demo Account" + } + } + } + } + } + } + } + }, + "getAccessibleServicesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The ID of the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "The status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result of the request", + "required": [ + "services" + ], + "properties": { + "services": { + "type": "array", + "description": "List of services available", + "items": { + "type": "object", + "required": [ + "uri", + "service" + ], + "properties": { + "uri": { + "type": "string", + "description": "The URI endpoint for the service", + "example": "/ext/orgs/demoold/v1/customers" + }, + "service": { + "type": "string", + "description": "The name of the service", + "example": "updateCustomers" + } + } + } + } + } + } + } + }, + "getArCodesSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "arcodes" + ], + "properties": { + "arcodes": { + "type": "object", + "required": [ + "arcode" + ], + "properties": { + "arcode": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the AR code.", + "example": 1 + }, + "code": { + "type": "integer", + "description": "The AR code value.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the AR code.", + "example": "Amber test" + }, + "codeType": { + "type": "string", + "description": "The type of the AR code.", + "example": "Other Income" + }, + "chargeUsage": { + "type": "string", + "description": "The usage of the charge.", + "example": "Special" + }, + "chargeTiming": { + "type": "string", + "description": "The timing of the charge.", + "example": "Month To Month Begin" + }, + "associatedLedger": { + "type": "string", + "description": "The associated ledger for the AR code.", + "example": "Resident" + }, + "debitGlAccountId": { + "type": "integer", + "description": "The debit GL account ID.", + "example": 87017 + }, + "creditGlAccountId": { + "type": "integer", + "description": "The credit GL account ID.", + "example": 87035 + }, + "displayAs": { + "type": "string", + "description": "The display name for the AR code.", + "example": "test1" + }, + "isDisabled": { + "type": "boolean", + "description": "Whether the AR code is disabled.", + "example": false + }, + "isEntrataDisabled": { + "type": "boolean", + "description": "Whether the AR code is disabled in Entrata.", + "example": false + }, + "isTaxable": { + "type": "boolean", + "description": "Whether the AR code is taxable.", + "example": false + } + } + } + } + } + } + } + } + } + } + } + }, + "getArPaymentsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "ArPayments" + ], + "properties": { + "ArPayments": { + "type": "object", + "required": [ + "ArPayment" + ], + "properties": { + "ArPayment": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "ArAllocations" + ], + "properties": { + "ArPaymentId": { + "type": "integer", + "description": "The ID of the AR payment.", + "example": 22330996 + }, + "PropertyName": { + "type": "string", + "description": "The name of the property associated with the payment.", + "example": "Park Avenue I" + }, + "CustomerId": { + "type": "integer", + "description": "The ID of the customer making the payment.", + "example": 12345 + }, + "CustomerFirstName": { + "type": "string", + "description": "The first name of the customer.", + "example": "Dave" + }, + "CustomerLastName": { + "type": "string", + "description": "The last name of the customer.", + "example": "Robinson" + }, + "UnitNumber": { + "type": "integer", + "description": "The unit number associated with the property.", + "example": 111 + }, + "EmailAddress": { + "type": "string", + "description": "The email address of the customer.", + "example": "dummy@example.com" + }, + "PaymentAmount": { + "type": "integer", + "description": "The amount of the payment.", + "example": 500 + }, + "PaymentDate": { + "type": "string", + "description": "The date when the payment was made.", + "example": "01/08/2013 00:00" + }, + "PaymentType": { + "type": "string", + "description": "The method of payment used.", + "example": "Cash" + }, + "PaymentStatus": { + "type": "string", + "description": "The status of the payment.", + "example": "Received" + }, + "ExternalId": { + "type": "string", + "description": "Customer's secondary number/external identifier.", + "example": "EXT-12345" + }, + "StreetLine1": { + "type": "string", + "description": "First line of billing street address.", + "example": "123 Main Street" + }, + "StreetLine2": { + "type": "string", + "description": "Second line of billing street address.", + "example": "Apt 4B" + }, + "StreetLine3": { + "type": "string", + "description": "Third line of billing street address.", + "example": "Building A" + }, + "City": { + "type": "string", + "description": "Billing city.", + "example": "New York" + }, + "StateCode": { + "type": "string", + "description": "Billing state code.", + "example": "NY" + }, + "PostalCode": { + "type": "string", + "description": "Billing postal/zip code.", + "example": "10001" + }, + "PhoneNumber": { + "type": "string", + "description": "Customer's phone number (processed to remove country code).", + "example": "5551234567" + }, + "CurrencyCode": { + "type": "string", + "description": "Currency code for the payment based on property.", + "example": "USD" + }, + "CapturedOn": { + "type": "string", + "description": "Date/time when payment was captured (truncated to 16 characters).", + "example": "01/08/2013 09:30" + }, + "DistributeOn": { + "type": "string", + "description": "Date/time when payment was distributed (truncated to 16 characters).", + "example": "01/09/2013 10:15" + }, + "ReturnedOn": { + "type": "string", + "description": "Date/time when payment was returned (truncated to 16 characters).", + "example": "01/10/2013 14:20" + }, + "ArAllocations": { + "type": "object", + "required": [ + "ArAllocation" + ], + "properties": { + "ArAllocation": { + "type": "array", + "items": { + "type": "object", + "required": [ + "ArTransactionId" + ], + "properties": { + "ArTransactionId": { + "type": "integer", + "description": "The ID of the AR transaction.", + "example": 340302642 + }, + "ChargeCodeId": { + "type": "integer", + "description": "The ID of the charge code associated with the payment.", + "example": 155594 + }, + "ChargeCodeName": { + "type": "string", + "description": "The name of the charge code.", + "example": "11AR" + }, + "AllocationDateTime": { + "type": "string", + "description": "The date and time when the allocation was made.", + "example": "08/11/2021" + }, + "Amount": { + "type": "integer", + "description": "The amount allocated to this AR transaction.", + "example": 50 + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getArInvoicesSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary identifier used to trace or track the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "arInvoices" + ], + "properties": { + "arInvoices": { + "type": "object", + "required": [ + "arInvoice" + ], + "properties": { + "arInvoice": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "ArAllocations" + ], + "properties": { + "id": { + "type": "integer", + "description": "A unique identifier for the invoice.", + "example": 12345 + }, + "propertyId": { + "type": "integer", + "description": "The identifier for the property associated with the invoice.", + "example": 12345 + }, + "unitId": { + "type": "integer", + "description": "The identifier for the unit associated with the invoice.", + "example": 12345 + }, + "leaseId": { + "type": "integer", + "description": "The identifier for the lease associated with the invoice.", + "example": 12345 + }, + "invoiceNumber": { + "type": "integer", + "description": "The invoice number, used to identify the invoice in the system.", + "example": 118 + }, + "correctedArInvoiceId": { + "type": "integer", + "description": "The identifier for the invoice that this one corrects, if applicable.", + "example": 123 + }, + "invoiceDate": { + "type": "string", + "description": "The date the invoice was issued.", + "example": "2020-02-16" + }, + "invoiceDueDate": { + "type": "string", + "description": "The date the payment for the invoice is due.", + "example": "2020-04-03" + }, + "customerId": { + "type": "string", + "description": "The unique identifier for the customer associated with the invoice.", + "example": "29529791" + }, + "customerName": { + "type": "string", + "description": "The name of the customer associated with the invoice.", + "example": "1400 Willow Council Of Co-Owners" + }, + "streetLine1": { + "type": "string", + "description": "The first line of the customer's address.", + "example": "street 1" + }, + "streetLine2": { + "type": "string", + "description": "The second line of the customer's address.", + "example": "street 2" + }, + "streetLine3": { + "type": "string", + "description": "The third line of the customer's address.", + "example": "street 3" + }, + "city": { + "type": "string", + "description": "The city where the customer resides.", + "example": "FL" + }, + "state": { + "type": "string", + "description": "The state where the customer resides.", + "example": "Florida" + }, + "postalCode": { + "type": "string", + "description": "The postal code for the customer's address.", + "example": "45677" + }, + "country": { + "type": "string", + "description": "The country of the customer.", + "example": "US" + }, + "note": { + "type": "string", + "description": "Any additional notes related to the invoice.", + "example": "note" + }, + "invoiceType": { + "type": "string", + "description": "The type of invoice (e.g., Standard, Correction).", + "example": "Standard" + }, + "invoiceSubTotal": { + "type": "string", + "description": "The total before tax is applied to the invoice.", + "example": "1099" + }, + "totalTaxAmount": { + "type": "integer", + "description": "The total tax applied to the invoice.", + "example": 44 + }, + "arTransactions": { + "type": "object", + "required": [ + "arTransaction" + ], + "properties": { + "arTransaction": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the AR transaction.", + "example": 12345 + }, + "arCodeId": { + "type": "integer", + "description": "The identifier for the AR code associated with the transaction.", + "example": 215681 + }, + "arCodeName": { + "type": "string", + "description": "The name of the AR code associated with the transaction.", + "example": "00Rent0308" + }, + "baseAmount": { + "type": "integer", + "description": "The base amount for the transaction before taxes.", + "example": 95 + }, + "taxRate": { + "type": "integer", + "description": "The tax rate applied to the transaction.", + "example": 10 + }, + "taxAmount": { + "type": "integer", + "description": "The tax amount for the transaction.", + "example": 850 + }, + "dueDate": { + "type": "string", + "description": "The date by which the transaction is due.", + "example": "2020-10-01" + }, + "fromDate": { + "type": "string", + "description": "The start date of the transaction period.", + "example": "2020-10-01" + }, + "toDate": { + "type": "string", + "description": "The end date of the transaction period.", + "example": "2020-10-01" + }, + "arPayments": { + "type": "object", + "required": [ + "arPayment" + ], + "properties": { + "arPayment": { + "type": "array", + "items": { + "type": "object", + "required": [ + "arPaymentId" + ], + "properties": { + "arPaymentId": { + "type": "integer", + "description": "The unique identifier for the payment related to this transaction.", + "example": 12345 + }, + "PaymentAmount": { + "type": "integer", + "description": "The total amount paid for the transaction.", + "example": 120 + }, + "PaymentDate": { + "type": "string", + "description": "The date the payment was made.", + "example": "2020-04-23" + }, + "PaymentTypeId": { + "type": "integer", + "description": "The identifier for the type of payment made.", + "example": 2 + }, + "PaymentTypeName": { + "type": "string", + "description": "The name of the payment method used.", + "example": "Check" + }, + "PaymentStatusTypeId": { + "type": "integer", + "description": "The identifier for the status of the payment.", + "example": 2 + }, + "PaymentStatusTypeName": { + "type": "string", + "description": "The name of the payment status.", + "example": "Received" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeaseArTransactionsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary identifier used to trace or track the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leases" + ], + "properties": { + "leases": { + "type": "object", + "required": [ + "lease" + ], + "properties": { + "lease": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the lease.", + "example": 14803775 + }, + "propertyId": { + "type": "integer", + "description": "The identifier for the property associated with the lease.", + "example": 172775 + }, + "unitSpaceId": { + "type": "integer", + "description": "The identifier for the unit space associated with the lease.", + "example": 5068340 + }, + "customers": { + "type": "object", + "required": [ + "customer", + "ledgers" + ], + "properties": { + "customer": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the customer associated with the lease.", + "example": 31094026 + }, + "firstName": { + "type": "string", + "description": "The first name of the customer.", + "example": "Alfred" + }, + "lastName": { + "type": "string", + "description": "The last name of the customer.", + "example": "Burge" + }, + "isActiveBankruptcy": { + "type": "boolean", + "description": "The Bankruptcy status of customer .", + "example": 1 + }, + "bankruptcyDate": { + "type": "string", + "description": "The Bankruptcy date of customer.", + "example": "08/22/2025" + }, + "bankruptcyNote": { + "type": "string", + "description": "XYZ" + } + } + }, + "ledgers": { + "type": "object", + "required": [ + "ledger" + ], + "properties": { + "ledger": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the ledger.", + "example": 11 + }, + "name": { + "type": "string", + "description": "The name of the ledger associated with the lease.", + "example": "Resident" + }, + "balance": { + "type": "integer", + "description": "The current balance of the ledger.", + "example": -924 + }, + "pastDueBalance": { + "type": "integer", + "description": "The overdue balance of the ledger.", + "example": -924 + }, + "writeOff": { + "type": "integer", + "description": "The amount that has been written off from the ledger.", + "example": 0 + }, + "transactions": { + "type": "object", + "required": [ + "transaction" + ], + "properties": { + "transaction": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the transaction.", + "example": 11 + }, + "transactionTypeId": { + "type": "integer", + "description": "The identifier for the type of transaction.", + "example": 1 + }, + "arCodeId": { + "type": "integer", + "description": "The identifier for the AR code associated with the transaction.", + "example": 1848 + }, + "arCodeName": { + "type": "string", + "description": "The name of the AR code associated with the transaction.", + "example": "-Payment" + }, + "leaseIntervalId": { + "type": "integer", + "description": "The identifier for the lease interval associated with the transaction.", + "example": 22033341 + }, + "description": { + "type": "string", + "description": "Additional details about the transaction.", + "example": "[]" + }, + "transactionDate": { + "type": "string", + "description": "The date the transaction took place.", + "example": "08/28/2020" + }, + "postDate": { + "type": "string", + "description": "The date the transaction was posted.", + "example": "08/28/2020" + }, + "postMonth": { + "type": "string", + "description": "The month the transaction was posted.", + "example": "09/01/2020" + }, + "isTemporary": { + "type": "boolean", + "description": "Indicates whether the transaction is temporary.", + "example": true + }, + "balanceDue": { + "type": "integer", + "description": "The remaining balance due on the transaction.", + "example": -12 + }, + "amount": { + "type": "integer", + "description": "The amount involved in the transaction.", + "example": -12 + }, + "amountPaid": { + "type": "integer", + "description": "The amount already paid toward the transaction.", + "example": 0 + }, + "scheduledChargeId": { + "type": "integer", + "description": "The identifier for the scheduled charge associated with the transaction.", + "example": 4202932 + }, + "creditArTransactionIds": { + "type": "string", + "description": "A list of credit AR transaction IDs associated with the transaction.", + "example": "340292930,340302015" + }, + "arPaymentId": { + "type": "integer", + "description": "The identifier for the payment related to the transaction.", + "example": 123456789 + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getMitsLeaseArTransactionsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "required": [ + "ResidentTransactions" + ], + "properties": { + "ResidentTransactions": { + "type": "object", + "required": [ + "Property", + "RT_Customer", + "Unit", + "RTServiceTransactions" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "PropertyID", + "MarketingName" + ], + "properties": { + "PropertyID": { + "type": "object", + "required": [ + "Identification" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Property ID", + "example": "Property123" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Property ID value", + "example": 12345 + } + } + } + } + }, + "MarketingName": { + "type": "string", + "description": "Marketing name of the property", + "example": "Green Acres" + } + } + }, + "RT_Customer": { + "type": "object", + "required": [ + "Identification", + "Customers" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Lease ID", + "example": "LeaseID123" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Customer's Lease ID", + "example": 98765 + } + } + }, + "Customers": { + "type": "object", + "required": [ + "Customer" + ], + "properties": { + "Customer": { + "type": "object", + "required": [ + "Identification", + "Name" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Customer ID", + "example": "CustID123" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Customer's ID", + "example": 56789 + } + } + }, + "Name": { + "type": "object", + "required": [ + "FirstName", + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "Customer's first name", + "example": "John" + }, + "LastName": { + "type": "string", + "description": "Customer's last name", + "example": "Doe" + } + } + } + } + } + } + } + } + }, + "Unit": { + "type": "object", + "required": [ + "Identification", + "MarketingName" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Unit ID", + "example": "UnitID123" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Unit ID value", + "example": 23456 + } + } + }, + "MarketingName": { + "type": "string", + "description": "Unit marketing name", + "example": "Unit A-1" + } + } + }, + "RTServiceTransactions": { + "type": "object", + "required": [ + "Transactions" + ], + "properties": { + "Transactions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Charge" + ], + "properties": { + "Charge": { + "type": "object", + "required": [ + "Detail" + ], + "properties": { + "Detail": { + "type": "object", + "required": [ + "Description", + "TransactionDate", + "TransactionID", + "ChargeCode", + "BalanceDue", + "Amount" + ], + "properties": { + "Description": { + "type": "string", + "description": "Description of the charge", + "example": "Late fee" + }, + "TransactionDate": { + "type": "string", + "description": "Transaction date", + "example": "2024-12-19" + }, + "ServiceToDate": { + "type": "string", + "description": "Service to date", + "example": "2024-12-19" + }, + "TransactionID": { + "type": "integer", + "description": "Transaction ID", + "example": 123456 + }, + "ChargeCode": { + "type": "string", + "description": "Charge code", + "example": "LATEFEE" + }, + "SupplementalID": { + "type": "object", + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Ar Code ID", + "example": "AR001" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Ar Code ID value", + "example": 123 + } + } + } + } + }, + "BalanceDue": { + "type": "string", + "description": "Balance due", + "example": "50.00" + }, + "Amount": { + "type": "string", + "description": "Charge amount", + "example": "50.00" + }, + "ReversalTranID": { + "type": "string", + "description": "Reversal transaction ID", + "example": "REV123" + } + } + } + } + }, + "Payment": { + "type": "object", + "required": [ + "@attributes", + "Detail" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "PaymentType": { + "type": "string", + "description": "Payment type (e.g., ACH)", + "example": "ACH" + } + } + }, + "Detail": { + "type": "object", + "required": [ + "Description", + "TransactionID", + "AmountPaid", + "BalanceDue" + ], + "properties": { + "Description": { + "type": "string", + "description": "Payment description", + "example": "Monthly payment" + }, + "TransactionID": { + "type": "integer", + "description": "Transaction ID", + "example": 654321 + }, + "AmountPaid": { + "type": "string", + "description": "Amount paid", + "example": "100.00" + }, + "BalanceDue": { + "type": "string", + "description": "Remaining balance due", + "example": "0.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendLeaseArTransactionReversalsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Transactions" + ], + "properties": { + "Transactions": { + "type": "object", + "required": [ + "Transaction" + ], + "properties": { + "Transaction": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "reference_id", + "transaction_id", + "status", + "message" + ], + "properties": { + "reference_id": { + "type": "string", + "description": "The reference identifier for the transaction", + "example": "123456" + }, + "transaction_id": { + "type": "string", + "description": "The transaction identifier", + "example": "123456" + }, + "status": { + "type": "string", + "description": "The status of the transaction", + "example": "success" + }, + "message": { + "type": "string", + "description": "Message associated with the transaction", + "example": "Transaction reversed successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendLeaseArTransactionsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Transactions" + ], + "properties": { + "Transactions": { + "type": "object", + "required": [ + "Transaction" + ], + "properties": { + "Transaction": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "reference_id", + "transaction_id", + "status", + "message" + ], + "properties": { + "reference_id": { + "type": "integer", + "description": "The reference identifier for the transaction", + "example": 79008 + }, + "transaction_id": { + "type": "string", + "description": "The transaction identifier", + "example": "100000" + }, + "status": { + "type": "string", + "description": "The status of the transaction", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message associated with the transaction", + "example": "Lease AR-Transaction inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getMarketingPreferencePickListSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "preferences", + "availabilityAlertFrequencies" + ], + "properties": { + "preferences": { + "type": "array", + "items": { + "type": "object", + "required": [ + "communicationChannel", + "recipientType", + "recipientTypeId", + "consentType", + "consentTypeId" + ], + "properties": { + "communicationChannel": { + "type": "string", + "description": "The communication channel used for notifications", + "example": "email" + }, + "recipientType": { + "type": "string", + "description": "The type of recipient (e.g., LEAD, RESIDENT)", + "example": "LEAD" + }, + "recipientTypeId": { + "type": "integer", + "description": "The identifier for the recipient type", + "example": 1 + }, + "consentType": { + "type": "string", + "description": "The type of consent for the communication", + "example": "Message Center Email" + }, + "consentTypeId": { + "type": "integer", + "description": "The identifier for the consent type", + "example": 1 + } + } + } + }, + "availabilityAlertFrequencies": { + "type": "array", + "items": { + "type": "object", + "required": [ + "frequencyId", + "frequencyName" + ], + "properties": { + "frequencyId": { + "type": "integer", + "description": "The identifier for the frequency of alerts", + "example": 5 + }, + "frequencyName": { + "type": "string", + "description": "The name of the frequency", + "example": "Monthly" + } + } + } + } + } + } + } + } + } + }, + "getMarketingPreferencesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code indicating the status of the request", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "customers" + ], + "properties": { + "customers": { + "type": "array", + "items": { + "type": "object", + "required": [ + "customerId", + "preferences" + ], + "properties": { + "customerId": { + "type": "integer", + "description": "The unique identifier for the customer", + "example": 29693427 + }, + "preferences": { + "type": "array", + "items": { + "type": "object", + "required": [ + "communicationChannel", + "recipientType", + "recipientTypeId", + "consentType", + "consentTypeId", + "optIn" + ], + "properties": { + "communicationChannel": { + "type": "string", + "description": "The communication channel used for notifications", + "example": "email" + }, + "recipientType": { + "type": "string", + "description": "The type of recipient (e.g., LEAD, RESIDENT)", + "example": "LEAD" + }, + "recipientTypeId": { + "type": "string", + "description": "The identifier for the recipient type", + "example": "1" + }, + "consentType": { + "type": "string", + "description": "The type of consent for the communication", + "example": "Contact Point Email" + }, + "consentTypeId": { + "type": "integer", + "description": "The identifier for the consent type", + "example": 9 + }, + "optIn": { + "type": "string", + "description": "Opt-in status for the communication (1 for opted-in, 0 for opted-out)", + "example": "1" + } + } + } + } + } + } + } + } + } + } + }, + "getCustomersSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response code indicating the status of the request", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "Customers" + ], + "properties": { + "Customers": { + "type": "object", + "required": [ + "Customer" + ], + "properties": { + "Customer": { + "type": "array", + "items": { + "type": "object", + "required": [ + "LeaseId", + "FirstName", + "LastName", + "UnitNumber", + "BuildingName", + "Address", + "City", + "State", + "PostalCode", + "Email", + "PhoneNumber", + "TermsApprovedDate", + "pointsEarned", + "Vehicles", + "CustomerIdentificationValues" + ], + "properties": { + "LeaseId": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "CustomerType" + ], + "properties": { + "Identification": { + "type": "array", + "items": { + "type": "object", + "required": [ + "IDValue", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "The ID value for the lease", + "example": "5424549" + }, + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "Type of ID", + "example": "Lease Id" + }, + "IDRank": { + "type": "string", + "description": "Rank of ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the ID", + "example": "sender" + }, + "Status": { + "type": "string", + "description": "Status of the lease", + "example": "Current" + } + } + } + } + } + }, + "CustomerType": { + "type": "string", + "description": "Type of the customer", + "example": "Primary" + } + } + } + }, + "FirstName": { + "type": "string", + "description": "The first name of the customer", + "example": "Amit" + }, + "LastName": { + "type": "string", + "description": "The last name of the customer", + "example": "Aryan" + }, + "UnitNumber": { + "type": "string", + "description": "The unit number of the customer", + "example": "71" + }, + "BuildingName": { + "type": "string", + "description": "The name of the building", + "example": "ZOM 3" + }, + "Address": { + "type": "string", + "description": "The primary address of the customer", + "example": "500 S 100 W" + }, + "City": { + "type": "string", + "description": "City where the customer resides", + "example": "Provo" + }, + "State": { + "type": "string", + "description": "State where the customer resides", + "example": "UT" + }, + "PostalCode": { + "type": "string", + "description": "Postal code for the customer address", + "example": "84601" + }, + "Email": { + "type": "string", + "description": "The email address of the customer", + "example": "amit@aryan.lcl" + }, + "PhoneNumber": { + "type": "string", + "description": "The phone number of the customer", + "example": "1234567890" + }, + "TermsApprovedDate": { + "type": "string", + "description": "The date when the terms were approved", + "example": "06/26/2012" + }, + "CustomerAddresses": { + "type": "object", + "required": [ + "CustomerAddress" + ], + "properties": { + "CustomerAddress": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Address", + "City", + "State", + "PostalCode", + "Country" + ], + "properties": { + "Address": { + "type": "string", + "description": "Forwarding address", + "example": "vcb" + }, + "City": { + "type": "string", + "description": "City of the forwarding address", + "example": "vcb" + }, + "State": { + "type": "string", + "description": "State of the forwarding address", + "example": "AK" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the forwarding address", + "example": "43534" + }, + "Country": { + "type": "string", + "description": "Country of the forwarding address", + "example": "US" + }, + "@attributes": { + "type": "object", + "properties": { + "AddressType": { + "type": "string", + "description": "Type of the address", + "example": "Forwarding" + } + } + } + } + } + } + } + }, + "pointsEarned": { + "type": "string", + "description": "The points earned by the customer", + "example": "11486" + }, + "Vehicles": { + "type": "object", + "required": [ + "Vehicle" + ], + "properties": { + "Vehicle": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Model", + "Color", + "Make", + "LicensePlateNumber", + "StateCode", + "Year" + ], + "properties": { + "Model": { + "type": "string", + "description": "The model of the vehicle", + "example": "aakash" + }, + "Color": { + "type": "string", + "description": "The color of the vehicle", + "example": "aakash" + }, + "Make": { + "type": "string", + "description": "The make of the vehicle", + "example": "aakash" + }, + "LicensePlateNumber": { + "type": "string", + "description": "The license plate number of the vehicle", + "example": "aakash" + }, + "StateCode": { + "type": "string", + "description": "State code where the vehicle is registered", + "example": "NB" + }, + "Year": { + "type": "string", + "description": "The manufacturing year of the vehicle", + "example": "1990" + } + } + } + } + } + }, + "CustomerIdentificationValues": { + "type": "object", + "required": [ + "CustomerIdentificationValue" + ], + "properties": { + "CustomerIdentificationValue": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Value", + "CompanyIdentificationTypeId" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identification number for the customer", + "example": 6789 + }, + "Value": { + "type": "string", + "description": "The value of the identification", + "example": "test123" + }, + "CompanyIdentificationTypeId": { + "type": "integer", + "description": "The ID representing the company identification type", + "example": 12345 + } + } + } + } + } + }, + "isActiveBankruptcy": { + "type": "boolean", + "description": "The Bankruptcy status of customer .", + "example": 1 + }, + "bankruptcyDate": { + "type": "string", + "description": "The Bankruptcy date of customer.", + "example": "08/22/2025" + }, + "bankruptcyNote": { + "type": "string", + "description": "XYZ" + }, + "@attributes": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the customer", + "example": "6526235" + }, + "ExternalId": { + "type": "string", + "description": "External identifier for the customer", + "example": "asdasdas" + } + } + } + } + } + } + } + } + } + } + } + }, + "getCustomerTestimonialsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "The unique identifier for the request", + "example": 15 + }, + "result": { + "type": "object", + "required": [ + "Testimonials" + ], + "properties": { + "Testimonials": { + "type": "object", + "required": [ + "Testimonial" + ], + "properties": { + "Testimonial": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name", + "Title", + "Testimonial", + "PropertyId", + "PropertyName", + "EmailAddress", + "TestimonialDatetime", + "TestimonialType", + "IsRecommended", + "ShowOnCorporateSites", + "VacancyPublished", + "ProspectPortalPublished", + "FirstName", + "LastName", + "TestimonialRatings" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the testimonial", + "example": "11111" + }, + "Name": { + "type": "string", + "description": "Name of the person providing the testimonial", + "example": "Testing Test" + }, + "Title": { + "type": "string", + "description": "Title of the testimonial", + "example": "well it is an awesome place to live in." + }, + "Testimonial": { + "type": "string", + "description": "The actual testimonial content", + "example": "I will recommend him to do not waste your opportunity and be here soon possible." + }, + "PropertyId": { + "type": "string", + "description": "The unique identifier for the property", + "example": "11111" + }, + "PropertyName": { + "type": "string", + "description": "The name of the property", + "example": "test company" + }, + "EmailAddress": { + "type": "string", + "description": "Email address of the person providing the testimonial", + "example": "04testing15_test.lcl@r3.com" + }, + "TestimonialDatetime": { + "type": "string", + "description": "Date and time when the testimonial was created", + "example": "06/03/2013 05:45:01.404402 MDT" + }, + "TestimonialType": { + "type": "string", + "description": "Type of testimonial", + "example": "APARTMENTRATINGS" + }, + "IsRecommended": { + "type": "string", + "description": "Whether the testimonial is a recommendation", + "example": "1" + }, + "ShowOnCorporateSites": { + "type": "string", + "description": "Whether the testimonial is shown on corporate sites", + "example": "0" + }, + "VacancyPublished": { + "type": "string", + "description": "Whether the vacancy is published", + "example": "0" + }, + "ProspectPortalPublished": { + "type": "string", + "description": "Whether the testimonial is published on the prospect portal", + "example": "1" + }, + "FirstName": { + "type": "string", + "description": "First name of the person providing the testimonial", + "example": "Testing" + }, + "LastName": { + "type": "string", + "description": "Last name of the person providing the testimonial", + "example": "Test" + }, + "TestimonialRatings": { + "type": "object", + "required": [ + "TestimonialRating" + ], + "properties": { + "TestimonialRating": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Type", + "Rating" + ], + "properties": { + "Type": { + "type": "string", + "description": "The type of the rating", + "example": "Overall" + }, + "Rating": { + "type": "string", + "description": "The rating score", + "example": "5" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getTestimonialPickListsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "TestimonialTypes", + "TestimonialRatingTypes" + ], + "properties": { + "TestimonialTypes": { + "type": "object", + "required": [ + "TestimonialType" + ], + "properties": { + "TestimonialType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the testimonial type", + "example": "5" + }, + "Name": { + "type": "string", + "description": "The name of the testimonial type", + "example": "ApartmentRatings" + } + } + } + } + } + } + } + }, + "TestimonialRatingTypes": { + "type": "object", + "required": [ + "TestimonialRatingType" + ], + "properties": { + "TestimonialRatingType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the testimonial rating type", + "example": "1" + }, + "Name": { + "type": "string", + "description": "The name of the testimonial rating type", + "example": "Parking" + } + } + } + } + } + } + } + } + } + } + } + }, + "searchCustomersSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "customers" + ], + "properties": { + "customers": { + "type": "object", + "required": [ + "customer" + ], + "properties": { + "customer": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "namePrefix", + "firstName", + "lastName", + "email", + "unitNumber", + "buildingName", + "address", + "city", + "state", + "postalCode" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the customer", + "example": "1234" + }, + "namePrefix": { + "type": "string", + "description": "The name prefix of the customer", + "example": "Mr." + }, + "firstName": { + "type": "string", + "description": "The first name of the customer", + "example": "Dave" + }, + "middleName": { + "type": "string", + "description": "The middle name of the customer", + "example": "Elisabeth" + }, + "lastName": { + "type": "string", + "description": "The last name of the customer", + "example": "Robinson" + }, + "email": { + "type": "string", + "description": "The email address of the customer", + "example": "dummy@example.com" + }, + "unitNumber": { + "type": "string", + "description": "The unit number of the customer's address", + "example": "111" + }, + "buildingName": { + "type": "string", + "description": "The name of the building where the customer resides", + "example": "Thornberry" + }, + "address": { + "type": "string", + "description": "The street address of the customer", + "example": "201 Se Scenic View Dr Df Df" + }, + "city": { + "type": "string", + "description": "The city where the customer resides", + "example": "Chandler" + }, + "state": { + "type": "string", + "description": "The state where the customer resides", + "example": "OR" + }, + "postalCode": { + "type": "string", + "description": "The postal code for the customer's address", + "example": "1333" + }, + "isActiveBankruptcy": { + "type": "boolean", + "description": "The Bankruptcy status of customer .", + "example": 1 + }, + "bankruptcyDate": { + "type": "string", + "description": "The Bankruptcy date of customer.", + "example": "08/22/2025" + }, + "bankruptcyNote": { + "type": "string", + "description": "XYZ" + } + } + } + } + } + } + } + } + } + }, + "sendCustomerTestimonialsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Testimonials" + ], + "properties": { + "Testimonials": { + "type": "object", + "required": [ + "Testimonial" + ], + "properties": { + "Testimonial": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "node", + "reference_id", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "The identifier for the testimonial node", + "example": 1 + }, + "reference_id": { + "type": "integer", + "description": "The reference ID of the testimonial", + "example": 8530 + }, + "status": { + "type": "string", + "description": "The status of the testimonial submission", + "example": "Success" + }, + "message": { + "type": "string", + "description": "The message indicating the result of the submission", + "example": "Testimonial inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateCustomersSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the status of the request.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "customers" + ], + "properties": { + "customers": { + "type": "object", + "required": [ + "customer" + ], + "properties": { + "customer": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "referenceId", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "The unique identifier for the customer node.", + "example": "1" + }, + "referenceId": { + "type": "string", + "description": "The reference ID of the customer.", + "example": "31025784" + }, + "status": { + "type": "string", + "description": "The status of the customer update request.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "The message indicating the result of the customer update.", + "example": "Customer updated successfully." + } + } + } + } + } + } + } + } + } + }, + "updateCustomerTestimonialsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "The response code indicating the status of the request.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "Testimonials" + ], + "properties": { + "Testimonials": { + "type": "object", + "required": [ + "Testimonial" + ], + "properties": { + "Testimonial": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "The status of the transmission vendor activation/deactivation.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "The message indicating the result of the transmission vendor operation.", + "example": "Succesfully Activated/deactivated Transmission Vendor." + } + } + } + } + } + } + } + } + } + } + }, + "updatePropertyResponseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "The response code indicating the status of the request.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "testimonials" + ], + "properties": { + "testimonials": { + "type": "object", + "required": [ + "testimonial" + ], + "properties": { + "testimonial": { + "type": "object", + "required": [ + "testimonialId", + "status", + "message" + ], + "properties": { + "testimonialId": { + "type": "string", + "description": "The unique identifier for the testimonial.", + "example": "123456" + }, + "status": { + "type": "string", + "description": "The status of the testimonial update.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "The message indicating the result of the testimonial update.", + "example": "Testimonial response updated successfully." + } + } + } + } + } + } + } + } + }, + "getApCodesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "The response code indicating the status of the request.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "apCodeCategories" + ], + "properties": { + "apCodeCategories": { + "type": "object", + "required": [ + "apCodeCategory" + ], + "properties": { + "apCodeCategory": { + "type": "array", + "description": "A list of accounts payable categories.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "apCodes" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the accounts payable category.", + "example": "1234" + }, + "name": { + "type": "string", + "description": "The name of the accounts payable category.", + "example": "ap category 1" + }, + "apCodes": { + "type": "object", + "required": [ + "apCode" + ], + "properties": { + "apCode": { + "type": "array", + "description": "A list of accounts payable codes associated with the category.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "glAccountId", + "apCodeTypeId", + "apCodeType" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the accounts payable code.", + "example": "6789" + }, + "name": { + "type": "string", + "description": "The name of the accounts payable code.", + "example": "ap code 1" + }, + "glAccountId": { + "type": "string", + "description": "The general ledger account ID associated with the AP code.", + "example": "1234" + }, + "apCodeTypeId": { + "type": "string", + "description": "The ID representing the type of the accounts payable code.", + "example": "3" + }, + "apCodeType": { + "type": "string", + "description": "The type of the accounts payable code.", + "example": "Job Cost" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getBankAccountsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "BankAccounts" + ], + "properties": { + "BankAccounts": { + "type": "object", + "required": [ + "BankAccount" + ], + "properties": { + "BankAccount": { + "type": "array", + "description": "A list of bank accounts.", + "items": { + "type": "object", + "required": [ + "Id", + "AccountName", + "BankAccountTypeId", + "PropertyBankAccounts", + "AccountType", + "CheckBankName", + "NextCheckNumber" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the bank account.", + "example": "11111" + }, + "AccountName": { + "type": "string", + "description": "The name of the bank account.", + "example": "Park Avenue I" + }, + "BankAccountTypeId": { + "type": "string", + "description": "The type ID of the bank account.", + "example": "8" + }, + "PropertyBankAccounts": { + "type": "object", + "required": [ + "PropertyBankAccount" + ], + "properties": { + "PropertyBankAccount": { + "type": "array", + "description": "A list of property bank accounts associated with the bank account.", + "items": { + "type": "object", + "required": [ + "Id", + "PropertyId", + "GlAccountId", + "IsDueToFrom" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the property bank account.", + "example": "123" + }, + "PropertyId": { + "type": "string", + "description": "The property identifier associated with the property bank account.", + "example": "11111" + }, + "GlAccountId": { + "type": "string", + "description": "The general ledger account ID associated with the property.", + "example": "12345" + }, + "IsDueToFrom": { + "type": "string", + "description": "Indicates if the account is due to/from a particular property.", + "example": "0" + } + } + } + } + } + }, + "AccountType": { + "type": "string", + "description": "The type of the bank account.", + "example": "Account Type I" + }, + "CheckBankName": { + "type": "string", + "description": "The name of the bank associated with checks for the account.", + "example": "Park Avenue I" + }, + "NextCheckNumber": { + "type": "string", + "description": "The next check number to be issued for the account.", + "example": "7" + } + } + } + } + } + } + } + } + } + }, + "getBudgetActualsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "budgetVsActuals" + ], + "properties": { + "budgetVsActuals": { + "type": "object", + "required": [ + "budgetVsActual" + ], + "properties": { + "budgetVsActual": { + "type": "array", + "description": "A list of budget vs actual records.", + "items": { + "type": "object", + "required": [ + "accountName", + "accountId", + "mtdActualIncome", + "mtdBudgetIncome", + "mtdVariance", + "mtdPercentageVariance", + "ytdActualIncome", + "ytdBudgetIncome", + "ytdVariance", + "ytdPercentageVariance", + "annualBudgetIncome" + ], + "properties": { + "accountName": { + "type": "string", + "description": "The name of the account.", + "example": "Testgldetails" + }, + "accountId": { + "type": "string", + "description": "The unique identifier for the account.", + "example": "171693" + }, + "mtdActualIncome": { + "type": "string", + "description": "The month-to-date actual income.", + "example": "150.00" + }, + "mtdBudgetIncome": { + "type": "string", + "description": "The month-to-date budgeted income.", + "example": "10000.00" + }, + "mtdVariance": { + "type": "string", + "description": "The month-to-date variance between actual and budgeted income.", + "example": "-9850.00" + }, + "mtdPercentageVariance": { + "type": "string", + "description": "The percentage variance for month-to-date income.", + "example": "-98.5" + }, + "ytdActualIncome": { + "type": "string", + "description": "The year-to-date actual income.", + "example": "0.00" + }, + "ytdBudgetIncome": { + "type": "string", + "description": "The year-to-date budgeted income.", + "example": "0.00" + }, + "ytdVariance": { + "type": "string", + "description": "The year-to-date variance between actual and budgeted income.", + "example": "0.00" + }, + "ytdPercentageVariance": { + "type": "string", + "description": "The percentage variance for year-to-date income.", + "example": "0.00" + }, + "annualBudgetIncome": { + "type": "string", + "description": "The annual budgeted income for the account.", + "example": "10000.00" + } + } + } + } + } + } + } + } + } + }, + "getBudgetsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "type": "object", + "required": [ + "property" + ], + "properties": { + "property": { + "type": "array", + "description": "A list of properties with associated budget data.", + "items": { + "type": "object", + "required": [ + "propertyId", + "propertyName", + "budgets" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "The unique identifier for the property.", + "example": "123" + }, + "propertyName": { + "type": "string", + "description": "The name of the property.", + "example": "Property Name" + }, + "budgets": { + "type": "object", + "required": [ + "budget" + ], + "properties": { + "budget": { + "type": "array", + "description": "A list of budget records for the property.", + "items": { + "type": "object", + "required": [ + "id", + "budgetName", + "budgetStatusTypeId", + "isDefault", + "fiscalStartDate", + "fiscalEndDate", + "fiscalYear", + "budgetTotal", + "glAccounts" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget.", + "example": "1234" + }, + "budgetName": { + "type": "string", + "description": "The name of the budget.", + "example": "budgetName" + }, + "budgetStatusTypeId": { + "type": "string", + "description": "The status type of the budget.", + "example": "1" + }, + "isDefault": { + "type": "string", + "description": "Indicates if this is the default budget.", + "example": "1" + }, + "fiscalStartDate": { + "type": "string", + "format": "date", + "description": "The fiscal start date for the budget.", + "example": "01/01/2017" + }, + "fiscalEndDate": { + "type": "string", + "format": "date", + "description": "The fiscal end date for the budget.", + "example": "04/30/2017" + }, + "fiscalYear": { + "type": "string", + "description": "The fiscal year for the budget.", + "example": "2017" + }, + "budgetTotal": { + "type": "string", + "description": "The total value of the budget.", + "example": "123.123" + }, + "glAccounts": { + "type": "object", + "required": [ + "glAccount" + ], + "properties": { + "glAccount": { + "type": "array", + "description": "A list of GL accounts for the budget.", + "items": { + "type": "object", + "required": [ + "id", + "accountName", + "accountNumber", + "glTotals", + "budgetMonths" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the GL account.", + "example": "154463" + }, + "accountName": { + "type": "string", + "description": "The name of the GL account.", + "example": "Accelerated Rent" + }, + "accountNumber": { + "type": "string", + "description": "The account number for the GL account.", + "example": "4010" + }, + "glTotals": { + "type": "object", + "required": [ + "glTotal" + ], + "properties": { + "glTotal": { + "type": "object", + "required": [ + "amount", + "glDimensionId" + ], + "properties": { + "amount": { + "type": "string", + "description": "The total amount for the GL account.", + "example": "360" + }, + "glDimensionId": { + "type": "string", + "description": "The GL dimension ID.", + "example": "463" + } + } + } + } + }, + "budgetMonths": { + "type": "object", + "required": [ + "budgetMonth" + ], + "properties": { + "budgetMonth": { + "type": "array", + "description": "The list of budget months with amounts.", + "items": { + "type": "object", + "required": [ + "month", + "amount" + ], + "properties": { + "month": { + "type": "string", + "description": "The month of the budget entry.", + "example": "01/01/2019" + }, + "amount": { + "type": "string", + "description": "The budgeted amount for the month.", + "example": "100" + }, + "glDimensionId": { + "type": "string", + "description": "The GL dimension ID for the month.", + "example": "463" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getFinancialPickList_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "GlGroupTypes", + "GlTreeTypes", + "GlAccountTypes", + "GlBooks", + "GlBranchTypes", + "GlExportBatchTypes", + "GlHeaderStatusTypes", + "GlHeaderTypes", + "GlLedgerTypes", + "GlReconciliationStatusTypes", + "GlTransactionTypes", + "Budgets", + "LedgerIds" + ], + "properties": { + "GlGroupTypes": { + "type": "object", + "required": [ + "GlGroupType" + ], + "properties": { + "GlGroupType": { + "type": "array", + "description": "A list of GL group types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL group type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL group type.", + "example": "Assets" + } + } + } + } + } + }, + "GlTreeTypes": { + "type": "object", + "required": [ + "GlTreeType" + ], + "properties": { + "GlTreeType": { + "type": "array", + "description": "A list of GL tree types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL tree type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL tree type.", + "example": "Standard" + } + } + } + } + } + }, + "GlAccountTypes": { + "type": "object", + "required": [ + "GlAccountType" + ], + "properties": { + "GlAccountType": { + "type": "array", + "description": "A list of GL account types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL account type.", + "example": 201 + }, + "Name": { + "type": "string", + "description": "The name of the GL account type.", + "example": "Accounts Payable" + } + } + } + } + } + }, + "GlBooks": { + "type": "object", + "required": [ + "GlBook" + ], + "properties": { + "GlBook": { + "type": "array", + "description": "A list of GL books.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL book.", + "example": 616 + }, + "Name": { + "type": "string", + "description": "The name of the GL book.", + "example": "Standard" + } + } + } + } + } + }, + "GlBranchTypes": { + "type": "object", + "required": [ + "GlBranchType" + ], + "properties": { + "GlBranchType": { + "type": "array", + "description": "A list of GL branch types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL branch type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL branch type.", + "example": "Standard Group" + } + } + } + } + } + }, + "GlExportBatchTypes": { + "type": "object", + "required": [ + "GlExportBatchType" + ], + "properties": { + "GlExportBatchType": { + "type": "array", + "description": "A list of GL export batch types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL export batch type.", + "example": 88 + }, + "Name": { + "type": "string", + "description": "The name of the GL export batch type.", + "example": "AMSI" + } + } + } + } + } + }, + "GlHeaderStatusTypes": { + "type": "object", + "required": [ + "GlHeaderStatusType" + ], + "properties": { + "GlHeaderStatusType": { + "type": "array", + "description": "A list of GL header status types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL header status type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL header status type.", + "example": "Posted" + } + } + } + } + } + }, + "GlHeaderTypes": { + "type": "object", + "required": [ + "GlHeaderType" + ], + "properties": { + "GlHeaderType": { + "type": "array", + "description": "A list of GL header types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL header type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL header type.", + "example": "Standard" + } + } + } + } + } + }, + "GlLedgerTypes": { + "type": "object", + "required": [ + "GlLedgerType" + ], + "properties": { + "GlLedgerType": { + "type": "array", + "description": "A list of GL ledger types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL ledger type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL ledger type.", + "example": "GL" + } + } + } + } + } + }, + "GlReconciliationStatusTypes": { + "type": "object", + "required": [ + "GlReconciliationStatusTypes" + ], + "properties": { + "GlReconciliationStatusTypes": { + "type": "array", + "description": "A list of GL reconciliation status types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL reconciliation status type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL reconciliation status type.", + "example": "Reconciled" + } + } + } + } + } + }, + "GlTransactionTypes": { + "type": "object", + "required": [ + "GlTransactionType" + ], + "properties": { + "GlTransactionType": { + "type": "array", + "description": "A list of GL transaction types.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the GL transaction type.", + "example": 1 + }, + "Name": { + "type": "string", + "description": "The name of the GL transaction type.", + "example": "GJ" + } + } + } + } + } + }, + "Budgets": { + "type": "object", + "required": [ + "Budget" + ], + "properties": { + "Budget": { + "type": "array", + "description": "A list of budget records.", + "items": { + "type": "object", + "required": [ + "Id", + "Name", + "StatusTypeId", + "IsDefault", + "StatusType" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the budget.", + "example": 67183 + }, + "Name": { + "type": "string", + "description": "The name of the budget.", + "example": "test budget HV" + }, + "StatusTypeId": { + "type": "integer", + "description": "The status type identifier for the budget.", + "example": 4 + }, + "IsDefault": { + "type": "integer", + "description": "Indicates if the budget is the default budget.", + "example": 0 + }, + "StatusType": { + "type": "string", + "description": "The status of the budget.", + "example": "Archived" + } + } + } + } + } + }, + "LedgerIds": { + "type": "object", + "required": [ + "LedgerId" + ], + "properties": { + "LedgerId": { + "type": "array", + "description": "A list of ledger identifiers.", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "integer", + "description": "The unique identifier for the ledger.", + "example": 3 + }, + "Name": { + "type": "string", + "description": "The name of the ledger.", + "example": "Military" + } + } + } + } + } + } + } + } + } + }, + "getFinancialPickList_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "glGroupTypes", + "glTreeTypes", + "glAccountTypes", + "glBooks", + "glBranchTypes", + "glExportBatchTypes", + "glHeaderStatusTypes", + "glHeaderTypes", + "glLedgerTypes", + "glReconciliationStatusTypes", + "glTransactionTypes", + "budgetStatusTypeIds", + "owners", + "ledgerIds" + ], + "properties": { + "glGroupTypes": { + "type": "object", + "required": [ + "glGroupType" + ], + "properties": { + "glGroupType": { + "type": "array", + "description": "A list of GL group types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL group type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL group type.", + "example": "Assets" + } + } + } + } + } + }, + "glTreeTypes": { + "type": "object", + "required": [ + "glTreeType" + ], + "properties": { + "glTreeType": { + "type": "array", + "description": "A list of GL tree types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL tree type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL tree type.", + "example": "Standard" + } + } + } + } + } + }, + "glAccountTypes": { + "type": "object", + "required": [ + "glAccountType" + ], + "properties": { + "glAccountType": { + "type": "array", + "description": "A list of GL account types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL account type.", + "example": 201 + }, + "name": { + "type": "string", + "description": "The name of the GL account type.", + "example": "Accounts Payable" + } + } + } + } + } + }, + "glBooks": { + "type": "object", + "required": [ + "glBook" + ], + "properties": { + "glBook": { + "type": "array", + "description": "A list of GL books.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL book.", + "example": 616 + }, + "name": { + "type": "string", + "description": "The name of the GL book.", + "example": "Standard" + } + } + } + } + } + }, + "glBranchTypes": { + "type": "object", + "required": [ + "glBranchType" + ], + "properties": { + "glBranchType": { + "type": "array", + "description": "A list of GL branch types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL branch type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL branch type.", + "example": "Standard Group" + } + } + } + } + } + }, + "glExportBatchTypes": { + "type": "object", + "required": [ + "glExportBatchType" + ], + "properties": { + "glExportBatchType": { + "type": "array", + "description": "A list of GL export batch types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL export batch type.", + "example": 88 + }, + "name": { + "type": "string", + "description": "The name of the GL export batch type.", + "example": "AMSI" + } + } + } + } + } + }, + "glHeaderStatusTypes": { + "type": "object", + "required": [ + "glHeaderStatusType" + ], + "properties": { + "glHeaderStatusType": { + "type": "array", + "description": "A list of GL header status types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL header status type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL header status type.", + "example": "Posted" + } + } + } + } + } + }, + "glHeaderTypes": { + "type": "object", + "required": [ + "glHeaderType" + ], + "properties": { + "glHeaderType": { + "type": "array", + "description": "A list of GL header types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL header type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL header type.", + "example": "Standard" + } + } + } + } + } + }, + "glLedgerTypes": { + "type": "object", + "required": [ + "glLedgerType" + ], + "properties": { + "glLedgerType": { + "type": "array", + "description": "A list of GL ledger types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL ledger type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL ledger type.", + "example": "GL" + } + } + } + } + } + }, + "glReconciliationStatusTypes": { + "type": "object", + "required": [ + "glReconciliationStatusType" + ], + "properties": { + "glReconciliationStatusType": { + "type": "array", + "description": "A list of GL reconciliation status types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL reconciliation status type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL reconciliation status type.", + "example": "Reconciled" + } + } + } + } + } + }, + "glTransactionTypes": { + "type": "object", + "required": [ + "glTransactionType" + ], + "properties": { + "glTransactionType": { + "type": "array", + "description": "A list of GL transaction types.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the GL transaction type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the GL transaction type.", + "example": "GJ" + } + } + } + } + } + }, + "budgetStatusTypeIds": { + "type": "object", + "required": [ + "budgetStatusTypeId" + ], + "properties": { + "budgetStatusTypeId": { + "type": "array", + "description": "A list of budget status type identifiers.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the budget status type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "The name of the budget status type.", + "example": "Current" + } + } + } + } + } + }, + "owners": { + "type": "object", + "required": [ + "owner" + ], + "properties": { + "owner": { + "type": "array", + "description": "A list of owners.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "propertyIds" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the owner.", + "example": "60732" + }, + "name": { + "type": "string", + "description": "The name of the owner.", + "example": "0000CNYE1" + }, + "propertyIds": { + "type": "string", + "description": "A comma-separated list of property IDs associated with the owner.", + "example": "19463,43634" + } + } + } + } + } + }, + "ledgerIds": { + "type": "object", + "required": [ + "ledgerId" + ], + "properties": { + "ledgerId": { + "type": "array", + "description": "A list of ledger identifiers.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the ledger.", + "example": 3 + }, + "name": { + "type": "string", + "description": "The name of the ledger.", + "example": "Military" + } + } + } + } + } + } + } + } + } + }, + "getGlTransactionsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "type": "object", + "required": [ + "property" + ], + "properties": { + "property": { + "type": "object", + "required": [ + "isCashBook", + "transactions", + "@attributes" + ], + "properties": { + "isCashBook": { + "type": "string", + "description": "Indicates whether the property is a cash book.", + "example": "false" + }, + "transactions": { + "type": "object", + "required": [ + "transaction" + ], + "properties": { + "transaction": { + "type": "array", + "description": "A list of transactions.", + "items": { + "type": "object", + "required": [ + "glTotal", + "@attributes" + ], + "properties": { + "glTotal": { + "type": "object", + "required": [ + "openingBalance", + "debitOpeningBalance", + "creditOpeningBalance", + "debitClosingBalance", + "creditClosingBalance", + "netChange", + "closingBalance" + ], + "properties": { + "openingBalance": { + "type": "string", + "description": "The opening balance of the transaction.", + "example": "0.00" + }, + "debitOpeningBalance": { + "type": "string", + "description": "The debit opening balance.", + "example": "0.00" + }, + "creditOpeningBalance": { + "type": "string", + "description": "The credit opening balance.", + "example": "0.00" + }, + "debitClosingBalance": { + "type": "string", + "description": "The debit closing balance.", + "example": "6.00" + }, + "creditClosingBalance": { + "type": "string", + "description": "The credit closing balance.", + "example": "-6.00" + }, + "netChange": { + "type": "string", + "description": "The net change in the transaction.", + "example": "0.00" + }, + "closingBalance": { + "type": "string", + "description": "The closing balance of the transaction.", + "example": "0.00" + } + } + }, + "glDetails": { + "type": "object", + "required": [ + "glDetail" + ], + "properties": { + "glDetail": { + "type": "array", + "description": "A list of GL detail entries for the transaction.", + "items": { + "type": "object", + "required": [ + "transactionDate", + "postMonth", + "postDate", + "debit", + "credit", + "balance", + "reference", + "memo", + "@attributes" + ], + "properties": { + "transactionDate": { + "type": "string", + "description": "The date of the transaction.", + "example": "2020/04/23" + }, + "postMonth": { + "type": "string", + "description": "The posting month of the transaction.", + "example": "Oct,2013" + }, + "postDate": { + "type": "string", + "description": "The posting date of the transaction.", + "example": "2020/04/23" + }, + "debit": { + "type": "string", + "description": "The debit amount of the transaction.", + "example": "6.00" + }, + "credit": { + "type": "string", + "description": "The credit amount of the transaction.", + "example": "0.00" + }, + "balance": { + "type": "string", + "description": "The balance after the transaction.", + "example": "6.00" + }, + "reference": { + "type": "string", + "description": "The reference for the transaction.", + "example": "Payment Received - #12345" + }, + "memo": { + "type": "string", + "description": "The memo for the transaction.", + "example": "Master 07 Unit #17" + }, + "@attributes": { + "type": "object", + "required": [ + "id", + "transactionType" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the transaction.", + "example": "12345" + }, + "transactionType": { + "type": "string", + "description": "The type of the transaction.", + "example": "AR Payment" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "required": [ + "accountId", + "accountName", + "accountNumber" + ], + "properties": { + "accountId": { + "type": "string", + "description": "The unique identifier for the account.", + "example": "1234" + }, + "accountName": { + "type": "string", + "description": "The name of the account.", + "example": "Undeposited Funds" + }, + "accountNumber": { + "type": "string", + "description": "The account number.", + "example": "1234" + }, + "externalId": { + "type": "string", + "description": "The external ID associated with the account.", + "example": "2" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "required": [ + "id", + "name", + "lookupCode", + "businessUnitCode" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the property.", + "example": "1234" + }, + "name": { + "type": "string", + "description": "The name of the property.", + "example": "silver park apartments" + }, + "lookupCode": { + "type": "string", + "description": "The lookup code for the property.", + "example": "123X" + }, + "businessUnitCode": { + "type": "string", + "description": "The business unit code for the property.", + "example": "silver" + } + } + } + } + } + } + } + } + } + } + }, + "getGlTrees_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "GlTrees" + ], + "properties": { + "GlTrees": { + "type": "object", + "required": [ + "GlTree" + ], + "properties": { + "GlTree": { + "type": "array", + "description": "A list of GL trees.", + "items": { + "type": "object", + "required": [ + "@attributes", + "Properties", + "Branches", + "GlAccounts" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the GL tree.", + "example": "1283" + }, + "Name": { + "type": "string", + "description": "The name of the GL tree.", + "example": "Master GL Tree" + } + } + }, + "Properties": { + "type": "object", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "array", + "description": "A list of properties associated with the GL tree.", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the property.", + "example": "2652" + }, + "Name": { + "type": "string", + "description": "The name of the property.", + "example": "TEST" + } + } + } + } + } + } + } + }, + "Branches": { + "type": "object", + "required": [ + "Branch" + ], + "properties": { + "Branch": { + "type": "array", + "description": "A list of branches associated with the GL tree.", + "items": { + "type": "object", + "required": [ + "BranchId", + "GroupType", + "IsEnabled", + "ShowGroupName", + "GroupName", + "ShowSummaryRow", + "Description" + ], + "properties": { + "BranchId": { + "type": "string", + "description": "The unique identifier for the branch.", + "example": "5531" + }, + "GroupType": { + "type": "string", + "description": "The type of the group.", + "example": "Standard Group" + }, + "IsEnabled": { + "type": "string", + "description": "Indicates whether the branch is enabled.", + "example": "1" + }, + "ShowGroupName": { + "type": "string", + "description": "Indicates whether to show the group name.", + "example": "1" + }, + "GroupName": { + "type": "string", + "description": "The name of the group.", + "example": "Assets" + }, + "ShowSummaryRow": { + "type": "string", + "description": "Indicates whether to show the summary row.", + "example": "1" + }, + "Description": { + "type": "string", + "description": "The description of the branch.", + "example": "Assets" + } + } + } + } + } + }, + "GlAccounts": { + "type": "object", + "required": [ + "GlAccount" + ], + "properties": { + "GlAccount": { + "type": "array", + "description": "A list of GL accounts within the GL tree.", + "items": { + "type": "object", + "required": [ + "@attributes", + "AccountNumber", + "AccountName", + "GlGroupType", + "GroupLocation", + "Description", + "Status", + "IsSystem" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "BranchId" + ], + "properties": { + "Id": { + "type": "string", + "description": "The unique identifier for the GL account.", + "example": "87019" + }, + "BranchId": { + "type": "string", + "description": "The unique identifier for the branch.", + "example": "56125" + } + } + }, + "AccountNumber": { + "type": "string", + "description": "The account number.", + "example": "101-000-0" + }, + "AccountName": { + "type": "string", + "description": "The name of the GL account.", + "example": "Cash in Bank - ResidentPay" + }, + "ExternalId": { + "type": "string", + "description": "The external identifier for the GL account.", + "example": "2894" + }, + "GlGroupType": { + "type": "string", + "description": "The GL group type.", + "example": "Assets" + }, + "GroupLocation": { + "type": "string", + "description": "The location of the GL account group.", + "example": "Cash" + }, + "Description": { + "type": "string", + "description": "A description of the GL account.", + "example": "Cash in Bank - ResidentPay" + }, + "Status": { + "type": "string", + "description": "The status of the GL account.", + "example": "Enabled" + }, + "IsSystem": { + "type": "string", + "description": "Indicates if the GL account is a system account.", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getGlTrees_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "response": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "HTTP status code indicating the result of the request", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result object containing the GL Tree data", + "required": [ + "glTrees" + ], + "properties": { + "glTrees": { + "type": "object", + "description": "GL Tree container object", + "required": [ + "glTree" + ], + "properties": { + "glTree": { + "type": "array", + "description": "Array of GL Trees", + "items": { + "type": "object", + "required": [ + "id", + "name", + "isMasterGlTree", + "branches", + "glAccounts" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the GL Tree", + "example": 12345 + }, + "name": { + "type": "string", + "description": "The name of the GL Tree", + "example": "Master GL Tree" + }, + "isMasterGlTree": { + "type": "integer", + "description": "Indicates if the GL Tree is a master GL Tree (1 = true, 0 = false)", + "example": 1 + }, + "branches": { + "type": "object", + "description": "Branch details related to the GL Tree", + "required": [ + "branch" + ], + "properties": { + "branch": { + "type": "array", + "description": "Array of branches associated with the GL Tree", + "items": { + "type": "object", + "required": [ + "branchId", + "groupType" + ], + "properties": { + "branchId": { + "type": "string", + "description": "Unique identifier for the branch", + "example": "12345" + }, + "groupType": { + "type": "string", + "description": "Type of the group for the branch", + "example": "Standard Group" + }, + "isEnabled": { + "type": "string", + "description": "Indicates if the branch is enabled ", + "example": "1" + }, + "showGroupName": { + "type": "integer", + "description": "Indicates if the group name should be displayed", + "example": 1 + }, + "groupName": { + "type": "string", + "description": "The name of the group in the branch", + "example": "Cash" + }, + "showSummaryRow": { + "type": "integer", + "description": "Indicates if the summary row should be shown", + "example": 1 + }, + "description": { + "type": "string", + "description": "A brief description of the branch", + "example": "Cash" + } + } + } + } + } + }, + "glAccounts": { + "type": "object", + "description": "GL Accounts associated with the GL Tree", + "required": [ + "glAccount" + ], + "properties": { + "glAccount": { + "type": "array", + "description": "Array of GL Accounts", + "items": { + "type": "object", + "required": [ + "id", + "branchId", + "accountNumber", + "accountName", + "externalId", + "glGroupType", + "status" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the GL Account", + "example": "12345" + }, + "branchId": { + "type": "string", + "description": "Unique identifier for the branch associated with the GL Account", + "example": "12345" + }, + "accountNumber": { + "type": "string", + "description": "Account number for the GL Account", + "example": "12345-12345" + }, + "accountName": { + "type": "string", + "description": "The name of the GL Account", + "example": "Cash in Bank - Operating" + }, + "externalId": { + "type": "string", + "description": "External identifier for the GL Account", + "example": "12345" + }, + "glGroupType": { + "type": "string", + "description": "The group type to which the GL Account belongs", + "example": "Assets" + }, + "groupLocation": { + "type": "string", + "description": "The location of the group for the GL Account", + "example": "Cash" + }, + "description": { + "type": "string", + "description": "A description of the GL Account", + "example": "Cash in Bank - Operating" + }, + "status": { + "type": "string", + "description": "The status of the GL Account (e.g., Enabled, Disabled)", + "example": "Enabled" + }, + "isSystem": { + "type": "integer", + "description": "Indicates if the GL Account is a system account (1 = true, 0 = false)", + "example": 1 + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getJobCategoriesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "jobCategories" + ], + "properties": { + "jobCategories": { + "type": "object", + "required": [ + "jobCategory" + ], + "properties": { + "jobCategory": { + "type": "array", + "description": "A list of job categories.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the job category.", + "example": "632" + }, + "name": { + "type": "string", + "description": "The name of the job category.", + "example": "Brittany's Job Type" + }, + "glAccountId": { + "type": "string", + "description": "The general ledger (GL) account ID associated with the job category, if applicable.", + "example": "86997" + } + } + } + } + } + } + } + } + } + }, + "getJobCostBudgetsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "jobs" + ], + "properties": { + "jobs": { + "type": "object", + "required": [ + "job" + ], + "properties": { + "job": { + "type": "array", + "description": "A list of jobs.", + "items": { + "type": "object", + "required": [ + "propertyId", + "jobId", + "jobStatusId", + "jobPhases" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "The unique identifier for the property associated with the job.", + "example": "172775" + }, + "jobId": { + "type": "string", + "description": "The unique identifier for the job.", + "example": "1249" + }, + "jobStatusId": { + "type": "string", + "description": "The status identifier of the job.", + "example": "1" + }, + "jobPhases": { + "type": "object", + "required": [ + "jobPhase" + ], + "properties": { + "jobPhase": { + "type": "array", + "description": "A list of job phases associated with the job.", + "items": { + "type": "object", + "required": [ + "jobPhaseId", + "jobPhaseName", + "apCodes" + ], + "properties": { + "jobPhaseId": { + "type": "string", + "description": "The unique identifier for the job phase.", + "example": "2700" + }, + "jobPhaseName": { + "type": "string", + "description": "The name of the job phase.", + "example": "PhaseGlAccountTest" + }, + "apCodes": { + "type": "array", + "description": "A list of accounts payable codes associated with the job phase.", + "items": { + "type": "object", + "required": [ + "apCode" + ], + "properties": { + "apCode": { + "type": "object", + "required": [ + "apCodeId", + "apCodeName", + "unitTypeBudget", + "locationBudget", + "generalBudget", + "postMonths" + ], + "properties": { + "apCodeId": { + "type": "string", + "description": "The unique identifier for the AP code.", + "example": "176844" + }, + "apCodeName": { + "type": "string", + "description": "The name of the AP code.", + "example": "1234 - Electrical" + }, + "unitTypeBudget": { + "type": "string", + "description": "The budget for the unit type.", + "example": "12" + }, + "locationBudget": { + "type": "string", + "description": "The budget for the location.", + "example": "0" + }, + "generalBudget": { + "type": "string", + "description": "The general budget for the AP code.", + "example": "0" + }, + "postMonths": { + "type": "object", + "required": [ + "postMonth" + ], + "properties": { + "postMonth": { + "type": "array", + "description": "A list of post months for the AP code.", + "items": { + "type": "object", + "required": [ + "apDetailId", + "postMonth", + "monthlyAmount" + ], + "properties": { + "apDetailId": { + "type": "string", + "description": "The unique identifier for the AP detail.", + "example": "11652280" + }, + "postMonth": { + "type": "string", + "description": "The month in which the AP code is posted.", + "example": "01/2021" + }, + "monthlyAmount": { + "type": "string", + "description": "The amount for the given month.", + "example": "0.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getJobsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "jobs" + ], + "properties": { + "jobs": { + "type": "object", + "required": [ + "job" + ], + "properties": { + "job": { + "type": "array", + "description": "A list of jobs.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "propertyId", + "jobCategoryId", + "glAccountId", + "jobStatusId", + "jobStatus", + "plannedStartDate", + "plannedCompletionDate", + "actualStartDate", + "actualCompletionDate", + "budgetTotal", + "jobPhases", + "apContracts" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the job.", + "example": "1001" + }, + "name": { + "type": "string", + "description": "The name of the job.", + "example": "RP 1" + }, + "propertyId": { + "type": "string", + "description": "The unique identifier for the property associated with the job.", + "example": "12345" + }, + "jobCategoryId": { + "type": "string", + "description": "The unique identifier for the job category.", + "example": "6" + }, + "glAccountId": { + "type": "string", + "description": "The unique identifier for the general ledger account.", + "example": "87063" + }, + "jobStatusId": { + "type": "string", + "description": "The status identifier of the job.", + "example": "5" + }, + "jobStatus": { + "type": "string", + "description": "The current status of the job.", + "example": "Completed" + }, + "plannedStartDate": { + "type": "string", + "format": "date", + "description": "The planned start date for the job.", + "example": "03/24/2021" + }, + "plannedCompletionDate": { + "type": "string", + "format": "date", + "description": "The planned completion date for the job.", + "example": "03/24/2021" + }, + "actualStartDate": { + "type": "string", + "format": "date", + "description": "The actual start date of the job.", + "example": "03/24/2021" + }, + "actualCompletionDate": { + "type": "string", + "format": "date", + "description": "The actual completion date of the job.", + "example": "03/24/2021" + }, + "budgetTotal": { + "type": "string", + "description": "The total budget for the job.", + "example": "300.00" + }, + "jobPhases": { + "type": "object", + "required": [ + "jobPhase" + ], + "properties": { + "jobPhase": { + "type": "array", + "description": "A list of job phases associated with the job.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "budget" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the job phase.", + "example": "2671" + }, + "name": { + "type": "string", + "description": "The name of the job phase.", + "example": "Phase 1" + }, + "budget": { + "type": "string", + "description": "The budget allocated to the job phase.", + "example": "30.00" + } + } + } + } + } + }, + "apContracts": { + "type": "object", + "required": [ + "apContract" + ], + "properties": { + "apContract": { + "type": "array", + "description": "A list of AP contracts associated with the job.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "contractTotal", + "contractVendor", + "plannedStartDate", + "plannedCompletionDate", + "actualStartDate", + "actualCompletionDate", + "apCodes" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the AP contract.", + "example": "595" + }, + "name": { + "type": "string", + "description": "The name of the AP contract.", + "example": "test contract 1" + }, + "contractTotal": { + "type": "string", + "description": "The total value of the AP contract.", + "example": "300.00" + }, + "contractVendor": { + "type": "string", + "description": "The vendor associated with the AP contract.", + "example": "001 East Park Property" + }, + "plannedStartDate": { + "type": "string", + "format": "date", + "description": "The planned start date for the AP contract.", + "example": "03/24/2021" + }, + "plannedCompletionDate": { + "type": "string", + "format": "date", + "description": "The planned completion date for the AP contract.", + "example": "03/25/2021" + }, + "actualStartDate": { + "type": "string", + "format": "date", + "description": "The actual start date of the AP contract.", + "example": "03/24/2021" + }, + "actualCompletionDate": { + "type": "string", + "format": "date", + "description": "The actual completion date of the AP contract.", + "example": "03/24/2021" + }, + "apCodes": { + "type": "object", + "required": [ + "apCode" + ], + "properties": { + "apCode": { + "type": "array", + "description": "A list of accounts payable codes associated with the AP contract.", + "items": { + "type": "object", + "required": [ + "id", + "jobPhaseId", + "glAccountId", + "contractAmount" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the AP code.", + "example": "179174" + }, + "jobPhaseId": { + "type": "string", + "description": "The ID of the associated job phase.", + "example": "2671" + }, + "glAccountId": { + "type": "string", + "description": "The unique identifier for the general ledger account.", + "example": "86985" + }, + "contractAmount": { + "type": "string", + "description": "The amount specified for the AP code in the contract.", + "example": "100.00" + }, + "changeOrderId": { + "type": "string", + "description": "The change order ID if applicable.", + "example": "750" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getTransactionTagListsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "transactionCustomTags", + "transactionRoutingTags" + ], + "properties": { + "transactionCustomTags": { + "type": "object", + "required": [ + "transactionCustomTag" + ], + "properties": { + "transactionCustomTag": { + "type": "array", + "description": "A list of transaction custom tags.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "isPublished" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the custom tag.", + "example": "545" + }, + "name": { + "type": "string", + "description": "The name of the custom tag.", + "example": "021" + }, + "code": { + "type": "string", + "description": "The code associated with the custom tag.", + "example": "T0021" + }, + "description": { + "type": "string", + "description": "The description of the custom tag.", + "example": "Expenses related to the fire" + }, + "isPublished": { + "type": "integer", + "description": "Indicates whether the custom tag is published.", + "example": 1 + } + } + } + } + } + }, + "transactionRoutingTags": { + "type": "object", + "required": [ + "transactionRoutingTag" + ], + "properties": { + "transactionRoutingTag": { + "type": "array", + "description": "A list of transaction routing tags.", + "items": { + "type": "object", + "required": [ + "id", + "name", + "isPublished" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the routing tag.", + "example": "112" + }, + "name": { + "type": "string", + "description": "The name of the routing tag.", + "example": "Ak Route Tag" + }, + "description": { + "type": "string", + "description": "The description of the routing tag.", + "example": "Ak Route Tag" + }, + "isPublished": { + "type": "integer", + "description": "Indicates whether the routing tag is published.", + "example": 1 + } + } + } + } + } + } + } + } + } + }, + "markGlTransactionsExportedSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "The status of the operation.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Detailed message about the operation.", + "example": "Gl Transactions marked as exported successfully." + } + } + } + } + }, + "sendBudgetsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "budgets" + ], + "properties": { + "budgets": { + "type": "object", + "required": [ + "budget" + ], + "properties": { + "budget": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "The node identifier for the budget insertion.", + "example": 1 + }, + "status": { + "type": "string", + "description": "The status of the budget insertion.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the budget insertion.", + "example": "budget inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "sendJournalEntriesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "glHeaders" + ], + "properties": { + "glHeaders": { + "type": "object", + "required": [ + "glHeader" + ], + "properties": { + "glHeader": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "status", + "message", + "glHeaderId", + "jeNumber" + ], + "properties": { + "node": { + "type": "string", + "description": "The node identifier for the GL header insertion.", + "example": "1" + }, + "status": { + "type": "string", + "description": "The status of the GL header insertion.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the GL header insertion.", + "example": "JE inserted successfully" + }, + "glHeaderId": { + "type": "string", + "description": "The unique identifier for the GL header.", + "example": "123456" + }, + "jeNumber": { + "type": "string", + "description": "The journal entry number.", + "example": "123456" + } + } + } + } + } + } + } + } + } + }, + "updateBudgetsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "budgets" + ], + "properties": { + "budgets": { + "type": "object", + "required": [ + "budget" + ], + "properties": { + "budget": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "The node identifier for the budget update.", + "example": "1" + }, + "status": { + "type": "string", + "description": "The status of the budget update.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the budget update.", + "example": "Budget updated successfully." + } + } + } + } + } + } + } + } + } + }, + "getLeadsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "propertyId", + "currencyCode", + "prospects" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "The property identifier.", + "example": "1234" + }, + "currencyCode": { + "type": "string", + "description": "The currency code used.", + "example": "USD" + }, + "prospects": { + "type": "object", + "required": [ + "prospect" + ], + "properties": { + "prospect": { + "type": "array", + "items": { + "type": "object", + "required": [ + "applicationId", + "status", + "statusId", + "leasingAgent", + "lease", + "customers", + "customerPreferences", + "events" + ], + "properties": { + "applicationId": { + "type": "string", + "description": "The unique identifier for the application.", + "example": "1234" + }, + "status": { + "type": "string", + "description": "The status of the application.", + "example": "Application Approved" + }, + "statusId": { + "type": "string", + "description": "The status identifier.", + "example": "12" + }, + "leadSourceId": { + "type": "string", + "description": "The lead source identifier.", + "example": "123456" + }, + "leadSource": { + "type": "string", + "description": "The source of the lead.", + "example": "123456" + }, + "leasingAgentId": { + "type": "string", + "description": "The leasing agent identifier.", + "example": "123456" + }, + "leasingAgent": { + "type": "string", + "description": "The name of the leasing agent.", + "example": "123456" + }, + "psProductId": { + "type": "string", + "description": "The product ID for the property or service.", + "example": "12" + }, + "internetListingServiceId": { + "type": "string", + "description": "The identifier of the internet listing service.", + "example": "123456" + }, + "internetListingService": { + "type": "string", + "description": "The internet listing service name.", + "example": "EXAMPLE.Com" + }, + "lastUpdatedDate": { + "type": "string", + "description": "The last updated date of the prospect.", + "example": "YYYY-MM-DD" + }, + "createdOn": { + "type": "string", + "description": "The creation date of the application.", + "example": "YYYY-MM-DD" + }, + "screeningResultStatus": { + "type": "string", + "description": "The result of the screening process.", + "example": "Fail" + }, + "spaceConfiguration": { + "type": "string", + "description": "The configuration of the space requested.", + "example": "Private" + }, + "lease": { + "type": "object", + "required": [ + "leaseId", + "status", + "leaseFromDate" + ], + "properties": { + "leaseId": { + "type": "string", + "description": "The lease identifier.", + "example": "1234" + }, + "status": { + "type": "string", + "description": "The status of the lease.", + "example": "Cancelled" + }, + "leaseIntervalId": { + "type": "string", + "description": "The lease interval ID.", + "example": "1234" + }, + "expectedMoveInDate": { + "type": "string", + "description": "The expected move-in date.", + "example": "YYYY-MM-DD" + }, + "expectedMoveOutDate": { + "type": "array", + "items": { + "type": "string", + "description": "The expected move-out date.", + "example": "YYYY-MM-DD" + } + }, + "leaseFromDate": { + "type": "string", + "description": "The date when the lease starts.", + "example": "YYYY-MM-DD" + }, + "leaseToDate": { + "type": "array", + "items": { + "type": "string", + "description": "The date when the lease ends.", + "example": "YYYY-MM-DD" + } + } + } + }, + "customers": { + "type": "object", + "required": [ + "customer" + ], + "properties": { + "customer": { + "type": "array", + "items": { + "type": "object", + "required": [ + "customerId", + "namePrefix", + "firstName", + "lastName" + ], + "properties": { + "customerId": { + "type": "string", + "description": "The customer identifier.", + "example": "1234" + }, + "namePrefix": { + "type": "string", + "description": "The prefix for the customer's name.", + "example": "MR" + }, + "firstName": { + "type": "string", + "description": "The first name of the customer.", + "example": "FIRST NAME" + }, + "middleName": { + "type": "string", + "description": "The middle name of the customer.", + "example": "MIDDLE NAME" + }, + "lastName": { + "type": "string", + "description": "The last name of the customer.", + "example": "LAST NAME" + }, + "maidenName": { + "type": "string", + "description": "The maiden name of the customer.", + "example": "MAIDEN NAME" + }, + "nameSuffix": { + "type": "string", + "description": "The suffix for the customer's name.", + "example": "JR" + }, + "personalPhoneNumber": { + "type": "string", + "description": "The personal phone number of the customer.", + "example": "1234" + }, + "cellPhoneNumber": { + "type": "string", + "description": "The cell phone number of the customer.", + "example": "1234567890" + }, + "officePhoneNumber": { + "type": "string", + "description": "The office phone number of the customer.", + "example": "1234567890" + }, + "faxPhoneNumber": { + "type": "string", + "description": "The fax number of the customer.", + "example": "1234567890" + }, + "email": { + "type": "string", + "description": "The email address of the customer.", + "example": "EAMIL@EXAMPLE.LCL" + }, + "birthDate": { + "type": "string", + "description": "The birthdate of the customer.", + "example": "YYYY-MM-DD" + }, + "addresses": { + "type": "object", + "required": [ + "address" + ], + "properties": { + "address": { + "type": "array", + "items": { + "type": "object", + "required": [ + "addressLine", + "city", + "state", + "countryCode", + "postalCode" + ], + "properties": { + "addressLine": { + "type": "string", + "description": "The address line.", + "example": "addressLine" + }, + "city": { + "type": "string", + "description": "The city of the address.", + "example": "CITY" + }, + "state": { + "type": "string", + "description": "The state of the address.", + "example": "GA" + }, + "province": { + "type": "string", + "description": "The province of the address.", + "example": "PROVINCE" + }, + "countryCode": { + "type": "string", + "description": "The country code.", + "example": "US" + }, + "postalCode": { + "type": "string", + "description": "The postal code.", + "example": "123456" + } + } + } + } + } + }, + "isActiveBankruptcy": { + "type": "boolean", + "description": "The Bankruptcy status of customer .", + "example": 1 + }, + "bankruptcyDate": { + "type": "string", + "description": "The Bankruptcy date of customer.", + "example": "08/22/2025" + }, + "bankruptcyNote": { + "type": "string", + "description": "XYZ" + } + } + } + } + } + }, + "customerPreferences": { + "type": "object", + "properties": { + "targetMoveInDate": { + "type": "string", + "description": "The target move-in date.", + "example": "YYYY-MM-DD" + }, + "desiredFloorplan": { + "type": "string", + "description": "The desired floorplan.", + "example": "One BHK - 2" + }, + "desiredUnit": { + "type": "object", + "properties": { + "propertyUnitId": { + "type": "string", + "description": "The unit identifier.", + "example": "1234" + }, + "unitNumber": { + "type": "string", + "description": "The unit number.", + "example": "112-B" + }, + "unitSpaceId": { + "type": "string", + "description": "The unit space identifier.", + "example": "1234" + }, + "unitType": { + "type": "string", + "description": "The type of unit desired.", + "example": "2BHK" + }, + "unitBedrooms": { + "type": "array", + "items": { + "type": "string", + "description": "The number of bedrooms." + } + }, + "unitBathrooms": { + "type": "array", + "items": { + "type": "string", + "description": "The number of bathrooms." + } + }, + "minSquareFeet": { + "type": "array", + "items": { + "type": "string", + "description": "The minimum square footage." + } + }, + "maxSquareFeet": { + "type": "array", + "items": { + "type": "string", + "description": "The maximum square footage." + } + }, + "initialRent": { + "type": "array", + "items": { + "type": "string", + "description": "The initial rent." + } + }, + "marketRent": { + "type": "array", + "items": { + "type": "string", + "description": "The market rent." + } + }, + "maxOccupants": { + "type": "array", + "items": { + "type": "string", + "description": "The maximum number of occupants." + } + }, + "floorplanId": { + "type": "array", + "items": { + "type": "string", + "description": "The floorplan ID." + } + }, + "floorplanName": { + "type": "array", + "items": { + "type": "string", + "description": "The floorplan name." + } + }, + "squareFootType": { + "type": "string", + "description": "The type of square footage.", + "example": "internal" + }, + "unitEconomicStatus": { + "type": "string", + "description": "The economic status of the unit.", + "example": "residential" + }, + "unitOccupancyStatus": { + "type": "string", + "description": "The occupancy status of the unit.", + "example": "vacant" + }, + "unitLeasedStatus": { + "type": "string", + "description": "The leased status of the unit.", + "example": "leased" + } + } + }, + "desiredMinRent": { + "type": "string", + "description": "The desired minimum rent.", + "example": "400.00" + }, + "desiredMaxRent": { + "type": "string", + "description": "The desired maximum rent.", + "example": "32854.00" + }, + "desiredNumBedrooms": { + "type": "array", + "items": { + "type": "string", + "description": "The desired number of bedrooms." + } + }, + "desiredNumBathrooms": { + "type": "array", + "items": { + "type": "string", + "description": "The desired number of bathrooms." + } + }, + "desiredLeaseTerms": { + "type": "string", + "description": "The desired lease terms.", + "example": "8" + }, + "desiredLeaseTermName": { + "type": "string", + "description": "The name of the lease term.", + "example": "8 months" + }, + "numberOfOccupants": { + "type": "string", + "description": "The number of occupants.", + "example": "1" + }, + "amenities": { + "type": "object", + "properties": { + "propertyAmenities": { + "type": "object", + "required": [ + "amenity" + ], + "properties": { + "amenity": { + "type": "array", + "items": { + "type": "object", + "required": [ + "amenityType", + "amenity" + ], + "properties": { + "amenityType": { + "type": "string", + "description": "The type of amenity.", + "example": "Apartment" + }, + "amenity": { + "type": "string", + "description": "The amenity itself.", + "example": "123" + }, + "description": { + "type": "string", + "description": "The description of the amenity.", + "example": "AMENITY DESCRIPTION" + } + } + } + } + } + } + } + }, + "pets": { + "type": "object", + "properties": { + "pet": { + "type": "array", + "items": { + "type": "object", + "properties": { + "petType": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The types of pets." + }, + "count": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The number of pets." + } + } + } + } + } + } + } + }, + "events": { + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "array", + "items": { + "type": "object", + "required": [ + "eventId", + "type", + "date" + ], + "properties": { + "eventId": { + "type": "string", + "description": "The event ID.", + "example": "1234" + }, + "type": { + "type": "string", + "description": "The type of event.", + "example": "Email - Outgoing" + }, + "typeId": { + "type": "string", + "description": "The event type ID.", + "example": "2" + }, + "leaseId": { + "type": "string", + "description": "The lease ID.", + "example": "123456" + }, + "leaseIntervalId": { + "type": "string", + "description": "The lease interval ID.", + "example": "123456" + }, + "applicantId": { + "type": "string", + "description": "The applicant ID.", + "example": "123456" + }, + "comments": { + "type": "string", + "description": "Additional comments related to the event.", + "example": "COMMENTS" + }, + "eventReasons": { + "type": "string", + "description": "Reasons for the event.", + "example": "INTERESTED" + }, + "date": { + "type": "string", + "description": "The date of the event.", + "example": "YYYY-MM-DD" + }, + "appointmentDate": { + "type": "string", + "description": "The appointment date.", + "example": "YYYY-MM-DD" + }, + "timeFrom": { + "type": "string", + "description": "Start time of the event.", + "example": "15:30:00" + }, + "timeTo": { + "type": "string", + "description": "End time of the event.", + "example": "16:00:00" + }, + "eventResultId": { + "type": "string", + "description": "The event result ID.", + "example": "2910914" + }, + "eventResult": { + "type": "string", + "description": "The result of the event.", + "example": "Success" + }, + "callData": { + "type": "object", + "properties": { + "callId": { + "type": "string", + "description": "The call ID.", + "example": "64744370" + }, + "callFrom": { + "type": "string", + "description": "The phone number the call was from.", + "example": "1234567890" + }, + "ringThrough": { + "type": "string", + "description": "The phone number that rang through.", + "example": "1234567890" + }, + "duration": { + "type": "string", + "description": "The call duration.", + "example": "37" + }, + "callStatus": { + "type": "string", + "description": "The status of the call.", + "example": "Unanswered" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeadEventsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "prospects": { + "type": "object", + "description": "Prospects related to the request.", + "properties": { + "prospect": { + "type": "array", + "description": "Array of prospects", + "items": { + "type": "object", + "required": [ + "applicationId", + "events" + ], + "properties": { + "applicationId": { + "type": "string", + "description": "The unique ID for the application.", + "example": "17851835" + }, + "events": { + "type": "object", + "description": "Events associated with the prospect.", + "properties": { + "event": { + "type": "array", + "description": "A list of events related to the prospect.", + "items": { + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The unique ID for the event.", + "example": "123456" + }, + "typeId": { + "type": "string", + "description": "The type ID of the event.", + "example": "17" + }, + "leaseId": { + "type": "integer", + "description": "The unique ID for the lease.", + "example": 123456 + }, + "leaseIntervalId": { + "type": "integer", + "description": "The lease interval ID.", + "example": 123456 + }, + "applicantId": { + "type": "string", + "description": "The unique ID for the applicant.", + "example": "123456" + }, + "date": { + "type": "string", + "description": "The date of the event.", + "example": "2019-09-20" + }, + "type": { + "type": "string", + "description": "The type of event.", + "example": "Scheduled Appointment" + }, + "appointmentDate": { + "type": "string", + "description": "The scheduled appointment date.", + "example": "2019-09-15" + }, + "timeFrom": { + "type": "string", + "description": "The start time of the event.", + "example": "23:30:00" + }, + "timeTo": { + "type": "string", + "description": "The end time of the event.", + "example": "01:00:00" + }, + "eventResultId": { + "type": "integer", + "description": "The ID of the event result.", + "example": 2342 + }, + "eventResult": { + "type": "string", + "description": "The result of the event.", + "example": "Completed" + }, + "eventReason": { + "type": "string", + "description": "The reason for the event.", + "example": "Schedule Appointment on 09/15/2019 from 11:30 PM MDT to 01:00 AM MDT" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "applyQuoteSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "status": { + "type": "string", + "description": "The status of the request.", + "example": "Success" + }, + "quoteId": { + "type": "string", + "description": "The unique ID of the quote.", + "example": "123" + }, + "message": { + "type": "string", + "description": "Message providing additional details about the result.", + "example": "Quote applied successfully" + } + } + } + } + }, + "generateQuotesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": "300" + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "quotes": { + "type": "object", + "description": "The quotes associated with the request.", + "properties": { + "quote": { + "type": "array", + "description": "A list of quotes.", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "The identifier for the quote node.", + "example": "1" + }, + "status": { + "type": "string", + "description": "The status of the quote generation.", + "example": "Success" + }, + "quoteId": { + "type": "string", + "description": "The unique ID for the quote.", + "example": "123" + }, + "message": { + "type": "string", + "description": "Message providing additional details about the quote.", + "example": "Quote generated successfully." + } + } + } + } + } + } + } + } + } + }, + "getLeadPickLists_r1_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "description": "The response data containing request information and result.", + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "EventTypes": { + "type": "object", + "description": "The event types associated with the request.", + "properties": { + "EventType": { + "type": "array", + "description": "A list of event types.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the event type.", + "properties": { + "name": { + "type": "string", + "description": "The name of the event.", + "example": "Application" + }, + "Id": { + "type": "integer", + "description": "The unique ID of the event.", + "example": 131 + }, + "entrataName": { + "type": "string", + "description": "The name of the event in the system.", + "example": "Add Applicant Application" + } + } + } + } + } + } + } + }, + "Property": { + "type": "object", + "description": "Properties associated with the request.", + "properties": { + "18462": { + "type": "object", + "description": "Property with ID 18462.", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the property.", + "properties": { + "Id": { + "type": "integer", + "description": "The unique ID for the property.", + "example": 18462 + } + } + }, + "LeasingAgents": { + "type": "object", + "description": "Leasing agents associated with the property.", + "properties": { + "LeasingAgent": { + "type": "array", + "description": "A list of leasing agents.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the leasing agent.", + "properties": { + "name": { + "type": "string", + "description": "The name of the leasing agent.", + "example": "Abby Stevens" + }, + "Id": { + "type": "string", + "description": "The unique ID for the leasing agent.", + "example": "175141" + } + } + } + } + } + } + } + }, + "LeadSources": { + "type": "object", + "description": "Lead sources associated with the property.", + "properties": { + "LeadSource": { + "type": "array", + "description": "A list of lead sources.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the lead source.", + "properties": { + "name": { + "type": "string", + "description": "The name of the lead source.", + "example": "Apartment Advisor" + }, + "Id": { + "type": "integer", + "description": "The unique ID for the lead source.", + "example": 68509 + }, + "WebVisible": { + "type": "string", + "description": "Indicates if the lead source is visible on the web.", + "example": "true" + } + } + } + } + } + } + } + } + } + } + } + }, + "EventResults": { + "type": "object", + "description": "Event results associated with the request.", + "properties": { + "EventResult": { + "type": "array", + "description": "A list of event results.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the event result.", + "example": "Cancelled" + }, + "Id": { + "type": "integer", + "description": "The unique ID of the event result.", + "example": 57024 + } + } + } + } + } + }, + "LeadStatuses": { + "type": "object", + "description": "Lead statuses associated with the request.", + "properties": { + "LeadStatus": { + "type": "array", + "description": "A list of lead statuses.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the lead status.", + "properties": { + "Id": { + "type": "integer", + "description": "The unique ID for the lead status.", + "example": 21 + }, + "name": { + "type": "string", + "description": "The name of the lead status.", + "example": "Renewal Proposal Generated" + }, + "leaseIntervalTypeName": { + "type": "string", + "description": "The type of lease interval.", + "example": "Renewal" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeadPickLists_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "eventTypes": { + "type": "object", + "description": "The event types associated with the request.", + "properties": { + "eventType": { + "type": "array", + "description": "A list of event types.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the event type.", + "properties": { + "name": { + "type": "string", + "description": "The name of the event.", + "example": "Application" + }, + "id": { + "type": "string", + "description": "The unique ID of the event.", + "example": "131" + }, + "entrataName": { + "type": "string", + "description": "The name of the event in the system.", + "example": "Add Applicant Application" + } + } + } + } + } + } + } + }, + "eventSubTypes": { + "type": "object", + "description": "The event subtypes associated with the request.", + "properties": { + "eventSubType": { + "type": "array", + "description": "A list of event subtypes.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the event subtype.", + "properties": { + "name": { + "type": "string", + "description": "The name of the event subtype.", + "example": "Leasing Appointments" + }, + "id": { + "type": "string", + "description": "The unique ID of the event subtype.", + "example": "453" + }, + "eventTypeId": { + "type": "string", + "description": "The ID of the related event type.", + "example": "17" + } + } + } + } + } + } + } + }, + "property": { + "type": "object", + "description": "The property data associated with the request.", + "properties": { + "leasingAgents": { + "type": "object", + "description": "Leasing agents associated with the property.", + "properties": { + "leasingAgent": { + "type": "array", + "description": "A list of leasing agents.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the leasing agent.", + "properties": { + "name": { + "type": "string", + "description": "The name of the leasing agent.", + "example": "Carter Babb" + }, + "id": { + "type": "string", + "description": "The unique ID of the leasing agent.", + "example": "315879" + } + } + } + } + } + } + } + }, + "quoteProvisions": { + "type": "object", + "description": "Quote provisions associated with the property.", + "properties": { + "quoteProvision": { + "type": "array", + "description": "A list of quote provisions.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the quote provision.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the quote provision.", + "example": "1193" + }, + "name": { + "type": "string", + "description": "The name of the quote provision.", + "example": "bumper offer, 1 month Airtel-extreme subscription free" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the property.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the property.", + "example": "173769" + } + } + } + } + }, + "eventResults": { + "type": "object", + "description": "Event results associated with the request.", + "properties": { + "eventResult": { + "type": "array", + "description": "A list of event results.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the event result.", + "properties": { + "name": { + "type": "string", + "description": "The name of the event result.", + "example": "check-in custom" + }, + "id": { + "type": "string", + "description": "The unique ID of the event result.", + "example": "2894233" + }, + "eventTypeId": { + "type": "string", + "description": "The ID of the related event type.", + "example": "9" + }, + "defaultEventResultId": { + "type": "string", + "description": "The ID of the default event result.", + "example": "83" + }, + "defaultEventResult": { + "type": "string", + "description": "The name of the default event result.", + "example": "Check - In" + } + } + } + } + } + } + } + }, + "leadStatuses": { + "type": "object", + "description": "Lead statuses associated with the request.", + "properties": { + "leadStatus": { + "type": "array", + "description": "A list of lead statuses.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the lead status.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the lead status.", + "example": "21" + }, + "name": { + "type": "string", + "description": "The name of the lead status.", + "example": "Renewal Proposal Generated" + }, + "leaseIntervalTypeName": { + "type": "string", + "description": "The type of lease interval.", + "example": "Renewal" + } + } + } + } + } + } + } + }, + "psProducts": { + "type": "object", + "description": "PS products associated with the request.", + "properties": { + "psProduct": { + "type": "array", + "description": "A list of PS products.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the PS product.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the PS product.", + "example": "7" + }, + "name": { + "type": "string", + "description": "The name of the PS product.", + "example": "API Services" + } + } + } + } + } + } + } + }, + "listItemTypes": { + "type": "object", + "description": "List item types associated with the request.", + "properties": { + "listItemType": { + "type": "array", + "description": "A list of list item types.", + "items": { + "type": "object", + "properties": { + "listItems": { + "type": "object", + "description": "The list items associated with the list item type.", + "properties": { + "listItem": { + "type": "array", + "description": "A list of list items.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the list item.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the list item.", + "example": "134417" + }, + "name": { + "type": "string", + "description": "The name of the list item.", + "example": "Archived" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the list item type.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the list item type.", + "example": "9" + }, + "name": { + "type": "string", + "description": "The name of the list item type.", + "example": "Lead Archive Reasons" + } + } + } + } + } + } + } + }, + "customerRelationshipTypes": { + "type": "object", + "description": "Customer relationship types associated with the request.", + "properties": { + "customerRelationshipType": { + "type": "array", + "description": "A list of customer relationship types.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the customer relationship type.", + "properties": { + "id": { + "type": "string", + "description": "The unique ID of the customer relationship type.", + "example": "18385" + }, + "name": { + "type": "string", + "description": "The name of the customer relationship type.", + "example": "Primary" + }, + "isDefault": { + "type": "string", + "description": "Indicates if the customer relationship type is the default.", + "example": "true" + }, + "customerType": { + "type": "string", + "description": "The type of customer.", + "example": "Primary" + }, + "customerTypeId": { + "type": "string", + "description": "The unique ID of the customer type.", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + }, + "getMitsLeadsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "CurrencyCode": { + "type": "string", + "description": "The currency code used in the request.", + "example": "USD" + }, + "LeadManagement": { + "type": "array", + "description": "A list of lead management entries.", + "items": { + "type": "object", + "properties": { + "Prospects": { + "type": "object", + "description": "The prospects associated with the lead management.", + "properties": { + "Prospect": { + "type": "array", + "description": "A list of prospects.", + "items": { + "type": "object", + "properties": { + "TransactionData": { + "type": "object", + "description": "Transaction-related data for the prospect.", + "properties": { + "Identification": { + "type": "array", + "description": "A list of identification details for the transaction.", + "items": { + "type": "object", + "properties": { + "IDValue": { + "type": "string", + "description": "The unique identifier for the transaction.", + "example": "19760815_17390875" + }, + "Status": { + "type": "string", + "description": "The status of the transaction.", + "example": "Guest Card Completed" + }, + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "The type of identification.", + "example": "Lead Number" + }, + "IDScopeType": { + "type": "string", + "description": "The scope of the identification.", + "example": "sender" + } + } + } + } + } + } + } + }, + "LastUpdateDate": { + "type": "string", + "description": "The date when the prospect was last updated.", + "example": "2019-02-20T08:07:53" + }, + "Customers": { + "type": "object", + "description": "Customer-related information.", + "properties": { + "Customer": { + "type": "object", + "properties": { + "Identification": { + "type": "array", + "description": "A list of identification details for the customer.", + "items": { + "type": "object", + "properties": { + "IDValue": { + "type": "string", + "description": "The unique identifier for the customer.", + "example": "19760815" + }, + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "The type of identification.", + "example": "Applicant Id" + }, + "IDScopeType": { + "type": "string", + "description": "The scope of the identification.", + "example": "sender" + } + } + } + } + } + }, + "Name": { + "type": "object", + "description": "The name of the customer.", + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the customer.", + "example": "Sdsad" + }, + "LastName": { + "type": "string", + "description": "The last name of the customer.", + "example": "Asdsa" + } + } + }, + "Phone": { + "type": "object", + "description": "The phone number of the customer.", + "properties": { + "PhoneNumber": { + "type": "string", + "description": "The phone number.", + "example": "2213213123" + }, + "@attributes": { + "type": "object", + "properties": { + "PhoneType": { + "type": "string", + "description": "The type of phone number.", + "example": "cell" + } + } + } + } + } + } + } + } + }, + "CustomerPreferences": { + "type": "object", + "description": "Customer preferences related to the lead.", + "properties": { + "TargetMoveInDate": { + "type": "string", + "description": "The target move-in date for the customer.", + "example": "2019-02-20" + }, + "DesiredLeaseTerms": { + "type": "string", + "description": "The desired lease terms.", + "example": "10" + }, + "DesiredLeaseTermName": { + "type": "string", + "description": "The name of the desired lease term.", + "example": "10 Months" + }, + "Amenities": { + "type": "array", + "description": "A list of customer amenities.", + "items": { + "type": "object", + "properties": { + "Description": { + "type": "string", + "description": "The description of the amenity.", + "example": "Abhishek_test_amenities" + }, + "@attributes": { + "type": "object", + "properties": { + "AmenityType": { + "type": "string", + "description": "The type of amenity.", + "example": "Other" + } + } + } + } + } + } + } + }, + "Events": { + "type": "object", + "description": "A list of events associated with the lead.", + "properties": { + "Event": { + "type": "array", + "description": "A list of events.", + "items": { + "type": "object", + "properties": { + "EventID": { + "type": "object", + "description": "Event identification details.", + "properties": { + "Identification": { + "type": "array", + "description": "A list of identification details for the event.", + "items": { + "type": "object", + "properties": { + "IDValue": { + "type": "string", + "description": "The unique identifier for the event.", + "example": "147128113" + }, + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "The type of identification.", + "example": "Event Id" + }, + "IDScopeType": { + "type": "string", + "description": "The scope of the identification.", + "example": "sender" + } + } + } + } + } + } + } + }, + "Agent": { + "type": "object", + "description": "The agent related to the event.", + "properties": { + "AgentID": { + "type": "object", + "properties": { + "Identification": { + "type": "object", + "properties": { + "IDValue": { + "type": "string", + "description": "The unique identifier for the agent.", + "example": "513102" + }, + "@attributes": { + "type": "object", + "properties": { + "IDType": { + "type": "string", + "description": "The type of agent identification.", + "example": "Agent Id" + }, + "IDScopeType": { + "type": "string", + "description": "The scope of agent identification.", + "example": "sender" + } + } + } + } + } + } + }, + "AgentName": { + "type": "object", + "properties": { + "FirstName": { + "type": "string", + "description": "The first name of the agent.", + "example": "testa" + }, + "LastName": { + "type": "string", + "description": "The last name of the agent.", + "example": "ygyugu" + } + } + } + } + }, + "Comments": { + "type": "string", + "description": "Comments related to the event.", + "example": "TestEast" + }, + "EventReasons": { + "type": "string", + "description": "The reasons for the event.", + "example": "Manual Contact added by Contact Points because Guest Card is submitted" + }, + "@attributes": { + "type": "object", + "properties": { + "EventType": { + "type": "string", + "description": "The type of the event.", + "example": "Appointment" + }, + "EventDate": { + "type": "string", + "description": "The date and time of the event.", + "example": "2019-02-20T08:10:27" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getQuotesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "currencyCode": { + "type": "string", + "description": "The currency code used in the request.", + "example": "USD" + }, + "applications": { + "type": "object", + "description": "The applications associated with the request.", + "properties": { + "application": { + "type": "array", + "description": "A list of application entries.", + "items": { + "type": "object", + "properties": { + "applicationId": { + "type": "string", + "description": "The unique identifier for the application.", + "example": "123456" + }, + "applicationStatusId": { + "type": "string", + "description": "The status ID of the application.", + "example": "1" + }, + "applicationStatus": { + "type": "string", + "description": "The status of the application.", + "example": "Started" + }, + "quotes": { + "type": "object", + "description": "The list of quotes associated with the application.", + "properties": { + "quote": { + "type": "array", + "description": "A list of quotes.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the quote.", + "example": "123456" + }, + "moveInDate": { + "type": "string", + "description": "The move-in date for the quoted lease.", + "example": "2020-05-13" + }, + "createdOn": { + "type": "string", + "description": "The date and time when the quote was created.", + "example": "2020-05-13 07:03:25" + }, + "acceptedOn": { + "type": "string", + "description": "The date when the quote was accepted.", + "example": "2020-05-13" + }, + "expiresOn": { + "type": "string", + "description": "The expiration date of the quote.", + "example": "2020-05-14 07:03:25" + }, + "isSelected": { + "type": "string", + "description": "Indicates whether the quote is selected.", + "example": "1" + }, + "buildingId": { + "type": "string", + "description": "The unique identifier for the building.", + "example": "12345" + }, + "buildingName": { + "type": "string", + "description": "The name of the building.", + "example": "Building B" + }, + "floorPlanId": { + "type": "string", + "description": "The unique identifier for the floor plan.", + "example": "12345" + }, + "floorPlanName": { + "type": "string", + "description": "The name of the floor plan.", + "example": "Three Bedroom" + }, + "unitNumber": { + "type": "string", + "description": "The unit number for the quoted lease.", + "example": "12" + }, + "numberOfBedRooms": { + "type": "string", + "description": "The number of bedrooms in the unit.", + "example": "3" + }, + "numberOfBathRooms": { + "type": "string", + "description": "The number of bathrooms in the unit.", + "example": "2.0000" + }, + "leaseTerms": { + "type": "object", + "description": "The lease terms for the quote.", + "properties": { + "leaseTerm": { + "type": "array", + "description": "A list of lease terms.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the lease term.", + "example": "3" + }, + "termMonth": { + "type": "string", + "description": "The duration of the lease in months.", + "example": "12" + }, + "quoteAmount": { + "type": "string", + "description": "The quote amount for the lease.", + "example": "5419.00" + } + } + } + } + } + }, + "quoteProvisions": { + "type": "object", + "description": "The provisions or discounts available for the quote.", + "properties": { + "quoteProvision": { + "type": "array", + "description": "A list of quote provisions.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the quote provision.", + "example": "1937" + }, + "name": { + "type": "string", + "description": "The name of the quote provision.", + "example": "50% discount till jun 2024" + } + } + } + } + } + }, + "optionalItems": { + "type": "object", + "description": "The list of optional items for the lease.", + "properties": { + "optionalItem": { + "type": "array", + "description": "A list of optional items.", + "items": { + "type": "object", + "properties": { + "addOnTypeId": { + "type": "string", + "description": "The unique identifier for the add-on type.", + "example": "2" + }, + "name": { + "type": "string", + "description": "The name of the optional item.", + "example": "Appliances" + }, + "type": { + "type": "string", + "description": "The type of the optional item.", + "example": "Appliances" + }, + "currentRate": { + "type": "string", + "description": "The current rate for the optional item.", + "example": "60.00" + }, + "deposit": { + "type": "string", + "description": "The deposit amount for the optional item.", + "example": "89.00" + }, + "reservationFee": { + "type": "string", + "description": "The reservation fee for the optional item.", + "example": "78.00" + } + } + } + } + } + }, + "services": { + "type": "object", + "description": "The list of services available with the lease.", + "properties": { + "service": { + "type": "array", + "description": "A list of services.", + "items": { + "type": "object", + "properties": { + "addOnTypeId": { + "type": "string", + "description": "The unique identifier for the add-on service.", + "example": "3" + }, + "name": { + "type": "string", + "description": "The name of the service.", + "example": "Meal Plans" + }, + "type": { + "type": "string", + "description": "The type of the service.", + "example": "Meal Plans" + }, + "currentRate": { + "type": "string", + "description": "The current rate for the service.", + "example": "98.00" + }, + "deposit": { + "type": "string", + "description": "The deposit for the service.", + "example": "30.00" + }, + "reservationFee": { + "type": "string", + "description": "The reservation fee for the service.", + "example": "80.00" + } + } + } + } + } + }, + "pets": { + "type": "object", + "description": "The list of pets allowed with the lease.", + "properties": { + "pet": { + "type": "array", + "description": "A list of pets.", + "items": { + "type": "object", + "properties": { + "petTypeId": { + "type": "string", + "description": "The unique identifier for the pet type.", + "example": "184368" + }, + "petType": { + "type": "string", + "description": "The type of pet.", + "example": "german shepherd" + } + } + } + } + } + }, + "charges": { + "type": "object", + "description": "The list of charges associated with the lease.", + "properties": { + "charge": { + "type": "array", + "description": "A list of charges.", + "items": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "description": "The pricing level ID.", + "example": 4 + }, + "pricingLevel": { + "type": "string", + "description": "The pricing level.", + "example": "Space" + }, + "pricingLevelReferenceId": { + "type": "integer", + "description": "The reference ID for the pricing level.", + "example": 5563869 + }, + "chargeUsageId": { + "type": "integer", + "description": "The charge usage ID.", + "example": 1 + }, + "chargeUsage": { + "type": "string", + "description": "The usage of the charge.", + "example": "Base" + }, + "chargeTimingId": { + "type": "integer", + "description": "The timing ID for the charge.", + "example": 202 + }, + "chargeTiming": { + "type": "string", + "description": "The timing for the charge.", + "example": "Move-In" + }, + "chargeCodeTypeId": { + "type": "integer", + "description": "The charge code type ID.", + "example": 7 + }, + "chargeCodeType": { + "type": "string", + "description": "The charge code type.", + "example": "Deposit" + }, + "chargeCodeId": { + "type": "integer", + "description": "The charge code ID.", + "example": 245694 + }, + "chargeCode": { + "type": "string", + "description": "The charge code.", + "example": "Deposit" + }, + "chargeAmount": { + "type": "string", + "description": "The charge amount.", + "example": "100.00" + }, + "taxAmount": { + "type": "string", + "description": "The tax amount associated with the charge.", + "example": "0.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendLeadsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response code indicating the result.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "prospects": { + "type": "object", + "description": "Information about the prospects.", + "properties": { + "prospect": { + "type": "array", + "description": "A list of prospect entries.", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "A node identifier for the prospect.", + "example": "1" + }, + "applicationId": { + "type": "string", + "description": "The unique identifier for the application.", + "example": "18112280" + }, + "applicantId": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "20429586" + }, + "status": { + "type": "string", + "description": "The status of the prospect.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "A message associated with the prospect.", + "example": "Lead inserted successfully." + }, + "applicants": { + "type": "object", + "description": "Information about the applicants.", + "properties": { + "applicant": { + "type": "array", + "description": "A list of applicants.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "20429586" + }, + "firstName": { + "type": "string", + "description": "The first name of the applicant.", + "example": "Gail" + }, + "lastName": { + "type": "string", + "description": "The last name of the applicant.", + "example": "Norberto" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendMitsLeadsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "Prospects": { + "type": "object", + "description": "Information about the prospects.", + "properties": { + "Prospect": { + "type": "array", + "description": "A list of prospect entries.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the prospect.", + "properties": { + "node": { + "type": "string", + "description": "A node identifier for the prospect.", + "example": "1" + }, + "reference_id": { + "type": "string", + "description": "The unique identifier for the reference.", + "example": "1253581" + }, + "applicant_id": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "1246084" + }, + "status": { + "type": "string", + "description": "The status of the prospect.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "A message associated with the prospect.", + "example": "Lead inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateLeads_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "Prospects": { + "type": "object", + "description": "Information about the prospects.", + "properties": { + "Prospect": { + "type": "array", + "description": "A list of prospect entries.", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the prospect.", + "properties": { + "node": { + "type": "string", + "description": "A node identifier for the prospect.", + "example": "1" + }, + "reference_id": { + "type": "string", + "description": "The unique identifier for the reference.", + "example": "123456" + }, + "applicant_id": { + "type": "string", + "description": "The unique identifier for the applicant.", + "example": "12345" + }, + "status": { + "type": "string", + "description": "The status of the prospect.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "A message associated with the prospect.", + "example": "Lead updated successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateLeads_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response status code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "prospects": { + "type": "array", + "description": "A list of prospects with their status and message.", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "A node identifier for the prospect.", + "example": "1" + }, + "status": { + "type": "string", + "description": "The status of the prospect.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "A message associated with the prospect.", + "example": "Lead updated successfully." + } + } + } + } + } + } + } + }, + "cancelLeaseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "The response status code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result data of the request.", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation.", + "example": "success" + }, + "message": { + "type": "string", + "description": "A message describing the result of the operation.", + "example": "Lease Cancelled successfully." + } + } + } + } + }, + "getEvictedLeasesSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "evictedLeases" + ], + "properties": { + "evictedLeases": { + "type": "object", + "required": [ + "summary", + "propertyFiles" + ], + "properties": { + "summary": { + "type": "object", + "required": [ + "generationTimeStamp", + "SourceOrganization", + "totalProperties", + "totalLeaseFiles", + "TotalTenants", + "TotalOpenAmount" + ], + "properties": { + "generationTimeStamp": { + "type": "string", + "description": "Timestamp when the report was generated.", + "example": "06/28/2017T04:12:23" + }, + "SourceOrganization": { + "type": "string", + "description": "The source organization providing the report.", + "example": "Entrata Inc" + }, + "totalProperties": { + "type": "string", + "description": "Total number of properties.", + "example": "1" + }, + "totalLeaseFiles": { + "type": "string", + "description": "Total number of lease files.", + "example": "37" + }, + "TotalTenants": { + "type": "string", + "description": "Total number of tenants.", + "example": "60" + }, + "TotalOpenAmount": { + "type": "string", + "description": "Total open amount in dollars.", + "example": "688929.50" + } + } + }, + "propertyFiles": { + "type": "object", + "required": [ + "propertyFile" + ], + "properties": { + "propertyFile": { + "type": "object", + "required": [ + "property", + "leaseFiles" + ], + "properties": { + "property": { + "type": "object", + "required": [ + "id", + "name", + "address", + "phone" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the property.", + "example": "123456" + }, + "name": { + "type": "string", + "description": "Name of the property.", + "example": "13th North Parkways Property" + }, + "address": { + "type": "array", + "items": { + "type": "object", + "required": [ + "addressType", + "address", + "city", + "country", + "state", + "postalCode" + ], + "properties": { + "addressType": { + "type": "string", + "description": "Type of address (e.g., Primary).", + "example": "Primary" + }, + "address": { + "type": "string", + "description": "Street address.", + "example": "50 North 100 West" + }, + "city": { + "type": "string", + "description": "City.", + "example": "Provo" + }, + "country": { + "type": "string", + "description": "Country.", + "example": "US" + }, + "state": { + "type": "string", + "description": "State.", + "example": "TX" + }, + "postalCode": { + "type": "string", + "description": "Postal code.", + "example": "89123" + } + } + } + }, + "phone": { + "type": "array", + "items": { + "type": "object", + "required": [ + "phoneType", + "phoneNumber" + ], + "properties": { + "phoneType": { + "type": "string", + "description": "Type of phone (e.g., Office, Other).", + "example": "Office" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number.", + "example": "8019013023" + } + } + } + } + } + }, + "leaseFiles": { + "type": "object", + "required": [ + "leaseFile" + ], + "properties": { + "leaseFile": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseId", + "evictionStatus", + "moveInDate", + "evictionStartDate", + "evictionDate", + "leaseBegin", + "leaseEnd", + "monthlyRentAmount", + "rentDueFromDate", + "rentDueToDate", + "buildingName", + "unit", + "tenants", + "transactions" + ], + "properties": { + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease.", + "example": "5715080" + }, + "evictionStatus": { + "type": "string", + "description": "Status of the eviction (e.g., Evicted).", + "example": "Evicted" + }, + "moveInDate": { + "type": "string", + "description": "Move-in date.", + "example": "06/02/2014" + }, + "evictionStartDate": { + "type": "string", + "description": "Start date of eviction.", + "example": "02/26/2015" + }, + "evictionDate": { + "type": "string", + "description": "Date of eviction.", + "example": "12/03/2015" + }, + "leaseBegin": { + "type": "string", + "description": "Lease start date.", + "example": "06/02/2014" + }, + "leaseEnd": { + "type": "string", + "description": "Lease end date.", + "example": "09/30/2023" + }, + "monthlyRentAmount": { + "type": "string", + "description": "Amount of monthly rent.", + "example": "13.00" + }, + "rentDueFromDate": { + "type": "string", + "description": "Start date for rent due period.", + "example": "06/01/2014" + }, + "rentDueToDate": { + "type": "string", + "description": "End date for rent due period.", + "example": "06/01/2017" + }, + "buildingName": { + "type": "string", + "description": "Name of the building.", + "example": "Live" + }, + "unit": { + "type": "object", + "required": [ + "unitNumber", + "address", + "city", + "country", + "state", + "postalCode" + ], + "properties": { + "unitNumber": { + "type": "string", + "description": "Unit number.", + "example": "MP4-D" + }, + "address": { + "type": "string", + "description": "Unit address.", + "example": "MP,PM" + }, + "city": { + "type": "string", + "description": "City.", + "example": "PMPM" + }, + "country": { + "type": "string", + "description": "Country.", + "example": "US" + }, + "state": { + "type": "string", + "description": "State.", + "example": "AL" + }, + "postalCode": { + "type": "string", + "description": "Postal code.", + "example": "52252" + } + } + }, + "tenants": { + "type": "object", + "required": [ + "tenant" + ], + "properties": { + "tenant": { + "type": "array", + "items": { + "type": "object", + "required": [ + "customerId", + "firstName", + "lastName", + "customerType", + "phone", + "dateOfBirth", + "ssn" + ], + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the tenant.", + "example": "6953693" + }, + "firstName": { + "type": "string", + "description": "First name of the tenant.", + "example": "New" + }, + "lastName": { + "type": "string", + "description": "Last name of the tenant.", + "example": "Lwersafd" + }, + "customerType": { + "type": "string", + "description": "Type of customer (e.g., Primary).", + "example": "Primary" + }, + "phone": { + "type": "array", + "items": { + "type": "object", + "required": [ + "phoneType", + "phoneNumber" + ], + "properties": { + "phoneType": { + "type": "string", + "description": "Type of phone.", + "example": "cell" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number.", + "example": "2133211231" + } + } + } + }, + "dateOfBirth": { + "type": "string", + "description": "Date of birth of the tenant.", + "example": "12/12/1950" + }, + "ssn": { + "type": "string", + "description": "Social Security Number.", + "example": "111223333" + } + } + } + } + } + }, + "transactions": { + "type": "object", + "required": [ + "transaction" + ], + "properties": { + "transaction": { + "type": "array", + "items": { + "type": "object", + "required": [ + "transactionId", + "transactionDate", + "description", + "transactionType", + "transactionAmount", + "openAmount" + ], + "properties": { + "transactionId": { + "type": "string", + "description": "Unique identifier for the transaction.", + "example": "145837339" + }, + "transactionDate": { + "type": "string", + "description": "Date of the transaction.", + "example": "06/01/2017" + }, + "description": { + "type": "string", + "description": "Description of the transaction.", + "example": "Application Fee - Monthly Fee Posted from 06/01/2017 to 06/30/2017" + }, + "transactionType": { + "type": "string", + "description": "Type of the transaction.", + "example": "Charge" + }, + "transactionAmount": { + "type": "string", + "description": "Amount of the transaction.", + "example": "3.00" + }, + "openAmount": { + "type": "string", + "description": "Open amount for the transaction.", + "example": "3.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getExpiringLeasesSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Leases" + ], + "properties": { + "Leases": { + "type": "object", + "required": [ + "Lease" + ], + "properties": { + "Lease": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes", + "Resident", + "LeaseStatus", + "LeaseStarts", + "LeaseExpires" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "integer", + "description": "Unique identifier for the lease.", + "example": 5641482 + } + } + }, + "Resident": { + "type": "object", + "required": [ + "@attributes", + "Name", + "PhoneNumber", + "Address" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "integer", + "description": "Unique identifier for the resident.", + "example": 4940016 + } + } + }, + "Name": { + "type": "string", + "description": "Name of the resident.", + "example": "Sample Name" + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number of the resident.", + "example": "1234567891" + }, + "EmailAddress": { + "type": "string", + "description": "Email address of the resident.", + "example": "sample_name@example.com" + }, + "Address": { + "type": "object", + "required": [ + "StreetLine1", + "City", + "StateCode", + "PostalCode" + ], + "properties": { + "StreetLine1": { + "type": "string", + "description": "First line of the address.", + "example": "Street Line1" + }, + "StreetLine2": { + "type": "string", + "description": "Second line of the address.", + "example": "Street Line1" + }, + "City": { + "type": "string", + "description": "City of the address.", + "example": "City Name" + }, + "StateCode": { + "type": "string", + "description": "State code of the address.", + "example": "AE" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the address.", + "example": "12345" + } + } + } + } + }, + "Unit": { + "type": "string", + "description": "Unit number associated with the lease.", + "example": "14" + }, + "LeaseStatus": { + "type": "string", + "description": "Current status of the lease (e.g., Current, Notice).", + "example": "Current" + }, + "LeaseStarts": { + "type": "string", + "description": "Start date of the lease.", + "example": "02/01/2013" + }, + "LeaseExpires": { + "type": "string", + "description": "Expiration date of the lease.", + "example": "02/27/2013" + }, + "NoticeDate": { + "type": "string", + "description": "Date the notice was given (if applicable).", + "example": "02/11/2014" + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeaseActivitiesSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "events" + ], + "properties": { + "events": { + "type": "array", + "items": { + "type": "object", + "required": [ + "eventId", + "typeId", + "leaseId", + "leaseIntervalId", + "type", + "getDataReferenceId", + "date" + ], + "properties": { + "eventId": { + "type": "integer", + "description": "Unique identifier for the event", + "example": 123456 + }, + "typeId": { + "type": "integer", + "description": "Type identifier for the event", + "example": 3 + }, + "leaseId": { + "type": "integer", + "description": "ID of the associated lease", + "example": 123456 + }, + "leaseIntervalId": { + "type": "integer", + "description": "ID of the lease interval", + "example": 123456 + }, + "type": { + "type": "string", + "description": "Type of the event", + "example": "Call - Incoming" + }, + "subtypeId": { + "type": "integer", + "description": "Subtype identifier for the event", + "example": 123 + }, + "getDataReferenceId": { + "type": "integer", + "description": "Reference ID for getting data", + "example": 123456 + }, + "date": { + "type": "string", + "description": "Date of the event", + "example": "YYYY-MM-DD" + }, + "Comments": { + "type": "string", + "description": "Comments about the event", + "example": "Self-Guided Tour Scheduled" + }, + "eventReasons": { + "type": "string", + "description": "Reasons for the event", + "example": "Outgoing Email to testsf46 test" + }, + "callData": { + "type": "object", + "description": "Call-specific data (only present for call events)", + "properties": { + "callId": { + "type": "string", + "description": "Unique identifier for the call", + "example": "123456" + }, + "callFrom": { + "type": "string", + "description": "Phone number that initiated the call", + "example": "+1334444444" + }, + "ringThrough": { + "type": "string", + "description": "Phone number that received the call", + "example": "+1334444444" + }, + "duration": { + "type": "string", + "description": "Duration of the call", + "example": "25" + }, + "callStatus": { + "type": "string", + "description": "Status of the call", + "example": "Voicemail Left" + }, + "audioLink": { + "type": "string", + "description": "URL to the call audio recording", + "example": "http://test.in" + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeaseDetails_r1_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leaseId", + "name", + "propertyUnitId", + "unitNumber", + "addOns", + "scheduledCharges" + ], + "properties": { + "leaseId": { + "type": "integer", + "description": "Unique identifier for the lease.", + "example": 12345678 + }, + "name": { + "type": "string", + "description": "Name of the resident.", + "example": "Resident Name" + }, + "propertyUnitId": { + "type": "integer", + "description": "Unique identifier for the property unit.", + "example": 4115010 + }, + "unitNumber": { + "type": "string", + "description": "Unit number of the leased property.", + "example": "A-2" + }, + "addOns": { + "type": "object", + "required": [ + "assignableItems", + "rentableItems", + "services" + ], + "properties": { + "assignableItems": { + "type": "object", + "required": [ + "assignableItem" + ], + "properties": { + "assignableItem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "addOnType", + "addOnCategory", + "addOnName", + "leaseStatusType", + "startDate", + "endDate", + "agent" + ], + "properties": { + "addOnType": { + "type": "string", + "description": "Type of the add-on item.", + "example": "Assignable Items" + }, + "addOnCategory": { + "type": "string", + "description": "Category of the add-on.", + "example": "Keys" + }, + "addOnGroup": { + "type": "string", + "description": "Group the add-on belongs to.", + "example": "Keys" + }, + "addOnName": { + "type": "string", + "description": "Name of the add-on item.", + "example": "Keys" + }, + "leaseStatusType": { + "type": "string", + "description": "Lease status of the add-on item.", + "example": "Current" + }, + "startDate": { + "type": "string", + "description": "Start date of the add-on.", + "example": "01/17/2017" + }, + "endDate": { + "type": "string", + "description": "End date of the add-on.", + "example": "05/15/2017" + }, + "agent": { + "type": "string", + "description": "Agent responsible for the add-on.", + "example": "Agent One" + } + } + } + } + } + }, + "rentableItems": { + "type": "object", + "required": [ + "rentableItem" + ], + "properties": { + "rentableItem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "addOnType", + "addOnCategory", + "addOnName", + "leaseStatusType", + "startDate", + "endDate", + "agent" + ], + "properties": { + "addOnType": { + "type": "string", + "description": "Type of the rentable item.", + "example": "Rentable Items" + }, + "addOnCategory": { + "type": "string", + "description": "Category of the rentable item.", + "example": "Garage" + }, + "addOnGroup": { + "type": "string", + "description": "Group the rentable item belongs to.", + "example": "Garage" + }, + "addOnName": { + "type": "string", + "description": "Name of the rentable item.", + "example": "Garage" + }, + "leaseStatusType": { + "type": "string", + "description": "Lease status of the rentable item.", + "example": "Future" + }, + "startDate": { + "type": "string", + "description": "Start date of the rentable item.", + "example": "01/17/2017" + }, + "endDate": { + "type": "string", + "description": "End date of the rentable item.", + "example": "05/15/2017" + }, + "agent": { + "type": "string", + "description": "Agent responsible for the rentable item.", + "example": "Agent One" + } + } + } + } + } + }, + "services": { + "type": "object", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "array", + "items": { + "type": "object", + "required": [ + "addOnType", + "addOnCategory", + "addOnName", + "leaseStatusType", + "startDate", + "endDate", + "agent" + ], + "properties": { + "addOnType": { + "type": "string", + "description": "Type of the service.", + "example": "Services" + }, + "addOnCategory": { + "type": "string", + "description": "Category of the service.", + "example": "Full Furnishing" + }, + "addOnGroup": { + "type": "string", + "description": "Group the service belongs to.", + "example": "Full Furnishing" + }, + "addOnName": { + "type": "string", + "description": "Name of the service.", + "example": "Full Furnishing" + }, + "leaseStatusType": { + "type": "string", + "description": "Lease status of the service.", + "example": "Future" + }, + "startDate": { + "type": "string", + "description": "Start date of the service.", + "example": "01/17/2017" + }, + "endDate": { + "type": "string", + "description": "End date of the service.", + "example": "05/15/2017" + }, + "agent": { + "type": "string", + "description": "Agent responsible for the service.", + "example": "Agent One" + } + } + } + } + } + } + } + }, + "scheduledCharges": { + "type": "object", + "required": [ + "recurringCharge", + "oneTimeCharge", + "conditionalCharge" + ], + "properties": { + "recurringCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseIntervalStatus", + "leaseIntervalType", + "activeScheduledCharges" + ], + "properties": { + "leaseIntervalStatus": { + "type": "string", + "description": "The status of the lease interval.", + "example": "Current" + }, + "leaseIntervalType": { + "type": "string", + "description": "Type of lease interval.", + "example": "Application" + }, + "activeScheduledCharges": { + "type": "object", + "required": [ + "activeScheduledCharge" + ], + "properties": { + "activeScheduledCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "chargeCode", + "chargeTiming", + "chargeUsage", + "chargeStartDate", + "chargeAmount" + ], + "properties": { + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "Bldg Maintenance CAM" + }, + "chargeTiming": { + "type": "string", + "description": "Timing for the charge.", + "example": "Monthly" + }, + "chargeUsage": { + "type": "string", + "description": "Usage of the charge.", + "example": "Base" + }, + "chargeStartDate": { + "type": "string", + "description": "Start date for the charge.", + "example": "05/16/2016" + }, + "chargeEndDate": { + "type": "string", + "description": "End date for the charge.", + "example": "End During Move-Out" + }, + "chargeAmount": { + "type": "string", + "description": "Amount of the charge.", + "example": "$33.00" + } + } + } + } + } + } + } + } + }, + "oneTimeCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseIntervalStatus", + "leaseIntervalType", + "activeScheduledCharges" + ], + "properties": { + "leaseIntervalStatus": { + "type": "string", + "description": "The status of the lease interval.", + "example": "Current" + }, + "leaseIntervalType": { + "type": "string", + "description": "Type of lease interval.", + "example": "Application" + }, + "activeScheduledCharges": { + "type": "object", + "required": [ + "activeScheduledCharge" + ], + "properties": { + "activeScheduledCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "chargeCode", + "chargeTiming", + "chargeUsage", + "chargeStartDate", + "chargeAmount" + ], + "properties": { + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "123 Rent" + }, + "chargeTiming": { + "type": "string", + "description": "Timing for the charge.", + "example": "Renewal Start" + }, + "chargeUsage": { + "type": "string", + "description": "Usage of the charge.", + "example": "Base" + }, + "chargeStartDate": { + "type": "string", + "description": "Start date for the charge.", + "example": "01/17/2017" + }, + "chargeAmount": { + "type": "string", + "description": "Amount of the charge.", + "example": "$10.00" + } + } + } + } + } + } + } + } + }, + "conditionalCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseIntervalStatus", + "leaseIntervalType", + "activeScheduledCharges" + ], + "properties": { + "leaseIntervalStatus": { + "type": "string", + "description": "The status of the lease interval.", + "example": "Current" + }, + "leaseIntervalType": { + "type": "string", + "description": "Type of lease interval.", + "example": "Application" + }, + "activeScheduledCharges": { + "type": "object", + "required": [ + "activeScheduledCharge" + ], + "properties": { + "activeScheduledCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "chargeCode", + "chargeTiming", + "chargeUsage", + "chargeStartDate", + "chargeAmount" + ], + "properties": { + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "10aug" + }, + "chargeUsage": { + "type": "string", + "description": "Usage of the charge.", + "example": "Base" + }, + "chargeStartDate": { + "type": "string", + "description": "Start date for the charge.", + "example": "01/17/2017" + }, + "chargeAmount": { + "type": "string", + "description": "Amount of the charge.", + "example": "$10.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeaseDetails_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leases" + ], + "properties": { + "leases": { + "type": "object", + "required": [ + "lease" + ], + "properties": { + "lease": { + "type": "object", + "required": [ + "leaseId", + "name", + "propertyUnitId", + "unitNumber", + "addOns", + "scheduledCharges" + ], + "properties": { + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease.", + "example": "12269740" + }, + "name": { + "type": "string", + "description": "Name of the resident.", + "example": "Ggkl Kkkkk" + }, + "propertyUnitId": { + "type": "string", + "description": "Unique identifier for the property unit.", + "example": "3980420" + }, + "unitNumber": { + "type": "string", + "description": "Unit number of the leased property.", + "example": "6285-D" + }, + "addOns": { + "type": "object", + "required": [ + "rentableItems" + ], + "properties": { + "rentableItems": { + "type": "object", + "required": [ + "rentableItem" + ], + "properties": { + "rentableItem": { + "type": "object", + "required": [ + "addOnId", + "addOnType", + "addOnCategory", + "addOnGroup", + "addOnName", + "leaseStatusType", + "startDate", + "endDate", + "agent" + ], + "properties": { + "addOnId": { + "type": "integer", + "description": "Unique identifier for the add-on.", + "example": 85993 + }, + "addOnType": { + "type": "string", + "description": "Type of the rentable item.", + "example": "Rentable Items" + }, + "addOnCategory": { + "type": "string", + "description": "Category of the rentable item.", + "example": "Furniture" + }, + "addOnGroup": { + "type": "string", + "description": "Group of the rentable item.", + "example": "Furniture" + }, + "addOnName": { + "type": "string", + "description": "Name of the rentable item.", + "example": "love sack" + }, + "leaseStatusType": { + "type": "string", + "description": "Status of the lease for this item.", + "example": "Past" + }, + "startDate": { + "type": "string", + "description": "Start date of the add-on.", + "example": "12/08/2013" + }, + "endDate": { + "type": "string", + "description": "End date of the add-on.", + "example": "12/31/1969" + }, + "agent": { + "type": "string", + "description": "Agent responsible for the add-on.", + "example": "sanjay dhakad" + } + } + } + } + } + } + }, + "scheduledCharges": { + "type": "object", + "required": [ + "recurringCharge", + "oneTimeCharge" + ], + "properties": { + "recurringCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseIntervalId", + "leaseIntervalStatus", + "leaseIntervalType", + "leaseStartDate", + "leaseEndDate" + ], + "properties": { + "leaseIntervalId": { + "type": "string", + "description": "Unique identifier for the lease interval.", + "example": "123456" + }, + "leaseIntervalStatus": { + "type": "string", + "description": "Status of the lease interval.", + "example": "Notice" + }, + "leaseIntervalType": { + "type": "string", + "description": "Type of lease interval.", + "example": "Month to Month" + }, + "leaseStartDate": { + "type": "string", + "description": "Start date of the lease interval.", + "example": "08/01/2017" + }, + "leaseEndDate": { + "type": "string", + "description": "End date of the lease interval.", + "example": "11/09/2017" + } + } + } + }, + "oneTimeCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseIntervalId", + "leaseIntervalStatus", + "leaseIntervalType", + "leaseStartDate", + "leaseEndDate" + ], + "properties": { + "leaseIntervalId": { + "type": "string", + "description": "Unique identifier for the lease interval.", + "example": "123456" + }, + "leaseIntervalStatus": { + "type": "string", + "description": "Status of the lease interval.", + "example": "Notice" + }, + "leaseIntervalType": { + "type": "string", + "description": "Type of lease interval.", + "example": "Month to Month" + }, + "leaseStartDate": { + "type": "string", + "description": "Start date of the lease interval.", + "example": "08/01/2017" + }, + "leaseEndDate": { + "type": "string", + "description": "End date of the lease interval.", + "example": "11/09/2017" + } + } + } + }, + "installment": { + "type": "object", + "required": [ + "installmentName", + "installmentStartDate", + "installmentEndDate", + "charges" + ], + "properties": { + "installmentName": { + "type": "string", + "description": "Name of the installment.", + "example": "1st Half" + }, + "installmentStartDate": { + "type": "string", + "description": "Start date of the installment.", + "example": "08/01/2016" + }, + "installmentEndDate": { + "type": "string", + "description": "End date of the installment.", + "example": "01/31/2017" + }, + "charges": { + "type": "object", + "required": [ + "charge" + ], + "properties": { + "charge": { + "type": "object", + "required": [ + "arCodeId", + "chargeCode", + "chargeTiming", + "chargeUsage", + "chargeStartDate", + "chargeAmount" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "The AR code identifier.", + "example": "120044" + }, + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "HarishRent" + }, + "chargeTiming": { + "type": "string", + "description": "When the charge is applied.", + "example": "Monthly" + }, + "chargeUsage": { + "type": "string", + "description": "Usage type of the charge.", + "example": "Amenity" + }, + "chargeStartDate": { + "type": "string", + "description": "Start date of the charge.", + "example": "08/01/2016" + }, + "chargeEndDate": { + "type": "string", + "description": "End date of the charge.", + "example": "01/31/2017" + }, + "chargeAmount": { + "type": "string", + "description": "Amount for the charge.", + "example": "$222.00" + } + } + }, + "activeScheduledCharges": { + "type": "object", + "required": [ + "activeScheduledCharge" + ], + "properties": { + "activeScheduledCharge": { + "type": "object", + "required": [ + "arCodeId", + "chargeCode", + "chargeTiming", + "chargeAmount" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "The AR code identifier.", + "example": "1858" + }, + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "AR's Rent" + }, + "chargeTiming": { + "type": "string", + "description": "When the charge is applied.", + "example": "Monthly" + }, + "chargeAmount": { + "type": "string", + "description": "Amount for the charge.", + "example": "$10.00" + } + } + } + } + }, + "pastScheduledCharges": { + "type": "object", + "required": [ + "pastScheduledCharge" + ], + "properties": { + "pastScheduledCharge": { + "type": "object", + "required": [ + "arCodeId", + "chargeCode", + "chargeTiming", + "chargeAmount" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "The AR code identifier.", + "example": "120044" + }, + "chargeCode": { + "type": "string", + "description": "Code for the charge.", + "example": "HarishRent" + }, + "chargeTiming": { + "type": "string", + "description": "When the charge is applied.", + "example": "Monthly" + }, + "chargeAmount": { + "type": "string", + "description": "Amount for the charge.", + "example": "$222.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeaseDocumentsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "LeaseDocuments" + ], + "properties": { + "LeaseDocuments": { + "type": "object", + "required": [ + "LeaseDocument" + ], + "properties": { + "LeaseDocument": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "Id", + "AppliesTo", + "Type", + "Title", + "Name", + "Path", + "FileData", + "AddedOn" + ], + "properties": { + "Id": { + "type": "integer", + "description": "Unique identifier for the lease document.", + "example": 3922962 + }, + "AppliesTo": { + "type": "string", + "description": "Indicates who the document applies to.", + "example": "All" + }, + "Type": { + "type": "string", + "description": "Type of the lease document.", + "example": "Transfer Document (Transfer Document - UTS)" + }, + "Title": { + "type": "string", + "description": "Title of the lease document.", + "example": "Scheduled Transfer Statement" + }, + "Name": { + "type": "string", + "description": "Filename of the lease document.", + "example": "transfer_statement_1419410849_1426025528.pdf" + }, + "Path": { + "type": "string", + "description": "Path where the document is stored.", + "example": "transfer_statement/2014/12/24/10548763/scheduled_transfer/" + }, + "FileData": { + "type": "string", + "description": "Data related to the file (empty in this case).", + "example": "" + }, + "AddedOn": { + "type": "string", + "description": "Timestamp when the document was added.", + "example": "12/24/2014 01:47:33" + } + } + } + } + } + } + } + } + } + }, + "getLeaseDocumentsListSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leaseDocuments" + ], + "properties": { + "leaseDocuments": { + "type": "object", + "required": [ + "leaseDocument" + ], + "properties": { + "leaseDocument": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "type", + "name", + "title", + "leaseId", + "externalLeaseId" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the lease document.", + "example": 13862207 + }, + "type": { + "type": "string", + "description": "Type of the lease document.", + "example": "eSign: Lease (eSign: Renewal Lease - LP)" + }, + "name": { + "type": "string", + "description": "Name of the lease document file.", + "example": "lease_document_13155819_1535017430.pdf" + }, + "title": { + "type": "string", + "description": "Title of the lease document.", + "example": "Renewal Offer" + }, + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease.", + "example": "1234567" + }, + "externalLeaseId": { + "type": "string", + "description": "External lease identifier used for cross-referencing.", + "example": "123456" + } + } + } + } + } + } + } + } + } + }, + "getLeasePickListSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "A unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leaseStatusTypes", + "leaseFileTypes", + "chargeTimings", + "chargeCodeTypes", + "eventTags" + ], + "properties": { + "leaseStatusTypes": { + "type": "object", + "required": [ + "leaseStatusType" + ], + "properties": { + "leaseStatusType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the lease status type.", + "example": 1 + }, + "name": { + "type": "string", + "description": "Name of the lease status type.", + "example": "Applicant" + }, + "type": { + "type": "string", + "description": "Type of the lease status.", + "example": "NA" + } + } + } + } + } + }, + "leaseFileTypes": { + "type": "object", + "required": [ + "leaseFileType" + ], + "properties": { + "leaseFileType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "systemCode", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the lease file type.", + "example": 1 + }, + "systemCode": { + "type": "string", + "description": "System code associated with the lease file type.", + "example": "LEASE" + }, + "name": { + "type": "string", + "description": "Name of the lease file type.", + "example": "Lease Agreement" + } + } + } + } + } + }, + "chargeTimings": { + "type": "object", + "required": [ + "chargeTiming" + ], + "properties": { + "chargeTiming": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the charge timing.", + "example": 302 + }, + "name": { + "type": "string", + "description": "Name of the charge timing.", + "example": "Daily" + } + } + } + } + } + }, + "chargeCodeTypes": { + "type": "object", + "required": [ + "chargeCodeType" + ], + "properties": { + "chargeCodeType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "allowed_charge_timing_ids" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the charge code type.", + "example": 2 + }, + "name": { + "type": "string", + "description": "Name of the charge code type.", + "example": "Rent" + }, + "allowed_charge_timing_ids": { + "type": "string", + "description": "Allowed charge timing IDs for this charge code type.", + "example": "307" + } + } + } + } + } + }, + "eventTags": { + "type": "object", + "required": [ + "eventTag" + ], + "properties": { + "eventTag": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the event tag.", + "example": 702 + }, + "name": { + "type": "string", + "description": "Name of the event tag.", + "example": "Amenity" + } + } + } + } + } + } + } + } + } + }, + "getLeases_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result object containing lease information", + "properties": { + "leases": { + "type": "object", + "description": "The list of leases", + "required": [ + "lease" + ], + "properties": { + "lease": { + "type": "array", + "description": "List of lease details", + "items": { + "type": "object", + "required": [ + "id", + "leaseStatusTypeId", + "leaseSubStatus", + "leaseType", + "transferLeaseId", + "transferLeasePropertyId", + "leaseIntervalStatus", + "occupancyTypeId", + "occupancyType", + "isMonthToMonth", + "leaseIntervalId", + "buildingId", + "buildingName", + "floorPlanId", + "floorPlanName", + "unitId", + "unitNumberSpace", + "unitSpaceId", + "spaceConfiguration", + "terminationStartDate" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "123456" + }, + "leaseStatusTypeId": { + "type": "string", + "description": "ID representing the lease status type", + "example": "2" + }, + "leaseSubStatus": { + "type": "string", + "description": "Sub-status of the lease", + "example": "Month To Month" + }, + "leaseType": { + "type": "string", + "description": "Type of the lease", + "example": "Standard" + }, + "transferLeaseId": { + "type": "string", + "description": "ID representing the transfer lease", + "example": "123456" + }, + "transferLeasePropertyId": { + "type": "string", + "description": "ID representing the transfer lease property", + "example": "123456" + }, + "leaseIntervalStatus": { + "type": "string", + "description": "Status of the lease interval", + "example": "Notice" + }, + "occupancyTypeId": { + "type": "string", + "description": "ID for the occupancy type", + "example": "2" + }, + "occupancyType": { + "type": "string", + "description": "Type of occupancy", + "example": "Conventional" + }, + "isMonthToMonth": { + "type": "string", + "description": "Indicates if the lease is month to month", + "example": "1" + }, + "leaseIntervalId": { + "type": "string", + "description": "Unique identifier for the lease interval", + "example": "123456" + }, + "buildingId": { + "type": "string", + "description": "Unique identifier for the building", + "example": "1234" + }, + "buildingName": { + "type": "string", + "description": "Name of the building", + "example": "B1" + }, + "floorPlanId": { + "type": "string", + "description": "Unique identifier for the floor plan", + "example": "123456" + }, + "floorPlanName": { + "type": "string", + "description": "Name of the floor plan", + "example": "F1" + }, + "unitId": { + "type": "string", + "description": "Unique identifier for the unit", + "example": "123456" + }, + "unitNumberSpace": { + "type": "string", + "description": "Unit number or space", + "example": "N1" + }, + "unitSpaceId": { + "type": "string", + "description": "ID representing the unit space", + "example": "123456" + }, + "spaceConfiguration": { + "type": "string", + "description": "Configuration of the space", + "example": "Private" + }, + "terminationStartDate": { + "type": "string", + "description": "Start date for termination", + "example": "YYYY-MM-DD" + }, + "leaseIntervals": { + "type": "object", + "description": "List of lease intervals", + "required": [ + "leaseInterval" + ], + "properties": { + "leaseInterval": { + "type": "array", + "description": "Array of lease intervals", + "items": { + "type": "object", + "required": [ + "id", + "startDate", + "endDate", + "leaseIntervalTypeId", + "leaseIntervalTypeName", + "leaseIntervalStatusTypeId", + "leaseIntervalStatusTypeName", + "leaseApprovedOn", + "applicationCompletedOn", + "applicationId" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the lease interval", + "example": "123456" + }, + "startDate": { + "type": "string", + "description": "Start date of the lease interval", + "example": "YYYY-MM-DD" + }, + "endDate": { + "type": "string", + "description": "End date of the lease interval", + "example": "YYYY-MM-DD" + }, + "leaseIntervalTypeId": { + "type": "string", + "description": "ID for the type of lease interval", + "example": "2" + }, + "leaseIntervalTypeName": { + "type": "string", + "description": "Name of the lease interval type", + "example": "Month" + }, + "leaseIntervalStatusTypeId": { + "type": "string", + "description": "ID for the lease interval status", + "example": "2" + }, + "leaseIntervalStatusTypeName": { + "type": "string", + "description": "Name of the lease interval status", + "example": "Type" + }, + "leaseApprovedOn": { + "type": "string", + "description": "Date when the lease was approved", + "example": "YYYY-MM-DD" + }, + "applicationCompletedOn": { + "type": "string", + "description": "Date when the application was completed", + "example": "YYYY-MM-DD" + }, + "applicationId": { + "type": "string", + "description": "ID for the application", + "example": "123" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getLeases_r2_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "description": "The main response object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing lease information", + "required": [ + "currencyCode", + "leases" + ], + "properties": { + "currencyCode": { + "type": "string", + "description": "The currency code used in the lease", + "example": "USD" + }, + "leases": { + "type": "object", + "description": "Information about leases", + "required": [ + "lease" + ], + "properties": { + "lease": { + "type": "array", + "description": "List of leases", + "items": { + "type": "object", + "required": [ + "id", + "leaseStatusTypeId", + "propertyId", + "moveInDate", + "moveOutDate", + "transferDate", + "propertyName", + "leaseIntervalStatus", + "occupancyTypeId", + "occupancyType", + "isMonthToMonth", + "leaseIntervalId", + "floorPlanId", + "floorPlanName", + "paymentAllowanceType", + "spaceConfiguration", + "customers", + "unitId", + "unitSpaces", + "leaseIntervals" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "15323250" + }, + "leaseStatusTypeId": { + "type": "string", + "description": "Status type identifier for the lease", + "example": "3" + }, + "propertyId": { + "type": "string", + "description": "Property identifier", + "example": "550592" + }, + "moveInDate": { + "type": "string", + "description": "Move-in date of the lease", + "example": "12/11/2019" + }, + "moveOutDate": { + "type": "string", + "description": "Move-out date of the lease", + "example": "12/14/2019" + }, + "transferDate": { + "type": "string", + "description": "Transfer date of the lease", + "example": "12/14/2019" + }, + "propertyName": { + "type": "string", + "description": "Name of the property", + "example": "Valhalla Estates V2" + }, + "leaseIntervalStatus": { + "type": "string", + "description": "Status of the lease interval", + "example": "Future" + }, + "occupancyTypeId": { + "type": "string", + "description": "Occupancy type ID", + "example": "12" + }, + "occupancyType": { + "type": "string", + "description": "Type of occupancy", + "example": "Flexible" + }, + "isMonthToMonth": { + "type": "integer", + "description": "Indicates if the lease is month-to-month", + "example": 0 + }, + "leaseIntervalId": { + "type": "string", + "description": "Lease interval ID", + "example": "21917305" + }, + "floorPlanId": { + "type": "string", + "description": "ID of the floor plan", + "example": "903825" + }, + "floorPlanName": { + "type": "string", + "description": "Name of the floor plan", + "example": "Three Bedroom" + }, + "paymentAllowanceType": { + "type": "string", + "description": "Type of payment allowance", + "example": "Allow All Payment Types" + }, + "spaceConfiguration": { + "type": "string", + "description": "Configuration of the unit space", + "example": "Private" + }, + "customers": { + "type": "object", + "description": "Information about the customer", + "required": [ + "customer" + ], + "properties": { + "customer": { + "type": "array", + "description": "List of customers", + "items": { + "type": "object", + "required": [ + "id", + "customerType", + "firstName", + "lastName", + "nameFull", + "emailAddress", + "leaseCustomerStatus", + "moveInDate", + "moveOutDate", + "phones" + ], + "properties": { + "id": { + "type": "integer", + "description": "Customer ID", + "example": 31061984 + }, + "customerType": { + "type": "string", + "description": "Type of the customer", + "example": "Primary" + }, + "firstName": { + "type": "string", + "description": "First name of the customer", + "example": "12Dec1" + }, + "lastName": { + "type": "string", + "description": "Last name of the customer", + "example": "12Dec1" + }, + "nameFull": { + "type": "string", + "description": "Full name of the customer", + "example": "12Dec1, 12Dec1" + }, + "emailAddress": { + "type": "string", + "description": "Email address of the customer", + "example": "skondhalkar_xento.com@r.com" + }, + "leaseCustomerStatus": { + "type": "string", + "description": "Status of the customer's lease", + "example": "Future" + }, + "moveInDate": { + "type": "string", + "description": "Move-in date for the customer", + "example": "12/11/2019" + }, + "moveOutDate": { + "type": "string", + "description": "Move-out date for the customer", + "example": "12/14/2019" + }, + "phones": { + "type": "object", + "description": "Phone information of the customer", + "required": [ + "phone" + ], + "properties": { + "phone": { + "type": "array", + "description": "List of phones", + "items": { + "type": "object", + "required": [ + "phoneTypeName", + "phoneType", + "phoneNumber", + "countryCode" + ], + "properties": { + "phoneTypeName": { + "type": "string", + "description": "Phone type name", + "example": "Primary" + }, + "phoneType": { + "type": "string", + "description": "Type of phone", + "example": "personal" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number", + "example": "+1 4564565464" + }, + "countryCode": { + "type": "integer", + "description": "Country code of the phone number", + "example": 1 + } + } + } + } + } + }, + "isActiveBankruptcy": { + "type": "boolean", + "description": "The Bankruptcy status of customer .", + "example": 1 + }, + "bankruptcyDate": { + "type": "string", + "description": "The Bankruptcy date of customer.", + "example": "08/22/2025" + }, + "bankruptcyNote": { + "type": "string", + "description": "XYZ" + } + } + } + } + } + }, + "unitId": { + "type": "string", + "description": "Unit ID of the lease", + "example": "4486096" + }, + "unitSpaces": { + "type": "object", + "description": "Information about unit spaces", + "required": [ + "unitSpace" + ], + "properties": { + "unitSpace": { + "type": "array", + "description": "List of unit spaces", + "items": { + "type": "object", + "required": [ + "unitSpaceId", + "unitSpace" + ], + "properties": { + "unitSpaceId": { + "type": "integer", + "description": "Unit space ID", + "example": 5219776 + }, + "unitSpace": { + "type": "string", + "description": "Name of the unit space", + "example": "AB1-J" + } + } + } + } + } + }, + "leaseIntervals": { + "type": "object", + "description": "List of lease intervals", + "required": [ + "leaseInterval" + ], + "properties": { + "leaseInterval": { + "type": "array", + "description": "List of lease intervals", + "items": { + "type": "object", + "required": [ + "id", + "startDate", + "endDate", + "leaseIntervalTypeId", + "leaseIntervalTypeName", + "leaseIntervalStatusTypeId", + "intervalDateTime", + "applications" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the lease interval", + "example": "21917305" + }, + "startDate": { + "type": "string", + "description": "Start date of the lease interval", + "example": "12/11/2019" + }, + "endDate": { + "type": "string", + "description": "End date of the lease interval", + "example": "12/14/2019" + }, + "leaseIntervalTypeId": { + "type": "integer", + "description": "ID of the lease interval type", + "example": 1 + }, + "leaseIntervalTypeName": { + "type": "string", + "description": "Name of the lease interval type", + "example": "Application" + }, + "leaseIntervalStatusTypeId": { + "type": "integer", + "description": "ID of the lease interval status", + "example": 3 + }, + "intervalDateTime": { + "type": "string", + "description": "Date and time of the lease interval", + "example": "01/31/2022 23:16:51.110301 MST" + }, + "applications": { + "type": "object", + "description": "List of applications for the lease interval", + "required": [ + "application" + ], + "properties": { + "application": { + "type": "array", + "description": "List of applications", + "items": { + "type": "object", + "required": [ + "leaseTerm", + "leaseStartDate", + "leaseEndDate" + ], + "properties": { + "leaseTerm": { + "type": "string", + "description": "Term of the lease", + "example": "Hospitality lease term" + }, + "leaseStartDate": { + "type": "string", + "description": "Start date of the lease", + "example": "12/11/2019" + }, + "leaseEndDate": { + "type": "string", + "description": "End date of the lease", + "example": "12/14/2019" + }, + "applicationApprovedOn": { + "type": "string", + "description": "Date when the application was approved", + "example": "YYYY-MM-DD" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getMitsCollectionsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result of the API request", + "properties": { + "MITS-Collections": { + "type": "object", + "required": [ + "Summary", + "PropertyFiles", + "LeaseFiles" + ], + "properties": { + "Summary": { + "type": "object", + "required": [ + "MITSDocVersion", + "GenerationTimeStamp", + "SourceOrganization", + "TotalProperties", + "TotalLeaseFiles", + "TotalTenants", + "TotalOpenAmount" + ], + "properties": { + "MITSDocVersion": { + "type": "string", + "description": "Version of the MIT document", + "example": "3.0" + }, + "GenerationTimeStamp": { + "type": "string", + "description": "Timestamp when the document was generated", + "example": "2020-08-19T09:05:20" + }, + "SourceOrganization": { + "type": "string", + "description": "Name of the source organization", + "example": "Entrata Inc" + }, + "TotalProperties": { + "type": "string", + "description": "Total number of properties", + "example": "1" + }, + "TotalLeaseFiles": { + "type": "integer", + "description": "Total number of lease files", + "example": 7 + }, + "TotalTenants": { + "type": "integer", + "description": "Total number of tenants", + "example": 9 + }, + "TotalOpenAmount": { + "type": "string", + "description": "Total open amount", + "example": "5555555581301.66" + } + } + }, + "PropertyFiles": { + "type": "object", + "required": [ + "PropertyFile" + ], + "properties": { + "PropertyFile": { + "type": "object", + "required": [ + "Property", + "PropertyClient", + "LeaseFiles" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "Address", + "Phone" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "The type of the ID", + "example": "Property ID" + }, + "IDRank": { + "type": "string", + "description": "The rank of the ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "The scope type of the ID", + "example": "sender" + } + } + }, + "IDValue": { + "type": "integer", + "description": "The ID value", + "example": 172775 + } + } + }, + "MarketingName": { + "type": "string", + "description": "The marketing name of the property", + "example": "0001 East Park Property" + }, + "Address": { + "type": "array", + "description": "List of addresses", + "items": { + "type": "object", + "required": [ + "@attributes", + "Description", + "Address", + "City", + "State", + "PostalCode", + "Country", + "CountyName" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "AddressType" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "The type of address", + "example": "other" + } + } + }, + "Description": { + "type": "string", + "description": "Address description", + "example": "Primary address" + }, + "Address": { + "type": "string", + "description": "Street address", + "example": "4300 Pennsylvania Ave, street, road" + }, + "City": { + "type": "string", + "description": "City", + "example": "Dallas" + }, + "State": { + "type": "string", + "description": "State", + "example": "TX" + }, + "PostalCode": { + "type": "string", + "description": "Postal code", + "example": "75210" + }, + "Country": { + "type": "string", + "description": "Country", + "example": "US" + }, + "CountyName": { + "type": "string", + "description": "County name", + "example": "Unite States" + } + } + } + }, + "Phone": { + "type": "array", + "description": "List of phone numbers", + "items": { + "type": "object", + "required": [ + "@attributes", + "PhoneDescription", + "PhoneNumber" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "PhoneType" + ], + "properties": { + "PhoneType": { + "type": "string", + "description": "Type of phone", + "example": "office" + } + } + }, + "PhoneDescription": { + "type": "string", + "description": "Phone description", + "example": "Office phone number" + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number", + "example": "1111888888" + } + } + } + } + } + }, + "PropertyClient": { + "type": "object", + "required": [ + "Identification", + "CompanyName" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue" + ], + "properties": { + "IDValue": { + "type": "integer", + "description": "The ID value of the property client", + "example": 235 + } + } + }, + "CompanyName": { + "type": "string", + "description": "Company name", + "example": "Demo Account" + } + } + }, + "LeaseFiles": { + "type": "object", + "required": [ + "LeaseFile" + ], + "properties": { + "LeaseFile": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "CollectionStatus", + "MoveInDate", + "MoveOutDate", + "NoticeToVacateDate", + "LeaseBegin", + "LeaseEnd", + "FmoProcessedOn", + "RentDueFromDate", + "RentDueToDate", + "LastPaymentDate", + "TotalLeaseOpenAmount", + "BuildingName", + "Unit", + "Tenants", + "FileTransactions" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "The type of the ID", + "example": "Lease ID" + }, + "IDRank": { + "type": "string", + "description": "The rank of the ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "The scope type of the ID", + "example": "sender" + } + } + }, + "IDValue": { + "type": "integer", + "description": "The ID value", + "example": 14055346 + } + } + }, + "CollectionStatus": { + "type": "string", + "description": "The collection status", + "example": "true" + }, + "MoveInDate": { + "type": "string", + "description": "Move-in date", + "example": "2018-01-07" + }, + "MoveOutDate": { + "type": "string", + "description": "Move-out date", + "example": "2019-10-15" + }, + "NoticeToVacateDate": { + "type": "string", + "description": "Notice to vacate date", + "example": "2019-08-06" + }, + "LeaseBegin": { + "type": "string", + "description": "Lease begin date", + "example": "2019-07-24" + }, + "LeaseEnd": { + "type": "string", + "description": "Lease end date", + "example": "2020-07-31" + }, + "FmoProcessedOn": { + "type": "string", + "description": "Date the FMO was processed", + "example": "2018-04-30" + }, + "RentDueFromDate": { + "type": "string", + "description": "Rent due from date", + "example": "2018-01-08" + }, + "RentDueToDate": { + "type": "string", + "description": "Rent due to date", + "example": "2019-03-28" + }, + "LastPaymentDate": { + "type": "string", + "description": "Last payment date", + "example": "2019-05-29" + }, + "TotalLeaseOpenAmount": { + "type": "string", + "description": "Total open amount for the lease", + "example": "262.08" + }, + "BuildingName": { + "type": "string", + "description": "Name of the building", + "example": "Building A" + }, + "Unit": { + "type": "object", + "required": [ + "UnitNumber", + "Address" + ], + "properties": { + "UnitNumber": { + "type": "string", + "description": "Unit number", + "example": "Gx6 unit" + }, + "Address": { + "type": "object", + "required": [ + "@attributes", + "State", + "Country" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "AddressType" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Address type", + "example": "other" + } + } + }, + "State": { + "type": "string", + "description": "State", + "example": "AE" + }, + "Country": { + "type": "string", + "description": "Country", + "example": "US" + } + } + } + } + }, + "Tenants": { + "type": "array", + "items": { + "type": "object", + "required": [ + "PersonDetails", + "DateOfBirth" + ], + "properties": { + "PersonDetails": { + "type": "object", + "required": [ + "Identification", + "Name", + "Address", + "Phone" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "ID type", + "example": "Customer ID" + }, + "IDRank": { + "type": "string", + "description": "ID rank", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "ID scope type", + "example": "sender" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Customer ID value", + "example": 30279157 + } + } + }, + "Name": { + "type": "object", + "required": [ + "FirstName", + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "Customer first name", + "example": "0011Payment" + }, + "LastName": { + "type": "string", + "description": "Customer last name", + "example": "0011Ree" + } + } + }, + "Address": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes", + "Description", + "Address", + "City", + "State", + "PostalCode", + "Country", + "Email" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "AddressType" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Address type", + "example": "other" + } + } + }, + "Description": { + "type": "string", + "description": "Address description", + "example": "Primary address" + }, + "Address": { + "type": "string", + "description": "Address", + "example": "201 SE SCENIC VIEW DR, df, df" + }, + "City": { + "type": "string", + "description": "City", + "example": "Chandler" + }, + "State": { + "type": "string", + "description": "State", + "example": "--" + }, + "PostalCode": { + "type": "string", + "description": "Postal code", + "example": "840956" + }, + "Country": { + "type": "string", + "description": "Country", + "example": "CN" + }, + "Email": { + "type": "string", + "description": "Email address", + "example": "ppakhale+01@xento.com" + } + } + } + }, + "Phone": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes", + "PhoneNumber" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "PhoneType" + ], + "properties": { + "PhoneType": { + "type": "string", + "description": "Phone type", + "example": "cell" + } + } + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number", + "example": "6505541317" + } + } + } + } + } + }, + "DateOfBirth": { + "type": "string", + "description": "Tenant's date of birth", + "example": "1988-01-08" + } + } + } + }, + "FileTransactions": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "TransDate", + "TransTypeDesc", + "TransType", + "TransAmount", + "OpenAmount" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Transaction ID type", + "example": "Transaction ID" + }, + "IDRank": { + "type": "string", + "description": "Transaction ID rank", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Transaction ID scope type", + "example": "sender" + } + } + }, + "IDValue": { + "type": "integer", + "description": "Transaction ID value", + "example": 242952611 + } + } + }, + "TransDate": { + "type": "string", + "description": "Transaction date", + "example": "2019-12-19" + }, + "TransTypeDesc": { + "type": "string", + "description": "Transaction type description", + "example": "Accelerated Rent Income - fee posted" + }, + "TransType": { + "type": "string", + "description": "Transaction type", + "example": "Charge" + }, + "TransAmount": { + "type": "string", + "description": "Transaction amount", + "example": "60.00" + }, + "OpenAmount": { + "type": "string", + "description": "Open amount", + "example": "60.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getMitsLeasesSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "LeaseApplication" + ], + "properties": { + "LeaseApplication": { + "type": "object", + "required": [ + "Tenant", + "LA_Lease" + ], + "properties": { + "Tenant": { + "type": "array", + "items": { + "type": "object", + "required": [ + "ResidentType", + "Identification", + "LeaseID", + "Name", + "Residence", + "Phone" + ], + "properties": { + "ResidentType": { + "type": "string", + "description": "Type of the resident", + "example": "Primary" + }, + "Identification": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue", + "OrganizationName" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the identification", + "example": "Customer ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the identification", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the identification", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the identification", + "example": "7572305" + }, + "OrganizationName": { + "type": "string", + "description": "Name of the organization", + "example": "66259" + } + } + }, + "LeaseID": { + "type": "object", + "required": [ + "Identification" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the lease identification", + "example": "Lease ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the lease identification", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the lease identification", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the lease identification", + "example": "123456" + } + } + } + } + }, + "Name": { + "type": "object", + "required": [ + "FirstName", + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "First name of the tenant", + "example": "Julanne" + }, + "LastName": { + "type": "string", + "description": "Last name of the tenant", + "example": "Abernethy" + } + } + }, + "Residence": { + "type": "object", + "required": [ + "Address" + ], + "properties": { + "Address": { + "type": "object", + "required": [ + "AddressType", + "Address", + "City", + "State", + "PostalCode" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Type of the address", + "example": "current" + }, + "Address": { + "type": "string", + "description": "Address of the tenant", + "example": "2921 Sycamore Springs Drive, Unit # 103" + }, + "City": { + "type": "string", + "description": "City of the residence", + "example": "Kingwood" + }, + "State": { + "type": "string", + "description": "State of the residence", + "example": "TX" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the residence", + "example": "77339" + }, + "Email": { + "type": "string", + "description": "Email address of the tenant", + "example": "atest@yahoo.com" + } + } + } + } + }, + "Phone": { + "type": "object", + "required": [ + "PhoneType", + "PhoneNumber" + ], + "properties": { + "PhoneType": { + "type": "string", + "description": "Type of the phone", + "example": "personal" + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number of the tenant", + "example": "2819795654" + } + } + } + } + } + }, + "LA_Lease": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "AccountingData", + "LeaseEvents", + "Property", + "Status", + "Unit" + ], + "properties": { + "Identification": { + "type": "array", + "items": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the lease ID", + "example": "Lease ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the lease ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the lease ID", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the lease ID", + "example": "1234567" + } + } + } + }, + "AccountingData": { + "type": "object", + "required": [ + "ChargeSet" + ], + "properties": { + "ChargeSet": { + "type": "object", + "required": [ + "Start", + "End", + "Frequency", + "Charge" + ], + "properties": { + "Start": { + "type": "string", + "description": "Start date of the charge period", + "example": "2012-02-01" + }, + "End": { + "type": "string", + "description": "End date of the charge period", + "example": "2020-01-01" + }, + "Frequency": { + "type": "string", + "description": "Frequency of the charge", + "example": "Monthly" + }, + "Charge": { + "type": "object", + "required": [ + "ChargeType", + "Identification", + "Label", + "Amount" + ], + "properties": { + "ChargeType": { + "type": "string", + "description": "Type of the charge", + "example": "Other" + }, + "Identification": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the charge ID", + "example": "Charge ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the charge ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the charge ID", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the charge ID", + "example": "7449916" + } + } + }, + "Label": { + "type": "string", + "description": "Label for the charge", + "example": "Parking" + }, + "Amount": { + "type": "string", + "description": "Amount of the charge", + "example": "10.00" + } + } + } + } + } + } + }, + "LeaseEvents": { + "type": "object", + "required": [ + "LeaseEvent" + ], + "properties": { + "LeaseEvent": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Date", + "EventType" + ], + "properties": { + "Date": { + "type": "string", + "description": "Date of the lease event", + "example": "2014-04-04" + }, + "EventType": { + "type": "string", + "description": "Type of the lease event", + "example": "Application" + }, + "MoveOutReason": { + "type": "string", + "description": "Reason for the move-out", + "example": "Unit transfer." + } + } + } + } + } + }, + "Property": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "Address" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the property ID", + "example": "Property ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the property ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the property ID", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the property ID", + "example": "54613" + } + } + }, + "MarketingName": { + "type": "string", + "description": "Marketing name of the property", + "example": "Elm Grove - OLD" + }, + "Address": { + "type": "object", + "required": [ + "AddressType", + "Address", + "City", + "State", + "PostalCode" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Type of the address", + "example": "other" + }, + "Address": { + "type": "string", + "description": "Address of the property", + "example": "2921 Sycamore Springs Drive" + }, + "City": { + "type": "string", + "description": "City of the property", + "example": "Kingwood" + }, + "State": { + "type": "string", + "description": "State of the property", + "example": "TX" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the property", + "example": "77339" + }, + "Country": { + "type": "string", + "description": "Country of the property", + "example": "US" + } + } + } + } + }, + "Status": { + "type": "object", + "required": [ + "ApprovalStatus" + ], + "properties": { + "ApprovalStatus": { + "type": "string", + "description": "Approval status of the lease", + "example": "Current" + } + } + }, + "Unit": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "UnitType", + "UnitLeasedStatus", + "Address" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType", + "IDValue" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of the unit ID", + "example": "Property Unit Id" + }, + "IDRank": { + "type": "string", + "description": "Rank of the unit ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the unit ID", + "example": "sender" + }, + "IDValue": { + "type": "string", + "description": "Value of the unit ID", + "example": "123456" + } + } + }, + "MarketingName": { + "type": "string", + "description": "Marketing name of the unit", + "example": "TEST-A" + }, + "UnitType": { + "type": "string", + "description": "Type of the unit", + "example": "B-2/1" + }, + "UnitLeasedStatus": { + "type": "string", + "description": "Leased status of the unit", + "example": "leased" + }, + "Address": { + "type": "object", + "required": [ + "AddressType", + "Address", + "City", + "State", + "PostalCode" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Type of the address", + "example": "property" + }, + "Address": { + "type": "string", + "description": "Address of the unit", + "example": "2921 Sycamore Springs Drive, Unit # 103" + }, + "City": { + "type": "string", + "description": "City of the unit", + "example": "Kingwood" + }, + "State": { + "type": "string", + "description": "State of the unit", + "example": "TX" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the unit", + "example": "77339" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getParcelAlertsSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "packageBatches" + ], + "properties": { + "packageBatches": { + "type": "object", + "required": [ + "packageBatch" + ], + "properties": { + "packageBatch": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes", + "totalPackages", + "totalPickedUp", + "totalDelivered", + "totalPrint", + "totalResend", + "packageBatchDate", + "packages" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Identifier for the package batch", + "example": 248014 + }, + "name": { + "type": "string", + "description": "Name of the package batch", + "example": "dge" + } + } + }, + "totalPackages": { + "type": "string", + "description": "Total number of packages in the batch", + "example": "2" + }, + "totalPickedUp": { + "type": "string", + "description": "Total number of packages picked up", + "example": "0" + }, + "totalDelivered": { + "type": "string", + "description": "Total number of packages delivered", + "example": "0" + }, + "totalPrint": { + "type": "string", + "description": "Total number of packages printed", + "example": "0" + }, + "totalResend": { + "type": "string", + "description": "Total number of packages resent", + "example": "0" + }, + "packageBatchDate": { + "type": "string", + "description": "Date of the package batch", + "example": "2016-03-03" + }, + "packages": { + "type": "object", + "required": [ + "package" + ], + "properties": { + "package": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes", + "leaseId", + "customerId", + "customerEmailAddress", + "customerName", + "packageType", + "packageStatus", + "trackingNumber", + "shippingVendor", + "emailedOn", + "packageDate" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "description": "Identifier for the package", + "example": 1433603 + } + } + }, + "leaseId": { + "type": "integer", + "description": "Lease ID associated with the package", + "example": 11165108 + }, + "customerId": { + "type": "integer", + "description": "Customer ID associated with the package", + "example": 15200439 + }, + "customerEmailAddress": { + "type": "string", + "description": "Customer email address", + "example": "fqe@df.coc" + }, + "customerName": { + "type": "string", + "description": "Customer name", + "example": "Ergr Erggre" + }, + "packageType": { + "type": "string", + "description": "Type of the package", + "example": "FedEx" + }, + "packageStatus": { + "type": "string", + "description": "Status of the package", + "example": "Pending" + }, + "trackingNumber": { + "type": "string", + "description": "Tracking number for the package", + "example": "rtjert" + }, + "shippingVendor": { + "type": "string", + "description": "Shipping vendor for the package", + "example": "FedEx" + }, + "emailedOn": { + "type": "string", + "description": "Date when the package email was sent", + "example": "2016-03-03" + }, + "packageDate": { + "type": "string", + "description": "Date of the package", + "example": "2016-03-03" + }, + "unitSpaceId": { + "type": "integer", + "description": "ID of the unit space", + "example": 2615515 + }, + "unitNumber": { + "type": "string", + "description": "Unit number associated with the package", + "example": "1001-B" + }, + "printedOn": { + "type": "string", + "description": "Date when the package was printed", + "example": "2016-03-03" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getRentersInsurancePoliciesSuccessResponse": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "LeaseApplication" + ], + "properties": { + "LeaseApplication": { + "type": "object", + "required": [ + "Property", + "Tenant", + "LA_Lease" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "Address" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue", + "OrganizationName", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "Unique identifier for the property", + "example": "42420" + }, + "OrganizationName": { + "type": "string", + "description": "Organization name", + "example": "651" + }, + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of identifier", + "example": "Property ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the identifier", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the identifier", + "example": "sender" + } + } + } + } + }, + "MarketingName": { + "type": "string", + "description": "Marketing name for the property", + "example": "AuraCorp2 - Crystal" + }, + "Address": { + "type": "object", + "required": [ + "Description", + "Address", + "City", + "State", + "PostalCode", + "Country", + "@attributes" + ], + "properties": { + "Description": { + "type": "string", + "description": "Description of the address", + "example": "Primary address" + }, + "Address": { + "type": "string", + "description": "Street address", + "example": "500 S, 100 W, 100k" + }, + "City": { + "type": "string", + "description": "City of the property", + "example": "Provo" + }, + "State": { + "type": "string", + "description": "State of the property", + "example": "UT" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the property", + "example": "84601" + }, + "Country": { + "type": "string", + "description": "Country of the property", + "example": "US" + }, + "@attributes": { + "type": "object", + "required": [ + "AddressType" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Type of address", + "example": "other" + } + } + } + } + } + } + }, + "Tenant": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "LeaseID", + "Name", + "Residence", + "@attributes" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "Unique identifier for the tenant", + "example": "6720012" + }, + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of identifier", + "example": "Customer ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the identifier", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the identifier", + "example": "sender" + } + } + } + } + }, + "LeaseID": { + "type": "object", + "required": [ + "IDValue", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "5545944" + }, + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of lease identifier", + "example": "Lease ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of the lease identifier", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the lease identifier", + "example": "sender" + } + } + } + } + }, + "Name": { + "type": "object", + "required": [ + "FirstName", + "LastName" + ], + "properties": { + "FirstName": { + "type": "string", + "description": "Tenant's first name", + "example": "FirstName" + }, + "LastName": { + "type": "string", + "description": "Tenant's last name", + "example": "LastName" + } + } + }, + "Residence": { + "type": "object", + "required": [ + "Address" + ], + "properties": { + "Address": { + "type": "object", + "required": [ + "Address", + "City", + "State", + "PostalCode", + "CountryName", + "@attributes" + ], + "properties": { + "Address": { + "type": "string", + "description": "Street address of the tenant", + "example": "500 S, 100 W, 100k" + }, + "City": { + "type": "string", + "description": "City of the tenant's residence", + "example": "Provo" + }, + "State": { + "type": "string", + "description": "State of the tenant's residence", + "example": "UT" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the tenant's residence", + "example": "84601" + }, + "CountryName": { + "type": "string", + "description": "Country of the tenant's residence", + "example": "US" + }, + "Email": { + "type": "string", + "description": "Email address of the tenant", + "example": "nmohite_x.lc@r.com" + }, + "@attributes": { + "type": "object", + "required": [ + "AddressType" + ], + "properties": { + "AddressType": { + "type": "string", + "description": "Type of address", + "example": "current" + } + } + } + } + } + } + }, + "Phone": { + "type": "object", + "required": [ + "PhoneNumber", + "@attributes" + ], + "properties": { + "PhoneNumber": { + "type": "string", + "description": "Phone number of the tenant", + "example": "1112223333" + }, + "@attributes": { + "type": "object", + "required": [ + "PhoneType" + ], + "properties": { + "PhoneType": { + "type": "string", + "description": "Type of phone", + "example": "personal" + } + } + } + } + }, + "@attributes": { + "type": "object", + "required": [ + "ResidentType" + ], + "properties": { + "ResidentType": { + "type": "string", + "description": "Type of resident", + "example": "Primary" + } + } + } + } + } + }, + "LA_Lease": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Identification", + "Status", + "Unit", + "InsurancePolicies" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "5545944" + }, + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of lease identifier", + "example": "Lease ID" + }, + "IDRank": { + "type": "string", + "description": "Rank of lease identifier", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the lease identifier", + "example": "sender" + } + } + } + } + }, + "Status": { + "type": "object", + "required": [ + "ApprovalStatus" + ], + "properties": { + "ApprovalStatus": { + "type": "string", + "description": "Approval status of the lease", + "example": "Current" + } + } + }, + "Unit": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "UnitType", + "UnitBedrooms", + "UnitBathrooms", + "SquareFootType", + "UnitEconomicStatus", + "UnitLeasedStatus", + "NumberOccupants", + "BuildingName" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue", + "@attributes" + ], + "properties": { + "IDValue": { + "type": "string", + "description": "Unique identifier for the property unit", + "example": "2512028" + }, + "@attributes": { + "type": "object", + "required": [ + "IDType", + "IDRank", + "IDScopeType" + ], + "properties": { + "IDType": { + "type": "string", + "description": "Type of property unit identifier", + "example": "Property Unit Id" + }, + "IDRank": { + "type": "string", + "description": "Rank of property unit identifier", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of property unit identifier", + "example": "sender" + } + } + } + } + }, + "MarketingName": { + "type": "string", + "description": "Marketing name of the property unit", + "example": "UK16" + }, + "UnitType": { + "type": "string", + "description": "Type of the unit", + "example": "ZOM 2" + }, + "UnitBedrooms": { + "type": "string", + "description": "Number of bedrooms in the unit", + "example": "2" + }, + "UnitBathrooms": { + "type": "string", + "description": "Number of bathrooms in the unit", + "example": "2" + }, + "SquareFootType": { + "type": "string", + "description": "Type of square footage measurement", + "example": "internal" + }, + "UnitEconomicStatus": { + "type": "string", + "description": "Economic status of the unit", + "example": "residential" + }, + "UnitLeasedStatus": { + "type": "string", + "description": "Leased status of the unit", + "example": "leased" + }, + "NumberOccupants": { + "type": "object", + "required": [ + "@value", + "@attributes" + ], + "properties": { + "@value": { + "type": "string", + "description": "Total number of occupants", + "example": "4" + }, + "@attributes": { + "type": "object", + "required": [ + "Total" + ], + "properties": { + "Total": { + "type": "string", + "description": "Total number of occupants", + "example": "4" + } + } + } + } + }, + "BuildingName": { + "type": "string", + "description": "Building name", + "example": "BUL113" + } + } + }, + "InsurancePolicies": { + "type": "object", + "required": [ + "InsurancePolicy" + ], + "properties": { + "InsurancePolicy": { + "type": "object", + "required": [ + "id", + "name", + "unitNumber", + "leaseId", + "customerId", + "policyNumber", + "startDate", + "liability", + "deductible", + "personalContents", + "policyTypeId", + "policyTypeName" + ], + "properties": { + "id": { + "type": "string", + "description": "Insurance policy ID", + "example": "110292" + }, + "name": { + "type": "string", + "description": "Insurance policy name", + "example": "Name" + }, + "unitNumber": { + "type": "string", + "description": "Unit number", + "example": "UK16" + }, + "leaseId": { + "type": "string", + "description": "Lease ID associated with the insurance policy", + "example": "5545944" + }, + "customerId": { + "type": "string", + "description": "Customer ID associated with the insurance policy", + "example": "6720012" + }, + "policyNumber": { + "type": "string", + "description": "Insurance policy number", + "example": "RLO1123001040" + }, + "startDate": { + "type": "string", + "description": "Start date of the insurance policy", + "example": "05/08/2016" + }, + "liability": { + "type": "string", + "description": "Liability coverage amount", + "example": "300000" + }, + "deductible": { + "type": "string", + "description": "Insurance policy deductible", + "example": "80" + }, + "personalContents": { + "type": "string", + "description": "Personal contents coverage", + "example": "50" + }, + "policyTypeId": { + "type": "integer", + "description": "ID for the type of insurance policy", + "example": 6 + }, + "policyTypeName": { + "type": "string", + "description": "Name of the insurance policy type", + "example": "Affordable" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "moveInLeaseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the move-in request", + "example": "success" + }, + "message": { + "type": "string", + "description": "Message regarding the move-in request", + "example": "Customer moved in successfully." + } + } + } + } + }, + "moveOutLeaseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the move-out request", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message regarding the move-out request", + "example": "Lease moved out successfully." + } + } + } + } + }, + "onNoticeLeaseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the lease notice placement", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message regarding the lease notice placement", + "example": "Successfully placed lease on Notice." + } + } + } + } + }, + "sendLeaseActivitiesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "events" + ], + "properties": { + "events": { + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "object", + "required": [ + "node", + "leaseId", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Node identifier for the event", + "example": "1" + }, + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "10873580" + }, + "status": { + "type": "string", + "description": "Status of the event insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the event insertion result", + "example": "Event inserted successfully." + } + } + } + } + } + } + } + } + }, + "sendLeaseDocumentsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "files" + ], + "properties": { + "files": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "fileId", + "fileName", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Node identifier for the file", + "example": "1" + }, + "fileId": { + "type": "string", + "description": "Unique identifier for the file", + "example": "13858364" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file", + "example": "file1.pdf" + }, + "status": { + "type": "string", + "description": "Status of the file upload", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the upload", + "example": "File uploaded successfully." + } + } + } + } + } + } + } + } + } + }, + "sendLeasesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "leases" + ], + "properties": { + "leases": { + "type": "object", + "required": [ + "lease" + ], + "properties": { + "lease": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "leaseId", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Node identifier for the lease", + "example": "1" + }, + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "123456" + }, + "status": { + "type": "string", + "description": "Status of the lease insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the insertion", + "example": "Lease inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "sendRentersInsurancePolicies_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "insurancePolicies" + ], + "properties": { + "insurancePolicies": { + "type": "object", + "required": [ + "insurancePolicy" + ], + "properties": { + "insurancePolicy": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "node", + "reference_id", + "lease_id", + "customer_id", + "status", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Node identifier for the insurance policy", + "example": "1" + }, + "reference_id": { + "type": "string", + "description": "Unique reference ID for the insurance policy", + "example": "123456" + }, + "lease_id": { + "type": "string", + "description": "Unique identifier for the lease associated with the policy", + "example": "123456" + }, + "customer_id": { + "type": "string", + "description": "Unique identifier for the customer associated with the policy", + "example": "123456" + }, + "status": { + "type": "string", + "description": "Status of the insurance policy update or insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the policy update or insertion", + "example": "Insurance policy updated successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "sendRentersInsurancePolicies_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "InsurancePolicies" + ], + "properties": { + "InsurancePolicies": { + "type": "object", + "required": [ + "InsurancePolicy" + ], + "properties": { + "InsurancePolicy": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Node", + "ReferenceId", + "LeaseId", + "CustomerId", + "Status", + "Message" + ], + "properties": { + "Node": { + "type": "string", + "description": "Node identifier for the insurance policy", + "example": "1" + }, + "ReferenceId": { + "type": "string", + "description": "Unique reference ID for the insurance policy", + "example": "123456" + }, + "LeaseId": { + "type": "string", + "description": "Unique identifier for the lease associated with the policy", + "example": "123456" + }, + "CustomerId": { + "type": "string", + "description": "Comma-separated list of customer IDs associated with the insurance policy", + "example": "123456,123456,123456" + }, + "Status": { + "type": "string", + "description": "Status of the insurance policy update or insertion", + "example": "Success" + }, + "Message": { + "type": "string", + "description": "Message detailing the result of the policy update or insertion", + "example": "Insurance policy updated successfully." + } + } + } + } + } + } + } + } + } + }, + "sendRoommateGroups_r2_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "roommateGroups" + ], + "properties": { + "roommateGroups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "roommateGroupId", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Node identifier for the roommate group", + "example": 1 + }, + "roommateGroupId": { + "type": "integer", + "description": "Unique identifier for the roommate group. Returns 0 if creation fails.", + "example": 22815 + }, + "status": { + "type": "string", + "description": "Status of the roommate group creation", + "enum": [ + "Success", + "Failure" + ], + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the group creation" + } + } + } + } + } + } + } + } + } + }, + "sendScheduledChargesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "scheduledCharges" + ], + "properties": { + "scheduledCharges": { + "type": "object", + "required": [ + "scheduledCharge" + ], + "properties": { + "scheduledCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "node", + "status", + "message" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the scheduled charge", + "example": "1234" + }, + "node": { + "type": "string", + "description": "Node identifier for the scheduled charge", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the scheduled charge insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the scheduled charge insertion", + "example": "Scheduled charge inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "updateLeaseSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response status code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "leaseId", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the lease update", + "example": "Success" + }, + "leaseId": { + "type": "string", + "description": "Unique identifier for the lease", + "example": "123456" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the lease update", + "example": "Lease updated successfully." + } + } + } + } + }, + "updateScheduledCharges_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "scheduledCharges" + ], + "properties": { + "scheduledCharges": { + "type": "object", + "required": [ + "scheduledCharge" + ], + "properties": { + "scheduledCharge": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "node", + "status", + "message" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the scheduled charge", + "example": "1234" + }, + "node": { + "type": "string", + "description": "Node identifier", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the scheduled charge update", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the scheduled charge update", + "example": "Scheduled charge updated successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateScheduledCharges_r2_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "scheduledCharges" + ], + "properties": { + "scheduledCharges": { + "type": "object", + "required": [ + "scheduledCharge" + ], + "properties": { + "scheduledCharge": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "node", + "status", + "message" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the scheduled charge", + "example": "32847564" + }, + "node": { + "type": "string", + "description": "Node identifier", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the scheduled charge update", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the result of the scheduled charge update", + "example": "Scheduled charge updated successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getCallLogsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "calls" + ], + "properties": { + "calls": { + "type": "object", + "required": [ + "call" + ], + "properties": { + "call": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "callerName", + "applicationId", + "originPhoneNumber", + "destinationPhoneNumber", + "callTypeId", + "callType", + "callSourceId", + "callSource", + "callResultId", + "callResult", + "callState", + "callAnalyzed", + "propertyId", + "voiceMailTypeId", + "answerStatus", + "leadSourceId", + "leadSourceName", + "agentName", + "callDuration", + "callCenterTalkTime" + ], + "properties": { + "id": { + "type": "string", + "description": "Call identifier", + "example": "1234" + }, + "callerName": { + "type": "string", + "description": "Name of the caller", + "example": "test caller" + }, + "applicationId": { + "type": "string", + "description": "Application identifier", + "example": "1234" + }, + "originPhoneNumber": { + "type": "string", + "description": "Origin phone number", + "example": "2342265293" + }, + "destinationPhoneNumber": { + "type": "string", + "description": "Destination phone number", + "example": "2342265256" + }, + "callTypeId": { + "type": "string", + "description": "Call type identifier", + "example": "21" + }, + "callType": { + "type": "string", + "description": "Call type", + "example": "Call Center Lead" + }, + "callSourceId": { + "type": "string", + "description": "Call source identifier", + "example": "2" + }, + "callSource": { + "type": "string", + "description": "Call source", + "example": "Leasing Center" + }, + "callResultId": { + "type": "string", + "description": "Call result identifier", + "example": "6" + }, + "callResult": { + "type": "string", + "description": "Call result", + "example": "lead" + }, + "callState": { + "type": "string", + "description": "State of the call", + "example": "Non-Archived" + }, + "callAnalyzed": { + "type": "string", + "description": "Whether the call was analyzed", + "example": "No" + }, + "propertyId": { + "type": "string", + "description": "Property identifier", + "example": "12345" + }, + "voiceMailTypeId": { + "type": "string", + "description": "Voice mail type identifier", + "example": "3" + }, + "answerStatus": { + "type": "string", + "description": "Call answer status", + "example": "Answered" + }, + "leadSourceId": { + "type": "string", + "description": "Lead source identifier", + "example": "45453" + }, + "leadSourceName": { + "type": "string", + "description": "Lead source name", + "example": "test souce" + }, + "agentName": { + "type": "string", + "description": "Agent's name", + "example": "agent name" + }, + "callDuration": { + "type": "string", + "description": "Duration of the call", + "example": "00:00:18" + }, + "callCenterTalkTime": { + "type": "string", + "description": "Talk time in the call center", + "example": "00:00:05" + } + } + } + } + } + } + } + } + } + }, + "getLeasingCenterPickListsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "callSources", + "callTypes", + "callResults" + ], + "properties": { + "callSources": { + "type": "object", + "required": [ + "callSource" + ], + "properties": { + "callSource": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the call source", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the call source", + "example": "On-Site" + } + } + } + } + } + }, + "callTypes": { + "type": "object", + "required": [ + "callType" + ], + "properties": { + "callType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the call type", + "example": "23" + }, + "name": { + "type": "string", + "description": "Name of the call type", + "example": "Call Center Emergency" + } + } + } + } + } + }, + "callResults": { + "type": "object", + "required": [ + "callResult" + ], + "properties": { + "callResult": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the call result", + "example": "2" + }, + "name": { + "type": "string", + "description": "Name of the call result", + "example": "Unknown" + } + } + } + } + } + } + } + } + } + }, + "getInspectionsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "inspections" + ], + "properties": { + "inspections": { + "type": "object", + "required": [ + "inspection" + ], + "properties": { + "inspection": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "propertyId", + "inspectionTypeId", + "inspectionStatusTypeId", + "inspectionStatusType", + "inspectionFormId", + "scheduledDate", + "dueDate", + "leaseId", + "unitSpaceId", + "note", + "locations" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the inspection", + "example": "123456" + }, + "propertyId": { + "type": "string", + "description": "ID of the property", + "example": "12345" + }, + "inspectionTypeId": { + "type": "string", + "description": "ID of the inspection type", + "example": "1" + }, + "inspectionStatusTypeId": { + "type": "string", + "description": "ID of the inspection status type", + "example": "3" + }, + "inspectionStatusType": { + "type": "string", + "description": "Status of the inspection", + "example": "Review" + }, + "inspectionFormId": { + "type": "string", + "description": "ID of the inspection form", + "example": "12345" + }, + "scheduledDate": { + "type": "string", + "format": "date", + "description": "Scheduled date for the inspection", + "example": "2020-04-24" + }, + "dueDate": { + "type": "string", + "format": "date", + "description": "Due date for the inspection", + "example": "2020-04-30" + }, + "leaseId": { + "type": "string", + "description": "Lease ID related to the inspection", + "example": "123456" + }, + "unitSpaceId": { + "type": "string", + "description": "Unit space ID", + "example": "1234" + }, + "note": { + "type": "string", + "description": "Additional notes for the inspection", + "example": "Test Inspection" + }, + "locations": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "location": { + "type": "array", + "items": { + "type": "object", + "required": [ + "locationId", + "locationName", + "problems" + ], + "properties": { + "locationId": { + "type": "string", + "description": "ID of the location", + "example": "1234" + }, + "locationName": { + "type": "string", + "description": "Name of the location", + "example": "Kitchen" + }, + "problems": { + "type": "object", + "required": [ + "problem" + ], + "properties": { + "problem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "problemId", + "problemName", + "response" + ], + "properties": { + "problemId": { + "type": "string", + "description": "ID of the problem", + "example": "12345" + }, + "problemName": { + "type": "string", + "description": "Name of the problem", + "example": "cabinet" + }, + "response": { + "type": "string", + "description": "Response to the problem", + "example": "Fail" + }, + "subProblems": { + "type": "object", + "properties": { + "subProblem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "subProblemId", + "subProblemName" + ], + "properties": { + "subProblemId": { + "type": "string", + "description": "ID of the subproblem", + "example": "123456" + }, + "subProblemName": { + "type": "string", + "description": "Name of the subproblem", + "example": "Clean" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getInspectionTemplatesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "inspectionTemplates" + ], + "properties": { + "inspectionTemplates": { + "type": "object", + "required": [ + "inspectionTemplate" + ], + "properties": { + "inspectionTemplate": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "type", + "isActive", + "allowActions", + "customText", + "termsAndConditions", + "propertyIds", + "locations" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the inspection template", + "example": "1234" + }, + "name": { + "type": "string", + "description": "Name of the inspection template", + "example": "Template Name" + }, + "type": { + "type": "string", + "description": "Type of the inspection template", + "example": "Type" + }, + "isActive": { + "type": "string", + "description": "Indicates if the template is active", + "example": "true" + }, + "allowActions": { + "type": "string", + "description": "Indicates if actions are allowed", + "example": "true" + }, + "customText": { + "type": "string", + "description": "Custom text that can be included in the template", + "example": "Top Text" + }, + "termsAndConditions": { + "type": "string", + "description": "Terms and conditions for the inspection", + "example": "Bottom Text" + }, + "propertyIds": { + "type": "string", + "description": "Comma-separated list of property IDs the template applies to", + "example": "12345,45678" + }, + "locations": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "location": { + "type": "array", + "items": { + "type": "object", + "required": [ + "maintenanceLocationId", + "locationName", + "problems" + ], + "properties": { + "maintenanceLocationId": { + "type": "string", + "description": "ID of the maintenance location", + "example": "12345" + }, + "locationName": { + "type": "string", + "description": "Name of the location", + "example": "location name" + }, + "problems": { + "type": "object", + "required": [ + "problem" + ], + "properties": { + "problem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "maintenanceProblemId", + "problemName" + ], + "properties": { + "maintenanceProblemId": { + "type": "string", + "description": "ID of the maintenance problem", + "example": "123456" + }, + "problemName": { + "type": "string", + "description": "Name of the maintenance problem", + "example": "problem name" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getWorkOrderPickListsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Status code of the response", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "Property", + "InspectionStatuses", + "WorkOrderTypes", + "CompanyEmployees" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "Locations", + "Priorities", + "StatusTypes", + "Categories", + "Problems" + ], + "properties": { + "Locations": { + "type": "object", + "required": [ + "Location" + ], + "properties": { + "Location": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name", + "Type", + "IsResidentPortalEnabled" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the location", + "example": "26900" + }, + "Name": { + "type": "string", + "description": "Name of the location", + "example": "Basement" + }, + "Type": { + "type": "string", + "description": "Type of the location", + "example": "Unit" + }, + "IsResidentPortalEnabled": { + "type": "string", + "description": "Indicates if the location is enabled on the resident portal", + "example": "0" + }, + "unitTypes": { + "type": "object", + "properties": { + "unitType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the unit type", + "example": "474887" + }, + "Name": { + "type": "string", + "description": "Name of the unit type", + "example": "1" + } + } + } + } + } + } + } + } + } + } + }, + "Priorities": { + "type": "object", + "required": [ + "Priority" + ], + "properties": { + "Priority": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the priority", + "example": "19421" + }, + "Name": { + "type": "string", + "description": "Name of the priority", + "example": "Normal" + } + } + } + } + } + }, + "StatusTypes": { + "type": "object", + "required": [ + "StatusType" + ], + "properties": { + "StatusType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name", + "Code" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the status type", + "example": "15106" + }, + "Name": { + "type": "string", + "description": "Name of the status type", + "example": "Awaiting Parts" + }, + "Code": { + "type": "string", + "description": "Code of the status type", + "example": "AP" + } + } + } + } + } + }, + "Categories": { + "type": "object", + "required": [ + "Category" + ], + "properties": { + "Category": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the category", + "example": "91983" + }, + "Name": { + "type": "string", + "description": "Name of the category", + "example": "demo" + } + } + } + } + } + }, + "Problems": { + "type": "object", + "required": [ + "Problem" + ], + "properties": { + "Problem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the problem", + "example": "67718" + }, + "Name": { + "type": "string", + "description": "Name of the problem", + "example": "Wet Floor" + }, + "IsResidentPortalEnabled": { + "type": "string", + "description": "Indicates if the problem is visible on the resident portal", + "example": "1" + }, + "subMaintenanceProblems": { + "type": "object", + "properties": { + "subMaintenanceProblem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the sub-maintenance problem", + "example": "569575" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "InspectionStatuses": { + "type": "object", + "required": [ + "InspectionStatus" + ], + "properties": { + "InspectionStatus": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the inspection status", + "example": "1" + }, + "Name": { + "type": "string", + "description": "Name of the inspection status", + "example": "Not Started" + } + } + } + } + } + }, + "WorkOrderTypes": { + "type": "object", + "required": [ + "WorkOrderType" + ], + "properties": { + "WorkOrderType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the work order type", + "example": "1" + }, + "Name": { + "type": "string", + "description": "Name of the work order type", + "example": "Make Ready" + } + } + } + } + } + }, + "CompanyEmployees": { + "type": "object", + "required": [ + "CompanyEmployee" + ], + "properties": { + "CompanyEmployee": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "ID of the company employee", + "example": "299001" + }, + "Name": { + "type": "string", + "description": "Name of the company employee", + "example": "Andrew Marshall" + } + } + } + } + } + } + } + } + } + }, + "getWorkOrdersSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Identifier of the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "workOrders" + ], + "properties": { + "workOrders": { + "type": "object", + "required": [ + "workOrder" + ], + "properties": { + "workOrder": { + "type": "array", + "items": { + "type": "object", + "required": [ + "maintenanceRequestId", + "propertyId", + "buildingName", + "unitNumber", + "customerId", + "nameFirst", + "nameLast", + "primaryPhoneNumber", + "createdOn", + "assignedTo", + "maintenanceStatus", + "maintenancePriority", + "maintenanceCategoryName", + "maintenanceProblem", + "maintenanceDescription" + ], + "properties": { + "maintenanceRequestId": { + "type": "string", + "description": "ID of the maintenance request", + "example": "307132" + }, + "propertyId": { + "type": "string", + "description": "ID of the property", + "example": "11111" + }, + "buildingName": { + "type": "string", + "description": "Building name", + "example": "B1" + }, + "unitNumber": { + "type": "string", + "description": "Unit number", + "example": "8" + }, + "customerId": { + "type": "string", + "description": "Customer ID", + "example": "4856298" + }, + "nameFirst": { + "type": "string", + "description": "First name of the customer", + "example": "Cosin" + }, + "nameLast": { + "type": "string", + "description": "Last name of the customer", + "example": "Dome" + }, + "primaryPhoneNumber": { + "type": "string", + "description": "Primary phone number of the customer", + "example": "123456789" + }, + "alternatePhoneNumber": { + "type": "string", + "description": "Alternate phone number", + "example": "12121212121" + }, + "emailAddress": { + "type": "string", + "description": "Email address of the customer", + "example": "cosin@dome.com" + }, + "createdOn": { + "type": "string", + "description": "Timestamp of when the request was created", + "example": "01/05/2012 05:22:26.184567 MST" + }, + "assignedTo": { + "type": "string", + "description": "Employee assigned to the work order", + "example": "jiniaxena" + }, + "maintenanceStatus": { + "type": "string", + "description": "Status of the maintenance request", + "example": "New" + }, + "maintenancePriority": { + "type": "string", + "description": "Priority level of the work order", + "example": "NOWrn Never is question" + }, + "maintenanceCategoryName": { + "type": "string", + "description": "Category of the maintenance request", + "example": "test123" + }, + "maintenanceProblem": { + "type": "string", + "description": "Problem related to the maintenance", + "example": "Problem With Lights" + }, + "maintenanceDescription": { + "type": "string", + "description": "Description of the maintenance issue", + "example": "Some description" + }, + "labors": { + "type": "object", + "properties": { + "labor": { + "type": "array", + "items": { + "type": "object", + "required": [ + "employeeName", + "description", + "laborType", + "laborTypeId", + "startDateTime", + "endDateTime", + "totalMinutes", + "perHourRate", + "totalCharge" + ], + "properties": { + "employeeName": { + "type": "string", + "description": "Name of the employee performing the labor", + "example": "ABC" + }, + "description": { + "type": "string", + "description": "Description of the labor", + "example": "sdf" + }, + "laborType": { + "type": "string", + "description": "Type of labor", + "example": "Regular" + }, + "laborTypeId": { + "type": "string", + "description": "ID of the labor type", + "example": "1" + }, + "startDateTime": { + "type": "string", + "description": "Start date and time of labor", + "example": "02/28/2018 01:11:00" + }, + "endDateTime": { + "type": "string", + "description": "End date and time of labor", + "example": "02/28/2018 01:15:00" + }, + "totalMinutes": { + "type": "string", + "description": "Total minutes worked", + "example": "4" + }, + "perHourRate": { + "type": "string", + "description": "Hourly rate of the labor", + "example": "1.00" + }, + "totalCharge": { + "type": "string", + "description": "Total charge for the labor", + "example": "0.07" + } + } + } + }, + "subTotal": { + "type": "object", + "required": [ + "totalCharge", + "totalMinutes" + ], + "properties": { + "totalCharge": { + "type": "string", + "description": "Total charge for all labor", + "example": "10.27" + }, + "totalMinutes": { + "type": "integer", + "description": "Total minutes worked for all labor", + "example": 616 + } + } + } + } + }, + "scheduledStartDate": { + "type": "string", + "description": "Scheduled start date for the work order", + "example": "01/06/2012 00:00:00 MDT" + }, + "scheduledEndDate": { + "type": "string", + "description": "Scheduled end date for the work order", + "example": "01/09/2012 00:00:00 MDT" + }, + "dueDate": { + "type": "string", + "description": "Due date for the work order", + "example": "02/04/2022 18:34:11 MST" + }, + "isFloating": { + "type": "string", + "description": "Indicates if the work order is floating", + "example": "false" + }, + "permissionToEnter": { + "type": "string", + "description": "Indicates if permission to enter is granted", + "example": "0" + }, + "petInfo": { + "type": "string", + "description": "Information about pets at the location", + "example": "Dogs,Dogs,Dogs,Dogs,Snake,Snake" + }, + "alarmInfo": { + "type": "string", + "description": "Alarm information for the location", + "example": "123454" + }, + "maintenanceRequestFrom": { + "type": "string", + "description": "Source of the maintenance request", + "example": "Entrata PaaS" + }, + "maintenanceRequestBy": { + "type": "string", + "description": "Person who created the maintenance request", + "example": "R R1" + }, + "isDeleted": { + "type": "string", + "description": "Indicates if the work order has been deleted", + "example": "0" + }, + "childWorkOrders": { + "type": "object", + "properties": { + "childWorkOrder": { + "type": "array", + "items": { + "type": "object", + "required": [ + "maintenanceRequestId", + "maintenanceStatus", + "maintenancePriority", + "maintenanceProblem" + ], + "properties": { + "maintenanceRequestId": { + "type": "string", + "description": "ID of the child maintenance request", + "example": "5039921" + }, + "maintenanceStatus": { + "type": "string", + "description": "Status of the child maintenance request", + "example": "1test" + }, + "maintenancePriority": { + "type": "string", + "description": "Priority level of the child work order", + "example": "JS Testing 1" + }, + "maintenanceProblem": { + "type": "string", + "description": "Problem related to the maintenance", + "example": "12" + }, + "maintenanceLocation": { + "type": "string", + "description": "Location of the maintenance", + "example": "1234" + }, + "completedOn": { + "type": "string", + "description": "Completion date of the child work order", + "example": "03/22/2017 03:27:46 MDT" + }, + "entryNotes": { + "type": "string", + "description": "Entry notes for the child work order", + "example": "This is an entry note" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendWorkOrdersSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "Result object containing the success details", + "properties": { + "Success": { + "type": "array", + "description": "List of success messages", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of the success message", + "properties": { + "message": { + "type": "string", + "description": "Message indicating success", + "example": "Work order inserted successfully." + }, + "node": { + "type": "integer", + "description": "Node ID where the operation was performed", + "example": 1 + }, + "reference_id": { + "type": "integer", + "description": "Reference ID associated with the operation", + "example": 4699547 + } + } + } + } + } + } + } + } + } + } + } + }, + "updateWorkOrders_r1_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result of the work order operation", + "properties": { + "workOrders": { + "type": "object", + "description": "Work orders result containing the details of the work orders", + "properties": { + "workOrder": { + "type": "array", + "description": "List of work order results", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of the work order", + "properties": { + "workOrderId": { + "type": "string", + "description": "Unique identifier for the work order", + "example": "1234" + }, + "status": { + "type": "string", + "description": "The current status of the work order", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the outcome of the work order", + "example": "Work order updated successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "updateWorkOrders_r2_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result of the work order operation", + "properties": { + "workOrders": { + "type": "object", + "description": "Work orders result containing the details of the work orders", + "properties": { + "workOrder": { + "type": "array", + "description": "List of work order results", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of the work order", + "properties": { + "workOrderId": { + "type": "string", + "description": "Unique identifier for the work order", + "example": "1234" + }, + "status": { + "type": "string", + "description": "The current status of the work order", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message detailing the outcome of the work order", + "example": "Work order updated successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPricingPicklistsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "14" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing pricing levels, charge usages, charge timings, and charge code types", + "properties": { + "pricingLevels": { + "type": "object", + "description": "Pricing levels details", + "properties": { + "pricingLevel": { + "type": "array", + "description": "List of pricing levels", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of each pricing level", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the pricing level", + "example": 1 + }, + "name": { + "type": "string", + "description": "Name of the pricing level", + "example": "Property" + } + } + } + } + } + } + } + }, + "chargeUsages": { + "type": "object", + "description": "Charge usages details", + "properties": { + "chargeUsage": { + "type": "array", + "description": "List of charge usages", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of each charge usage", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the charge usage", + "example": 1 + }, + "name": { + "type": "string", + "description": "Name of the charge usage", + "example": "Base" + } + } + } + } + } + } + } + }, + "chargeTimings": { + "type": "object", + "description": "Charge timings details", + "properties": { + "chargeTiming": { + "type": "array", + "description": "List of charge timings", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of each charge timing", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the charge timing", + "example": 102 + }, + "name": { + "type": "string", + "description": "Name of the charge timing", + "example": "Application Completed" + } + } + } + } + } + } + } + }, + "chargeCodeTypes": { + "type": "object", + "description": "Charge code types details", + "properties": { + "chargeCodeType": { + "type": "array", + "description": "List of charge code types", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of each charge code type", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the charge code type", + "example": 2 + }, + "name": { + "type": "string", + "description": "Name of the charge code type", + "example": "Rent" + }, + "allowed_charge_timing_ids": { + "type": "string", + "description": "Comma-separated list of allowed charge timing IDs for the charge code type", + "example": "307" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertyFeesSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "An arbitrary value sent with the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "propertyFees", + "floorPlanFees", + "unitTypeFees", + "unitSpaceFees" + ], + "properties": { + "propertyFees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeeDetails" + } + }, + "floorPlanFees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeeDetails" + } + }, + "unitTypeFees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeeDetails" + } + }, + "unitSpaceFees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeeDetails" + } + } + } + } + } + } + } + }, + "FeeDetails": { + "type": "object", + "properties": { + "propertyId": { + "type": "string", + "description": "Property identifier", + "example": "12345" + }, + "propertyFloorplanId": { + "type": "string", + "description": "Floor plan identifier", + "example": "921405" + }, + "unitTypeId": { + "type": "string", + "description": "Unit type identifier", + "example": "653938" + }, + "unitSpaceId": { + "type": "string", + "description": "Unit space identifier", + "example": "" + }, + "entrataCategoryId": { + "type": "string", + "description": "Category identifier", + "example": "1" + }, + "entrataCategory": { + "type": "string", + "description": "Category name", + "example": "Base" + }, + "associatedItemId": { + "type": "string", + "description": "Associated item identifier", + "example": "0" + }, + "associatedItem": { + "type": "string", + "description": "Associated item name", + "example": "Dishwasher" + }, + "cascadeId": { + "type": "string", + "description": "Cascade identifier", + "example": "1" + }, + "cascadeReferenceId": { + "type": "string", + "description": "Cascade reference identifier", + "example": "12345" + }, + "cascadeReferenceName": { + "type": "string", + "description": "Cascade reference name", + "example": "16th Street" + }, + "spaceConfigurationId": { + "type": "string", + "description": "Space configuration identifier", + "example": "0" + }, + "spaceConfiguration": { + "type": "string", + "description": "Space configuration name", + "example": "" + }, + "chargeCodeId": { + "type": "string", + "description": "Charge code identifier", + "example": "1234" + }, + "chargeCodeName": { + "type": "string", + "description": "Charge code name", + "example": "Return Fee" + }, + "chargeCodeDescription": { + "type": "string", + "description": "Charge code description", + "example": "Return Fee" + }, + "chargeCodeGroupName": { + "type": "string", + "description": "Charge code group name", + "example": "" + }, + "leaseTermId": { + "type": "string", + "description": "Lease term identifier", + "example": "0" + }, + "leaseTerm": { + "type": "string", + "description": "Lease term", + "example": "" + }, + "leaseStartWindowId": { + "type": "string", + "description": "Lease start window identifier", + "example": "0" + }, + "termStartDate": { + "type": "string", + "description": "Term start date", + "example": "" + }, + "termEndDate": { + "type": "string", + "description": "Term end date", + "example": "" + }, + "chargeTimingId": { + "type": "string", + "description": "Charge timing identifier", + "example": "406" + }, + "chargeTiming": { + "type": "string", + "description": "Charge timing name", + "example": "Return Item Fee" + }, + "formulaId": { + "type": "string", + "description": "Formula identifier", + "example": "1" + }, + "formulaReferenceId": { + "type": "string", + "description": "Formula reference identifier", + "example": "0" + }, + "rateAmount": { + "type": "string", + "description": "Rate amount", + "example": "50.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "Rate increase increment", + "example": "0.0000" + }, + "detailedAmount": { + "type": "string", + "description": "Detailed amount", + "example": "50.00" + }, + "isOptional": { + "type": "string", + "description": "Optional flag (0 or 1)", + "example": "0" + }, + "isRefundable": { + "type": "string", + "description": "Refundable flag (0 or 1)", + "example": "0" + }, + "customerRelationshipId": { + "type": "string", + "description": "Customer relationship identifier", + "example": "1" + }, + "customerRelationshipName": { + "type": "string", + "description": "Customer relationship name", + "example": "Primary" + } + } + }, + "insertPricingSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing pricing details", + "properties": { + "pricing": { + "type": "array", + "description": "List of pricing nodes", + "items": { + "type": "object", + "required": [ + "node", + "reference_id", + "status", + "is_valid", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Unique identifier for the pricing node", + "example": "1" + }, + "reference_id": { + "type": "string", + "description": "Reference ID associated with the pricing operation", + "example": "391937229" + }, + "status": { + "type": "string", + "description": "Status of the pricing operation (e.g., 'Success')", + "example": "Success" + }, + "is_valid": { + "type": "string", + "description": "Indicates if the pricing is valid (e.g., 'Yes')", + "example": "Yes" + }, + "message": { + "type": "string", + "description": "Message describing the result of the pricing operation", + "example": "Rate inserted/updated successfully." + } + } + } + } + } + } + } + }, + "insertPricing_r2SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing pricing details", + "properties": { + "pricing": { + "type": "array", + "description": "List of pricing nodes", + "items": { + "type": "object", + "required": [ + "node", + "referenceId", + "status", + "isValid", + "message" + ], + "properties": { + "node": { + "type": "string", + "description": "Unique identifier for the pricing node", + "example": "1" + }, + "referenceId": { + "type": "string", + "description": "Reference ID associated with the pricing operation", + "example": "391937229" + }, + "status": { + "type": "string", + "description": "Status of the pricing operation (e.g., 'Success')", + "example": "Success" + }, + "isValid": { + "type": "string", + "description": "Indicates if the pricing is valid (e.g., 'Yes')", + "example": "Yes" + }, + "message": { + "type": "string", + "description": "Message describing the result of the pricing operation", + "example": "Rate inserted/updated successfully." + } + } + } + } + } + } + } + }, + "sendBudgetedRentSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing pricing details", + "properties": { + "pricing": { + "type": "array", + "description": "List of pricing nodes", + "items": { + "type": "object", + "required": [ + "node", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the pricing node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the pricing operation (e.g., 'Success')", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message describing the result of the pricing operation", + "example": "Budgeted rent updated successfully." + } + } + } + } + } + } + } + }, + "getAmenityReservationsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing amenities details", + "properties": { + "amenities": { + "type": "object", + "description": "List of amenities", + "properties": { + "amenity": { + "type": "array", + "description": "List of amenity objects", + "items": { + "type": "object", + "required": [ + "id", + "name", + "description", + "isPublished" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the amenity", + "example": "123456" + }, + "name": { + "type": "string", + "description": "Name of the amenity", + "example": "Cats" + }, + "description": { + "type": "string", + "description": "Description of the amenity", + "example": "Rent yourself a cat for a few hours." + }, + "isPublished": { + "type": "string", + "description": "Indicates if the amenity is published", + "example": "1" + }, + "reservations": { + "type": "object", + "description": "Reservations for the amenity", + "properties": { + "reservation": { + "type": "array", + "description": "List of reservations for the amenity", + "items": { + "type": "object", + "required": [ + "id", + "resident", + "reservationDate", + "reservationStartTime", + "reservationEndTime", + "status" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the reservation", + "example": "123456" + }, + "resident": { + "type": "string", + "description": "Name of the resident who made the reservation", + "example": "Transfer Test 3" + }, + "leaseId": { + "type": "string", + "description": "ID of the lease associated with the reservation", + "example": "123456" + }, + "unitId": { + "type": "string", + "description": "ID of the unit where the amenity is reserved", + "example": "123456" + }, + "unitNumber": { + "type": "string", + "description": "Unit number where the amenity is reserved", + "example": "123456" + }, + "reservationDate": { + "type": "string", + "description": "Date of the reservation", + "example": "2020-04-08" + }, + "reserveByDay": { + "type": "string", + "description": "Indicates whether the reservation is by day", + "example": "0" + }, + "reservationStartTime": { + "type": "string", + "description": "Start time of the reservation", + "example": "03:00 PM" + }, + "reservationEndTime": { + "type": "string", + "description": "End time of the reservation", + "example": "05:00 PM" + }, + "statusTypeId": { + "type": "string", + "description": "ID representing the status type", + "example": "3" + }, + "status": { + "type": "string", + "description": "Status of the reservation", + "example": "Approved" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getCalendarAvailability_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing property calendar details", + "properties": { + "propertyCalendarSettings": { + "type": "object", + "description": "Settings related to property calendar", + "properties": { + "propertyId": { + "type": "string", + "description": "Unique identifier for the property", + "example": "123456" + }, + "appointmentLength": { + "type": "integer", + "description": "Length of an appointment in minutes", + "example": 90 + }, + "selfGuidedTourAppointmentLength": { + "type": "integer", + "description": "Length of a self-guided tour appointment in minutes", + "example": 30 + }, + "minLeadTimeTour": { + "type": "string", + "description": "Minimum lead time required for a tour", + "example": "8 Hours" + }, + "selfGuidedTourMinLeadTime": { + "type": "string", + "description": "Minimum lead time for self-guided tours", + "example": "15 Minutes" + }, + "availabilities": { + "type": "object", + "description": "Availability schedule for the property", + "properties": { + "availability": { + "type": "array", + "description": "List of availability slots", + "items": { + "type": "object", + "required": [ + "day", + "startTime", + "endTime", + "simultaneousAppointmentLimit" + ], + "properties": { + "day": { + "type": "string", + "description": "Day of the week", + "example": "Monday" + }, + "startTime": { + "type": "string", + "description": "Start time of the availability slot", + "example": "09:00:00MST" + }, + "endTime": { + "type": "string", + "description": "End time of the availability slot", + "example": "17:00:00MST" + }, + "simultaneousAppointmentLimit": { + "type": "string", + "description": "Limit of simultaneous appointments", + "example": "4" + } + } + } + } + } + }, + "selfGuidedTourAvailabilities": { + "type": "object", + "description": "Availability schedule for self-guided tours", + "properties": { + "availability": { + "type": "array", + "description": "List of self-guided tour availability slots", + "items": { + "type": "object", + "required": [ + "day", + "startTime", + "endTime", + "simultaneousAppointmentLimit" + ], + "properties": { + "day": { + "type": "string", + "description": "Day of the week", + "example": "Monday" + }, + "startTime": { + "type": "string", + "description": "Start time of the self-guided tour availability", + "example": "06:00:00MST" + }, + "endTime": { + "type": "string", + "description": "End time of the self-guided tour availability", + "example": "14:59:00MST" + }, + "simultaneousAppointmentLimit": { + "type": "string", + "description": "Limit of simultaneous self-guided tours", + "example": "No Limit" + } + } + } + } + } + } + } + }, + "propertyCalendarAvailability": { + "type": "object", + "description": "Availability for specific dates in the property calendar", + "properties": { + "availableHours": { + "type": "object", + "description": "List of available hours for specific dates", + "properties": { + "availableHour": { + "type": "array", + "description": "List of available hours", + "items": { + "type": "object", + "required": [ + "date", + "startTime", + "endTime" + ], + "properties": { + "date": { + "type": "string", + "description": "Date for the availability", + "example": "09/23/2019" + }, + "startTime": { + "type": "string", + "description": "Start time of the availability", + "example": "09:00:00MST" + }, + "endTime": { + "type": "string", + "description": "End time of the availability", + "example": "17:00:00MST" + } + } + } + } + } + } + } + } + } + } + } + }, + "getCalendarAvailability_r2_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "description": "The result containing available tours and their timeslots", + "properties": { + "availableTours": { + "type": "object", + "description": "Available tours with their respective timeslots", + "properties": { + "availableTour": { + "type": "array", + "description": "List of available tours", + "items": { + "type": "object", + "required": [ + "tourDate", + "tourTime" + ], + "properties": { + "tourDate": { + "type": "string", + "description": "The date when the tour is available", + "example": "2024-08-26" + }, + "tourTime": { + "type": "array", + "description": "List of available time slots for the tour", + "items": { + "type": "string", + "description": "Specific time slot for the tour", + "example": "05:00 MDT - 06:00 MDT" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getFloorPlansSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "description": "Result containing floor plan details", + "properties": { + "FloorPlans": { + "type": "object", + "description": "Details about the floor plans", + "properties": { + "FloorPlan": { + "type": "object", + "required": [ + "Identification", + "Name", + "PropertyId", + "FloorplanGroups", + "Comment", + "UnitCount", + "UnitsAvailable", + "UnitTypes", + "IsDisabled", + "Room", + "SquareFeet", + "MarketRent", + "Deposit", + "Amenity", + "File" + ], + "properties": { + "Identification": { + "type": "object", + "description": "Identification information for the floor plan", + "properties": { + "IDValue": { + "type": "string", + "description": "ID value for the floor plan", + "example": "456789" + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the floor plan identification", + "properties": { + "IDRank": { + "type": "string", + "description": "Rank of the ID", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "Scope type of the ID", + "example": "sender" + }, + "IDType": { + "type": "string", + "description": "Type of the ID", + "example": "Floorplan ID" + } + } + } + } + }, + "Name": { + "type": "string", + "description": "Name of the floor plan", + "example": "Floorplan 1" + }, + "PropertyId": { + "type": "integer", + "description": "Property ID associated with the floor plan", + "example": 123456 + }, + "FloorplanGroups": { + "type": "object", + "description": "Groups associated with the floor plan", + "properties": { + "FloorplanGroup": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes of the floor plan group", + "properties": { + "id": { + "type": "string", + "description": "ID of the floor plan group", + "example": "256" + }, + "name": { + "type": "string", + "description": "Name of the floor plan group", + "example": "Test_23_test" + } + } + } + } + } + } + }, + "Comment": { + "type": "string", + "description": "Comment related to the floor plan", + "example": "test" + }, + "UnitCount": { + "type": "string", + "description": "Number of units in the floor plan", + "example": "1" + }, + "UnitsAvailable": { + "type": "string", + "description": "Number of available units in the floor plan", + "example": "10" + }, + "UnitTypes": { + "type": "object", + "description": "Types of units in the floor plan", + "properties": { + "UnitType": { + "type": "array", + "description": "List of unit types", + "items": { + "type": "object", + "required": [ + "@value", + "@attributes" + ], + "properties": { + "@value": { + "type": "string", + "description": "The value of the unit type", + "example": "1BHK" + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the unit type", + "properties": { + "Id": { + "type": "string", + "description": "ID of the unit type", + "example": "297171" + } + } + } + } + } + } + } + }, + "IsDisabled": { + "type": "boolean", + "description": "Indicates whether the floor plan is disabled", + "example": false + }, + "Room": { + "type": "array", + "description": "List of rooms in the floor plan", + "items": { + "type": "object", + "required": [ + "Count", + "@attributes" + ], + "properties": { + "Count": { + "type": "string", + "description": "Number of rooms of a particular type", + "example": "2" + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the room", + "properties": { + "RoomType": { + "type": "string", + "description": "Type of the room", + "example": "Bedroom" + } + } + } + } + } + }, + "SquareFeet": { + "type": "object", + "description": "Square footage of the floor plan", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the square footage", + "properties": { + "Max": { + "type": "string", + "description": "Maximum square footage", + "example": "900" + }, + "Min": { + "type": "string", + "description": "Minimum square footage", + "example": "900" + } + } + } + } + }, + "MarketRent": { + "type": "object", + "description": "Market rent details of the floor plan", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to market rent", + "properties": { + "Max": { + "type": "string", + "description": "Maximum rent", + "example": "850" + }, + "Min": { + "type": "string", + "description": "Minimum rent", + "example": "850" + } + } + } + } + }, + "Deposit": { + "type": "object", + "description": "Deposit details for the floor plan", + "properties": { + "Amount": { + "type": "object", + "description": "Deposit amount information", + "properties": { + "ValueRange": { + "type": "object", + "description": "Range for the deposit amount", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the deposit range", + "properties": { + "Min": { + "type": "string", + "description": "Minimum deposit", + "example": "250" + }, + "Max": { + "type": "string", + "description": "Maximum deposit", + "example": "250" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the deposit", + "properties": { + "DepositType": { + "type": "string", + "description": "Type of deposit", + "example": "security deposit" + } + } + } + } + }, + "Amenity": { + "type": "array", + "description": "Amenities available in the floor plan", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the amenity", + "properties": { + "AmenityType": { + "type": "string", + "description": "Type of amenity", + "example": "AdditionalStorage" + } + } + } + } + } + }, + "File": { + "type": "object", + "description": "File related to the floor plan", + "properties": { + "FileType": { + "type": "string", + "description": "Type of the file", + "example": "Floorplan" + }, + "Description": { + "type": "string", + "description": "Description of the file", + "example": "2D Floor Plan" + }, + "Name": { + "type": "string", + "description": "Name of the file", + "example": "Floorplan1.jpg" + }, + "Caption": { + "type": "string", + "description": "Caption of the file", + "example": "Floorplan1.jpg" + }, + "Format": { + "type": "string", + "description": "Format of the file", + "example": "Jpg" + }, + "Width": { + "type": "string", + "description": "Width of the file", + "example": "480" + }, + "Height": { + "type": "string", + "description": "Height of the file", + "example": "640" + }, + "Src": { + "type": "array", + "description": "Source of the file", + "items": { + "type": "string" + } + }, + "@attributes": { + "type": "object", + "description": "Attributes related to the file", + "properties": { + "FileID": { + "type": "string", + "description": "ID of the file", + "example": "345678" + }, + "Active": { + "type": "string", + "description": "Whether the file is active", + "example": "true" + }, + "IsDefault": { + "type": "boolean", + "description": "Whether the file is the default file", + "example": true + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPetTypesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "Result containing pet types for properties", + "required": [ + "PetTypes" + ], + "properties": { + "PetTypes": { + "type": "object", + "description": "Pet types available for the properties", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "object", + "description": "Properties containing pet type data", + "additionalProperties": { + "type": "object", + "description": "Specific pet types for each property", + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the property", + "properties": { + "id": { + "type": "integer", + "description": "Unique property identifier", + "example": 11111 + } + } + }, + "PetType": { + "type": "array", + "description": "List of pet types available for the property", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Attributes related to the pet type", + "properties": { + "Name": { + "type": "string", + "description": "Name of the pet type", + "example": "Cat" + }, + "Id": { + "type": "integer", + "description": "Unique identifier for the pet type", + "example": 3467 + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertiesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "Result containing the property details", + "required": [ + "PhysicalProperty" + ], + "properties": { + "PhysicalProperty": { + "type": "object", + "description": "Physical property details", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "array", + "description": "List of properties", + "items": { + "type": "object", + "required": [ + "PropertyID", + "MarketingName", + "Type", + "YearBuilt", + "ShortDescription", + "LongDescription", + "webSite", + "Address", + "PostMonths", + "IsDisabled", + "IsFeaturedProperty" + ], + "properties": { + "PropertyID": { + "type": "string", + "description": "Unique identifier for the property", + "example": "22090" + }, + "ParentPropertyID": { + "type": "integer", + "description": "Parent property identifier", + "example": 653357 + }, + "MarketingName": { + "type": "string", + "description": "Marketing name of the property", + "example": "55 Hundred" + }, + "Type": { + "type": "string", + "description": "Type of the property (e.g., Apartment)", + "example": "Apartment" + }, + "General_ID": { + "type": "string", + "description": "General identifier for the property", + "example": "co405" + }, + "YearBuilt": { + "type": "string", + "description": "Year the property was built", + "example": "2009" + }, + "ShortDescription": { + "type": "object", + "description": "Short description of the property", + "properties": { + "b": { + "type": "string", + "description": "Text in bold", + "example": "LIVE AT THE SPEED OF LIGHT." + } + } + }, + "LongDescription": { + "type": "object", + "description": "Long description of the property", + "properties": { + "b": { + "type": "string", + "description": "Text in bold", + "example": "55 HUNDRED" + } + } + }, + "webSite": { + "type": "string", + "description": "Website URL for the property", + "example": "http://www.55hundredlifestyle.com" + }, + "Address": { + "type": "object", + "description": "Address of the property", + "properties": { + "Address": { + "type": "string", + "description": "Street address", + "example": "5500 Columbia Pike" + }, + "City": { + "type": "string", + "description": "City of the property", + "example": "Arlington" + }, + "State": { + "type": "string", + "description": "State of the property", + "example": "VA" + }, + "PostalCode": { + "type": "string", + "description": "Postal code of the property", + "example": "22204" + }, + "Country": { + "type": "string", + "description": "Country of the property", + "example": "US" + }, + "Email": { + "type": "string", + "description": "Contact email for the property", + "example": "devsupport@propertysolutions.lcl" + }, + "@attributes": { + "type": "object", + "description": "Additional attributes of the address", + "properties": { + "AddressType": { + "type": "string", + "description": "Type of address", + "example": "property" + } + } + } + } + }, + "PostMonths": { + "type": "object", + "description": "Post months for accounting", + "properties": { + "ArPostMonth": { + "type": "string", + "description": "Account receivable post month", + "example": "01/2014" + }, + "ApPostMonth": { + "type": "string", + "description": "Account payable post month", + "example": "01/2014" + }, + "GlPostMonth": { + "type": "string", + "description": "General ledger post month", + "example": "01/2014" + } + } + }, + "IsDisabled": { + "type": "string", + "description": "Indicates if the property is disabled", + "example": "0" + }, + "IsFeaturedProperty": { + "type": "string", + "description": "Indicates if the property is featured", + "example": "0" + }, + "CustomKeysData": { + "type": "object", + "description": "Custom key-value data for the property", + "properties": { + "CustomKeyData": { + "type": "array", + "description": "List of custom key-value pairs", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string", + "description": "Custom key", + "example": "Key" + }, + "Value": { + "type": "string", + "description": "Custom value", + "example": "KeyValue" + } + } + } + } + } + }, + "PropertyHours": { + "type": "object", + "description": "Operating hours for the property", + "properties": { + "HolidayHours": { + "type": "object", + "description": "Holiday hours", + "properties": { + "HolidayHour": { + "type": "object", + "description": "Specific holiday hour", + "properties": { + "Name": { + "type": "string", + "description": "Name of the holiday", + "example": "Columbus Day" + }, + "Date": { + "type": "string", + "description": "Date of the holiday", + "example": "10/08/2018" + } + } + } + } + }, + "OfficeHours": { + "type": "object", + "description": "Office operating hours", + "properties": { + "OfficeHour": { + "type": "object", + "description": "Specific office hour", + "properties": { + "Day": { + "type": "string", + "description": "Day of the week", + "example": "Monday" + }, + "AvailabilityType": { + "type": "string", + "description": "Office availability type", + "example": "Open" + }, + "OpenTime": { + "type": "string", + "description": "Office open time", + "example": "9:00 AM" + }, + "CloseTime": { + "type": "string", + "description": "Office close time", + "example": "6:30 PM" + }, + "LunchStartTime": { + "type": "string", + "description": "Lunch start time", + "example": "1:00 PM" + }, + "LunchEndTime": { + "type": "string", + "description": "Lunch end time", + "example": "2:00 PM" + } + } + } + } + }, + "PoolHours": { + "type": "object", + "description": "Pool operating hours", + "properties": { + "PoolHour": { + "type": "object", + "description": "Specific pool hour", + "properties": { + "Day": { + "type": "string", + "description": "Day of the week", + "example": "Monday" + }, + "OpenTime": { + "type": "string", + "description": "Pool open time", + "example": "8:20 AM" + }, + "CloseTime": { + "type": "string", + "description": "Pool close time", + "example": "4:06 PM" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertyAddOnsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "1" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "Result containing the add-on details", + "required": [ + "currencyCode", + "addOns" + ], + "properties": { + "currencyCode": { + "type": "string", + "description": "Currency code for pricing information", + "example": "USD" + }, + "addOns": { + "type": "object", + "description": "Add-ons available for the property", + "required": [ + "addon" + ], + "properties": { + "addon": { + "type": "array", + "description": "List of add-ons", + "items": { + "type": "object", + "required": [ + "id", + "name", + "addOnTypeId", + "addOnCategoryId", + "addOnGroupId", + "isInventory", + "addOnAvailableOn", + "isWebVisible", + "availability", + "reservationStartDate", + "reservationEndDate", + "holdUntilDate" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the add-on", + "example": 319751 + }, + "name": { + "type": "string", + "description": "Name of the add-on", + "example": "1" + }, + "addOnTypeId": { + "type": "string", + "description": "Identifier for the add-on type", + "example": "2" + }, + "addOnCategoryId": { + "type": "integer", + "description": "Identifier for the add-on category", + "example": 275 + }, + "addOnGroupId": { + "type": "integer", + "description": "Identifier for the add-on group", + "example": 11375 + }, + "isInventory": { + "type": "integer", + "description": "Indicates if the add-on is part of inventory (1 = Yes, 0 = No)", + "example": 1 + }, + "addOnAvailableOn": { + "type": "string", + "description": "Date when the add-on becomes available", + "example": "04/19/2019" + }, + "isWebVisible": { + "type": "integer", + "description": "Indicates if the add-on is visible on the web (1 = Visible, 0 = Not Visible)", + "example": 1 + }, + "availability": { + "type": "string", + "description": "Availability status of the add-on", + "example": "Vacant Ready (Unavailable)" + }, + "reservationStartDate": { + "type": "string", + "description": "Start date for reservation", + "example": "04/19/2019" + }, + "reservationEndDate": { + "type": "string", + "description": "End date for reservation", + "example": "04/18/2020" + }, + "holdUntilDate": { + "type": "string", + "description": "Date until which the add-on is held", + "example": "04/18/2020" + }, + "rates": { + "type": "object", + "description": "Pricing information for the add-on", + "properties": { + "rate": { + "type": "array", + "description": "List of rate details", + "items": { + "type": "object", + "required": [ + "chargeTimingId", + "chargeCodeId", + "amount" + ], + "properties": { + "chargeTimingId": { + "type": "integer", + "description": "Unique identifier for the charge timing", + "example": 211 + }, + "chargeCodeId": { + "type": "integer", + "description": "Unique identifier for the charge code", + "example": 207684 + }, + "amount": { + "type": "string", + "description": "Charge amount for the rate", + "example": "5.00" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertyAnnouncementsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Unique identifier for the request", + "example": 15 + }, + "result": { + "type": "object", + "description": "Contains the announcements information", + "required": [ + "Announcements" + ], + "properties": { + "Announcements": { + "type": "object", + "description": "Details of the announcements", + "required": [ + "Announcement" + ], + "properties": { + "Announcement": { + "type": "array", + "description": "List of announcements", + "items": { + "type": "object", + "required": [ + "AnnouncementTypeId", + "FrequencyId", + "Title", + "Description", + "StartDate", + "EndDate" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Additional attributes for the announcement", + "properties": { + "Id": { + "type": "integer", + "description": "Unique identifier for the announcement", + "example": 111 + } + } + }, + "AnnouncementTypeId": { + "type": "integer", + "description": "Identifier for the type of announcement", + "example": 9 + }, + "FrequencyId": { + "type": "integer", + "description": "Identifier for the frequency of the announcement", + "example": 2 + }, + "Title": { + "type": "string", + "description": "Title of the announcement", + "example": "Test Announcement Title" + }, + "Description": { + "type": "string", + "description": "Description of the announcement", + "example": "Hello" + }, + "StartDate": { + "type": "string", + "format": "date", + "description": "The start date of the announcement", + "example": "06/16/2013" + }, + "EndDate": { + "type": "string", + "format": "date", + "description": "The end date of the announcement", + "example": "07/31/2013" + } + } + } + } + } + } + } + } + } + }, + "getPropertyPickLists_r1_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "Contains company, property, and search area data", + "required": [ + "company", + "Property" + ], + "properties": { + "company": { + "type": "object", + "description": "Contains search areas and countries", + "required": [ + "searchAreas" + ], + "properties": { + "searchAreas": { + "type": "object", + "description": "Details of search areas", + "required": [ + "countries" + ], + "properties": { + "countries": { + "type": "array", + "description": "List of countries with states and search areas", + "items": { + "type": "object", + "required": [ + "country" + ], + "properties": { + "country": { + "type": "array", + "description": "List of countries with states", + "items": { + "type": "object", + "required": [ + "states", + "@attributes" + ], + "properties": { + "states": { + "type": "object", + "description": "States within the country", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "array", + "description": "List of states", + "items": { + "type": "object", + "required": [ + "@attributes", + "searchArea" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Additional metadata for the state", + "properties": { + "Code": { + "type": "string", + "description": "State code", + "example": "AE" + }, + "Name": { + "type": "string", + "description": "State name", + "example": "Armed Forces Europe, Middle East, Africa & Canada" + } + } + }, + "searchArea": { + "type": "array", + "description": "Search areas within the state", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Search area attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Search area ID", + "example": 1651 + }, + "Name": { + "type": "string", + "description": "Search area name", + "example": "search area" + } + } + } + } + } + } + } + } + } + } + }, + "Property": { + "type": "array", + "description": "List of properties", + "items": { + "type": "object", + "required": [ + "@attributes", + "UnitTypes", + "PropertyBuildings", + "PropertyFloorplans", + "MoveOutReasons" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Property metadata", + "properties": { + "Id": { + "type": "integer", + "description": "Unique property ID", + "example": 42420 + }, + "Name": { + "type": "string", + "description": "Property name", + "example": "AuraCorp2 - Crystal" + }, + "IsDisabled": { + "type": "integer", + "description": "Flag to indicate if the property is disabled", + "example": 0 + } + } + }, + "UnitTypes": { + "type": "object", + "description": "Unit types available at the property", + "required": [ + "UnitType" + ], + "properties": { + "UnitType": { + "type": "array", + "description": "List of unit types", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Unit type attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Unit type ID", + "example": 474667 + }, + "Name": { + "type": "string", + "description": "Unit type name", + "example": "X4" + } + } + } + } + } + } + } + }, + "PropertyBuildings": { + "type": "object", + "description": "Buildings within the property", + "required": [ + "PropertyBuilding" + ], + "properties": { + "PropertyBuilding": { + "type": "array", + "description": "List of buildings", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Building attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Building ID", + "example": 56180 + }, + "Name": { + "type": "string", + "description": "Building name", + "example": "BUILDING 01" + } + } + } + } + } + } + } + }, + "PropertyFloorplans": { + "type": "object", + "description": "Floorplans available at the property", + "required": [ + "PropertyFloorplan" + ], + "properties": { + "PropertyFloorplan": { + "type": "array", + "description": "List of floorplans", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Floorplan attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Floorplan ID", + "example": 477949 + }, + "Name": { + "type": "string", + "description": "Floorplan name", + "example": "Exist501" + } + } + } + } + } + } + } + }, + "MoveOutReasons": { + "type": "object", + "description": "Reasons for moving out of the property", + "required": [ + "MoveOutReason" + ], + "properties": { + "MoveOutReason": { + "type": "array", + "description": "List of move-out reasons", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Move-out reason attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Move-out reason ID", + "example": 1039203 + }, + "SystemCode": { + "type": "string", + "description": "System code for the move-out reason", + "example": "TESTING_SYSTEM_CODE" + }, + "Name": { + "type": "string", + "description": "Move-out reason name", + "example": "13th_avenue_need_big_rooms" + } + } + } + } + } + } + } + }, + "PropertySearchAreas": { + "type": "object", + "description": "Search areas related to the property", + "required": [ + "SearchAreas" + ], + "properties": { + "SearchAreas": { + "type": "object", + "description": "List of search areas for the property", + "required": [ + "SearchArea" + ], + "properties": { + "SearchArea": { + "type": "array", + "description": "List of search areas", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "description": "Search area attributes", + "properties": { + "Id": { + "type": "integer", + "description": "Search area ID", + "example": 33674 + }, + "CompanySearchAreaId": { + "type": "integer", + "description": "Company-specific search area ID", + "example": 1206 + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertyPickLists_r2_SuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "description": "Contains properties, search areas, and other relevant data", + "required": [ + "properties", + "searchAreaStates", + "phoneNumberTypes", + "addressTypes", + "amenityReservationStatusTypes", + "taxNumberTypes", + "companyIdentificationTypes", + "unitSpaceStatusTypes", + "genders", + "defaultAmenities", + "amenityTypes", + "academicYears" + ], + "properties": { + "properties": { + "type": "object", + "description": "Details of properties", + "required": [ + "property" + ], + "properties": { + "property": { + "type": "array", + "description": "List of properties", + "items": { + "type": "object", + "required": [ + "id", + "name", + "unitTypes", + "propertyBuildings", + "propertyFloorplans", + "propertyFloors", + "rentableItems", + "addOnCategories", + "assignableItems", + "services", + "moveOutTypes", + "moveOutReasons", + "leaseTerms", + "UnitExclusionReasonTypes" + ], + "properties": { + "id": { + "type": "integer", + "description": "Property ID", + "example": 172775 + }, + "name": { + "type": "string", + "description": "Property name", + "example": "0001 Ea@@st Park Prop@erty test" + }, + "unitTypes": { + "type": "object", + "description": "Unit types available at the property", + "required": [ + "unitType" + ], + "properties": { + "unitType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unit type ID", + "example": 582099 + }, + "name": { + "type": "string", + "description": "Unit type name", + "example": "Unit type 2" + } + } + } + } + } + }, + "propertyBuildings": { + "type": "object", + "description": "Buildings within the property", + "required": [ + "propertyBuilding" + ], + "properties": { + "propertyBuilding": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Building ID", + "example": 56457 + }, + "name": { + "type": "string", + "description": "Building name", + "example": "Building A" + } + } + } + } + } + }, + "propertyFloorplans": { + "type": "object", + "description": "Floorplans available at the property", + "required": [ + "propertyFloorplan" + ], + "properties": { + "propertyFloorplan": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Floorplan ID", + "example": 1088268 + }, + "name": { + "type": "string", + "description": "Floorplan name", + "example": "Studio" + } + } + } + } + } + }, + "propertyFloors": { + "type": "object", + "description": "Floors in the property", + "required": [ + "propertyFloor" + ], + "properties": { + "propertyFloor": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "title" + ], + "properties": { + "id": { + "type": "integer", + "description": "Floor ID", + "example": 2662740 + }, + "title": { + "type": "string", + "description": "Floor title", + "example": "Floor A" + } + } + } + } + } + }, + "rentableItems": { + "type": "object", + "description": "Items that are rentable", + "required": [ + "rentableItem" + ], + "properties": { + "rentableItem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Rentable item ID", + "example": 81449 + }, + "name": { + "type": "string", + "description": "Rentable item name", + "example": "TempGarage" + } + } + } + } + } + }, + "addOnCategories": { + "type": "object", + "description": "Categories of add-ons available", + "required": [ + "addOnCategory" + ], + "properties": { + "addOnCategory": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Add-on category ID", + "example": 275 + }, + "name": { + "type": "string", + "description": "Add-on category name", + "example": "Garage" + } + } + } + } + } + }, + "assignableItems": { + "type": "object", + "description": "Items that can be assigned", + "required": [ + "assignableItem" + ], + "properties": { + "assignableItem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Assignable item ID", + "example": 8377 + }, + "name": { + "type": "string", + "description": "Assignable item name", + "example": "Gym Card" + } + } + } + } + } + }, + "services": { + "type": "object", + "description": "Services available at the property", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Service ID", + "example": 77455 + }, + "name": { + "type": "string", + "description": "Service name", + "example": "Full Furnishing 1" + } + } + } + } + } + }, + "moveOutTypes": { + "type": "object", + "description": "Types of move-out scenarios", + "required": [ + "moveOutType" + ], + "properties": { + "moveOutType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Move-out type ID", + "example": 1 + }, + "name": { + "type": "string", + "description": "Move-out type name", + "example": "Eviction" + } + } + } + } + } + }, + "moveOutReasons": { + "type": "object", + "description": "Reasons for move-out", + "required": [ + "moveOutReason" + ], + "properties": { + "moveOutReason": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "moveOutTypeId" + ], + "properties": { + "id": { + "type": "integer", + "description": "Move-out reason ID", + "example": 116934 + }, + "name": { + "type": "string", + "description": "Move-out reason name", + "example": "Unknown Skip Reason" + }, + "moveOutTypeId": { + "type": "integer", + "description": "Associated move-out type ID", + "example": 2 + } + } + } + } + } + }, + "leaseTerms": { + "type": "object", + "description": "Lease terms available for the property", + "required": [ + "leaseTerm" + ], + "properties": { + "leaseTerm": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "leaseStartWindows" + ], + "properties": { + "leaseTermId": { + "type": "integer", + "description": "Lease term ID", + "example": 19136 + }, + "leaseTermName": { + "type": "string", + "description": "Lease term name", + "example": "Fall 2020" + }, + "leaseStartWindows": { + "type": "object", + "description": "Lease start windows for the term", + "required": [ + "leaseStartWindow" + ], + "properties": { + "leaseStartWindow": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseStartWindowId", + "windowStartDate", + "windowEndDate", + "academicYearId" + ], + "properties": { + "leaseStartWindowId": { + "type": "integer", + "description": "Lease start window ID", + "example": 110263 + }, + "windowStartDate": { + "type": "string", + "description": "Window start date", + "example": "08/01/2020" + }, + "windowEndDate": { + "type": "string", + "description": "Window end date", + "example": "12/31/2020" + }, + "academicYearId": { + "type": "integer", + "description": "Academic year ID", + "example": 3 + } + } + } + } + } + } + } + } + } + } + }, + "UnitExclusionReasonTypes": { + "type": "object", + "description": "Exclusion reasons for units", + "required": [ + "UnitExclusionReasonType" + ], + "properties": { + "UnitExclusionReasonType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Exclusion reason type ID", + "example": 2 + }, + "name": { + "type": "string", + "description": "Exclusion reason type name", + "example": "Hospitality Unit" + } + } + } + } + } + } + } + } + } + } + }, + "searchAreaStates": { + "type": "object", + "description": "Search area states and associated details", + "required": [ + "searchAreaState" + ], + "properties": { + "searchAreaState": { + "type": "array", + "items": { + "type": "object", + "required": [ + "state", + "stateCode", + "countryCode", + "searchAreas" + ], + "properties": { + "state": { + "type": "string", + "description": "State name", + "example": "Armed Forces Americas (Excluding Canada)" + }, + "stateCode": { + "type": "string", + "description": "State code", + "example": "AA" + }, + "countryCode": { + "type": "string", + "description": "Country code", + "example": "US" + }, + "searchAreas": { + "type": "object", + "description": "Search areas within the state", + "required": [ + "searchArea" + ], + "properties": { + "searchArea": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "integer", + "description": "Search area ID", + "example": 2096 + }, + "name": { + "type": "string", + "description": "Search area name", + "example": "subsearch1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getRentableItemsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Unique identifier for the request", + "example": 15 + }, + "result": { + "type": "object", + "description": "Contains rentable item types, items, and charge details", + "required": [ + "RentableItemTypes" + ], + "properties": { + "RentableItemTypes": { + "type": "object", + "description": "Types of rentable items available", + "required": [ + "RentableItemType" + ], + "properties": { + "RentableItemType": { + "type": "object", + "required": [ + "Id", + "Name", + "Description", + "Rents", + "Deposits", + "RentableItems" + ], + "properties": { + "Id": { + "type": "integer", + "description": "ID of the rentable item type", + "example": 2628 + }, + "Name": { + "type": "string", + "description": "Name of the rentable item type", + "example": "Bikes" + }, + "Description": { + "type": "string", + "description": "Description of the rentable item type", + "example": "Motorcycles" + }, + "Rents": { + "type": "object", + "description": "Rent charges associated with the item", + "required": [ + "Rent" + ], + "properties": { + "Rent": { + "type": "object", + "required": [ + "Type", + "ChargeCode", + "Amount" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of rent charge", + "example": "RIT" + }, + "ChargeCode": { + "type": "string", + "description": "Charge code for rent", + "example": "Rent" + }, + "Amount": { + "type": "string", + "description": "Amount of the rent charge", + "example": "$100.00" + } + } + } + } + }, + "Deposits": { + "type": "object", + "description": "Deposit charges associated with the item", + "required": [ + "Deposit" + ], + "properties": { + "Deposit": { + "type": "object", + "required": [ + "Type", + "ChargeCode", + "Amount" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of deposit charge", + "example": "RIT" + }, + "ChargeCode": { + "type": "string", + "description": "Charge code for deposit", + "example": "example" + }, + "Amount": { + "type": "string", + "description": "Amount of the deposit charge", + "example": "$55.00" + } + } + } + } + }, + "RentableItems": { + "type": "object", + "description": "List of specific rentable items available", + "required": [ + "RentableItem" + ], + "properties": { + "RentableItem": { + "type": "object", + "required": [ + "Id", + "Name", + "ReservationStartDate", + "ReservationEndDate", + "HoldUntil", + "Rents", + "Deposits", + "Description" + ], + "properties": { + "Id": { + "type": "integer", + "description": "ID of the rentable item", + "example": 90613 + }, + "Name": { + "type": "string", + "description": "Name of the rentable item", + "example": "Hayabuza" + }, + "ReservationStartDate": { + "type": "string", + "description": "Start date for reservations", + "example": "05/04/2013" + }, + "ReservationEndDate": { + "type": "string", + "description": "End date for reservations", + "example": "06/30/2013" + }, + "HoldUntil": { + "type": "string", + "description": "Hold until date for the item", + "example": "04/11/2013" + }, + "Rents": { + "type": "object", + "description": "Rent charges for the specific item", + "required": [ + "Rent" + ], + "properties": { + "Rent": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Type", + "ChargeCode", + "Amount" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of rent charge", + "example": "RIT" + }, + "ChargeCode": { + "type": "string", + "description": "Charge code for rent", + "example": "Rent" + }, + "Amount": { + "type": "string", + "description": "Amount of the rent charge", + "example": "$100.00" + } + } + } + } + } + }, + "Deposits": { + "type": "object", + "description": "Deposit charges for the specific item", + "required": [ + "Deposit" + ], + "properties": { + "Deposit": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Type", + "ChargeCode", + "Amount" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of deposit charge", + "example": "RIT" + }, + "ChargeCode": { + "type": "string", + "description": "Charge code for deposit", + "example": "example" + }, + "Amount": { + "type": "string", + "description": "Amount of the deposit charge", + "example": "$55.00" + } + } + } + } + } + }, + "Description": { + "type": "string", + "description": "Description of the rentable item", + "example": "Suzuki" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getReservableAmenitiesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "amenities" + ], + "properties": { + "amenities": { + "type": "object", + "required": [ + "amenity" + ], + "properties": { + "amenity": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "reservedByDay", + "blockHoursByDay", + "maxReservationDays", + "maxHours", + "isApprovalRequired", + "isResidentVisible", + "isAllowFutureResident" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the amenity", + "example": "123456" + }, + "name": { + "type": "string", + "description": "Name of the amenity", + "example": "Tennis Court" + }, + "description": { + "type": "string", + "description": "Description of the amenity", + "example": "Beautiful see on the telly across the pond." + }, + "reservedByDay": { + "type": "string", + "description": "Indicates whether the amenity is reserved by day", + "example": "0" + }, + "blockHoursByDay": { + "type": "string", + "description": "Indicates how many hours per day the amenity is blocked", + "example": "1" + }, + "blockDays": { + "type": "object", + "description": "List of block hours for specific days", + "required": [ + "blockDay" + ], + "properties": { + "blockDay": { + "type": "array", + "items": { + "type": "object", + "required": [ + "day", + "blockHours" + ], + "properties": { + "day": { + "type": "string", + "description": "Day of the week", + "example": "Sunday" + }, + "blockHours": { + "type": "string", + "description": "Blocked hours for that day", + "example": "12am,1am,2am,11pm" + } + } + } + } + } + }, + "maxReservationDays": { + "type": "string", + "description": "Maximum number of days in advance a resident can reserve the amenity", + "example": "30" + }, + "maxHours": { + "type": "string", + "description": "Maximum number of hours that can be reserved for the amenity", + "example": "3" + }, + "isApprovalRequired": { + "type": "string", + "description": "Whether approval is required for reserving the amenity", + "example": "0" + }, + "isResidentVisible": { + "type": "string", + "description": "Indicates whether the amenity is visible to residents", + "example": "1" + }, + "isAllowFutureResident": { + "type": "string", + "description": "Indicates whether future residents are allowed to reserve the amenity", + "example": "0" + }, + "rates": { + "type": "object", + "description": "List of rates associated with the amenity", + "required": [ + "rate" + ], + "properties": { + "rate": { + "type": "array", + "items": { + "type": "object", + "required": [ + "arCodeId", + "arCodeTypeId", + "chargeTypeId", + "amount", + "active", + "isPublish" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "AR code ID for the rate", + "example": "1234" + }, + "arCodeTypeId": { + "type": "string", + "description": "AR code type ID", + "example": "7" + }, + "chargeTypeId": { + "type": "string", + "description": "Charge type ID", + "example": "410" + }, + "amount": { + "type": "string", + "description": "Amount for the rate", + "example": "$1.00" + }, + "active": { + "type": "string", + "description": "Whether the rate is active", + "example": "1" + }, + "isPublish": { + "type": "string", + "description": "Indicates whether the rate is published", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getWebsitesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "websites" + ], + "properties": { + "websites": { + "type": "object", + "required": [ + "website" + ], + "properties": { + "website": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "subdomain", + "isCorporateWebsite", + "websiteProperties", + "websiteDomains" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the website", + "example": "25079" + }, + "name": { + "type": "string", + "description": "Name of the website", + "example": "Abhi_website" + }, + "subdomain": { + "type": "string", + "description": "Subdomain of the website", + "example": "abhiwebsite" + }, + "isCorporateWebsite": { + "type": "integer", + "description": "Indicates if the website is corporate", + "example": 0 + }, + "websiteProperties": { + "type": "object", + "required": [ + "websiteProperty" + ], + "properties": { + "websiteProperty": { + "type": "array", + "items": { + "type": "object", + "required": [ + "propertyId", + "propertyName" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "ID of the property associated with the website", + "example": "160681" + }, + "propertyName": { + "type": "string", + "description": "Name of the property associated with the website", + "example": "Abhi_Test" + } + } + } + } + } + }, + "websiteDomains": { + "type": "object", + "required": [ + "websiteDomain" + ], + "properties": { + "websiteDomain": { + "type": "array", + "items": { + "type": "object", + "required": [ + "domain", + "isPrimary", + "isSecure" + ], + "properties": { + "domain": { + "type": "string", + "description": "Domain associated with the website", + "example": "test12.com" + }, + "isPrimary": { + "type": "integer", + "description": "Indicates whether the domain is primary", + "example": 1 + }, + "isSecure": { + "type": "boolean", + "description": "Indicates whether the domain is secure", + "example": false + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendFloorplansSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Floorplans" + ], + "properties": { + "Floorplans": { + "type": "object", + "required": [ + "Floorplan" + ], + "properties": { + "Floorplan": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "status", + "floorplanId", + "name", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Node identifier for the floorplan", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the floorplan insertion", + "example": "Success" + }, + "floorplanId": { + "type": "integer", + "description": "Unique identifier for the floorplan", + "example": 1145077 + }, + "name": { + "type": "string", + "description": "Name of the floorplan", + "example": "Floorplan 1" + }, + "message": { + "type": "string", + "description": "Message related to the floorplan insertion", + "example": "Floorplan inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "sendRentableItemsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "rentableItemTypes" + ], + "properties": { + "rentableItemTypes": { + "type": "object", + "required": [ + "rentableItemType" + ], + "properties": { + "rentableItemType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "rentableItemTypeId", + "rentableItemIds", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Node identifier for the rentable item type", + "example": 1 + }, + "rentableItemTypeId": { + "type": "integer", + "description": "Unique identifier for the rentable item type", + "example": 81625 + }, + "rentableItemIds": { + "type": "string", + "description": "Comma-separated list of rentable item IDs associated with this type", + "example": "7157472,7157473,7157474" + }, + "status": { + "type": "string", + "description": "Status of the rentable item type insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message related to the rentable item type insertion", + "example": "rentableItemType inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "getAmenitiesSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "result": { + "type": "object", + "required": [ + "Amenities" + ], + "properties": { + "Amenities": { + "type": "object", + "required": [ + "PropertyAmenities", + "UnitAmenities", + "FloorplanAmenities", + "UnitTypeAmenities" + ], + "properties": { + "PropertyAmenities": { + "type": "object", + "required": [ + "Amenity" + ], + "properties": { + "Amenity": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Name", + "Description", + "Rates", + "@attributes" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the property amenity", + "example": "Property Amenity 1" + }, + "ImageUrl": { + "type": "string", + "description": "URL to the image representing the amenity", + "example": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg" + }, + "Description": { + "type": "string", + "description": "Description of the amenity", + "example": "Property level Amenity" + }, + "Rates": { + "type": "object", + "required": [ + "Rate" + ], + "properties": { + "Rate": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "ArCodeId": { + "type": "string", + "description": "Unique identifier for the charge code", + "example": "149655" + }, + "ArCodeTypeId": { + "type": "string", + "description": "Type of the charge", + "example": "2" + }, + "ChargeTypeId": { + "type": "string", + "description": "Charge type ID", + "example": "302" + }, + "Amount": { + "type": "string", + "description": "The amount associated with the rate", + "example": "$300.00" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the rate is published", + "example": "1" + }, + "IsActive": { + "type": "string", + "description": "Indicates if the rate is active", + "example": "1" + }, + "LeaseTermId": { + "type": "string", + "description": "The lease term ID", + "example": "18414" + }, + "LeaseStartWindowId": { + "type": "string", + "description": "The lease start window ID", + "example": "12345" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the amenity", + "example": "11111" + }, + "ExternalId": { + "type": "string", + "description": "External identifier for the amenity", + "example": "AmenityRPK" + }, + "IsOptional": { + "type": "string", + "description": "Indicates if the amenity is optional", + "example": "0" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the amenity is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the amenity is featured", + "example": "0" + }, + "HideRates": { + "type": "string", + "description": "Indicates if the rates are hidden", + "example": "0" + } + } + } + } + } + } + } + }, + "UnitAmenities": { + "type": "object", + "required": [ + "Amenity" + ], + "properties": { + "Amenity": { + "type": "object", + "required": [ + "Name", + "Description", + "Units", + "@attributes" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the unit amenity", + "example": "Unit Amenity 1" + }, + "ImageUrl": { + "type": "string", + "description": "URL to the image representing the amenity", + "example": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg" + }, + "Description": { + "type": "string", + "description": "Description of the amenity", + "example": "Unit level Amenity" + }, + "Units": { + "type": "object", + "required": [ + "Unit" + ], + "properties": { + "Unit": { + "type": "object", + "required": [ + "Rates", + "@attributes" + ], + "properties": { + "Rates": { + "type": "object", + "required": [ + "Rate" + ], + "properties": { + "Rate": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "ArCodeId": { + "type": "string", + "description": "Unique identifier for the charge code", + "example": "149655" + }, + "ArCodeTypeId": { + "type": "string", + "description": "Type of the charge", + "example": "2" + }, + "ChargeTypeId": { + "type": "string", + "description": "Charge type ID", + "example": "307" + }, + "Amount": { + "type": "string", + "description": "The amount associated with the rate", + "example": "$500.00" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the rate is published", + "example": "0" + }, + "IsActive": { + "type": "string", + "description": "Indicates if the rate is active", + "example": "0" + }, + "LeaseTermId": { + "type": "string", + "description": "The lease term ID", + "example": "18414" + }, + "LeaseStartWindowId": { + "type": "string", + "description": "The lease start window ID", + "example": "12345" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "PropertyUnitId": { + "type": "string", + "description": "Unique identifier for the unit", + "example": "111111" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the unit is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the unit is featured", + "example": "0" + }, + "HideRates": { + "type": "string", + "description": "Indicates if the rates are hidden", + "example": "0" + }, + "ShowDescription": { + "type": "string", + "description": "Indicates if the description is shown", + "example": "0" + }, + "IncludeInRent": { + "type": "string", + "description": "Indicates if the amenity is included in rent", + "example": "0" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the unit amenity", + "example": "33333" + }, + "IsStandardAmenity": { + "type": "string", + "description": "Indicates if the amenity is standard", + "example": "1" + }, + "IsOptional": { + "type": "string", + "description": "Indicates if the amenity is optional", + "example": "0" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the amenity is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the amenity is featured", + "example": "0" + }, + "HideRates": { + "type": "string", + "description": "Indicates if the rates are hidden", + "example": "0" + }, + "ShowDescription": { + "type": "string", + "description": "Indicates if the description is shown", + "example": "0" + }, + "IncludeInRent": { + "type": "string", + "description": "Indicates if the amenity is included in rent", + "example": "0" + } + } + } + } + } + } + }, + "FloorplanAmenities": { + "type": "object", + "required": [ + "Amenity" + ], + "properties": { + "Amenity": { + "type": "object", + "required": [ + "Name", + "Description", + "Floorplans", + "@attributes" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the floorplan amenity", + "example": "Additional Storage" + }, + "ImageUrl": { + "type": "string", + "description": "URL to the image representing the amenity", + "example": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg" + }, + "Description": { + "type": "string", + "description": "Description of the amenity", + "example": "Floorplan Amenity" + }, + "Floorplans": { + "type": "object", + "required": [ + "Floorplan" + ], + "properties": { + "Floorplan": { + "type": "object", + "required": [ + "Rates", + "@attributes" + ], + "properties": { + "Rates": { + "type": "object", + "required": [ + "Rate" + ], + "properties": { + "Rate": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "ArCodeId": { + "type": "string", + "description": "Unique identifier for the charge code", + "example": "149655" + }, + "ArCodeTypeId": { + "type": "string", + "description": "Type of the charge", + "example": "2" + }, + "ChargeTypeId": { + "type": "string", + "description": "Charge type ID", + "example": "303" + }, + "Amount": { + "type": "string", + "description": "The amount associated with the rate", + "example": "$100.00" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the rate is published", + "example": "1" + }, + "IsActive": { + "type": "string", + "description": "Indicates if the rate is active", + "example": "1" + }, + "LeaseTermId": { + "type": "string", + "description": "The lease term ID", + "example": "18414" + }, + "LeaseStartWindowId": { + "type": "string", + "description": "The lease start window ID", + "example": "12345" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "PropertyFloorplanId": { + "type": "string", + "description": "Unique identifier for the floorplan", + "example": "00000" + }, + "ExternalId": { + "type": "string", + "description": "External identifier for the floorplan", + "example": "123456" + }, + "IsOptional": { + "type": "string", + "description": "Indicates if the floorplan is optional", + "example": "0" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the floorplan is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the floorplan is featured", + "example": "0" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the floorplan amenity", + "example": "0000" + } + } + } + } + } + } + }, + "UnitTypeAmenities": { + "type": "object", + "required": [ + "Amenity" + ], + "properties": { + "Amenity": { + "type": "object", + "required": [ + "Name", + "Description", + "Units", + "@attributes" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the unit type amenity", + "example": "Unit Amenity 1" + }, + "ImageUrl": { + "type": "string", + "description": "URL to the image representing the amenity", + "example": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg" + }, + "Description": { + "type": "string", + "description": "Description of the amenity", + "example": "Unit level Amenity" + }, + "Units": { + "type": "object", + "required": [ + "Unit" + ], + "properties": { + "Unit": { + "type": "object", + "required": [ + "Rates", + "@attributes" + ], + "properties": { + "Rates": { + "type": "object", + "required": [ + "Rate" + ], + "properties": { + "Rate": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "properties": { + "ArCodeId": { + "type": "string", + "description": "Unique identifier for the charge code", + "example": "149655" + }, + "ArCodeTypeId": { + "type": "string", + "description": "Type of the charge", + "example": "2" + }, + "ChargeTypeId": { + "type": "string", + "description": "Charge type ID", + "example": "307" + }, + "Amount": { + "type": "string", + "description": "The amount associated with the rate", + "example": "$500.00" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the rate is published", + "example": "0" + }, + "IsActive": { + "type": "string", + "description": "Indicates if the rate is active", + "example": "0" + }, + "LeaseTermId": { + "type": "string", + "description": "The lease term ID", + "example": "18414" + }, + "LeaseStartWindowId": { + "type": "string", + "description": "The lease start window ID", + "example": "12345" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "PropertyUnitId": { + "type": "string", + "description": "Unique identifier for the unit", + "example": "111111" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the unit is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the unit is featured", + "example": "0" + }, + "HideRates": { + "type": "string", + "description": "Indicates if the rates are hidden", + "example": "0" + }, + "ShowDescription": { + "type": "string", + "description": "Indicates if the description is shown", + "example": "0" + }, + "IncludeInRent": { + "type": "string", + "description": "Indicates if the amenity is included in rent", + "example": "0" + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the unit type amenity", + "example": "33333" + }, + "IsStandardAmenity": { + "type": "string", + "description": "Indicates if the amenity is standard", + "example": "1" + }, + "IsOptional": { + "type": "string", + "description": "Indicates if the amenity is optional", + "example": "0" + }, + "IsPublished": { + "type": "string", + "description": "Indicates if the amenity is published", + "example": "1" + }, + "IsFeatured": { + "type": "string", + "description": "Indicates if the amenity is featured", + "example": "0" + }, + "HideRates": { + "type": "string", + "description": "Indicates if the rates are hidden", + "example": "0" + }, + "ShowDescription": { + "type": "string", + "description": "Indicates if the description is shown", + "example": "0" + }, + "IncludeInRent": { + "type": "string", + "description": "Indicates if the amenity is included in rent", + "example": "0" + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getMitsPropertyUnitsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "description": "Unique identifier for the request", + "type": "string", + "example": "15" + }, + "result": { + "description": "Result data containing detailed property information", + "type": "object", + "properties": { + "PhysicalProperty": { + "description": "Physical property details", + "type": "object", + "properties": { + "Management": { + "description": "Property management information", + "type": "object", + "properties": { + "Identification": { + "description": "Identification details for the management", + "type": "object", + "properties": { + "IDValue": { + "description": "Unique ID for the management", + "type": "string", + "example": "1234" + }, + "OrganizationName": { + "description": "Name of the managing organization", + "type": "string", + "example": "DB Xento Systems Pvt. Ltd." + } + } + }, + "PropertyContacts": { + "description": "Contacts for the property management", + "type": "object", + "properties": { + "Companies": { + "description": "Companies related to the property", + "type": "object", + "properties": { + "Identification": { + "description": "Identification details for the company", + "type": "object", + "properties": { + "IDValue": { + "description": "Unique company ID", + "type": "string", + "example": "1234" + } + } + }, + "CompanyName": { + "description": "Name of the company", + "type": "string", + "example": "DB Xento Systems Pvt. Ltd." + }, + "WebSite": { + "description": "Company website URL", + "type": "string", + "example": "http://newtestinggroup.prospectportal.com" + } + } + } + } + } + } + }, + "Property": { + "description": "Details of the property", + "type": "array", + "items": { + "type": "object", + "properties": { + "Identification": { + "description": "Identification details of the property", + "type": "object", + "properties": { + "IDValue": { + "description": "Property ID value", + "type": "string", + "example": "1234" + }, + "@attributes": { + "description": "Attributes related to the property ID", + "type": "object", + "properties": { + "IDScopeType": { + "description": "Scope type of the ID", + "type": "string", + "example": "sender" + }, + "IDRank": { + "description": "Rank of the ID", + "type": "string", + "example": "primary" + } + } + } + } + }, + "PropertyID": { + "description": "Property ID and details", + "type": "object", + "properties": { + "Identification": { + "description": "Identification of the property", + "type": "object", + "properties": { + "IDValue": { + "description": "Property ID value", + "type": "string", + "example": "1234" + } + } + }, + "MarketingName": { + "description": "Marketing name of the property", + "type": "string", + "example": "ZOMBIES" + }, + "LegalName": { + "description": "Legal name of the property", + "type": "string", + "example": "ZOMBIES" + }, + "WebSite": { + "description": "Property website", + "type": "string", + "example": "http://testrentreminderlobby.prospectportal.com" + }, + "Address": { + "description": "Address of the property", + "type": "object", + "properties": { + "Address": { + "description": "Street address of the property", + "type": "string", + "example": "500 S, 100 W, 100k" + }, + "City": { + "description": "City of the property", + "type": "string", + "example": "Provo" + }, + "State": { + "description": "State of the property", + "type": "string", + "example": "UT" + }, + "PostalCode": { + "description": "Postal code for the property", + "type": "string", + "example": "84601" + }, + "Country": { + "description": "Country of the property", + "type": "string", + "example": "US" + } + } + }, + "Phone": { + "description": "Phone numbers associated with the property", + "type": "array", + "items": { + "type": "object", + "properties": { + "PhoneDescription": { + "description": "Description of the phone number", + "type": "string", + "example": "Office" + }, + "PhoneNumber": { + "description": "Phone number", + "type": "string", + "example": "190018000" + }, + "@attributes": { + "description": "Attributes related to the phone number", + "type": "object", + "properties": { + "PhoneType": { + "description": "Type of phone", + "type": "string", + "example": "office" + } + } + } + } + } + } + } + }, + "ILS_Identification": { + "description": "ILS identification details", + "type": "object", + "properties": { + "DaylightSaving": { + "description": "Daylight saving time status", + "type": "string", + "example": "0" + }, + "TimeZone": { + "description": "Time zone of the property", + "type": "string", + "example": "Central Standard Time (GMT -0600)" + }, + "@attributes": { + "description": "Attributes related to ILS identification", + "type": "object", + "properties": { + "ILS_IdentificationType": { + "description": "Type of ILS identification", + "type": "string", + "example": "Apartment" + }, + "RentalType": { + "description": "Rental type", + "type": "string", + "example": "Unspecified" + } + } + } + } + }, + "Information": { + "description": "General information about the property", + "type": "object", + "properties": { + "StructureType": { + "description": "Type of the property structure", + "type": "string", + "example": "Unspecified" + }, + "UnitCount": { + "description": "Number of units in the property", + "type": "string", + "example": "6" + }, + "YearBuilt": { + "description": "Year the property was built", + "type": "string", + "example": "2012" + }, + "OfficeHour": { + "description": "Office hours for the property", + "type": "array", + "items": { + "type": "object", + "properties": { + "OpenTime": { + "description": "Opening time for the property office", + "type": "string", + "example": "11:11 AM" + }, + "CloseTime": { + "description": "Closing time for the property office", + "type": "string", + "example": "3:11 PM" + }, + "Day": { + "description": "Day of the week for the office hours", + "type": "string", + "example": "Monday" + } + } + } + }, + "ShortDescription": { + "description": "Short description of the property", + "type": "string", + "example": "This is data thank you" + }, + "LongDescription": { + "description": "Long description of the property", + "type": "string", + "example": "This is.Thank you." + }, + "LeaseLength": { + "description": "Available lease lengths", + "type": "string", + "example": "1 month, 2 months, 3 months, 4 months, 6 months, 12 months, 18 months" + }, + "DrivingDirections": { + "description": "Directions to the property", + "type": "string", + "example": "This characters." + }, + "PropertyAvailabilityURL": { + "description": "URL for property availability", + "type": "string", + "example": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234" + } + } + } + } + } + }, + "Fee": { + "description": "Fees related to the property", + "type": "object", + "properties": { + "ApplicationFee": { + "description": "Application fee details", + "type": "object", + "properties": { + "@attributes": { + "description": "Attributes related to the fee", + "type": "object", + "properties": { + "Type": { + "description": "Type of applicant", + "type": "string", + "example": "Primary Applicant" + }, + "Amount": { + "description": "Fee amount", + "type": "string", + "example": "30" + } + } + } + } + } + } + }, + "Concession": { + "description": "Concession details for the property", + "type": "array", + "items": { + "type": "object", + "properties": { + "Value": { + "description": "Value of the concession", + "type": "string", + "example": "10.00" + }, + "DescriptionHeader": { + "description": "Header for the concession description", + "type": "string", + "example": "Test_Special" + }, + "DescriptionBody": { + "description": "Body of the concession description", + "type": "string", + "example": "description" + }, + "DescriptionFooter": { + "description": "Footer of the concession description", + "type": "string", + "example": "footer description" + }, + "@attributes": { + "description": "Attributes related to the concession", + "type": "object", + "properties": { + "Active": { + "description": "Indicates if the concession is active", + "type": "string", + "example": "1" + } + } + } + } + } + }, + "Amenity": { + "description": "Property amenities", + "type": "array", + "items": { + "type": "object", + "properties": { + "Description": { + "description": "Description of the amenity", + "type": "string", + "example": "24 Hour Emergency Maintenancess" + }, + "@attributes": { + "description": "Attributes related to the amenity", + "type": "object", + "properties": { + "AmenityType": { + "description": "Type of the amenity", + "type": "string", + "example": "Other" + } + } + } + } + } + }, + "Policy": { + "description": "Property policies", + "type": "object", + "properties": { + "Pet": { + "description": "Pet policy", + "type": "array", + "items": { + "type": "object", + "properties": { + "Pets": { + "description": "Details of the pet policy", + "type": "object", + "properties": { + "@attributes": { + "description": "Attributes related to the pet policy", + "type": "object", + "properties": { + "Count": { + "description": "Number of pets allowed", + "type": "string", + "example": "0" + }, + "Description": { + "description": "Description of the pets allowed", + "type": "string", + "example": "Cat" + }, + "PetType": { + "description": "Type of pet allowed", + "type": "string", + "example": "Cat" + }, + "Size": { + "description": "Size of the pet", + "type": "string", + "example": "Medium" + }, + "Weight": { + "description": "Weight of the pet", + "type": "string", + "example": "" + } + } + } + } + }, + "@attributes": { + "description": "Attributes related to the pet policy", + "type": "object", + "properties": { + "Allowed": { + "description": "Indicates if pets are allowed", + "type": "string", + "example": "true" + } + } + } + } + } + }, + "General": { + "description": "General policies for the property", + "type": "string", + "example": "You can park your vehical anywhere except reserved parking spaces." + } + } + }, + "Building": { + "description": "Details of the building", + "type": "array", + "items": { + "type": "object", + "properties": { + "Identification": { + "description": "Building identification", + "type": "object", + "properties": { + "IDValue": { + "description": "Building ID value", + "type": "string", + "example": "1234" + }, + "@attributes": { + "description": "Attributes related to the building ID", + "type": "object", + "properties": { + "IDScopeType": { + "description": "Scope type of the building ID", + "type": "string", + "example": "sender" + }, + "IDRank": { + "description": "Rank of the building ID", + "type": "string", + "example": "primary" + } + } + } + } + }, + "Name": { + "description": "Name of the building", + "type": "string", + "example": "ZOM 1" + }, + "Description": { + "description": "Description of the building", + "type": "string", + "example": "ZOM 1" + }, + "UnitCount": { + "description": "Number of units in the building", + "type": "string", + "example": "85" + }, + "SquareFeet": { + "description": "Square footage of the building", + "type": "string", + "example": "0" + }, + "File": { + "description": "Files related to the building", + "type": "array", + "items": { + "type": "object", + "properties": { + "FileType": { + "description": "Type of the file", + "type": "string", + "example": "Photo" + }, + "Name": { + "description": "Name of the file", + "type": "string", + "example": "hotchocolate2_documentation_copy1.pdf" + }, + "Format": { + "description": "File format", + "type": "string", + "example": "pdf" + }, + "Src": { + "description": "Source URL of the file", + "type": "string", + "example": "https://medialibrary.propertysolutions.com/media_library/1234/51cbf70a726cd636.pdf" + }, + "Rank": { + "description": "Rank of the file", + "type": "string", + "example": "3" + }, + "@attributes": { + "description": "Attributes related to the file", + "type": "object", + "properties": { + "FileID": { + "description": "Unique file ID", + "type": "string", + "example": "461182" + }, + "Active": { + "description": "Indicates if the file is active", + "type": "string", + "example": "true" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPropertyUnitsSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Request ID - The ID for the request", + "example": 15 + }, + "result": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "type": "object", + "required": [ + "property" + ], + "properties": { + "property": { + "type": "object", + "required": [ + "propertyId", + "propertyName", + "remotePrimaryKey", + "unitCount", + "buildingCount", + "propertyAvailabilityURL", + "units" + ], + "properties": { + "propertyId": { + "type": "integer", + "description": "Unique identifier for the property", + "example": 1234 + }, + "propertyName": { + "type": "string", + "description": "Name of the property", + "example": "property name" + }, + "remotePrimaryKey": { + "type": "string", + "description": "Identifier from the remote system", + "example": "client name" + }, + "unitCount": { + "type": "integer", + "description": "Number of units in the property", + "example": 6 + }, + "buildingCount": { + "type": "integer", + "description": "Number of buildings in the property", + "example": 4 + }, + "propertyAvailabilityURL": { + "type": "string", + "description": "URL for checking property availability", + "example": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234" + }, + "units": { + "type": "object", + "required": [ + "unit" + ], + "properties": { + "unit": { + "type": "object", + "required": [ + "id", + "unitNumber", + "buildingId", + "buildingName", + "floorplanId", + "floorplanName", + "unitTypeId", + "unitTypeName", + "noOfBedrooms", + "noOfBathrooms", + "squareFeet", + "isFurnished", + "isCorportateRented", + "numberOccupants", + "maxPets", + "unitAvailabilityURL", + "unitAddress", + "unitSpaces", + "customKeysData", + "files" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unit ID", + "example": 5678 + }, + "unitNumber": { + "type": "integer", + "description": "Unit number", + "example": 302 + }, + "buildingId": { + "type": "integer", + "description": "Building ID", + "example": 34 + }, + "buildingName": { + "type": "string", + "description": "Name of the building", + "example": "ShashiZom4" + }, + "floorplanId": { + "type": "integer", + "description": "Floorplan ID", + "example": 123 + }, + "floorplanName": { + "type": "string", + "description": "Floorplan name", + "example": "ZOM 1" + }, + "unitTypeId": { + "type": "integer", + "description": "Unit type ID", + "example": 6789 + }, + "unitTypeName": { + "type": "string", + "description": "Unit type name", + "example": "ZOM 1" + }, + "noOfBedrooms": { + "type": "integer", + "description": "Number of bedrooms in the unit", + "example": 3 + }, + "noOfBathrooms": { + "type": "integer", + "description": "Number of bathrooms in the unit", + "example": 2 + }, + "squareFeet": { + "type": "integer", + "description": "Unit size in square feet", + "example": 1500 + }, + "isFurnished": { + "type": "integer", + "description": "Indicates if the unit is furnished", + "example": 1 + }, + "isCorportateRented": { + "type": "integer", + "description": "Indicates if the unit is corporate rented", + "example": 1 + }, + "numberOccupants": { + "type": "integer", + "description": "Number of occupants allowed in the unit", + "example": 1 + }, + "maxPets": { + "type": "integer", + "description": "Maximum number of pets allowed in the unit", + "example": 1 + }, + "unitAvailabilityURL": { + "type": "string", + "description": "URL for unit availability", + "example": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234/launch_guest_card/1/property_floorplan[id]/1234/property_unit[id]/1234" + }, + "unitAddress": { + "type": "object", + "required": [ + "address", + "city", + "state", + "postalCode", + "country" + ], + "properties": { + "address": { + "type": "string", + "description": "Unit address", + "example": "500 S, 100 W, 100k" + }, + "city": { + "type": "string", + "description": "City where the unit is located", + "example": "Provo" + }, + "state": { + "type": "string", + "description": "State where the unit is located", + "example": "UT" + }, + "postalCode": { + "type": "integer", + "description": "Postal code of the unit", + "example": 84601 + }, + "country": { + "type": "string", + "description": "Country of the unit", + "example": "US" + } + } + }, + "unitSpaces": { + "type": "object", + "required": [ + "unitSpace" + ], + "properties": { + "unitSpace": { + "type": "object", + "required": [ + "unitSpaceId", + "unitNumber", + "isAffordable", + "hasPricing", + "excludedReason", + "spaceConfiguration", + "availabilityStatus", + "availableDate", + "makeReadyDate", + "rent", + "minDeposit", + "maxDeposit", + "reserveUntil", + "amenities", + "pets", + "rentableItems", + "assignableItems", + "services" + ], + "properties": { + "unitSpaceId": { + "type": "integer", + "description": "Unit space ID", + "example": 1245 + }, + "unitNumber": { + "type": "string", + "description": "Unit space number", + "example": "302-A" + }, + "isAffordable": { + "type": "integer", + "description": "Indicates if the unit space is affordable", + "example": 0 + }, + "hasPricing": { + "type": "integer", + "description": "Indicates if the unit space has pricing", + "example": 0 + }, + "excludedReason": { + "type": "string", + "description": "Reason for exclusion from availability", + "example": "Hospitality Unit" + }, + "spaceConfiguration": { + "type": "string", + "description": "Configuration of the space", + "example": "space configuration name" + }, + "availabilityStatus": { + "type": "string", + "description": "Availability status of the unit space", + "example": "Unoccupied" + }, + "availableDate": { + "type": "string", + "description": "Date when the unit space will be available", + "example": "YYYY-MM-DD" + }, + "makeReadyDate": { + "type": "string", + "description": "Date when the unit space will be ready", + "example": "YYYY-MM-DD" + }, + "rent": { + "type": "object", + "required": [ + "minRent", + "maxRent", + "termRent" + ], + "properties": { + "minRent": { + "type": "integer", + "description": "Minimum rent for the unit space", + "example": 25000 + }, + "maxRent": { + "type": "integer", + "description": "Maximum rent for the unit space", + "example": 30000 + }, + "termRent": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "startDate", + "endDate", + "amount", + "isBestPrice" + ], + "properties": { + "leaseTermId": { + "type": "integer", + "description": "Lease term ID", + "example": 8 + }, + "leaseTermName": { + "type": "string", + "description": "Lease term name", + "example": "1 month" + }, + "startDate": { + "type": "string", + "description": "Lease start date", + "example": "YYYY-MM-DD" + }, + "endDate": { + "type": "string", + "description": "Lease end date", + "example": "YYYY-MM-DD" + }, + "amount": { + "type": "integer", + "description": "Amount of the lease term", + "example": 0 + }, + "isBestPrice": { + "type": "integer", + "description": "Indicates if the price is the best price", + "example": 1 + } + } + } + } + }, + "minDeposit": { + "type": "string", + "description": "Minimum deposit for the unit space", + "example": "6,000.00" + }, + "maxDeposit": { + "type": "string", + "description": "Maximum deposit for the unit space", + "example": "7,000.00" + }, + "reserveUntil": { + "type": "string", + "description": "Date until when the unit is reserved", + "example": "" + }, + "amenities": { + "type": "object", + "required": [ + "amenity" + ], + "properties": { + "amenity": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "integer", + "description": "Amenity ID", + "example": 234 + }, + "name": { + "type": "string", + "description": "Amenity name", + "example": "amenity1" + }, + "type": { + "type": "string", + "description": "Amenity type", + "example": "type" + } + } + } + } + }, + "pets": { + "type": "object", + "required": [ + "pet" + ], + "properties": { + "pet": { + "type": "object", + "required": [ + "type", + "count", + "deposit", + "rent", + "fee", + "petCare", + "restrictions", + "description" + ], + "properties": { + "type": { + "type": "string", + "description": "Pet type", + "example": "Cat" + }, + "count": { + "type": "integer", + "description": "Number of pets allowed", + "example": 2 + }, + "deposit": { + "type": "integer", + "description": "Deposit for the pet", + "example": 50 + }, + "rent": { + "type": "integer", + "description": "Rent for the pet", + "example": 50 + }, + "fee": { + "type": "integer", + "description": "Fee for the pet", + "example": 50 + }, + "petCare": { + "type": "boolean", + "description": "Indicates if pet care is provided", + "example": false + }, + "restrictions": { + "type": "string", + "description": "Pet restrictions", + "example": "PET Allowed" + }, + "description": { + "type": "string", + "description": "Description of pet policy", + "example": "PET Allowed" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getSpecials_r1_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "The unique ID for the request.", + "example": 15 + }, + "result": { + "type": "object", + "required": [ + "PhysicalProperty" + ], + "properties": { + "PhysicalProperty": { + "type": "object", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "Identification", + "PropertyID", + "Concession", + "Floorplan", + "ILS_Unit" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue" + ], + "properties": { + "IDValue": { + "type": "integer", + "description": "The unique identifier for the property.", + "example": 21442 + } + } + }, + "PropertyID": { + "type": "object", + "required": [ + "Identification", + "MarketingName", + "LegalName" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue", + "OrganizationName" + ], + "properties": { + "IDValue": { + "type": "integer", + "description": "The unique identifier for the property.", + "example": 21442 + }, + "OrganizationName": { + "type": "string", + "description": "The organization name associated with the property.", + "example": "DB Xento Systems Pvt. Ltd." + } + } + }, + "MarketingName": { + "type": "string", + "description": "The marketing name of the property.", + "example": "Marketing Name" + }, + "LegalName": { + "type": "string", + "description": "The legal name of the property.", + "example": "Legal Name" + } + } + }, + "Concession": { + "type": "array", + "description": "List of concessions for the property.", + "items": { + "type": "object", + "required": [ + "@attributes", + "Value", + "DescriptionHeader", + "DescriptionBody", + "DescriptionFooter" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Active" + ], + "properties": { + "Active": { + "type": "integer", + "description": "Indicates if the concession is active.", + "example": 1 + } + } + }, + "Value": { + "type": "string", + "description": "The value of the concession.", + "example": "10.00" + }, + "DescriptionHeader": { + "type": "string", + "description": "The header for the concession description.", + "example": "Consession" + }, + "DescriptionBody": { + "type": "string", + "description": "The body of the concession description.", + "example": "description body" + }, + "DescriptionFooter": { + "type": "string", + "description": "The footer for the concession description.", + "example": "description footer" + } + } + } + }, + "Floorplan": { + "type": "array", + "description": "List of floorplans for the property.", + "items": { + "type": "object", + "required": [ + "Identification", + "Name", + "Comment", + "Concession" + ], + "properties": { + "Identification": { + "type": "object", + "required": [ + "IDValue" + ], + "properties": { + "IDValue": { + "type": "integer", + "description": "The unique identifier for the floorplan.", + "example": 127493 + } + } + }, + "Name": { + "type": "string", + "description": "The name of the floorplan.", + "example": "FP" + }, + "Comment": { + "type": "string", + "description": "A comment about the floorplan.", + "example": "FP" + }, + "Concession": { + "type": "array", + "description": "List of concessions for the floorplan.", + "items": { + "type": "object", + "required": [ + "@attributes", + "Value", + "DescriptionHeader", + "DescriptionBody", + "DescriptionFooter" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Active" + ], + "properties": { + "Active": { + "type": "integer", + "description": "Indicates if the concession is active.", + "example": 1 + } + } + }, + "Value": { + "type": "string", + "description": "The value of the concession.", + "example": "100.00" + }, + "DescriptionHeader": { + "type": "string", + "description": "The header for the concession description.", + "example": "Consession" + }, + "DescriptionBody": { + "type": "string", + "description": "The body of the concession description.", + "example": "Description" + }, + "DescriptionFooter": { + "type": "string", + "description": "The footer for the concession description.", + "example": "Description" + } + } + } + } + } + } + }, + "ILS_Unit": { + "type": "array", + "description": "List of units associated with the property.", + "items": { + "type": "object", + "required": [ + "Units", + "Concession" + ], + "properties": { + "Units": { + "type": "object", + "required": [ + "Unit" + ], + "properties": { + "Unit": { + "type": "object", + "required": [ + "@attributes", + "Identification", + "MarketingName" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "BuildingId", + "FloorPlanId" + ], + "properties": { + "BuildingId": { + "type": "integer", + "description": "The building ID for the unit.", + "example": null + }, + "FloorPlanId": { + "type": "integer", + "description": "The floorplan ID associated with the unit.", + "example": 127469 + } + } + }, + "Identification": { + "type": "object", + "required": [ + "@attributes", + "IDValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "IDRank", + "IDScopeType", + "IDType" + ], + "properties": { + "IDRank": { + "type": "string", + "description": "The rank of the unit ID.", + "example": "primary" + }, + "IDScopeType": { + "type": "string", + "description": "The scope type for the unit ID.", + "example": "sender" + }, + "IDType": { + "type": "string", + "description": "The type of the unit ID.", + "example": "UnitID" + } + } + }, + "IDValue": { + "type": "integer", + "description": "The unique identifier for the unit.", + "example": 2261175 + } + } + }, + "MarketingName": { + "type": "string", + "description": "The marketing name for the unit.", + "example": "unit1" + } + } + } + } + }, + "Concession": { + "type": "array", + "description": "List of concessions for the unit.", + "items": { + "type": "object", + "required": [ + "@attributes", + "Value", + "DescriptionHeader", + "DescriptionBody", + "DescriptionFooter" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Active" + ], + "properties": { + "Active": { + "type": "integer", + "description": "Indicates if the concession is active.", + "example": 1 + } + } + }, + "Value": { + "type": "string", + "description": "The value of the concession.", + "example": "50.00" + }, + "DescriptionHeader": { + "type": "string", + "description": "The header for the concession description.", + "example": "Test Special" + }, + "DescriptionBody": { + "type": "string", + "description": "The body of the concession description.", + "example": "description body" + }, + "DescriptionFooter": { + "type": "string", + "description": "The footer for the concession description.", + "example": "description footer" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getSpecials_r2_SuccessResponse": { + "type": "object", + "required": [ + "specials" + ], + "properties": { + "specials": { + "type": "object", + "required": [ + "propertyId", + "organizationName", + "marketingName", + "legalName", + "propertySpecials", + "floorplanSpecials", + "unitTypeSpecials", + "unitSpaceSpecials" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "The unique identifier for the property.", + "example": "54638" + }, + "organizationName": { + "type": "string", + "description": "The name of the organization associated with the property.", + "example": "Demo Account" + }, + "marketingName": { + "type": "string", + "description": "The marketing name of the property.", + "example": "JJ Property (Jonathan's)" + }, + "legalName": { + "type": "string", + "description": "The legal name of the property.", + "example": "JJ Property (Jonathan's)" + }, + "propertySpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "required": [ + "id", + "name", + "description", + "startDate", + "endDate", + "couponCode", + "cap", + "remaining", + "showOnWebsite", + "isActive", + "rates", + "leaseTerms" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the special.", + "example": "505909" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "aaa" + }, + "description": { + "type": "string", + "description": "Description of the special.", + "example": "Through the month of January we give renters a special $300 off their first month's rent." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The start date of the special.", + "example": "08/06/2018" + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the special.", + "example": "08/30/2018" + }, + "couponCode": { + "type": "string", + "description": "Coupon code for the special.", + "example": "GET50" + }, + "cap": { + "type": "string", + "description": "The cap limit for the special.", + "example": "100" + }, + "remaining": { + "type": "string", + "description": "The remaining quantity of the special.", + "example": "100" + }, + "showOnWebsite": { + "type": "string", + "description": "Flag to indicate if the special should be shown on the website.", + "example": "1" + }, + "isActive": { + "type": "string", + "description": "Flag to indicate if the special is active.", + "example": "1" + }, + "rates": { + "type": "array", + "description": "List of rates associated with the special.", + "items": { + "type": "object", + "required": [ + "chargeCodeId", + "chargeCodeTypeId", + "amount" + ], + "properties": { + "chargeCodeId": { + "type": "string", + "description": "The charge code ID for the rate.", + "example": "149206" + }, + "chargeCodeTypeId": { + "type": "string", + "description": "The charge code type ID.", + "example": "2" + }, + "amount": { + "type": "string", + "description": "The amount for the rate.", + "example": "42" + }, + "showOnWebsite": { + "type": "boolean", + "description": "Indicates whether the rate should be shown on the website.", + "example": true + }, + "leaseTermId": { + "type": "string", + "description": "The ID of the lease term associated with the rate.", + "example": "3677" + } + } + } + }, + "leaseTerms": { + "type": "array", + "description": "List of lease terms for the special.", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "isActive" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "The lease term ID.", + "example": "838" + }, + "leaseTermName": { + "type": "string", + "description": "The lease term name.", + "example": "6 months" + }, + "isActive": { + "type": "string", + "description": "Indicates if the lease term is active.", + "example": "1" + } + } + } + } + } + } + } + }, + "floorplanSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "required": [ + "id", + "name", + "description", + "startDate", + "endDate", + "couponCode", + "cap", + "remaining", + "showOnWebsite", + "isActive", + "floorplans" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the special.", + "example": "12015762" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "TestFloorPlan" + }, + "description": { + "type": "string", + "description": "Description of the special.", + "example": "Description" + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The start date of the special.", + "example": "08/06/2018" + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the special.", + "example": "08/23/2018" + }, + "couponCode": { + "type": "string", + "description": "Coupon code for the special.", + "example": "GET50" + }, + "cap": { + "type": "string", + "description": "The cap limit for the special.", + "example": "10" + }, + "remaining": { + "type": "string", + "description": "The remaining quantity of the special.", + "example": "10" + }, + "showOnWebsite": { + "type": "string", + "description": "Flag to indicate if the special should be shown on the website.", + "example": "1" + }, + "isActive": { + "type": "string", + "description": "Flag to indicate if the special is active.", + "example": "1" + }, + "floorplans": { + "type": "object", + "required": [ + "floorplan" + ], + "properties": { + "floorplan": { + "type": "object", + "required": [ + "id", + "name", + "rates", + "leaseTerms" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the floorplan.", + "example": "145501" + }, + "name": { + "type": "string", + "description": "The name of the floorplan.", + "example": "Lincoln" + }, + "rates": { + "type": "array", + "description": "List of rates associated with the floorplan.", + "items": { + "type": "object", + "required": [ + "chargeCodeId", + "chargeCodeTypeId", + "amount" + ], + "properties": { + "chargeCodeId": { + "type": "string", + "description": "The charge code ID for the rate.", + "example": "185264" + }, + "chargeCodeTypeId": { + "type": "string", + "description": "The charge code type ID.", + "example": "2" + }, + "amount": { + "type": "string", + "description": "The amount for the rate.", + "example": "3" + } + } + } + }, + "leaseTerms": { + "type": "array", + "description": "List of lease terms for the floorplan.", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "isActive" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "The lease term ID.", + "example": "838" + }, + "leaseTermName": { + "type": "string", + "description": "The lease term name.", + "example": "6 months" + }, + "isActive": { + "type": "string", + "description": "Indicates if the lease term is active.", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + }, + "unitTypeSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "required": [ + "id", + "name", + "description", + "startDate", + "endDate", + "couponCode", + "cap", + "remaining", + "showOnWebsite", + "isActive", + "unitTypes" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the special.", + "example": "12015763" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "TestFloorPlanUnitType" + }, + "description": { + "type": "string", + "description": "Description of the special.", + "example": "Description" + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The start date of the special.", + "example": "08/06/2018" + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the special.", + "example": "08/31/2018" + }, + "couponCode": { + "type": "string", + "description": "Coupon code for the special.", + "example": "GET50" + }, + "cap": { + "type": "string", + "description": "The cap limit for the special.", + "example": "10" + }, + "remaining": { + "type": "string", + "description": "The remaining quantity of the special.", + "example": "10" + }, + "showOnWebsite": { + "type": "string", + "description": "Flag to indicate if the special should be shown on the website.", + "example": "1" + }, + "isActive": { + "type": "string", + "description": "Flag to indicate if the special is active.", + "example": "1" + }, + "unitTypes": { + "type": "object", + "required": [ + "unitType" + ], + "properties": { + "unitType": { + "type": "object", + "required": [ + "id", + "name", + "rates", + "leaseTerms" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the unit type.", + "example": "161606" + }, + "name": { + "type": "string", + "description": "The name of the unit type.", + "example": "One Bedroom" + }, + "rates": { + "type": "array", + "description": "List of rates associated with the unit type.", + "items": { + "type": "object", + "required": [ + "chargeCodeId", + "chargeCodeTypeId", + "amount" + ], + "properties": { + "chargeCodeId": { + "type": "string", + "description": "The charge code ID for the rate.", + "example": "152686" + }, + "chargeCodeTypeId": { + "type": "string", + "description": "The charge code type ID.", + "example": "2" + }, + "amount": { + "type": "string", + "description": "The amount for the rate.", + "example": "6" + } + } + } + }, + "leaseTerms": { + "type": "array", + "description": "List of lease terms for the unit type.", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "isActive" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "The lease term ID.", + "example": "838" + }, + "leaseTermName": { + "type": "string", + "description": "The lease term name.", + "example": "6 months" + }, + "isActive": { + "type": "string", + "description": "Indicates if the lease term is active.", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + }, + "unitSpaceSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "required": [ + "id", + "name", + "description", + "startDate", + "endDate", + "couponCode", + "cap", + "remaining", + "showOnWebsite", + "isActive", + "unitSpaces" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the special.", + "example": "12015764" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "TestFloorPlanUnitSpace" + }, + "description": { + "type": "string", + "description": "Description of the special.", + "example": "Description" + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The start date of the special.", + "example": "08/06/2018" + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the special.", + "example": "08/31/2018" + }, + "couponCode": { + "type": "string", + "description": "Coupon code for the special.", + "example": "GET50" + }, + "cap": { + "type": "string", + "description": "The cap limit for the special.", + "example": "10" + }, + "remaining": { + "type": "string", + "description": "The remaining quantity of the special.", + "example": "10" + }, + "showOnWebsite": { + "type": "string", + "description": "Flag to indicate if the special should be shown on the website.", + "example": "1" + }, + "isActive": { + "type": "string", + "description": "Flag to indicate if the special is active.", + "example": "1" + }, + "unitSpaces": { + "type": "object", + "required": [ + "unitSpace" + ], + "properties": { + "unitSpace": { + "type": "object", + "required": [ + "id", + "buildingId", + "buildingName", + "propertyUnitId", + "name", + "rates", + "leaseTerms" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the unit space.", + "example": "2421766" + }, + "buildingId": { + "type": "string", + "description": "The building ID for the unit space.", + "example": "17642" + }, + "buildingName": { + "type": "string", + "description": "The name of the building.", + "example": "One" + }, + "propertyUnitId": { + "type": "string", + "description": "The property unit ID for the unit space.", + "example": "2409587" + }, + "name": { + "type": "string", + "description": "The name of the unit space.", + "example": "88" + }, + "rates": { + "type": "array", + "description": "List of rates associated with the unit space.", + "items": { + "type": "object", + "required": [ + "chargeCodeId", + "chargeCodeTypeId", + "amount" + ], + "properties": { + "chargeCodeId": { + "type": "string", + "description": "The charge code ID for the rate.", + "example": "208782" + }, + "chargeCodeTypeId": { + "type": "string", + "description": "The charge code type ID.", + "example": "2" + }, + "amount": { + "type": "string", + "description": "The amount for the rate.", + "example": "45" + } + } + } + }, + "leaseTerms": { + "type": "array", + "description": "List of lease terms for the unit space.", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermName", + "isActive" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "The lease term ID.", + "example": "838" + }, + "leaseTermName": { + "type": "string", + "description": "The lease term name.", + "example": "6 months" + }, + "isActive": { + "type": "string", + "description": "Indicates if the lease term is active.", + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getSpecials_r3_SuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "specials" + ], + "properties": { + "specials": { + "type": "object", + "required": [ + "propertyId", + "organizationName", + "marketingName", + "legalName", + "propertySpecials", + "floorplanSpecials", + "unitTypeSpecials", + "unitSpaceSpecials" + ], + "properties": { + "propertyId": { + "type": "integer", + "description": "The unique identifier for the property.", + "example": 171712 + }, + "organizationName": { + "type": "string", + "description": "The name of the organization associated with the property.", + "example": "Demo Account" + }, + "marketingName": { + "type": "string", + "description": "The marketing name of the property.", + "example": "14 th South Avenue" + }, + "legalName": { + "type": "string", + "description": "The legal name of the property.", + "example": "14 th South Avenue" + }, + "propertySpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "id", + "name", + "showOnWebsite", + "isActive", + "giftValue" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the special.", + "example": "12019486" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "90 - 61" + }, + "showOnWebsite": { + "type": "integer", + "description": "Indicates if the special is shown on the website.", + "example": 1 + }, + "isActive": { + "type": "integer", + "description": "Indicates if the special is active.", + "example": 1 + }, + "giftValue": { + "type": "string", + "description": "The value of the gift associated with the special.", + "example": "0.00" + } + } + } + } + } + }, + "floorplanSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "id", + "name", + "description", + "startDate", + "endDate", + "showOnWebsite", + "isActive", + "giftValue", + "floorplans" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the floorplan special.", + "example": "12033041" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "Floor special2" + }, + "description": { + "type": "string", + "description": "Description of the special.", + "example": "Great Deal!!! Great Deal!!! Great Deal!!!" + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The start date of the special.", + "example": "12/15/2020" + }, + "endDate": { + "type": "string", + "format": "date", + "description": "The end date of the special.", + "example": "12/30/2020" + }, + "showOnWebsite": { + "type": "integer", + "description": "Indicates if the special is shown on the website.", + "example": 1 + }, + "isActive": { + "type": "integer", + "description": "Indicates if the special is active.", + "example": 1 + }, + "giftValue": { + "type": "string", + "description": "The value of the gift associated with the special.", + "example": "200.00" + }, + "floorplans": { + "type": "object", + "required": [ + "floorplan" + ], + "properties": { + "floorplan": { + "type": "array", + "description": "List of floorplans included in the special.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the floorplan.", + "example": "935877" + }, + "name": { + "type": "string", + "description": "The name of the floorplan.", + "example": "Catch All Floor Plan" + } + } + } + } + } + } + } + } + } + } + }, + "unitTypeSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "id", + "name", + "showOnWebsite", + "isActive", + "giftValue", + "unitTypes" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the unit type special.", + "example": "12017831" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "unit type gift incentive" + }, + "showOnWebsite": { + "type": "integer", + "description": "Indicates if the special is shown on the website.", + "example": 1 + }, + "isActive": { + "type": "integer", + "description": "Indicates if the special is active.", + "example": 1 + }, + "giftValue": { + "type": "string", + "description": "The value of the gift associated with the special.", + "example": "300.00" + }, + "unitTypes": { + "type": "object", + "required": [ + "unitType" + ], + "properties": { + "unitType": { + "type": "array", + "description": "List of unit types included in the special.", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the unit type.", + "example": "577608" + }, + "name": { + "type": "string", + "description": "The name of the unit type.", + "example": "Alabaster" + } + } + } + } + } + } + } + } + } + } + }, + "unitSpaceSpecials": { + "type": "object", + "required": [ + "special" + ], + "properties": { + "special": { + "type": "object", + "additionalProperties": { + "type": "object", + "required": [ + "id", + "name", + "showOnWebsite", + "isActive", + "giftValue", + "unitSpaces" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique ID for the unit space special.", + "example": "12034174" + }, + "name": { + "type": "string", + "description": "The name of the special.", + "example": "Test" + }, + "showOnWebsite": { + "type": "integer", + "description": "Indicates if the special is shown on the website.", + "example": 1 + }, + "isActive": { + "type": "integer", + "description": "Indicates if the special is active.", + "example": 1 + }, + "giftValue": { + "type": "string", + "description": "The value of the gift associated with the special.", + "example": "400.00" + }, + "unitSpaces": { + "type": "object", + "required": [ + "unitSpace" + ], + "properties": { + "unitSpace": { + "type": "array", + "description": "List of unit spaces included in the special.", + "items": { + "type": "object", + "required": [ + "id", + "propertyUnitId", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the unit space.", + "example": "5164266" + }, + "propertyUnitId": { + "type": "string", + "description": "The property unit ID for the unit space.", + "example": "4880109" + }, + "name": { + "type": "string", + "description": "The name of the unit space.", + "example": "A3" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getUnitsAvailabilityAndPricingSuccessResponse": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique request identifier", + "example": "15" + }, + "result": { + "type": "object", + "description": "Result object containing properties and units", + "required": [ + "Properties", + "PropertyUnits" + ], + "properties": { + "Properties": { + "type": "object", + "description": "Information about the property", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "object", + "description": "Details of the property", + "required": [ + "PropertyId", + "MarketingName", + "Floorplans" + ], + "properties": { + "PropertyId": { + "type": "string", + "description": "Unique identifier for the property", + "example": "1234" + }, + "MarketingName": { + "type": "string", + "description": "The marketing name of the property", + "example": "Andover House" + }, + "Floorplans": { + "type": "object", + "description": "List of floor plans available in the property", + "required": [ + "Floorplan" + ], + "properties": { + "Floorplan": { + "type": "array", + "description": "List of floor plans for the property", + "items": { + "type": "object", + "required": [ + "Name", + "UnitCount", + "UnitsAvailable", + "Room", + "SquareFeet", + "MarketRent", + "Deposit" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the floor plan", + "example": "Fairview" + }, + "UnitCount": { + "type": "integer", + "description": "Number of units available for this floor plan", + "example": 1 + }, + "UnitsAvailable": { + "type": "integer", + "description": "Units currently available for rent", + "example": 1 + }, + "Room": { + "type": "array", + "description": "List of rooms in the floor plan", + "items": { + "type": "object", + "required": [ + "Description", + "Count", + "RoomType" + ], + "properties": { + "Description": { + "type": "string", + "description": "Description of the room", + "example": "Bedrooms" + }, + "Count": { + "type": "integer", + "description": "Number of rooms of this type", + "example": 1 + }, + "RoomType": { + "type": "string", + "description": "Type of the room (e.g., Bedroom, Bathroom)", + "example": "Bedroom" + } + } + } + }, + "SquareFeet": { + "type": "object", + "description": "Square footage of the floor plan", + "properties": { + "Avg": { + "type": "integer", + "description": "Average square footage", + "example": 968 + }, + "Max": { + "type": "integer", + "description": "Maximum square footage", + "example": 968 + }, + "Min": { + "type": "integer", + "description": "Minimum square footage", + "example": 968 + } + } + }, + "MarketRent": { + "type": "object", + "description": "Market rent details for the floor plan", + "properties": { + "Avg": { + "type": "integer", + "description": "Average market rent", + "example": 3000 + }, + "Max": { + "type": "integer", + "description": "Maximum rent", + "example": 4459 + }, + "Min": { + "type": "integer", + "description": "Minimum rent", + "example": 2577 + } + } + }, + "Deposit": { + "type": "object", + "description": "Deposit details for the floor plan", + "required": [ + "Amount" + ], + "properties": { + "Amount": { + "type": "object", + "description": "Deposit amount details", + "properties": { + "ValueRange": { + "type": "object", + "description": "Range for deposit amount", + "required": [ + "Min", + "Max" + ], + "properties": { + "Min": { + "type": "string", + "description": "Minimum deposit amount", + "example": "$100.00" + }, + "Max": { + "type": "string", + "description": "Maximum deposit amount", + "example": "$100.00" + } + } + }, + "AmountType": { + "type": "string", + "description": "Type of the deposit", + "example": "MonthMultiple" + }, + "DepositType": { + "type": "string", + "description": "Type of deposit (e.g., security deposit)", + "example": "security deposit" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "PropertyUnits": { + "type": "object", + "description": "Details about available units in the property", + "required": [ + "PropertyUnit" + ], + "properties": { + "PropertyUnit": { + "type": "array", + "description": "List of available units", + "items": { + "type": "object", + "required": [ + "UnitSpace" + ], + "properties": { + "UnitSpace": { + "type": "object", + "description": "Information about each unit", + "required": [ + "Rent", + "Deposit", + "UnitNumber" + ], + "properties": { + "Rent": { + "type": "object", + "description": "Rent details for the unit", + "required": [ + "TermRent" + ], + "properties": { + "TermRent": { + "type": "object", + "description": "Details about the lease term", + "required": [ + "LeaseTerm", + "Rent" + ], + "properties": { + "LeaseTerm": { + "type": "string", + "description": "Length of the lease", + "example": "10 Months" + }, + "Rent": { + "type": "string", + "description": "Monthly rent amount", + "example": "1000.00" + }, + "RateFrequency": { + "type": "string", + "description": "Frequency of rent payment", + "example": "Monthly" + } + } + } + } + }, + "Deposit": { + "type": "object", + "description": "Deposit details for the unit", + "properties": { + "MinDeposit": { + "type": "string", + "description": "Minimum deposit for the unit", + "example": "$95.00" + }, + "MaxDeposit": { + "type": "string", + "description": "Maximum deposit for the unit", + "example": "$565.00" + } + } + }, + "UnitNumber": { + "type": "string", + "description": "Unit number", + "example": "A" + }, + "Availability": { + "type": "string", + "description": "Availability status of the unit", + "example": "Available" + }, + "Status": { + "type": "string", + "description": "Current status of the unit", + "example": "Vacant Ready (Available)" + }, + "AvailableOn": { + "type": "string", + "description": "Date when the unit becomes available", + "example": "08/03/2013" + }, + "OccupancyType": { + "type": "string", + "description": "Type of occupancy for the unit", + "example": "Conventional" + }, + "IsAffordable": { + "type": "integer", + "description": "Whether the unit is affordable", + "example": 0 + }, + "HasPricing": { + "type": "integer", + "description": "Whether pricing is available for the unit", + "example": 1 + }, + "Area": { + "type": "string", + "description": "Area of the unit in square meters", + "example": "1300.0000 SquareMeter" + } + } + } + } + } + } + } + } + } + } + } + }, + "getUnitTypesSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "integer", + "description": "Unique identifier for the request", + "example": 15 + }, + "result": { + "type": "object", + "required": [ + "property", + "unitTypes" + ], + "properties": { + "property": { + "type": "object", + "required": [ + "type", + "propertyId", + "marketingName", + "shortDescription", + "longDescription" + ], + "properties": { + "type": { + "type": "string", + "description": "Type of the property", + "example": "Apartment" + }, + "propertyId": { + "type": "string", + "description": "Unique identifier for the property", + "example": "00000" + }, + "parentPropertyId": { + "type": "string", + "description": "Parent property identifier", + "example": "0000" + }, + "marketingName": { + "type": "string", + "description": "Marketing name of the property", + "example": "Test" + }, + "generalId": { + "type": "string", + "description": "General identifier for the property", + "example": "0000" + }, + "yearBuilt": { + "type": "string", + "description": "Year the property was built", + "example": "0000" + }, + "shortDescription": { + "type": "string", + "description": "Short description of the property", + "example": "This is short description" + }, + "longDescription": { + "type": "string", + "description": "Long description of the property", + "example": "This is Long Description" + } + } + }, + "unitTypes": { + "type": "object", + "required": [ + "unitType" + ], + "properties": { + "unitType": { + "type": "array", + "description": "List of unit types available in the property", + "items": { + "type": "object", + "required": [ + "identificationType", + "name", + "floorplan", + "unitBedRooms", + "unitBathrooms", + "minSquareFeet", + "maxSquareFeet", + "rent" + ], + "properties": { + "identificationType": { + "type": "object", + "required": [ + "@attributes", + "idValue" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "idType" + ], + "properties": { + "idType": { + "type": "string", + "description": "The type of the identification", + "example": "unitTypeId" + } + } + }, + "idValue": { + "type": "string", + "description": "The unique identifier for the unit type", + "example": "0000" + } + } + }, + "name": { + "type": "string", + "description": "Name of the unit type", + "example": "test" + }, + "floorplan": { + "type": "object", + "description": "Floor plans available for this unit type", + "additionalProperties": { + "type": "object", + "description": "Floorplan details for this unit type", + "required": [ + "@attributes", + "@value" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "Floorplan ID", + "example": "543312" + } + } + }, + "@value": { + "type": "string", + "description": "Floorplan name or code", + "example": "FPN" + } + } + } + }, + "unitBedRooms": { + "type": "string", + "description": "Number of bedrooms in the unit", + "example": "0" + }, + "unitBathrooms": { + "type": "string", + "description": "Number of bathrooms in the unit", + "example": "0" + }, + "minSquareFeet": { + "type": "string", + "description": "Minimum square footage of the unit", + "example": "000" + }, + "maxSquareFeet": { + "type": "string", + "description": "Maximum square footage of the unit", + "example": "0000" + }, + "minMarketRent": { + "type": "string", + "description": "Minimum market rent for the unit", + "example": "0000" + }, + "maxMarketRent": { + "type": "string", + "description": "Maximum market rent for the unit", + "example": "0000" + }, + "rent": { + "type": "object", + "required": [ + "termRent" + ], + "properties": { + "termRent": { + "type": "array", + "description": "List of available rent terms for the unit", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "leaseTerm", + "leaseTermId", + "leaseTermName", + "rent", + "startDate", + "endDate", + "spaceOption", + "isSoldOut" + ], + "properties": { + "leaseTerm": { + "type": "string", + "description": "Duration of the lease", + "example": "6 Months" + }, + "leaseTermId": { + "type": "integer", + "description": "Unique identifier for the lease term", + "example": 19125 + }, + "leaseTermName": { + "type": "string", + "description": "Name of the lease term", + "example": "6 months" + }, + "rent": { + "type": "string", + "description": "Rent for the unit for this lease term", + "example": "10.00" + }, + "startDate": { + "type": "string", + "description": "Start date of the lease term", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "End date of the lease term", + "example": "MM/DD/YYYY" + }, + "spaceOption": { + "type": "string", + "description": "Space option for the unit", + "example": "Private" + }, + "isSoldOut": { + "type": "boolean", + "description": "Whether the unit is sold out", + "example": "false\"" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendAmenitiesSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "propertyAmenities", + "unitAmenities" + ], + "properties": { + "propertyAmenities": { + "type": "array", + "description": "List of property amenities", + "items": { + "type": "object", + "required": [ + "node", + "status", + "amenityId", + "rateAssociationId", + "name", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the amenity operation", + "example": "Success" + }, + "amenityId": { + "type": "integer", + "description": "Unique identifier for the property amenity", + "example": 1200111 + }, + "rateAssociationId": { + "type": "integer", + "description": "Unique identifier for the rate association", + "example": 9050818 + }, + "name": { + "type": "string", + "description": "Name of the property amenity", + "example": "P Amenity 1011" + }, + "message": { + "type": "string", + "description": "Message about the amenity operation", + "example": "Amenity inserted successfully." + } + } + } + }, + "unitAmenities": { + "type": "array", + "description": "List of unit amenities", + "items": { + "type": "object", + "required": [ + "node", + "status", + "amenityId", + "rateAssociationId", + "name", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the unit amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the unit amenity operation", + "example": "Success" + }, + "amenityId": { + "type": "integer", + "description": "Unique identifier for the unit amenity", + "example": 1200113 + }, + "rateAssociationId": { + "type": "integer", + "description": "Unique identifier for the rate association", + "example": 9050820 + }, + "name": { + "type": "string", + "description": "Name of the unit amenity", + "example": "U Amenity 1011" + }, + "message": { + "type": "string", + "description": "Message about the unit amenity operation", + "example": "Amenity inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "sendPropertyUnitsSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "units" + ], + "properties": { + "units": { + "type": "object", + "required": [ + "unit" + ], + "properties": { + "unit": { + "type": "array", + "description": "List of units inserted", + "items": { + "type": "object", + "required": [ + "node", + "unitId", + "unitNumber", + "unitSpace", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the unit node", + "example": 1 + }, + "unitId": { + "type": "integer", + "description": "Unique identifier for the unit", + "example": 5242133 + }, + "unitNumber": { + "type": "string", + "description": "Unit number", + "example": "CC20BB" + }, + "unitSpace": { + "type": "string", + "description": "Space associated with the unit", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the unit operation", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message about the unit operation", + "example": "unit inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateAmenitiesSuccessResponse": { + "type": "object", + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Successful response code.", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "propertyAmenities", + "floorplanAmenities", + "unitTypeAmenities", + "unitSpaceAmenities" + ], + "properties": { + "propertyAmenities": { + "type": "object", + "required": [ + "propertyAmenity" + ], + "properties": { + "propertyAmenity": { + "type": "array", + "description": "List of property amenities updated", + "items": { + "type": "object", + "required": [ + "node", + "status", + "amenityId", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the property amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the operation", + "example": "Success" + }, + "amenityId": { + "type": "integer", + "description": "ID of the property amenity", + "example": 147852 + }, + "message": { + "type": "string", + "description": "Message about the property amenity operation", + "example": "Amenity updated successfully." + } + } + } + } + } + }, + "floorplanAmenities": { + "type": "object", + "required": [ + "floorplanAmenity" + ], + "properties": { + "floorplanAmenity": { + "type": "array", + "description": "List of floorplan amenities updated", + "items": { + "type": "object", + "required": [ + "node", + "status", + "amenityId", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the floorplan amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the operation", + "example": "Success" + }, + "amenityId": { + "type": "integer", + "description": "ID of the floorplan amenity", + "example": 1139719 + }, + "message": { + "type": "string", + "description": "Message about the floorplan amenity operation", + "example": "Amenity updated successfully." + } + } + } + } + } + }, + "unitTypeAmenities": { + "type": "object", + "required": [ + "unitTypeAmenity" + ], + "properties": { + "unitTypeAmenity": { + "type": "array", + "description": "List of unit type amenities updated", + "items": { + "type": "object", + "required": [ + "node", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the unit type amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the operation", + "example": "Failure" + }, + "message": { + "type": "string", + "description": "Message about the unit type amenity operation", + "example": "Missing value for parameter 'id'." + } + } + } + } + } + }, + "unitSpaceAmenities": { + "type": "object", + "required": [ + "unitSpaceAmenity" + ], + "properties": { + "unitSpaceAmenity": { + "type": "array", + "description": "List of unit space amenities updated", + "items": { + "type": "object", + "required": [ + "node", + "status", + "amenityId", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Unique identifier for the unit space amenity node", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the operation", + "example": "Success" + }, + "amenityId": { + "type": "integer", + "description": "ID of the unit space amenity", + "example": 1162615 + }, + "message": { + "type": "string", + "description": "Message about the unit space amenity operation", + "example": "Amenity updated successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "sendSpecialGroupSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "requestId", + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "specialGroupId", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the operation", + "example": "success" + }, + "specialGroupId": { + "type": "integer", + "description": "ID of the created special group", + "example": 12345 + }, + "message": { + "type": "string", + "description": "Detailed message about the operation", + "example": "Special added successfully." + } + } + } + } + } + } + }, + "updateSpecialGroupSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "requestId", + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "specialGroupId", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the operation", + "example": "success" + }, + "specialGroupId": { + "type": "integer", + "description": "ID of the updated special group", + "example": 12345 + }, + "message": { + "type": "string", + "description": "Detailed message about the operation", + "example": "Special updated successfully." + } + } + } + } + } + } + }, + "getSpecials_r4_SuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "example": "15" + }, + "code": { + "type": "integer", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "specialGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialGroupId": { + "type": "string", + "example": "12345" + }, + "specialGroupName": { + "type": "string", + "example": "Demo_special_name1" + }, + "quantityBudgeted": { + "type": "string", + "nullable": true, + "example": null + }, + "quantityRemaining": { + "type": "string", + "nullable": true, + "example": null + }, + "isActive": { + "type": "string", + "example": "0" + }, + "isAdvertised": { + "type": "string", + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "example": "0" + }, + "startDate": { + "type": "string", + "nullable": true, + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "nullable": true, + "example": "MM/DD/YYYY" + }, + "description": { + "type": "string", + "nullable": true, + "example": null + }, + "internalDescription": { + "type": "string", + "nullable": true, + "example": null + }, + "couponCode": { + "type": "string", + "nullable": true, + "example": null + }, + "specialRecipientDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialRecipientId": { + "type": "integer", + "example": 2 + }, + "specialRecipientName": { + "type": "string", + "example": "ABC" + } + } + } + }, + "limitQuantity": { + "type": "string", + "example": "0" + }, + "termsAndConditions": { + "type": "string", + "nullable": true, + "example": null + }, + "leadSourceDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 2 + }, + "name": { + "type": "string", + "example": "ABC" + } + } + } + }, + "renewalLeaseStartDateRange": { + "type": "string", + "nullable": true, + "example": null + }, + "prospectLeaseStartDateRange": { + "type": "string", + "nullable": true, + "example": null + }, + "spaceConfigurationDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "spaceConfigurationId": { + "type": "integer", + "example": 2 + }, + "spaceConfigurationName": { + "type": "string", + "example": "ABC" + } + } + } + }, + "incentiveLimit": { + "type": "string", + "example": "1" + }, + "isSelectable": { + "type": "string", + "example": "0" + }, + "associations": { + "type": "object", + "properties": { + "levelId": { + "type": "string", + "example": "1" + }, + "levelName": { + "type": "string", + "example": "XYZ" + }, + "unitCount": { + "type": "integer", + "example": 1 + }, + "references": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "7777777" + }, + "name": { + "type": "string", + "example": "PQR" + } + } + } + } + } + }, + "specialRecipientTriggerTypeDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialRecipientTriggerTypeId": { + "type": "string", + "example": "11" + }, + "specialRecipientTriggerTypeName": { + "type": "string", + "example": "Application Completed" + } + } + } + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "leaseTermId": { + "type": "string", + "example": "1" + }, + "leaseTermName": { + "type": "string", + "example": "UVW" + }, + "leaseStartWindowId": { + "type": "string", + "example": "0" + } + } + } + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "properties": { + "specialId": { + "type": "string", + "example": "88888888" + }, + "specialTypeId": { + "type": "string", + "example": "1" + }, + "specialName": { + "type": "string", + "example": "consession" + }, + "giftValue": { + "type": "string", + "example": "0.00" + }, + "rate": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rateId": { + "type": "string", + "example": "999999999" + }, + "arCodeId": { + "type": "string", + "example": "666666" + }, + "arCodeTypeName": { + "type": "string", + "example": "Dummy_name" + }, + "arCodeName": { + "type": "string", + "example": "XYZ" + }, + "arTriggerId": { + "type": "string", + "example": "333" + }, + "arTriggerName": { + "type": "string", + "example": "ABC" + }, + "arFormulaId": { + "type": "string", + "example": "1" + }, + "arFormulaName": { + "type": "string", + "example": "Formula_name" + }, + "arFormulaReferenceId": { + "type": "string", + "example": "0" + }, + "rateAmount": { + "type": "string", + "example": "-1.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "example": "0.000000" + }, + "rateShowOnWebsite": { + "type": "string", + "example": "1" + }, + "rateShowInEntrata": { + "type": "string", + "example": "1" + }, + "spaceConfigurationId": { + "type": "string", + "example": "0" + }, + "spaceConfigurationName": { + "type": "string", + "example": "" + }, + "leaseTermId": { + "type": "string", + "example": "1" + }, + "leaseTermName": { + "type": "string", + "example": "PQR" + }, + "leaseStartWindowId": { + "type": "string", + "example": "0" + }, + "windowStartDate": { + "type": "string", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "example": "MM/DD/YYYY" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getInvoices_r1_SuccessResponse": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "invoices" + ], + "properties": { + "invoices": { + "type": "object", + "required": [ + "invoice" + ], + "properties": { + "invoice": { + "type": "object", + "required": [ + "id", + "isOnHold", + "invoiceNumber", + "date", + "postMonth", + "dueDate", + "remittance", + "vendor", + "invoicePayments", + "amount", + "amountDue", + "note", + "isPosted", + "lineItems" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the invoice", + "example": "623413" + }, + "isOnHold": { + "type": "string", + "description": "Flag indicating if the invoice is on hold", + "example": "0" + }, + "invoiceNumber": { + "type": "string", + "description": "Invoice number", + "example": "55555" + }, + "date": { + "type": "string", + "description": "Invoice date", + "example": "10/09/2015" + }, + "postMonth": { + "type": "string", + "description": "The month the invoice was posted", + "example": "10/01/2015" + }, + "dueDate": { + "type": "string", + "description": "Due date of the invoice", + "example": "10/30/2015" + }, + "remittance": { + "type": "object", + "required": [ + "id", + "name", + "apPaymentTypeId", + "apPaymentType", + "streetLine1", + "streetLine2", + "City", + "stateCode", + "postalCode" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the remittance", + "example": "XXXX" + }, + "name": { + "type": "string", + "description": "Name of the remittance", + "example": "Carson Check Payment" + }, + "apPaymentTypeId": { + "type": "string", + "description": "ID for the payment type", + "example": "X" + }, + "apPaymentType": { + "type": "string", + "description": "Payment type", + "example": "Check" + }, + "streetLine1": { + "type": "string", + "description": "Street address line 1", + "example": "20500 Belshaw Ave" + }, + "streetLine2": { + "type": "string", + "description": "Street address line 2", + "example": "Fox Street" + }, + "streetLine3": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Additional street address lines" + }, + "City": { + "type": "string", + "description": "City", + "example": "Carson" + }, + "stateCode": { + "type": "string", + "description": "State code", + "example": "CA" + }, + "postalCode": { + "type": "string", + "description": "Postal code", + "example": "XXXXX" + } + } + }, + "vendor": { + "type": "object", + "required": [ + "id", + "name", + "locationName", + "address" + ], + "properties": { + "id": { + "type": "string", + "description": "Vendor ID", + "example": "18418" + }, + "name": { + "type": "string", + "description": "Vendor name", + "example": "Test, Corporate" + }, + "locationName": { + "type": "string", + "description": "Location name of the vendor", + "example": "Corporate" + }, + "address": { + "type": "object", + "required": [ + "streetLine1", + "streetLine2", + "city", + "stateCode", + "postalCode" + ], + "properties": { + "streetLine1": { + "type": "string", + "description": "Street address line 1", + "example": "streetLine1" + }, + "streetLine2": { + "type": "string", + "description": "Street address line 2", + "example": "streetLine2" + }, + "city": { + "type": "string", + "description": "City", + "example": "city" + }, + "stateCode": { + "type": "string", + "description": "State code", + "example": "CA" + }, + "postalCode": { + "type": "string", + "description": "Postal code", + "example": "XXXXX" + } + } + } + } + }, + "invoicePayments": { + "type": "object", + "required": [ + "invoicePayment" + ], + "properties": { + "invoicePayment": { + "type": "array", + "description": "List of invoice payments", + "items": { + "type": "object", + "required": [ + "paymentId", + "paymentBankId", + "paymentBankName", + "paymentBankAccountName", + "paymentType", + "paymentStatus", + "reconciliationStatus", + "paymentDate", + "paymentIssuedOn", + "payeeName", + "paymentNumber", + "paymentAmount", + "postMonth", + "postDate", + "isReversed", + "isQuickCheck" + ], + "properties": { + "paymentId": { + "type": "string", + "description": "Unique identifier for the payment", + "example": "xxxxx" + }, + "paymentBankId": { + "type": "string", + "description": "Payment bank ID", + "example": "XXXX" + }, + "paymentBankName": { + "type": "string", + "description": "Name of the payment bank", + "example": "Wells Fargo" + }, + "paymentBankAccountName": { + "type": "string", + "description": "Account name of the payment bank", + "example": "The Vista at Prima Lake - 8545" + }, + "paymentType": { + "type": "string", + "description": "Type of payment", + "example": "Check" + }, + "paymentStatus": { + "type": "string", + "description": "Status of the payment", + "example": "Received" + }, + "reconciliationStatus": { + "type": "string", + "description": "Reconciliation status of the payment", + "example": "Historical" + }, + "paymentDate": { + "type": "string", + "description": "Payment date", + "example": "10/09/2015" + }, + "paymentIssuedOn": { + "type": "string", + "description": "Date when the payment was issued", + "example": "10/09/2015" + }, + "payeeName": { + "type": "string", + "description": "Name of the payee", + "example": "Test" + }, + "paymentNumber": { + "type": "string", + "description": "Payment number", + "example": "9" + }, + "paymentAmount": { + "type": "string", + "description": "Amount of the payment", + "example": "30.00" + }, + "postMonth": { + "type": "string", + "description": "Post month for the payment", + "example": "10/01/2015" + }, + "postDate": { + "type": "string", + "description": "Post date for the payment", + "example": "10/09/2015" + }, + "isReversed": { + "type": "string", + "description": "Indicates if the payment is reversed", + "example": "0" + }, + "isQuickCheck": { + "type": "string", + "description": "Indicates if the payment is a quick check", + "example": "0" + } + } + } + } + } + }, + "amount": { + "type": "string", + "description": "Total invoice amount", + "example": "$50.00" + }, + "amountDue": { + "type": "string", + "description": "Amount due on the invoice", + "example": "$0.00" + }, + "note": { + "type": "string", + "description": "Additional note regarding the invoice", + "example": "test" + }, + "isPosted": { + "type": "string", + "description": "Flag indicating if the invoice is posted", + "example": "true" + }, + "lineItems": { + "type": "object", + "required": [ + "lineitem" + ], + "properties": { + "lineitem": { + "type": "array", + "description": "List of line items for the invoice", + "items": { + "type": "object", + "required": [ + "id", + "property", + "glAccount", + "quantity", + "rate", + "amount", + "amountDue", + "shippingAmount", + "discountAmount", + "taxAmount", + "paymentIds" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the line item", + "example": "11648172" + }, + "property": { + "type": "object", + "required": [ + "id", + "name", + "lookupCode" + ], + "properties": { + "id": { + "type": "string", + "description": "Property ID", + "example": "19463" + }, + "name": { + "type": "string", + "description": "Property name", + "example": "22 Exchange" + }, + "lookupCode": { + "type": "string", + "description": "Lookup code for the property", + "example": "AK lookUp 22 Exchange" + } + } + }, + "glAccount": { + "type": "object", + "required": [ + "id", + "name", + "accountNumber" + ], + "properties": { + "id": { + "type": "string", + "description": "GL account ID", + "example": "295527" + }, + "name": { + "type": "string", + "description": "GL account name", + "example": "TestCashPositionExpenseAccount" + }, + "accountNumber": { + "type": "string", + "description": "GL account number", + "example": "0000" + } + } + }, + "quantity": { + "type": "string", + "description": "Quantity for the line item", + "example": "1.000000" + }, + "rate": { + "type": "string", + "description": "Rate for the line item", + "example": "$-2500.00" + }, + "amount": { + "type": "string", + "description": "Amount for the line item", + "example": "$-2416.66" + }, + "amountDue": { + "type": "string", + "description": "Amount due for the line item", + "example": "$-2416.66" + }, + "shippingAmount": { + "type": "string", + "description": "Shipping amount for the line item", + "example": "$125.00" + }, + "discountAmount": { + "type": "string", + "description": "Discount amount for the line item", + "example": "$83.33" + }, + "taxAmount": { + "type": "string", + "description": "Tax amount for the line item", + "example": "$41.67" + }, + "paymentIds": { + "type": "string", + "description": "Payment IDs associated with the line item", + "example": "XXXXX,XXXXX" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getInvoices_r2_SuccessResponse": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "invoices" + ], + "properties": { + "invoices": { + "type": "object", + "required": [ + "invoice" + ], + "properties": { + "invoice": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "isOnHold", + "invoiceNumber", + "invoiceType", + "date", + "postMonth", + "dueDate", + "remittance", + "vendor", + "invoicePayments", + "amount", + "amountDue", + "isPosted", + "lineItems" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the invoice", + "example": "123456" + }, + "isOnHold": { + "type": "string", + "description": "Flag indicating whether the invoice is on hold", + "example": "0" + }, + "invoiceNumber": { + "type": "string", + "description": "Invoice number", + "example": "INV0101" + }, + "invoiceType": { + "type": "string", + "description": "Type of the invoice", + "example": "Standard" + }, + "date": { + "type": "string", + "description": "Date the invoice was created", + "example": "2020-02-11" + }, + "postMonth": { + "type": "string", + "description": "Month when the invoice was posted", + "example": "2020-02-01" + }, + "postStatus": { + "type": "string", + "description": "Status of the invoice posting", + "example": "status" + }, + "reversalInvoiceId": { + "type": "integer", + "description": "ID of the reversal invoice, if applicable", + "example": 233434 + }, + "dueDate": { + "type": "string", + "description": "Due date of the invoice", + "example": "2020-02-12" + }, + "postDate": { + "type": "string", + "description": "Date when the invoice was posted", + "example": "2020-02-12" + }, + "invoiceNote": { + "type": "string", + "description": "Note related to the invoice", + "example": "Testing the task" + }, + "routingTagId": { + "type": "string", + "description": "Routing tag identifier", + "example": "92" + }, + "routingTagName": { + "type": "string", + "description": "Name of the routing tag", + "example": "ghghg" + }, + "remittance": { + "type": "object", + "required": [ + "id", + "name", + "apPaymentTypeId", + "apPaymentType", + "streetLine1", + "streetLine2", + "city", + "stateCode", + "postalCode" + ], + "properties": { + "id": { + "type": "string", + "description": "Remittance identifier", + "example": "1234" + }, + "name": { + "type": "string", + "description": "Name of the remittance", + "example": "Check" + }, + "apPaymentTypeId": { + "type": "string", + "description": "Payment type ID", + "example": "2" + }, + "apPaymentType": { + "type": "string", + "description": "Payment type", + "example": "Check" + }, + "streetLine1": { + "type": "string", + "description": "Street address line 1", + "example": "THIS IS" + }, + "streetLine2": { + "type": "string", + "description": "Street address line 2", + "example": "REMITTANCE" + }, + "city": { + "type": "string", + "description": "City", + "example": "ADDRESS" + }, + "stateCode": { + "type": "string", + "description": "State code", + "example": "UT" + }, + "postalCode": { + "type": "string", + "description": "Postal code", + "example": "84043" + } + } + }, + "vendor": { + "type": "object", + "required": [ + "id", + "name", + "locationName", + "address" + ], + "properties": { + "id": { + "type": "string", + "description": "Vendor identifier", + "example": "123456" + }, + "name": { + "type": "string", + "description": "Vendor name", + "example": "0000CNYE1, Corporate" + }, + "locationName": { + "type": "string", + "description": "Location name of the vendor", + "example": "Corporate" + }, + "locationCode": { + "type": "string", + "description": "Location code of the vendor", + "example": "Corporate_123" + }, + "externalId": { + "type": "string", + "description": "External ID of the vendor", + "example": "ext- rpk" + }, + "address": { + "type": "object", + "required": [ + "streetLine1", + "streetLine2", + "city", + "stateCode", + "postalCode" + ], + "properties": { + "streetLine1": { + "type": "string", + "description": "Street address line 1", + "example": "AddressLine1" + }, + "streetLine2": { + "type": "string", + "description": "Street address line 2", + "example": "AddressLine2" + }, + "city": { + "type": "string", + "description": "City", + "example": "TestCity" + }, + "stateCode": { + "type": "string", + "description": "State code", + "example": "MO" + }, + "postalCode": { + "type": "string", + "description": "Postal code", + "example": "41101" + } + } + } + } + }, + "account": { + "type": "object", + "required": [ + "id", + "accountNumber" + ], + "properties": { + "id": { + "type": "string", + "description": "Account ID", + "example": "12345" + }, + "accountNumber": { + "type": "string", + "description": "Account number", + "example": "12345" + } + } + }, + "invoicePayments": { + "type": "object", + "required": [ + "invoicePayment" + ], + "properties": { + "invoicePayment": { + "type": "array", + "items": { + "type": "object", + "required": [ + "paymentId", + "paymentBankId", + "paymentBankName", + "paymentBankAccountName", + "paymentType", + "paymentStatus", + "paymentDate", + "paymentIssuedOn", + "payeeName", + "paymentNumber", + "paymentAmount", + "postMonth", + "postDate", + "isReversed", + "isQuickCheck" + ], + "properties": { + "paymentId": { + "type": "string", + "description": "Payment identifier", + "example": "xxxxx" + }, + "paymentBankId": { + "type": "string", + "description": "Payment bank identifier", + "example": "1234" + }, + "paymentBankName": { + "type": "string", + "description": "Payment bank name", + "example": "Wells Fargo" + }, + "paymentBankAccountName": { + "type": "string", + "description": "Bank account name for the payment", + "example": "The Vista - 8545" + }, + "paymentType": { + "type": "string", + "description": "Type of payment", + "example": "Check" + }, + "paymentStatus": { + "type": "string", + "description": "Status of the payment", + "example": "Received" + }, + "reconciliationStatus": { + "type": "string", + "description": "Reconciliation status of the payment", + "example": "Historical" + }, + "paymentDate": { + "type": "string", + "description": "Date of payment", + "example": "2020-02-12" + }, + "paymentIssuedOn": { + "type": "string", + "description": "Issued date of payment", + "example": "2020-02-12" + }, + "payeeName": { + "type": "string", + "description": "Payee name", + "example": "Test" + }, + "paymentNumber": { + "type": "string", + "description": "Payment number", + "example": "9" + }, + "paymentAmount": { + "type": "string", + "description": "Amount paid", + "example": "30.00" + }, + "postMonth": { + "type": "string", + "description": "Month the payment was posted", + "example": "2020-02-10" + }, + "postDate": { + "type": "string", + "description": "Date the payment was posted", + "example": "2020-02-12" + }, + "isReversed": { + "type": "string", + "description": "Flag indicating if payment is reversed", + "example": "0" + }, + "isQuickCheck": { + "type": "string", + "description": "Flag indicating if the payment is a quick check", + "example": "0" + } + } + } + } + } + }, + "subTotal": { + "type": "string", + "description": "Subtotal of the invoice", + "example": "1000.00" + }, + "taxAmount": { + "type": "string", + "description": "Tax amount for the invoice", + "example": "100.00" + }, + "shippingAmount": { + "type": "string", + "description": "Shipping amount for the invoice", + "example": "0.00" + }, + "discountAmount": { + "type": "string", + "description": "Discount amount on the invoice", + "example": "-100.00" + }, + "amount": { + "type": "string", + "description": "Total amount for the invoice", + "example": "1000.00" + }, + "amountDue": { + "type": "string", + "description": "Amount due for the invoice", + "example": "1000.00" + }, + "note": { + "type": "string", + "description": "Invoice note", + "example": "Testing the task" + }, + "isPosted": { + "type": "string", + "description": "Flag indicating if the invoice has been posted", + "example": "0" + }, + "retention": { + "type": "string", + "description": "Retention amount for the invoice", + "example": "0.00" + }, + "lineItems": { + "type": "object", + "required": [ + "lineItem" + ], + "properties": { + "lineItem": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "description", + "quantity", + "rate", + "amount", + "amountDue" + ], + "properties": { + "id": { + "type": "string", + "description": "Line item identifier", + "example": "123456" + }, + "description": { + "type": "string", + "description": "Description of the line item", + "example": "test" + }, + "quantity": { + "type": "string", + "description": "Quantity of the item", + "example": "1" + }, + "rate": { + "type": "string", + "description": "Rate per item", + "example": "1000.00" + }, + "amount": { + "type": "string", + "description": "Total amount for the line item", + "example": "1000.00" + }, + "amountDue": { + "type": "string", + "description": "Amount due for the line item", + "example": "1000.00" + }, + "maintenanceLocationId": { + "type": "string", + "description": "Maintenance location ID", + "example": "40802" + }, + "departmentId": { + "type": "string", + "description": "Department ID", + "example": "1982" + }, + "departmentName": { + "type": "string", + "description": "Department name", + "example": "Managerial" + }, + "propertyBuildingNumber": { + "type": "string", + "description": "Building number", + "example": "Building A" + }, + "poNumber": { + "type": "string", + "description": "Purchase order number", + "example": "1234654" + }, + "customTagId": { + "type": "string", + "description": "Custom tag ID", + "example": "406" + }, + "customTagName": { + "type": "string", + "description": "Custom tag name", + "example": "Ak Test Tag" + }, + "confidential": { + "type": "string", + "description": "Flag indicating if the line item is confidential", + "example": "1" + }, + "is1099": { + "type": "string", + "description": "Flag indicating if the line item is 1099", + "example": "1" + }, + "billback": { + "type": "string", + "description": "Billback flag", + "example": "0" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPoReceivingRecordsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "purchaseOrders": { + "type": "object", + "properties": { + "purchaseOrder": { + "type": "object", + "required": [ + "purchaseOrderNumber", + "purchaseOrderPostMonth", + "poDetails" + ], + "properties": { + "purchaseOrderNumber": { + "type": "string", + "description": "The unique purchase order number.", + "example": "123456" + }, + "purchaseOrderPostMonth": { + "type": "string", + "description": "The post month for the purchase order.", + "example": "06/2021" + }, + "poDetails": { + "type": "object", + "properties": { + "poDetail": { + "type": "object", + "required": [ + "id", + "catalogItemName", + "qtyOrdered", + "unitCost", + "receivingRecords", + "cancelledRecords" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the purchase order detail.", + "example": "123" + }, + "catalogItemName": { + "type": "string", + "description": "Name of the catalog item.", + "example": "vaishali_catalog_test" + }, + "qtyOrdered": { + "type": "string", + "description": "Quantity of items ordered.", + "example": "1" + }, + "unitCost": { + "type": "string", + "description": "Cost per unit of the catalog item.", + "example": "11.00" + }, + "receivingRecords": { + "type": "object", + "properties": { + "receivingRecord": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "propertyId", + "postMonthReceived", + "receiverName", + "assetLocation", + "qtyReceived", + "unitCost", + "dateReceived", + "qtyInvoiced" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the receiving record.", + "example": "123456" + }, + "propertyId": { + "type": "integer", + "description": "Property ID where the item was received.", + "example": 172775 + }, + "postMonthReceived": { + "type": "string", + "description": "Month when the item was received.", + "example": "06/2021" + }, + "receiverName": { + "type": "string", + "description": "Name of the receiver.", + "example": "Admin Admin" + }, + "assetLocation": { + "type": "string", + "description": "Location where the asset is stored.", + "example": "fixed asset1" + }, + "qtyReceived": { + "type": "string", + "description": "Quantity of items received.", + "example": "1.000" + }, + "unitCost": { + "type": "string", + "description": "Cost per unit of the received item.", + "example": "11.00" + }, + "dateReceived": { + "type": "string", + "description": "Date when the item was received.", + "example": "2019-08-21" + }, + "qtyInvoiced": { + "type": "string", + "description": "Quantity of items invoiced.", + "example": "1.000000" + } + } + } + }, + "unreceivingRecord": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier for the unreceived record.", + "example": 123456 + }, + "propertyId": { + "type": "integer", + "description": "Property ID where the item was unreceived.", + "example": 172775 + }, + "postMonthUnreceived": { + "type": "string", + "description": "Month when the item was unreceived.", + "example": "05/2023" + }, + "unreceiverName": { + "type": "string", + "description": "Name of the unreceiver.", + "example": "Admin Admin" + }, + "qtyUnreceived": { + "type": "string", + "description": "Quantity of items unreceived.", + "example": "-1.000" + }, + "unitCost": { + "type": "string", + "description": "Cost per unit of the unreceived item.", + "example": "10.00" + }, + "dateUnreceived": { + "type": "string", + "description": "Date when the item was unreceived.", + "example": "2023-05-29" + }, + "qtyInvoiced": { + "type": "integer", + "description": "Quantity of items invoiced.", + "example": 0 + } + } + } + }, + "returnRecord": { + "type": "array", + "items": { + "type": "object", + "properties": { + "receiverId": { + "type": "string", + "description": "Unique identifier for the receiver.", + "example": "1234567" + }, + "propertyId": { + "type": "integer", + "description": "Property ID where the item was returned.", + "example": 172775 + }, + "creditInvoiceId": { + "type": "string", + "description": "Credit invoice ID associated with the return.", + "example": "56567" + }, + "qtyReturned": { + "type": "string", + "description": "Quantity of items returned.", + "example": "-1.000" + }, + "unitCost": { + "type": "string", + "description": "Cost per unit of the returned item.", + "example": "11.00" + }, + "dateReturned": { + "type": "string", + "description": "Date when the item was returned.", + "example": "2019-08-21" + }, + "postMonthReturned": { + "type": "string", + "description": "Month when the return was posted.", + "example": "06/2021" + }, + "receiverName": { + "type": "string", + "description": "Name of the person who received the return.", + "example": "Admin Admin" + }, + "assetLocation": { + "type": "string", + "description": "Location where the returned asset is stored.", + "example": "fixed asset1" + } + } + } + } + } + }, + "cancelledRecords": { + "type": "object", + "properties": { + "cancelledRecord": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "propertyId", + "qtyCancelled", + "unitCost", + "dateCancelled", + "postMonthCancelled", + "cancelledBy" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the cancelled record.", + "example": "1234" + }, + "propertyId": { + "type": "integer", + "description": "Property ID where the item was cancelled.", + "example": 172775 + }, + "qtyCancelled": { + "type": "string", + "description": "Quantity of items cancelled.", + "example": "1.000" + }, + "unitCost": { + "type": "string", + "description": "Cost per unit of the cancelled item.", + "example": "35.00" + }, + "dateCancelled": { + "type": "string", + "description": "Date when the item was cancelled.", + "example": "2020-06-11" + }, + "postMonthCancelled": { + "type": "string", + "description": "Month when the cancellation was posted.", + "example": "08/2015" + }, + "cancelledBy": { + "type": "string", + "description": "Name of the person who cancelled the item.", + "example": "ABC Services" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getPurchaseOrdersSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code.", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "purchaseOrders": { + "type": "object", + "properties": { + "purchaseOrder": { + "type": "array", + "items": { + "type": "object", + "required": [ + "purchaseOrderNumber", + "purchaseOrderType", + "vendor", + "postMonth", + "postDate", + "poStatusId", + "poApprovalTypeId", + "routingTagId", + "subTotal", + "orderAmount", + "poNote", + "lineItems" + ], + "properties": { + "purchaseOrderNumber": { + "type": "string", + "description": "The unique number assigned to the purchase order.", + "example": "1234" + }, + "purchaseOrderType": { + "type": "string", + "description": "The type of purchase order (e.g., Standard, Catalog, Job/Contract).", + "example": "Standard" + }, + "vendor": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the vendor.", + "example": "67645" + }, + "name": { + "type": "string", + "description": "Name of the vendor.", + "example": "22 Exchange" + } + } + }, + "vendorCode": { + "type": "string", + "description": "The unique vendor code.", + "example": "2423478552" + }, + "vendorLocation": { + "type": "string", + "description": "The location of the vendor.", + "example": "Corporate" + }, + "postMonth": { + "type": "string", + "description": "The month when the purchase order was posted.", + "example": "01/01/2019" + }, + "postDate": { + "type": "string", + "description": "The date when the purchase order was posted.", + "example": "01/23/2019" + }, + "poStatusId": { + "type": "string", + "description": "The status ID of the purchase order.", + "example": "1" + }, + "poApprovalTypeId": { + "type": "string", + "description": "The approval type ID for the purchase order.", + "example": "1" + }, + "routingTagId": { + "type": "string", + "description": "The routing tag ID for the purchase order.", + "example": "112" + }, + "subTotal": { + "type": "string", + "description": "The subtotal amount for the purchase order.", + "example": "60.00" + }, + "taxAmount": { + "type": "string", + "description": "The total tax amount for the purchase order.", + "example": "0.00" + }, + "shippingAmount": { + "type": "string", + "description": "The shipping cost for the purchase order.", + "example": "0.00" + }, + "discountAmount": { + "type": "string", + "description": "The discount amount for the purchase order.", + "example": "0.00" + }, + "orderAmount": { + "type": "string", + "description": "The total order amount.", + "example": "60.00" + }, + "poNote": { + "type": "string", + "description": "A note or comment related to the purchase order.", + "example": "24th Jan" + }, + "createdOn": { + "type": "string", + "description": "The timestamp when the purchase order was created.", + "example": "01/23/2019 21:58:03.698637 MST" + }, + "attachedUrl": { + "type": "string", + "description": "URL attached to the purchase order.", + "example": "https://demoold.stage.entrata.lcl/" + }, + "lineItems": { + "type": "object", + "properties": { + "lineItem": { + "type": "object", + "required": [ + "id", + "glAccountId", + "glAccountNumber", + "catalogItemName", + "catalogItemNumber", + "contractName", + "description", + "orderQuantity", + "rate", + "subTotal", + "orderAmount", + "propertyId", + "departmentId" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the line item.", + "example": "123456" + }, + "glAccountId": { + "type": "string", + "description": "General ledger account ID.", + "example": "123456" + }, + "glAccountNumber": { + "type": "string", + "description": "General ledger account number.", + "example": "123" + }, + "catalogItemName": { + "type": "string", + "description": "Name of the catalog item.", + "example": "demo asset" + }, + "catalogItemNumber": { + "type": "string", + "description": "Unique number for the catalog item.", + "example": "123456" + }, + "contractName": { + "type": "string", + "description": "Name of the contract associated with the line item.", + "example": "Flooring contract" + }, + "description": { + "type": "string", + "description": "Description of the line item.", + "example": "Description:standard" + }, + "orderStatus": { + "type": "string", + "description": "Status of the order.", + "example": "1" + }, + "orderQuantity": { + "type": "string", + "description": "Quantity of items ordered.", + "example": "1.000" + }, + "rate": { + "type": "string", + "description": "Price per unit for the ordered item.", + "example": "60.000" + }, + "subTotal": { + "type": "string", + "description": "Subtotal amount for the line item.", + "example": "60.00" + }, + "taxAmount": { + "type": "string", + "description": "Tax amount for the line item.", + "example": "0.00" + }, + "shippingAmount": { + "type": "string", + "description": "Shipping cost for the line item.", + "example": "0.00" + }, + "discountAmount": { + "type": "string", + "description": "Discount amount for the line item.", + "example": "0.00" + }, + "orderAmount": { + "type": "string", + "description": "Total amount for the line item.", + "example": "60.00" + }, + "propertyId": { + "type": "string", + "description": "Property ID associated with the line item.", + "example": "123456" + }, + "departmentId": { + "type": "string", + "description": "Department ID for the line item.", + "example": "1982" + }, + "customTagId": { + "type": "string", + "description": "Custom tag ID associated with the line item.", + "example": "406" + }, + "customTagName": { + "type": "string", + "description": "Custom tag name associated with the line item.", + "example": "abc" + }, + "customTagCode": { + "type": "string", + "description": "Custom tag code associated with the line item.", + "example": "A12" + }, + "isConfidential": { + "type": "string", + "description": "Indicates whether the line item is confidential.", + "example": "1" + }, + "invoices": { + "type": "object", + "properties": { + "invoice": { + "type": "array", + "items": { + "type": "object", + "properties": { + "invoiceId": { + "type": "string", + "description": "Unique identifier for the invoice.", + "example": "7539935" + }, + "invoiceNumber": { + "type": "string", + "description": "Invoice number associated with the purchase order.", + "example": "ABC-342" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getTaxFormDataSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code.", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "Properties": { + "type": "object", + "properties": { + "property": { + "type": "array", + "items": { + "type": "object", + "required": [ + "vendors", + "payers", + "@attributes" + ], + "properties": { + "vendors": { + "type": "object", + "properties": { + "vendor": { + "type": "array", + "items": { + "type": "object", + "required": [ + "vendorId", + "vendorType", + "vendorTinType", + "vendorTin", + "vendorBusinessNameorName", + "vendorAddress1", + "vendorCity", + "vendorState", + "vendorZipCode", + "formType", + "form1099Boxes" + ], + "properties": { + "vendorId": { + "type": "string", + "description": "Unique identifier for the vendor.", + "example": "68050" + }, + "vendorType": { + "type": "string", + "description": "Type of the vendor (e.g., Business, Individual).", + "example": "Individual" + }, + "vendorTinType": { + "type": "string", + "description": "Type of the vendor's tax identification number.", + "example": "2" + }, + "vendorTin": { + "type": "string", + "description": "Tax Identification Number of the vendor.", + "example": "930-71-6072" + }, + "vendorBusinessNameorName": { + "type": "string", + "description": "Business name or individual's name for the vendor.", + "example": "001Test" + }, + "nameOnTaxReturn": { + "type": "string", + "description": "Legal name of the entity as per tax return.", + "example": "Legal Entity Name" + }, + "vendorAddress1": { + "type": "string", + "description": "Street address of the vendor.", + "example": "Street Lines1" + }, + "vendorAddress2": { + "type": "string", + "description": "Optional second line of the vendor's street address.", + "example": "Street Line2" + }, + "vendorCity": { + "type": "string", + "description": "City where the vendor is located.", + "example": "US" + }, + "vendorState": { + "type": "string", + "description": "State where the vendor is located.", + "example": "Marshall Islands" + }, + "vendorZipCode": { + "type": "string", + "description": "Postal code of the vendor's location.", + "example": "84601" + }, + "formType": { + "type": "string", + "description": "Type of form the vendor receives (e.g., 1099 - MISC).", + "example": "1099 - MISC" + }, + "form1099Boxes": { + "type": "object", + "properties": { + "form1099Box": { + "type": "object", + "required": [ + "boxNumber", + "boxValue" + ], + "properties": { + "boxNumber": { + "type": "string", + "description": "The box number on the form.", + "example": "1" + }, + "boxValue": { + "type": "string", + "description": "The value inside the box on the form.", + "example": "13" + } + } + } + } + } + } + } + } + } + }, + "payers": { + "type": "object", + "properties": { + "payer": { + "type": "array", + "items": { + "type": "object", + "required": [ + "payerType", + "payerTinType", + "payerTin", + "payerBusinessNameOrName" + ], + "properties": { + "payerType": { + "type": "string", + "description": "The type of payer (e.g., Business, Individual).", + "example": "Business" + }, + "payerTinType": { + "type": "string", + "description": "Type of the payer's tax identification number.", + "example": "1" + }, + "payerTin": { + "type": "string", + "description": "Tax Identification Number of the payer.", + "example": "65-1111111" + }, + "payerBusinessNameOrName": { + "type": "string", + "description": "Business name or individual's name for the payer.", + "example": "22 Exchange Venture LLP" + }, + "payerAddress1": { + "type": "string", + "description": "Street address of the payer.", + "example": "123 Main St." + }, + "payerCity": { + "type": "string", + "description": "City where the payer is located.", + "example": "Lehi" + }, + "payerState": { + "type": "string", + "description": "State where the payer is located.", + "example": "Utah" + }, + "payerZipCode": { + "type": "string", + "description": "Postal code of the payer's location.", + "example": "84043" + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "properties": { + "isCompanyLevel": { + "type": "string", + "description": "Indicates if the property level is a company level.", + "example": "0" + } + } + }, + "id": { + "type": "string", + "description": "Unique identifier for the property.", + "example": "1234" + } + } + } + } + } + } + } + } + } + }, + "getVendorLocationsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Success response code.", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "Locations": { + "type": "object", + "properties": { + "Location": { + "type": "array", + "items": { + "type": "object", + "required": [ + "VendorId", + "VendorName", + "Status", + "Term", + "LegalEntity", + "Properties", + "Contacts", + "@attributes" + ], + "properties": { + "VendorId": { + "type": "string", + "description": "Unique identifier for the vendor.", + "example": "2726" + }, + "VendorName": { + "type": "string", + "description": "Name of the vendor.", + "example": "Test for Kirk" + }, + "Status": { + "type": "string", + "description": "Current status of the vendor.", + "example": "Active" + }, + "Term": { + "type": "string", + "description": "Payment terms for the vendor.", + "example": "Net" + }, + "LegalEntity": { + "type": "object", + "required": [ + "@value", + "@attributes" + ], + "properties": { + "@value": { + "type": "string", + "description": "Legal entity name.", + "example": "Test for Kirk" + }, + "@attributes": { + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the legal entity.", + "example": "470" + } + } + } + } + }, + "Properties": { + "type": "object", + "required": [ + "Property" + ], + "properties": { + "Property": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the property.", + "example": "19463" + }, + "Name": { + "type": "string", + "description": "Name of the property.", + "example": "22 Exchange" + } + } + } + } + } + } + }, + "Contacts": { + "type": "object", + "properties": { + "Contact": { + "type": "array", + "items": { + "type": "object", + "required": [ + "Name", + "@attributes" + ], + "properties": { + "Name": { + "type": "string", + "description": "Name of the contact.", + "example": "Check" + }, + "StreetLine1": { + "type": "string", + "description": "First line of the contact's street address.", + "example": "125 Test" + }, + "City": { + "type": "string", + "description": "City of the contact.", + "example": "84062" + }, + "State": { + "type": "string", + "description": "State of the contact.", + "example": "UT" + }, + "Country": { + "type": "string", + "description": "Country of the contact.", + "example": "US" + }, + "PhoneNumber": { + "type": "string", + "description": "Phone number of the contact.", + "example": "801-358-0099" + }, + "EmailAddress": { + "type": "string", + "description": "Email address of the contact.", + "example": "dunnkster@yahoo.com" + }, + "@attributes": { + "type": "object", + "required": [ + "Type" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of contact.", + "example": "Vendor_Remittence" + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "required": [ + "Id", + "Name" + ], + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the location.", + "example": "123" + }, + "Name": { + "type": "string", + "description": "Name of the location.", + "example": "Corporate" + } + } + } + } + } + } + } + }, + "Insurances": { + "type": "object", + "properties": { + "Insurance": { + "type": "array", + "items": { + "type": "object", + "required": [ + "VendorId", + "PolicyTypes", + "@attributes" + ], + "properties": { + "VendorId": { + "type": "string", + "description": "Unique identifier for the vendor.", + "example": "53813" + }, + "PolicyTypes": { + "type": "object", + "required": [ + "PolicyType" + ], + "properties": { + "PolicyType": { + "type": "object", + "required": [ + "Type", + "PolicyNumber", + "Expiration", + "Coverages" + ], + "properties": { + "Type": { + "type": "string", + "description": "Type of insurance policy.", + "example": "Workers Compensation" + }, + "PolicyNumber": { + "type": "string", + "description": "Policy number.", + "example": "P200" + }, + "Expiration": { + "type": "string", + "description": "Expiration date of the policy.", + "example": "03/13/2015" + }, + "Coverages": { + "type": "object", + "required": [ + "Coverage" + ], + "properties": { + "Coverage": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "Item", + "Amount" + ], + "properties": { + "Item": { + "type": "string", + "description": "Coverage item.", + "example": "Disease - Policy Limit" + }, + "Amount": { + "type": "string", + "description": "Coverage amount.", + "example": "200.00" + } + } + } + } + } + } + } + } + } + } + }, + "@attributes": { + "type": "object", + "required": [ + "Id", + "Provider" + ], + "properties": { + "Id": { + "type": "string", + "description": "Unique identifier for the insurance.", + "example": "1031" + }, + "Provider": { + "type": "string", + "description": "Provider name for the insurance.", + "example": "Provider 7" + } + } + } + } + } + } + } + } + } + } + } + }, + "getVendorPickListsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response code.", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "vendorCategoryTypes": { + "type": "object", + "properties": { + "vendorCategoryType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the vendor category.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the vendor category.", + "example": "Abatement Services - Asbestos" + } + } + } + } + } + } + } + }, + "ownerTypes": { + "type": "object", + "properties": { + "ownerType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the owner type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the owner type.", + "example": "Sole Proprietorship" + } + } + } + } + } + } + } + }, + "apPayeeTerms": { + "type": "object", + "properties": { + "apPayeeTerm": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the AP payee term.", + "example": "4446" + }, + "name": { + "type": "string", + "description": "Name of the AP payee term.", + "example": "Net 15" + } + } + } + } + } + } + } + }, + "apPayeeTypes": { + "type": "object", + "properties": { + "apPayeeType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the AP payee type.", + "example": "2" + }, + "name": { + "type": "string", + "description": "Name of the AP payee type.", + "example": "Owner" + } + } + } + } + } + } + } + }, + "apPayeeStatusTypes": { + "type": "object", + "properties": { + "apPayeeStatusType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the AP payee status type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the AP payee status type.", + "example": "Active" + } + } + } + } + } + } + } + }, + "form1099Types": { + "type": "object", + "properties": { + "form1099Type": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the 1099 form type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the 1099 form type.", + "example": "1099 - MISC" + } + } + } + } + } + } + }, + "form1099BoxTypes": { + "type": "object", + "properties": { + "form1099BoxType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the 1099 box type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the 1099 box type.", + "example": "1 - Rents" + } + } + } + } + } + } + } + }, + "apRemittanceTypes": { + "type": "object", + "properties": { + "apRemittanceType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the AP remittance type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the AP remittance type.", + "example": "Wire Transfer" + } + } + } + } + } + } + } + }, + "utilityBillReceiptTypes": { + "type": "object", + "properties": { + "utilityBillReceiptType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the utility bill receipt type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the utility bill receipt type.", + "example": "Mail" + } + } + } + } + } + } + } + }, + "bankAccountTypes": { + "type": "object", + "properties": { + "bankAccountType": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the bank account type.", + "example": "1" + }, + "name": { + "type": "string", + "description": "Name of the bank account type.", + "example": "Business Checking" + } + } + } + } + } + } + } + }, + "complianceStatuses": { + "type": "object", + "properties": { + "complianceStatus": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the compliance status.", + "example": "5" + }, + "name": { + "type": "string", + "description": "Name of the compliance status.", + "example": "Compliant" + } + } + } + } + } + } + } + }, + "routingTags": { + "type": "object", + "properties": { + "routingTag": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the routing tag.", + "example": "93" + }, + "name": { + "type": "string", + "description": "Name of the routing tag.", + "example": "routingTag1" + } + } + } + } + } + } + } + }, + "unitsOfMeasure": { + "type": "object", + "properties": { + "unitOfMeasure": { + "type": "array", + "items": { + "type": "object", + "required": [ + "@attributes" + ], + "properties": { + "@attributes": { + "type": "object", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the unit of measure.", + "example": "80" + }, + "name": { + "type": "string", + "description": "Name of the unit of measure.", + "example": "100 Packing" + }, + "type": { + "type": "string", + "description": "Type of the unit of measure.", + "example": "Area" + } + } + } + } + } + } + } + }, + "policies": { + "type": "object", + "properties": { + "policy": { + "type": "array", + "items": { + "type": "object", + "required": [ + "policyTypeId", + "policyTypeName", + "coverages" + ], + "properties": { + "policyTypeId": { + "type": "string", + "description": "ID for the policy type.", + "example": "7" + }, + "policyTypeName": { + "type": "string", + "description": "Name of the policy type.", + "example": "General Liability" + }, + "coverages": { + "type": "object", + "required": [ + "coverage" + ], + "properties": { + "coverage": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Coverage ID.", + "example": "12" + }, + "name": { + "type": "string", + "description": "Coverage name.", + "example": "Each Occurrence" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getVendorsSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "code": { + "type": "string", + "description": "Response code.", + "example": 200 + }, + "result": { + "type": "object", + "properties": { + "vendors": { + "type": "object", + "properties": { + "vendor": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "vendorName", + "vendorTypeId", + "vendorType", + "statusTypeId", + "status", + "termId", + "term", + "isConsolidated", + "externalId", + "isOnSite", + "vendorCategoryTypeId", + "vendorCategoryType", + "website", + "legalEntities", + "apRemittances", + "contacts", + "locations", + "compliances", + "accounts" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the vendor.", + "example": "xxxx" + }, + "vendorName": { + "type": "string", + "description": "Name of the vendor.", + "example": "1st Choice Painting & Restoration, Inc." + }, + "vendorTypeId": { + "type": "string", + "description": "Unique identifier for the vendor type.", + "example": "1" + }, + "vendorType": { + "type": "string", + "description": "Name of the vendor type.", + "example": "Standard" + }, + "statusTypeId": { + "type": "string", + "description": "Unique identifier for the status type.", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the vendor.", + "example": "Active" + }, + "termId": { + "type": "string", + "description": "Unique identifier for the term.", + "example": "1841" + }, + "term": { + "type": "string", + "description": "Payment term for the vendor.", + "example": "Net" + }, + "isConsolidated": { + "type": "string", + "description": "Indicates if the vendor is consolidated.", + "example": "true" + }, + "externalId": { + "type": "string", + "description": "External identifier for the vendor.", + "example": "395382" + }, + "isOnSite": { + "type": "string", + "description": "Indicates if the vendor is on site.", + "example": "false" + }, + "vendorCategoryTypeId": { + "type": "string", + "description": "Unique identifier for the vendor category.", + "example": "6" + }, + "vendorCategoryType": { + "type": "string", + "description": "Name of the vendor category.", + "example": "Advertising" + }, + "website": { + "type": "string", + "description": "Website URL of the vendor.", + "example": "https://campusapartments.qapchikne.entrata.lcl" + }, + "notes": { + "type": "string", + "description": "Notes associated with the vendor.", + "example": "Notes in Vendor Info" + }, + "legalEntities": { + "type": "object", + "properties": { + "legalEntity": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "taxIdNumber", + "receives1099", + "form1099TypeId", + "form1099Type", + "form1099BoxTypeId", + "form1099BoxType" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the legal entity.", + "example": "3214" + }, + "name": { + "type": "string", + "description": "Name of the legal entity.", + "example": "NoTR" + }, + "taxIdNumber": { + "type": "string", + "description": "Tax ID number of the legal entity.", + "example": "333-22-4444" + }, + "receives1099": { + "type": "string", + "description": "Indicates if the legal entity receives a 1099 form.", + "example": "true" + }, + "form1099TypeId": { + "type": "string", + "description": "Unique identifier for the 1099 form type.", + "example": "3" + }, + "form1099Type": { + "type": "string", + "description": "Type of 1099 form.", + "example": "1099 - DIV" + }, + "form1099BoxTypeId": { + "type": "string", + "description": "Unique identifier for the 1099 form box type.", + "example": "2" + }, + "form1099BoxType": { + "type": "string", + "description": "Box type of the 1099 form.", + "example": "2-Royalties" + } + } + } + } + } + }, + "apRemittances": { + "type": "object", + "properties": { + "apRemittance": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "apPaymentTypeId", + "apPaymentType", + "checkAccountTypeId", + "checkAccountType", + "isDefault" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the AP remittance.", + "example": "5433" + }, + "name": { + "type": "string", + "description": "Name of the AP remittance.", + "example": "Check Name" + }, + "apPaymentTypeId": { + "type": "string", + "description": "Payment type identifier.", + "example": "5" + }, + "apPaymentType": { + "type": "string", + "description": "Type of payment.", + "example": "Ach" + }, + "checkAccountTypeId": { + "type": "string", + "description": "Account type identifier.", + "example": "1" + }, + "checkAccountType": { + "type": "string", + "description": "Type of check account.", + "example": "Business Checking" + }, + "isDefault": { + "type": "string", + "description": "Indicates if this remittance is the default.", + "example": "1" + } + } + } + } + } + }, + "contacts": { + "type": "object", + "properties": { + "contact": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "nameFirst", + "nameLast", + "email", + "phone", + "position" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the contact.", + "example": "123654" + }, + "nameFirst": { + "type": "string", + "description": "First name of the contact.", + "example": "Max" + }, + "nameLast": { + "type": "string", + "description": "Last name of the contact.", + "example": "Collins" + }, + "email": { + "type": "string", + "description": "Email address of the contact.", + "example": "email@dot.com" + }, + "phone": { + "type": "string", + "description": "Phone number of the contact.", + "example": "3214567894" + }, + "position": { + "type": "string", + "description": "Position of the contact within the company.", + "example": "Head" + } + } + } + } + } + }, + "locations": { + "type": "object", + "properties": { + "location": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name", + "vendorCode", + "legalEntityId", + "apRemittanceId", + "isPrimary", + "propertyIds" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the location.", + "example": "26685" + }, + "name": { + "type": "string", + "description": "Name of the location.", + "example": "Corporate" + }, + "vendorCode": { + "type": "string", + "description": "Vendor code associated with the location.", + "example": "MangoCode" + }, + "isPrimary": { + "type": "string", + "description": "Indicates if this is the primary location.", + "example": "t" + }, + "propertyIds": { + "type": "string", + "description": "Comma-separated list of property IDs associated with this location.", + "example": "264438,264439,264461" + } + } + } + } + } + }, + "compliances": { + "type": "object", + "properties": { + "compliance": { + "type": "array", + "items": { + "type": "object", + "required": [ + "legalEntityId", + "legalEntity", + "propertyId", + "statusId", + "status" + ], + "properties": { + "legalEntityId": { + "type": "string", + "description": "ID of the legal entity.", + "example": "123456" + }, + "legalEntity": { + "type": "string", + "description": "Name of the legal entity.", + "example": "legalEntityName" + }, + "propertyId": { + "type": "string", + "description": "ID of the property.", + "example": "1234" + }, + "statusId": { + "type": "string", + "description": "ID of the compliance status.", + "example": "5" + }, + "status": { + "type": "string", + "description": "Compliance status.", + "example": "Compliant" + } + } + } + } + } + }, + "accounts": { + "type": "object", + "properties": { + "account": { + "type": "array", + "items": { + "type": "object", + "required": [ + "accountId", + "accountNumber", + "description", + "remittanceId", + "remittanceName", + "remittancePaymentTypeId", + "glAccountId", + "locationName", + "utilityBillReceiptTypeId" + ], + "properties": { + "accountId": { + "type": "string", + "description": "Unique identifier for the account.", + "example": "123456" + }, + "accountNumber": { + "type": "string", + "description": "Account number.", + "example": "123456" + }, + "description": { + "type": "string", + "description": "Description of the account.", + "example": "Test" + }, + "remittanceId": { + "type": "string", + "description": "ID of the remittance.", + "example": "260598" + }, + "remittanceName": { + "type": "string", + "description": "Name of the remittance.", + "example": "Check" + }, + "remittancePaymentTypeId": { + "type": "string", + "description": "ID of the remittance payment type.", + "example": "5" + }, + "glAccountId": { + "type": "string", + "description": "General ledger account ID.", + "example": "274509" + }, + "locationName": { + "type": "string", + "description": "Location name.", + "example": "locationName" + }, + "utilityBillReceiptTypeId": { + "type": "string", + "description": "Utility bill receipt type ID.", + "example": "1" + }, + "isAuditInvoice": { + "type": "string", + "description": "Indicates if the invoice is for audit purposes.", + "example": "0" + }, + "isDisabled": { + "type": "string", + "description": "Indicates if the account is disabled.", + "example": "0" + }, + "isCaptureInvoiceTotalOnly": { + "type": "string", + "description": "Indicates if only the invoice total should be captured.", + "example": "0" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "markInvoicesExportedSuccessResponse": { + "type": "object", + "required": [ + "requestId", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier for the request.", + "example": "15" + }, + "result": { + "type": "object", + "properties": { + "success": { + "type": "string", + "description": "Message indicating the success of the export action.", + "example": "Invoices marked as exported successfully." + } + } + } + } + }, + "sendInvoices_r1_SuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "ApBatch": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "properties": { + "reference_id": { + "type": "string", + "description": "Unique reference ID for the batch.", + "example": "1838" + } + } + }, + "ApHeaders": { + "type": "object", + "properties": { + "ApHeader": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "properties": { + "invoice_number": { + "type": "string", + "description": "The invoice number.", + "example": "311" + }, + "reference_id": { + "type": "string", + "description": "The unique reference ID for the AP Header.", + "example": "42652" + }, + "status": { + "type": "string", + "description": "Status of the AP Header insertion.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the AP Header insertion.", + "example": "ApHeader inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "sendInvoices_r2_SuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "apBatch": { + "type": "object", + "properties": { + "apBatchId": { + "type": "integer", + "description": "Unique identifier for the AP batch.", + "example": 99999 + }, + "apHeaders": { + "type": "object", + "properties": { + "apHeader": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "integer", + "description": "Node identifier for the AP header.", + "example": 1 + }, + "invoiceNumber": { + "type": "string", + "description": "The invoice number associated with the AP header.", + "example": "123456" + }, + "apHeaderId": { + "type": "integer", + "description": "Unique identifier for the AP header.", + "example": 111111 + }, + "status": { + "type": "string", + "description": "Status of the AP header insertion.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the AP header insertion.", + "example": "ApHeader inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "sendPurchaseOrdersSuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "apHeaders": { + "type": "object", + "properties": { + "apHeader": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "integer", + "description": "Node identifier for the AP header.", + "example": 1 + }, + "status": { + "type": "string", + "description": "Status of the AP header insertion.", + "example": "Success" + }, + "apHeaderId": { + "type": "integer", + "description": "Unique identifier for the AP header.", + "example": 7578703 + }, + "poNumber": { + "type": "integer", + "description": "Purchase Order number associated with the AP header.", + "example": 3850 + }, + "message": { + "type": "string", + "description": "Message indicating the result of the AP header insertion.", + "example": "Purchase Order inserted successfully." + } + } + } + } + } + } + } + } + } + }, + "sendVendorsSuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "vendors": { + "type": "object", + "properties": { + "vendor": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "description": "Unique identifier for the vendor.", + "example": 13019 + }, + "status": { + "type": "string", + "description": "Status of the vendor insertion.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the vendor insertion.", + "example": "Vendor inserted successfully." + } + } + } + } + } + } + } + } + } + } + } + }, + "updateInvoicesSuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "apHeaders": { + "type": "object", + "properties": { + "apHeader": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reference_id": { + "type": "string", + "description": "Unique identifier for the invoice update request.", + "example": "3115425" + }, + "status": { + "type": "string", + "description": "Status of the invoice update.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the invoice update.", + "example": "Invoice updated successfully." + } + } + } + } + } + } + } + } + } + }, + "updateVendorsSuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "vendors": { + "type": "object", + "properties": { + "vendor": { + "type": "object", + "properties": { + "1": { + "type": "object", + "properties": { + "@attributes": { + "type": "object", + "properties": { + "reference_id": { + "type": "string", + "description": "Unique identifier for the vendor update request.", + "example": "13245" + }, + "status": { + "type": "string", + "description": "Status of the vendor update.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the vendor update.", + "example": "Vendor updated successfully." + } + } + } + } + } + } + } + } + } + } + } + } + }, + "voidApPaymentsSuccessResponse": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "type": "object", + "properties": { + "apPayments": { + "type": "object", + "properties": { + "apPayment": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "The node identifier of the payment.", + "example": "1" + }, + "status": { + "type": "string", + "description": "Status of the payment void operation.", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Message indicating the result of the payment void.", + "example": "Payment voided successfully." + }, + "paymentId": { + "type": "string", + "description": "The unique identifier for the payment.", + "example": "123456" + }, + "paymentNumber": { + "type": "string", + "description": "The payment number.", + "example": "980" + } + } + } + } + } + } + } + } + } + }, + "successResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "an arbitary value sent with the request." + }, + "code": { + "type": "integer", + "description": "Successful response code." + }, + "result": { + "type": "object", + "description": "webservice response data" + } + } + } + } + }, + "errorResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "type": "integer", + "description": "error code one of the [ 1xx, 3xx, 4xx, 5xx ]" + }, + "message": { + "type": "string", + "description": "error details." + } + } + } + } + } + } + }, + "getStatus": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getStatus" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getCompanyApplications": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCompanyApplications" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendApplicantGeneralDetails": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicantGeneralDetails" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicantId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "isTrue": { + "type": "integer", + "enum": [ + 0, + 1 + ] + }, + "comments": { + "type": "string", + "format": "string", + "example": "Test Comments", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId", + "applicantId", + "id" + ] + } + } + } + } + }, + "sendApplication": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplication" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "originatingLeadSourceId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leasingAgentId": { + "type": "integer", + "format": "int64", + "example": 445655, + "description": "This is a required field. This field accepts single value." + }, + "unitSpaceId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value." + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "floorplanId": { + "type": "integer", + "format": "int64", + "example": 205814, + "description": "This is a required field. This field accepts single value." + }, + "leaseTermId": { + "type": "integer", + "format": "int64", + "example": 1862, + "description": "This is a required field. This field accepts single value." + }, + "applicationStatusId": { + "type": "integer", + "format": "int64", + "example": 3, + "description": "This is an optional field. This field accepts single value. Acceptable values are 3 (COMPLETED ) & 4 (APPLICATION_APPROVED )" + } + }, + "required": [ + "propertyId", + "originatingLeadSourceId" + ] + } + } + } + } + }, + "sendApplicationAddOns": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "sendApplicationEmployers": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationEmployers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer record." + }, + "incomeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required." + }, + "customerId": { + "type": "integer", + "format": "int64", + "example": 17378378, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter. If \"id\" is not provided, this parame ter is required." + }, + "frequencyId": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range which are: 3 [ weekly ], 4 [ Monthly ] and 6 [ Yearly ]" + }, + "position": { + "type": "string", + "format": "string", + "example": "Technical Manager", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionName": { + "type": "string", + "format": "string", + "example": "Entrata Inc.", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionPhoneNumber": { + "type": "string", + "format": "string", + "example": "7544898565", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number." + }, + "institutionStreetLine1": { + "type": "string", + "format": "string", + "example": "address line 1", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStreetLine2": { + "type": "string", + "format": "string", + "example": "address line 2", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStreetLine3": { + "type": "string", + "format": "string", + "example": "address line 3", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionCity": { + "type": "string", + "format": "string", + "example": "City", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionStateCode": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionProvince": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionPostalCode": { + "type": "string", + "format": "string", + "example": "11111", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "institutionCountryCode": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required." + }, + "contactName": { + "type": "string", + "format": "string", + "example": "People Ops team", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "contactPhone": { + "type": "string", + "format": "string", + "example": "9954809807", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number." + }, + "contactEmail": { + "type": "string", + "format": "string", + "example": "hr@example.lcl", + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts string value" + }, + "incomeEffectiveDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format." + }, + "dateStarted": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format." + }, + "dateEnded": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded." + }, + "isDelete": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + "sendApplicationPets": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendApplicationPets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Required parameter, accepts integer value." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 123, + "description": "This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided we will update the pet record" + }, + "customerId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Conditionally required. Accepts integer value. If id is not provided, this parameter is required" + }, + "typeId": { + "type": "integer", + "format": "int64", + "example": 17378378, + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "breed": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "gender": { + "type": "string", + "format": "string", + "example": "F", + "description": "This is an optional field. This field accepts single value." + }, + "color": { + "type": "string", + "format": "string", + "example": "White", + "description": "This is an optional field. This field accepts single value." + }, + "weight": { + "type": "integer", + "format": "float", + "example": "30.99", + "description": "This is an optional field. This field accepts single value." + }, + "age": { + "type": "integer", + "format": "int64", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Description.", + "description": "This is an optional field. This field accepts single value." + }, + "licenseCity": { + "type": "string", + "format": "string", + "example": "XYZ", + "description": "This is an optional field. This field accepts single value." + }, + "licenseNumber": { + "type": "string", + "format": "string", + "example": "156", + "description": "This is an optional field. This field accepts single value." + }, + "isAssistanceAnimal": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isPetSpayedOrNeutered": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "petSpayedOrNeuteredDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "isHouseBroken": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "specialProvisions": { + "type": "string", + "format": "string", + "example": "Test", + "description": "This is an optional field. This field accepts single value." + }, + "isDelete": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + "sendApplicationVehicles": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vehicleTypeId": { + "type": "integer", + "format": "int64", + "example": 2, + "description": "This is a required field. This field accepts single value. Indicates the type of vehicle. Possible values are 1, 2, or 3 where 1 = Primary, 2 = Secondary, and 3 = Other." + } + }, + "required": [ + "vehicleTypeId" + ] + } + } + } + } + }, + "updateApplication": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "applicationId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node accepts application id which needs to be updated." + }, + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node accepts the property id." + }, + "applicationStatusId": { + "type": "integer", + "format": "int64", + "example": 3, + "description": "This is an optional field. This field accepts single value. This node accept the status id." + }, + "floorplanId": { + "type": "integer", + "format": "int64", + "example": 1235, + "description": "This is an optional field. This field accepts single value. This node accept the associated floorplan id or the floorplan which ne eds to be associated with the application." + }, + "unitSpaceId": { + "type": "integer", + "format": "int64", + "example": 1442, + "description": "This is an optional field. This field accepts single value. This node accept the associated unit space id or the unit space which needs to be associated with the application." + }, + "leaseTermId": { + "type": "integer", + "format": "int64", + "example": 4, + "description": "This is an optional field. This field accepts single value. This node accepts the lease length." + }, + "leasingAgentId": { + "type": "integer", + "format": "int64", + "example": 147896, + "description": "This is an optional field. This field accepts single value. This node accepts the associated leasing agent or the leasing agent wh ich needs to be updated." + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This node accepts the move-in date. In ISO format as well." + }, + "originatingLeadSourceId": { + "type": "integer", + "format": "int64", + "example": 8521, + "description": "This is an optional field. This field accepts single value. This node accepts the lead source id." + }, + "id": { + "type": "integer", + "format": "int64", + "example": 7893, + "description": " This is an optional field. This field accepts single value. This node accepts the applicants id." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants first name." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts applicants last name." + }, + "maternalName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This node accepts applicants maternal name." + }, + "preferredName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": " This is an optional field. This field accepts single value. This node accepts applicants preferred name." + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This node accepts applicants birth date. Supports ISO format." + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "int64", + "example": "1264", + "description": "This is an optional field. This field accepts single value. This node accepts customer relationship id." + }, + "email": { + "type": "string", + "format": "string", + "example": "test@gmail.com", + "description": " This is an optional field. This field accepts single value. This node accepts the applicants email." + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "int64", + "example": "3", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number type id. This is condition al mandatory node, if phoneNumber is provided then phoneNumberTypeId is required." + }, + "phoneNumber": { + "type": "integer", + "format": "int64", + "example": "(123)-111-1111", + "description": "This is an optional field. This field accepts single value. This node accepts applicants phone number. This is conditional manda tory node, if value for phoneNumberTypeId is provided then this node is required." + }, + "addressTypeId": { + "type": "integer", + "format": "int64", + "example": "11", + "description": "This is an optional field. This field accepts single value. This node accepts address type id." + }, + "addressLine1": { + "type": "string", + "format": "string", + "example": "addressLine1", + "description": "This is an optional field. This field accepts single value." + }, + "addressLine2": { + "type": "string", + "format": "string", + "example": "addressLine2", + "description": "This is an optional field. This field accepts single value." + }, + "addressLine3": { + "type": "string", + "format": "string", + "example": "addressLine3", + "description": "This is an optional field. This field accepts single value." + }, + "city": { + "type": "string", + "format": "string", + "example": "City", + "description": "This is an optional field. This field accepts single value." + }, + "postalCode": { + "type": "integer", + "format": "int64", + "example": "12345", + "description": "This is an optional field. This field accepts single value." + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "CA", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + "getAccessibleClients": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleClients" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getAccessibleServices": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAccessibleServices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getArCodes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArCodes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid." + } + } + } + } + } + } + }, + "getArPayments": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArPayments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "arPaymentIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids." + }, + "paymentStatusTypeIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From date." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. To date" + }, + "isIncludeAllocations": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment" + } + }, + "required": [ + "applicationId", + "propertyId" + ] + } + } + } + } + }, + "getArInvoices": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getArInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseIds": { + "type": "string", + "format": "string", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds" + }, + "arInvoiceId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": " This is an optional field. This field accepts single value. arInvoiceId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From date." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. To date" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeaseArTransactions": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "leaseIds": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. leaseIds" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "int64", + "example": "3,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled." + }, + "transactionTypeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12" + }, + "arCodeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds" + }, + "showFullLedger": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response." + }, + "includeReversals": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be t rue(1)." + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This will return transactions starting from the provided date." + }, + "transactionToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This will return transaction till the provided date." + }, + "ledgerIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getMitsLeaseArTransactions": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "leaseId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is an optional field. This field accepts single value. leaseId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "int64", + "example": "3,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled." + }, + "arCodeIds": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. arCodeIds" + }, + "showFullLedger": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items." + }, + "includeReversals": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \"showFullLedger\" must be true(1)." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This is parameter allows you to pull ledger history as displayed under resident portal" + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response." + }, + "includePaymentsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This parameter is used to retrieve payments transactions in the response" + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionFromDate" + }, + "transactionToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionToDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendLeaseArTransactionReversals": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactionReversals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "TransactionId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value. This ID represents the \"reference_id\" provided in the sendLeaseArTrans actions response or the \"TransactionID\" provided in getMitsLeaseArTran sactions." + }, + "TransactionAmount": { + "type": "integer", + "format": "float", + "example": "100.50", + "description": "This is a required field. This field accepts single value. The amount for which the original charge was posted. If the Original c harge was a negative charge, a credit, please send this amount as nega tive as well." + }, + "PropertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "ReverseDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. If a date is sent in this parameter, we will set this value as postDate for the reversed transactions." + }, + "Description": { + "type": "string", + "format": "string", + "example": "Test Description", + "description": "This is an optional field. This field accepts single value. This is an optional parameter. We highly recommend that you provide a detailed description of the reason for which the charged is reversed." + } + }, + "required": [ + "TransactionId", + "TransactionAmount" + ] + } + } + } + } + }, + "sendLeaseArTransactions": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseArTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "transactionId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is a required field. This field accepts single value. Unique Transaction ID of client system" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": "2342", + "description": "This is a required field. This field accepts single value. Lease ID" + }, + "arCodeId": { + "type": "integer", + "format": "int64", + "example": 11, + "description": "This is a required field. This field accepts single value. Ar Code ID" + }, + "transactionAmount": { + "type": "integer", + "format": "float", + "example": "1000.00", + "description": "This is a required field. This field accepts single value. Transaction Amount" + }, + "transactionDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. transactionDate" + }, + "arPostMonth": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Charge Posting Month" + } + }, + "required": [ + "transactionId", + "leaseId", + "arCodeId", + "transactionAmount", + "transactionDate" + ] + } + } + } + } + }, + "getMarketingPreferencePickList": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferencePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getMarketingPreferences": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMarketingPreferences" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,2342", + "description": "This is a required field. This field accepts comma seperated multiple values. Customer Ids" + }, + "recipientTypeId": { + "type": "integer", + "format": "int64", + "example": 11, + "description": "This is a required field. This field accepts single value. Possible values are 1 = Lead 2 = Resident" + } + }, + "required": [ + "propertyId", + "customerIds", + "arCodeId" + ] + } + } + } + } + }, + "getCustomers": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,5678,9865", + "description": "This is an optional field. This field accepts comma seperated multiple values. Customer Ids" + }, + "leaseStatusTypeIds": { + "type": "string", + "format": "string", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values. Lease Status types" + }, + "isAgreedToTermsOnly": { + "type": "boolean", + "example": "1" + }, + "companyIdentificationTypeIds": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts comma seperated multiple values. company Identification type IDs" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getCustomerTestimonials": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Property id" + }, + "isApproved": { + "type": "boolean" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials from this date" + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. This will fetch the testimonials until this date" + } + } + } + } + } + } + }, + "getTestimonialPickLists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTestimonialPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "searchCustomers": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "searchCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id. This is system ID associated with each property." + }, + "search": { + "type": "string", + "format": "string", + "example": "Thornberry", + "description": "This is a required field. This field accepts single value. Search string accepts phone number, name, building, unit, secondary number." + } + }, + "required": [ + "propertyId", + "search" + ] + } + } + } + } + }, + "sendCustomerTestimonials": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "CustomerId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Customer Id." + }, + "TestimonialTypeId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. The following are valid testimonial type ids: 1 Resident testimonial 2 Employee testimonial 3 Client testimonial 4 Vacancy 5 Apartmentr atings.com 6 Yelp.com 7 atlanta.citysearch.com" + }, + "Name": { + "type": "string", + "format": "string", + "example": "Bryan Murfy", + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Name of a person who submitted the testi monial." + }, + "Title": { + "type": "string", + "format": "string", + "example": "So far a great experience", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Title of testimonial." + }, + "Review": { + "type": "string", + "format": "string", + "example": "This is a nice community that makes you feel like you are a valued memeber.", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Review content." + }, + "RecommendToFriend": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Do you recommend this property to any friend?." + }, + "AuthorizeToShowOnCorporateSites": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value. Child element of Testimonial. Do you authorize property manager to dis play your testimonial on its portal and affiliate websites?." + }, + "RatingTypeId": { + "type": "integer", + "format": "int64", + "example": "1", + "description": "This is a required field. This field accepts single value. The following are valid testimonial rating types ids: 1 Parking 2 No ise 3 Grounds 5 Construction 6 Maintenance 7 Staff 8 Overall" + }, + "Rating": { + "type": "integer", + "format": "int64", + "example": "3", + "description": "This is a required field. This field accepts single value. Child element of TestimonialRatings. Rating value." + }, + "AutoApproveForProspectPortal": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on prospect portal." + }, + "AutoApproveForVacancy": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on vacany.com" + }, + "PropertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "TestimonialDatetime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYY", + "description": "This is an optional field. This field accepts single value. Testimonial submission date." + }, + "TransmissionVendorId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Transmission Vendor Id" + }, + "Email": { + "type": "string", + "format": "string", + "example": "br@mycomp.com", + "description": "This is an optional field. This field accepts single value. Email will be required if CustomerId is not provided. Child element of Testimonial. Email of a person who submitted the testimonial." + }, + "PropertyResponse": { + "type": "string", + "format": "string", + "example": "Property Response...", + "description": "This is an optional field. This field accepts single value. The property`s response to the review." + } + }, + "required": [ + "TestimonialTypeId", + "Title", + "Review", + "AuthorizeToShowOnCorporateSites", + "RatingTypeId", + "Rating", + "PropertyId" + ] + } + } + } + } + }, + "updateCustomers": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomers" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 31025784, + "description": "This is a required field. This field accepts single value. This should be the unique ID of the customer to be updated and they mu st be in at least an applicant or higher lease status." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "Ephraim", + "description": "This is an optional field. This field accepts single value." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "Kassulke", + "description": "This is an optional field. This field accepts single value." + }, + "namePrefix": { + "type": "string", + "format": "string", + "example": "Ms.", + "description": "This is an optional field. This field accepts single value." + }, + "middleName": { + "type": "string", + "format": "string", + "example": "Emie", + "description": "This is an optional field. This field accepts single value." + }, + "maidenName": { + "type": "string", + "format": "string", + "example": "MaidenName", + "description": "This is an optional field. This field accepts single value." + }, + "nameSuffix": { + "type": "string", + "format": "string", + "example": "III", + "description": "This is an optional field. This field accepts single value." + }, + "email": { + "type": "string", + "format": "string", + "example": "Carson87@example.org", + "description": "This is an optional field. This field accepts single value." + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "YYYY/MM/DD", + "description": "This is an optional field. This field accepts single value." + }, + "taxNumberTypeId": { + "type": "integer", + "format": "int64", + "example": 9, + "description": "This is an optional field. This field accepts single value." + }, + "taxNumber": { + "type": "integer", + "format": "int64", + "example": "844-588-2283", + "description": "This is an optional field. This field accepts single value." + }, + "addressTypeId": { + "type": "integer", + "format": "int64", + "example": 8, + "description": "This is an optional field. This field accepts single value." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "3927 Austen Groves", + "description": "This is an optional field. This field accepts single value." + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "43853 Thompson Rapids", + "description": "This is an optional field. This field accepts single value." + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "085 Weber Streets", + "description": "This is an optional field. This field accepts single value." + }, + "city": { + "type": "string", + "format": "string", + "example": "Streichtown", + "description": "This is an optional field. This field accepts single value." + }, + "country": { + "type": "string", + "format": "string", + "example": "US", + "description": "This is an optional field. This field accepts single value." + }, + "state": { + "type": "string", + "format": "string", + "example": "CA", + "description": "This is an optional field. This field accepts single value." + }, + "postalCode": { + "type": "integer", + "format": "int64", + "example": 22222, + "description": "This is an optional field. This field accepts single value." + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "int64", + "example": 2, + "description": "This is an optional field. This field accepts single value." + }, + "isPrimary": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value." + }, + "phoneNumber": { + "type": "integer", + "format": "int64", + "example": "1231231234", + "description": "This is an optional field. This field accepts single value." + }, + "companyIdentificationTypeId": { + "type": "integer", + "format": "int64", + "example": 5587, + "description": "This is an optional field. This field accepts single value." + }, + "identificationValue": { + "type": "string", + "format": "string", + "example": "688", + "description": "This is an optional field. This field accepts single value." + }, + "idExpirationDate": { + "type": "string", + "format": "date", + "example": "YYYY/MM/DD", + "description": "This is an optional field. This field accepts single value." + }, + "StateCode": { + "type": "string", + "format": "string", + "example": "GN", + "description": "This is an optional field. This field accepts single value." + }, + "countryCode": { + "type": "string", + "format": "string", + "example": "Guinea", + "description": "This is an optional field. This field accepts single value. \"countryCode\" is accepted under \"companyIdentificationValue\" node." + } + }, + "required": [ + "id" + ] + } + } + } + } + }, + "updateCustomerTestimonials": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateCustomerTestimonials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "transmissionVendorId": { + "type": "integer", + "format": "int64", + "example": 12, + "description": "This is a required field. This field accepts single value." + }, + "testimonialId": { + "type": "integer", + "format": "int64", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "isPublished": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "transmissionVendorId", + "isPublished" + ] + } + } + } + } + }, + "updatePropertyResponse": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyResponse" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "testimonialId": { + "type": "integer", + "format": "int64", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "reviewResponse": { + "type": "string", + "format": "string", + "example": 12345, + "description": "Test Review Response" + }, + "isPublish": { + "type": "boolean", + "example": "1", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "testimonialId", + "isPublish" + ] + } + } + } + } + }, + "getApCodes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getApCodes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "apCodeTypeIds": { + "type": "integer", + "format": "int64", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. Currently supporting only job cost (3)" + } + } + } + } + } + } + }, + "getBankAccounts": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBankAccounts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "bankAccountTypeId": { + "type": "integer", + "format": "int64", + "example": "1234,5678", + "description": "This is an optional field. This field accepts single value. Bank Account Type Identification Number" + }, + "isCreditCardAccount": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + } + } + } + } + } + }, + "getBudgetActuals": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgetActuals" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "int64", + "example": "123456", + "description": "This is a required field. This field accepts single value. propertyId" + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is a required field. This field accepts single value." + }, + "budgetId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is a required field. This field accepts single value." + }, + "postMonthFrom": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. MM/YYYY" + }, + "postMonthTo": { + "type": "string", + "format": "string", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. MM/YYYY" + }, + "glBookTypeIds": { + "type": "integer", + "format": "int64", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. glBookTypeIds" + }, + "budgetStatusTypeId": { + "type": "integer", + "format": "int64", + "example": "1234", + "description": "This is an optional field. This field accepts single value. budgetStatusTypeId" + }, + "accountingMethod": { + "type": "string", + "format": "string", + "example": "Cash", + "description": "This is a required field. This field accepts single value. accountingMethod" + } + }, + "required": [ + "propertyId", + "glTreeId", + "budgetId", + "postMonthFrom", + "postMonthTo" + ] + } + } + } + } + }, + "getBudgets": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. propertyIds" + }, + "budgetIds": { + "type": "string", + "format": "string", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetIds" + }, + "budgetStatusTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,4", + "description": "This is an optional field. This field accepts comma seperated multiple values. budgetStatusTypeIds" + }, + "fiscalYears": { + "type": "string", + "format": "string", + "example": "YYYY,YYYY", + "description": "This is an optional field. This field accepts comma seperated multiple values. fiscalYears" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getFinancialPickList_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": "123456", + "description": "This is an optional field. This field accepts single value. Property Id" + } + } + } + } + } + } + }, + "getFinancialPickList_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + } + } + } + } + }, + "getGlTransactions": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTransactions" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,112233", + "description": "This is a required field. This field accepts comma seperated multiple values." + }, + "glAccountFrom": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "glAccountTo": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "postMonthFrom": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. If no post month is provided, then the default post month of the prope rty will be used. If multiple properties are passed then the post mon th of any property would be used randomly." + }, + "postMonthTo": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "postDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "postDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "isCashBook": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isDetailed": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "glBookTypeIds": { + "type": "integer", + "format": "int64", + "example": "1,2,3", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "transactionDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction." + }, + "transactionDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the actual system created date of the transaction." + }, + "excludeApTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag will filter off any ap transactions from the response." + }, + "excludeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag will filter off any Ar Transactions from the response." + }, + "excludeExportedTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If passed as true (1) the API will not return any transaction that was previously marked exported using the markGlTransactionsExported API. Transaction exported under a different export format in Entrata wil l still qualify to be returned until specifically marked exported over the markGlTransactionsExported API." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getGlTrees_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Property Id" + }, + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Tree Id" + }, + "glBranchId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Branch Id" + }, + "glGroupTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Group Type Id" + }, + "glTreeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id" + }, + "accountNumbers": { + "type": "string", + "format": "date", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + "getGlTrees_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getGlTrees" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "glTreeId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Tree Id" + }, + "glBranchId": { + "type": "integer", + "format": "int64", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Gl Branch Id" + }, + "glGroupTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Group Type Id" + }, + "glTreeTypeId": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "This is an optional field. This field accepts single value. Gl Tree Type Id" + }, + "accountNumbers": { + "type": "string", + "format": "date", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + "getJobCategories": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCategories" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glAccountIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This is the glAccount Id associated with job category" + } + } + } + } + } + } + }, + "getJobCostBudgets": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobCostBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id." + }, + "jobIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id." + }, + "jobStatusIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept job status Id." + }, + "apCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept apCode Id" + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node should accept job Phase Id" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getJobs": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getJobs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This node should accept the propertyId." + }, + "jobCategoryIds": { + "type": "integer", + "format": "integer", + "example": "6", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the jobCategoryIds" + }, + "jobStatusIds": { + "type": "integer", + "format": "integer", + "example": "4", + "description": "This is an optional field. This field accepts comma seperated multiple values. This node should accept the job statusIds." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getTransactionTagLists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTransactionTagLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "markGlTransactionsExported": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markGlTransactionsExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "glDetailId": { + "type": "integer", + "format": "integer", + "example": "[\"123456\",\"67890\"]", + "description": "This is a required field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "glDetailId" + ] + } + } + } + } + }, + "sendBudgets": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "budgetName": { + "type": "string", + "format": "string", + "example": "budgets name 1", + "description": "This is a required field. This field accepts single value." + }, + "fiscalYear": { + "type": "integer", + "format": "integer", + "example": "YYYY", + "description": "This is a required field. This field accepts single value." + }, + "fiscalStartMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts fiscal start month in MM/YYYY format." + }, + "fiscalEndMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts fiscal end month in MM/YYYY format." + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. This node accepts GL account id." + }, + "budgetMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format." + }, + "amount": { + "type": "integer", + "format": "float", + "example": "10.00", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "budgetName", + "fiscalYear", + "fiscalStartMonth", + "fiscalEndMonth", + "id", + "budgetMonth", + "amount" + ] + } + } + } + } + }, + "sendJournalEntries": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendJournalEntries" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "glHeaderTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. If the value for glHeaderTypeId is not provided take default as Standard" + }, + "reference": { + "type": "string", + "format": "string", + "example": "Enter Journal Entries", + "description": "This is an optional field. This field accepts single value." + }, + "accountingMethod": { + "type": "string", + "format": "string", + "example": "cash", + "description": "This is an optional field. This field accepts single value. If not provided, the accounting method of \"Both\" is used." + }, + "glBookId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "postDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If not provided then the default date will be the current date. The pa st date is acceptable" + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. If not provided then the default will be the current post month. Past post month is acceptable" + }, + "isReverse": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. By default value will be false." + }, + "reversePostMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Conditionally required. Based on \"isReverse\" flag." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "notes": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is an optional field. This field accepts single value." + }, + "defaultPropertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "defaultPropertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "defaultGlDimensionId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "memo": { + "type": "string", + "format": "string", + "example": "Test Memo", + "description": "This is an optional field. This field accepts single value." + }, + "debitAmount": { + "type": "integer", + "format": "integer", + "example": "100.00", + "description": "This is an optional field. This field accepts single value. Conditional Required. If the Credit amount is passed then this should be 0." + }, + "creditAmount": { + "type": "integer", + "format": "integer", + "example": "10.00", + "description": "This is an optional field. This field accepts single value. Conditional Required. If Debit amount is passed this should be 0" + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value" + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value" + }, + "glDimensionId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "defaultJobPhaseId": { + "type": "integer", + "format": "integer", + "example": 1233, + "description": "This is an optional field. This field accepts single value" + }, + "defaultApContractId": { + "type": "integer", + "format": "integer", + "example": 23, + "description": "This is an optional field. This field accepts single value" + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 23, + "description": "This is an optional field. This field accepts single value" + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value" + } + }, + "required": [ + "propertyId", + "glAccountId", + "glBookId" + ] + } + } + } + } + }, + "updateBudgets": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateBudgets" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "month": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format." + }, + "amount": { + "type": "integer", + "format": "float", + "example": "122.88", + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "id", + "month", + "amount" + ] + } + } + } + } + }, + "getLeads": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leadId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Accepts combination of Firstname & Lastname to filter leads depending on inputs." + }, + "telephone": { + "type": "integer", + "format": "integer", + "example": "1234567890", + "description": "This is an optional field. This field accepts single value. Accepts Primary/Work/Home/Mobile number as input." + }, + "email": { + "type": "string", + "format": "string", + "example": "example@email.com", + "description": "This is an optional field. This field accepts single value." + }, + "leadStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "psProductIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "includeDemographics": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range." + }, + "createdOnDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range." + }, + "createdOnDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. In the response, events will not be returned unless we pass specific E vent Type Id(s) in this node. Accepts comma-separated values with lim it 5." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY" + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeadEvents": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeadEvents" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Conditionally required, If eventTypeIds and eventDates are not passed then applicationId is required." + }, + "eventTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "applyQuote": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "applyQuote" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "generateQuotes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "generateQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application." + }, + "adjustmentsAndProvisionIds": { + "type": "string", + "format": "string", + "example": "123,234", + "description": "This is an optional field. This field accepts comma seperated multiple values. adjustmentsAndProvisionIds" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeadPickLists_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,4533", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyIds" + } + } + } + } + } + } + }, + "getLeadPickLists_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. propertyId" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getMitsLeads": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leadId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Application Id referring PSI system" + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This field accepts a combination of Firstname & Lastname. If either of one is provided, leads matching with given input will be returned in the response." + }, + "telephone": { + "type": "integer", + "format": "integer", + "example": "1234567890", + "description": "This is an optional field. This field accepts single value. This field accepts Primary/Mobile/Home/Work number of prospect in any format" + }, + "email": { + "type": "string", + "format": "string", + "example": "example@email.com", + "description": "This is an optional field. This field accepts single value. This field accepts email address of prospect." + }, + "leadStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. leadStatusIds - comma seperated" + }, + "psProductIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values. psProductIds - comma seperated" + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "10,15", + "description": "This is an optional field. This field accepts comma seperated multiple values. eventTypeIds - comma seperated" + }, + "sendUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. sendUnitSpaces" + }, + "fromDateTime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field.If name or telephone or email or leadId is provided then fromDate is not required." + }, + "toDateTime": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. This is an conditionally mandatory field. If name or telephone or emai l or leadId is provided then toDate is not required." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. eventDateFrom" + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. eventDateTo" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getQuotes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getQuotes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This will fetch quotes associated with the property." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application." + }, + "leaseStartDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Format: MM/DD/YYYY, YYYY-MM-DD, MM/DD/YY" + }, + "quoteId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + }, + "includeExpiredQuotes": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If pass value \"1\" then expired quotes should get returned in the response." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendLeads": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is a required field. This field accepts a single integer value fo r Property ID." + }, + "subtypeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\"" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendMitsLeads": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendMitsLeads" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "doNotSendConfirmationEmail": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Allows restricting the guest card confirmation emails to prospect/prop erty if set to 1." + }, + "isWaitList": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. When sent as 1, Units will be listed in waitlist." + }, + "LastUpdateDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYYT HH:MM:SS", + "description": "This is a required field. This field accepts single value. LastUpdateDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "updateLeads_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. PropertyId" + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. ApplicationId" + } + }, + "required": [ + "propertyId", + "applicationId" + ] + } + } + } + } + }, + "updateLeads_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts the property Id value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. Accept the Application_Id(Lead_Id), can be obtained from getLeads API." + }, + "eventId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Accepts the value for Event Id." + }, + "typeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value. Accepts the Event Type Id value under this node." + }, + "eventResultId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. Value for event result id should be fetched from getLeadPickLists API. Depending on the Events this node should be considered mandatory." + }, + "subtypeId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \"Appointment\":- 453:\"Leasing Appointments\", 560:\"Self-Guided Tour\", 454:\" Tour\", 525:\"Virtual Tour\". And under event type \"Tour\":- 524:\"Self-Gui ded Tour\"" + }, + "date": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This is the event date. During cloning, all the lead event dates will be set to the current date." + } + }, + "required": [ + "propertyId", + "applicationId", + "typeId" + ] + } + } + } + } + }, + "cancelLease": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "cancelLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + "getEvictedLeases": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getEvictedLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Provide a valid propertyId." + }, + "evictionStartDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateFrom." + }, + "evictionStartDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Provide a valid evictionStartDateTo" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getExpiringLeases": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getExpiringLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Date from which leases are required" + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Date upto which leases are required" + }, + "isMonthToMonth": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Is Month To Month" + }, + "isWaitList": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this parameter is enabled then we will show leases with lease type status notice and the property setting HIDE_NOTICE_RESIDENTS_FROM_RENE WALS should be disabled for this, else we will return error." + } + }, + "required": [ + "propertyId", + "toDate" + ] + } + } + } + } + }, + "getLeaseActivities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "leaseId", + "propertyId" + ], + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "createdOnDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventTypeIds": { + "type": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + "getLeaseDetails_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "includeAddOns": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "includeCharge": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + "getLeaseDetails_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "includeAddOns": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "includeCharge": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeaseDocuments": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocuments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Lease Id - Required if externalLeaseId is not provided" + }, + "externalLeaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. The remote primary key which is associated to lease. Required if leas eId is not provided." + }, + "documentIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "fileTypesCode": { + "type": "string", + "format": "string", + "example": "LA", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files" + }, + "addedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If provided, this will return the documents which have AddedOn dates o n or after the date provided." + }, + "showDeletedFile": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeaseDocumentsList": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeaseDocumentsList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "externalLeaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. This is the remote primary key that is associated to lease." + }, + "documentIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "fileTypesCode": { + "type": "string", + "format": "string", + "example": "LA", + "description": "This is an optional field. This field accepts comma seperated multiple values. System code for file files" + }, + "showDeletedFile": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeasePickList": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasePickList" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getLeases_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getLeases_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getMitsCollections": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsCollections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "includeEvictions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Include Evictions leases" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. From Date" + }, + "transactionFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. transactionFromDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getMitsLeases": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. customerId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "leaseIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "eventTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduledArCodeIds": { + "type": "integer", + "format": "integer", + "example": "12345,56744", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "12", + "description": "This is an optional field. This field accepts single value." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveInDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateFrom": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "eventDateTo": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "leaseExpiringDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "moveOutDateTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeOtherIncomeLeases": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "residentFriendlyMode": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeLeaseHistory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeArTransactions": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getParcelAlerts": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getParcelAlerts" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "isActive": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getRentersInsurancePolicies": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentersInsurancePolicies" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds" + }, + "lastUpdatedOn": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. lastUpdatedOn" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "moveInLease": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveInLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId" + ] + } + } + } + } + }, + "moveOutLease": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "moveOutLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "moveOutTypeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutTypeId" + }, + "moveOutReasonId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutReasonId" + }, + "noticeDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. noticeDate" + }, + "moveOutDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveOutDate" + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate" + }, + "endContinuingScheduledCharges": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. endContinuingScheduledCharges" + }, + "postAcceleratedRent": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. postAcceleratedRent" + }, + "refundMethodId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": " This is an optional field. This field accepts single value. refundMethodId" + }, + "makeReadyEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line1" + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line2" + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding Address street_Line3" + }, + "city": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Forwarding address`s city" + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AK", + "description": "This is an optional field. This field accepts single value. Forwarding Address`s stateCode" + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": 99501, + "description": "This is an optional field. This field accepts single value. Forwarding Address`s Postal Code" + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate" + ] + } + } + } + } + }, + "onNoticeLease": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "onNoticeLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "moveOutTypeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutTypeId" + }, + "moveOutReasonId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. moveOutReasonId" + }, + "noticeDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. noticeDate (YYYY-MM-DD)" + }, + "moveOutDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveOutDate (YYYY-MM-DD)" + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. unitAvailableOnDate (YYYY-MM-DD)" + }, + "makeReadyEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. According to Property Preference \"Require Make Ready Work Order on Mov e-out,...\" the makeReadyEndDate is conditional mandatory." + }, + "submitRefundDetails": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value. submitRefundDetails" + }, + "refundMethodId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"refundMet hodId\" is required." + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 1\" is required." + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 2\" is required." + }, + "streetLine3": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"streetLie 3\" is required." + }, + "city": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"city\" is required." + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AK", + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"stateCode\" is required." + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": 99501, + "description": "This is an optional field. This field accepts single value. If the value of \"submitRefundDetails\" is \"1\", only then the \"postalCod \" is required." + } + }, + "required": [ + "propertyId", + "leaseId", + "moveOutTypeId", + "moveOutReasonId", + "moveOutDate", + "unitAvailableOnDate", + "makeReadyEndDate", + "submitRefundDetails" + ] + } + } + } + } + }, + "sendLeaseActivities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseActivities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "eventTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. Acceptable values are: 8,335,4,436,5,6,15,56. 4 for \"Call-Outgoing\" , 5 for \"Text-Incoming\", 6 for \"Text-Outgoing\", 8 for \"Notes\", 335 fo r \"Lease Retrieved By Collections Agency\", 436 for \"Hazard Notes\", 15 for \"Scheduled Follow-Up\", 56 for \"Delinquency Notes\"." + }, + "eventDateTime": { + "type": "string", + "format": "date", + "example": "09/2/2018 03:57:00 PST", + "description": "This is a required field. This field accepts single value." + }, + "comment": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6." + }, + "hazardEndDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. This would give end date for the hazard note." + }, + "hazardNote": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. This would add note when creating hazard event." + }, + "leaseIntervalId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "leasingAgentId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15." + }, + "eventResultId": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "his is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6." + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "scheduleDateTime": { + "type": "string", + "format": "date", + "example": "06/18/2022 11:30:45", + "description": "This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15." + } + }, + "required": [ + "propertyId", + "leaseId", + "eventTypeId", + "eventDateTime", + "hazardNote" + ] + } + } + } + } + }, + "sendLeaseDocuments": { + "type": "object", + "required": [ + "requestContentType", + "requestBody", + "file1" + ], + "properties": { + "requestContentType": { + "type": "string", + "description": "This is required field. This field specify the content of requestBody field. This field accept fixed value as `application/json`.", + "enum": [ + "application/json" + ], + "example": "application/json" + }, + "requestBody": { + "type": "object", + "description": "This is required field. This field accept the details of lease, and ducuments being uploaded.", + "required": [ + "auth", + "method" + ], + "properties": { + "auth": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "method": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeaseDocuments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "files" + ], + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. This is the conditionally required, if applicationId and applicantId is not provided." + }, + "applicationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a optional field. This field accepts single value. This is the conditionally required, if leaseId and applicantId is not provided." + }, + "applicantId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a optional field. This field accepts single value. This is conditionally required, if leaseId and applicationId is not provided." + }, + "files": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "array", + "items": { + "type": "object", + "required": [ + "fileName" + ], + "properties": { + "fileName": { + "type": "string", + "description": "This is a required field. This will be the name of the file being uploaded.", + "example": "lease.pdf" + }, + "leaseFileType": { + "type": "string", + "description": "This is a optional field. This field accepts single value. This is conditionally required if fileTypeId is not provided. This will be the type of the file being uploaded.", + "example": "POI" + }, + "fileTypeId": { + "type": "integer", + "description": "This is a optional field. This field accepts single value. This is conditionally required if leaseFileType is not provided.", + "example": 12345 + }, + "isShowInResidentPortal": { + "type": "integer", + "description": "This is a optional field. This will specify the visibility of uploaded document in the resident portal.", + "example": 1, + "enum": [ + 0, + 1 + ] + }, + "customerIds": { + "type": "string", + "description": "This is a optional field. This will accepts comma separated multiple values. If provided this file will attach to the mentioned customers. if skipped, the file will be attached to all the customers of the lease.", + "example": "1234,5678" + } + } + } + } + } + } + } + } + } + } + } + }, + "file1": { + "type": "string", + "description": "This is required field. This will accept the file being uploaded to the lease. This should match and can repeate the field as per the files mentioned in the requestBody.", + "format": "binary" + } + } + }, + "sendLeases": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendLeases" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseStartDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. leaseStartDate (YYYY-MM-DD)" + }, + "leaseEndDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. leaseEndDate (YYYY-MM-DD)" + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a required field. This field accepts single value. moveInDate (YYYY-MM-DD)" + }, + "leaseTermId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseTermId" + }, + "floorplanId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. floorplanId" + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. unitSpaceId" + }, + "spaceConfigurationId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"spaceConfigurationId\" is required." + }, + "leaseStartWindowId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is an optional field. This field accepts single value. If the provided property is of type \"Student\", only then \"leaseStartWindowId\" is required." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. firstName" + }, + "middleName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. middleName" + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. lastName" + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. emailAddress" + }, + "birthDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. birthDate (YYYY-MM-DD)" + }, + "phoneNumberTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. phoneNumberTypeId" + }, + "phoneNumber": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. Primary phoneNumber" + }, + "addressTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. addressTypeId" + }, + "streetLine1": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Address streetLine1" + }, + "streetLine2": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. streetLine2" + }, + "city": { + "type": "string", + "format": "string", + "example": "city1", + "description": "This is a required field. This field accepts single value. city" + }, + "stateCode": { + "type": "string", + "format": "string", + "example": "AZ", + "description": "This is a required field. This field accepts single value. stateCode" + }, + "postalCode": { + "type": "integer", + "format": "integer", + "example": "05559", + "description": "This is a required field. This field accepts single value. postalCode" + } + }, + "required": [ + "propertyId", + "leaseStartDate", + "leaseEndDate", + "moveInDate", + "leaseTermId", + "floorplanId", + "unitSpaceId", + "firstName", + "lastName", + "customerRelationshipTypeId", + "phoneNumberTypeId", + "phoneNumber", + "addressTypeId", + "streetLine1", + "city", + "stateCode", + "postalCode" + ] + } + } + } + } + }, + "sendRentersInsurancePolicies_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Insurance policy id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. customerId" + }, + "provider": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. provider" + }, + "policyNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. policyNumber" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. endDate" + }, + "liability": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is a required field. This field accepts single value. liability" + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + } + } + } + }, + "sendRentersInsurancePolicies_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Insurance policy id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "customerIds": { + "type": "string", + "format": "string", + "example": "12345,6789", + "description": "This is a required field. This field accepts comma seperated multiple values. customerIds" + }, + "provider": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. provider" + }, + "policyNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. policyNumber" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. endDate" + }, + "liability": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is a required field. This field accepts single value. liability" + }, + "personalContents": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is an optional field. This field accepts single value. personalContents" + }, + "deductible": { + "type": "integer", + "format": "integer", + "example": 12350000, + "description": "This is an optional field. This field accepts single value. deductible" + }, + "isCancelled": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "leaseId", + "customerId", + "provider", + "policyNumber", + "startDate", + "endDate", + "liability" + ] + } + } + } + } + }, + "sendRoommateGroups_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "15" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRoommateGroups" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "required": [ + "roommateGroups" + ], + "properties": { + "roommateGroups": { + "type": "object", + "required": [ + "roommateGroup" + ], + "properties": { + "roommateGroup": { + "type": "array", + "items": { + "type": "object", + "properties": { + "invitorApplicationId": { + "type": "integer", + "description": "Required field unless inviteeApplicationId is provided. This field accepts single value.", + "example": 12345678 + }, + "inviteeApplicationId": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Required field. This field accepts multiple values.", + "example": [ + 12345678, + 55555555, + 88888888 + ] + }, + { + "type": "string", + "description": "Can be empty string", + "example": "" + } + ] + } + } + } + } + } + } + } + } + } + } + } + }, + "sendScheduledCharges": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendScheduledCharges" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "example": 307, + "description": "This is a required field. This field accepts single value. chargeTimingId" + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. chargeCodeTypeId" + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value. chargeCodeId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. startDate" + }, + "leaseIntervalId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. leaseIntervalId" + } + }, + "required": [ + "propertyId", + "leaseId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "startDate" + ] + } + } + } + } + }, + "updateLease": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateLease" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts the single property Id that is associated with a lease." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Accepts a single lease id for updating the lease details." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single" + }, + "moveInDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is a optional field. This field accepts single value. moveInDate (YYYY-MM-DD)" + }, + "occupants": { + "type": "object", + "description": "Optional object containing occupant details", + "properties": { + "occupant": { + "type": "array", + "description": "List of occupants", + "items": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. firstName" + }, + "lastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. lastName" + } + } + } + } + } + }, + "customerRelationshipTypeId": { + "type": "integer", + "format": "integer", + "example": 8, + "description": "This is a required field. This field accepts single value. customerRelationshipTypeId" + } + }, + "required": [ + "propertyId", + "leaseId", + "firstName", + "lastName", + "customerRelationshipTypeId" + ] + } + } + } + } + }, + "updateScheduledCharges_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. scheduledChargeid" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "isDeleted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1." + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + } + } + } + }, + "updateScheduledCharges_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. scheduledChargeid" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. leaseId" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 5000, + "description": "This is a required field. This field accepts single value. amount" + }, + "isDeleted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This field support value 0 and 1." + } + }, + "required": [ + "id", + "propertyId", + "leaseId" + ] + } + } + } + } + }, + "getCallLogs": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getCallLogs" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "123456,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. This node should accept property Id`s." + }, + "callSourceId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. Supported values (1, 2, 7)" + }, + "callTypeIds": { + "type": "integer", + "format": "integer", + "example": "3,8", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "callResultIds": { + "type": "integer", + "format": "integer", + "example": "8,1", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "answerStatus": { + "type": "integer", + "format": "integer", + "example": 1, + "description": " This is an optional field. This field accepts single value. Supports only 1 (ANSWERED) & 2 (UNANSWERED)" + }, + "voiceMailTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supported values are 1 (VOICE_MESSAGE) or 2 (UNPLAYED_VOICE_MESSAGE) o r 3 (NO_VOICE_MESSAGE)." + }, + "callAnalyzed": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Supports 1 (ANALYZED) or 0 (NON_ANALYZED)" + }, + "callState": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supports 1 (NON-ARCHIVED) or 2 (ARCHIVED)." + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getLeasingCenterPickLists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getLeasingCenterPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getInspections": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspections" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "statusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "inspectionFormId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value." + }, + "inspectionTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. Supported values are 1( ROUTINE ), 2(MOVE_IN), 3(MOVE_OUT)" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getInspectionTemplates": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getInspectionTemplates" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,678", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value." + }, + "showDisabled": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. The node accepts a boolean value and default value for this node is \"0\"." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getWorkOrderPickLists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrderPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "123456,678", + "description": "This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value." + } + } + } + } + } + } + }, + "getWorkOrders": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. propertyUnitId" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "leaseStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. leaseStatusTypeIds" + }, + "workOrderTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts single value. workOrderTypeIds" + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. buildingName" + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Unit number" + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. maintenancePriorityId" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. maintenanceCategoryId" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. maintenanceProblemId" + }, + "includeChildWorkOrders": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. includeChildWorkOrders" + }, + "includeDeletedWorkOrders": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not." + }, + "createdOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. createdOnFromDate" + }, + "createdOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. createdOnToDate" + }, + "lastUpdatedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter." + }, + "lastUpdatedOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter." + }, + "completedOnFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. completedOnFromDate" + }, + "completedOnToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. completedOnToDate" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendWorkOrders": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Customer Id" + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Lease ID" + }, + "unitNumber": { + "type": "string", + "format": "string", + "example": "5", + "description": "This is an optional field. This field accepts single value. Unit mumber" + }, + "customerFirstName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Customer First Name" + }, + "customerLastName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Customer Last Name" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value. Permission to enter" + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. Maintenance Priority" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description is required if the lease has pets or if permission t o enter is denied so that a reason why entry is not permitted can be e xplained or a pet warning given." + }, + "buildingName": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. buildingName" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "scheduledStartDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDateTime" + }, + "scheduledEndDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDateTime" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "isFloatingWorkOrder": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Negative numbers not allowed. This parameter is not applicable to mos t clients and should not be used without first checking with Entrata." + } + }, + "required": [ + "propertyId", + "mainPhoneNumber", + "permissionToEnter", + "maintenanceLocationId", + "maintenanceCategoryId", + "maintenanceProblemId", + "problemDescription" + ] + } + } + } + } + }, + "updateWorkOrders_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "maintenanceStatusTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 100, + "description": "This is an optional field. This field accepts single value." + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given." + }, + "completedDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value." + }, + "closingComments": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "scheduledStartDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDate" + }, + "scheduledEndDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDate" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "parentWorkOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. parentWorkOrderId" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "2017-04-02", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed." + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a optional field. This field accepts single value. Permission to enter" + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + } + } + } + }, + "updateWorkOrders_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateWorkOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "workOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value." + }, + "leaseId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "customerId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is an optional field. This field accepts single value." + }, + "maintenanceStatusTypeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value." + }, + "maintenancePriorityId": { + "type": "integer", + "format": "integer", + "example": 100, + "description": "This is an optional field. This field accepts single value." + }, + "maintenanceLocationId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance location" + }, + "maintenanceCategoryId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance Category Id" + }, + "maintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. Maintenance problem" + }, + "subMaintenanceProblemId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. SubMaintenance problem" + }, + "mainPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 123456789, + "description": "This is a required field. This field accepts single value. Main contact phone number" + }, + "altPhoneNumber": { + "type": "integer", + "format": "integer", + "example": 12121212, + "description": "This is an optional field. This field accepts single value. Alternate contact phone number" + }, + "emailAddress": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is an optional field. This field accepts single value. Email Address" + }, + "problemDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. Problem Description" + }, + "petsDescription": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given." + }, + "completedDateTime": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value." + }, + "closingComments": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "scheduledStartDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 13:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledStartDate" + }, + "scheduledEndDate": { + "type": "string", + "format": "date", + "example": "2017-06-24 11:00:00 PST", + "description": "This is an optional field. This field accepts single value. scheduledEndDate" + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. vendorId" + }, + "parentWorkOrderId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is an optional field. This field accepts single value. parentWorkOrderId" + }, + "assignedTo": { + "type": "integer", + "format": "integer", + "example": 4553, + "description": "This is an optional field. This field accepts single value. assignedTo" + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "06/15/2017 12:45:56", + "description": "This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting." + }, + "unitAvailableOnDate": { + "type": "string", + "format": "date", + "example": "2017-04-02", + "description": "This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate." + }, + "priorityOrderNum": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Negative numbers not allowed." + }, + "permissionToEnter": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a optional field. This field accepts single value. Permission to enter" + } + }, + "required": [ + "propertyId", + "workOrderId", + "maintenanceProblemId" + ] + } + } + } + } + }, + "getPricingPicklists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPricingPicklists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getPropertyFees": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyFees" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId" + ], + "properties": { + "propertyId": { + "type": "string", + "example": "12345", + "description": "This is a required field. This field accepts single value. propertyId" + } + } + } + } + } + } + }, + "insertPricing": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "format": "integer", + "example": 4, + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space." + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id." + }, + "chargeUsageId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance" + }, + "chargeUsageReferenceId": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0." + }, + "isRenewal": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent." + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "example": 307, + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed" + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit" + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use." + }, + "leaseTermMonths": { + "type": "integer", + "format": "integer", + "example": 12, + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms." + }, + "leaseStartRangeStart": { + "type": "integer", + "format": "integer", + "example": 0, + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit`s available on the date [if available on a date is in future]. If sending \"isRenewal\" as true this value should always be sent as 0" + }, + "leaseStartRangeEnd": { + "type": "integer", + "format": "integer", + "example": 10000, + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending \"isRenewal\" as true this value should always be sent as 0" + }, + "amount": { + "type": "integer", + "format": "float", + "example": 1840, + "description": "This is a required field. This field accepts single value. Rate Amount." + }, + "leaseTermName": { + "type": "string", + "format": "string", + "example": "chris@sam.com", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory." + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeUsageReferenceId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "amount", + "leaseTermName" + ] + } + } + } + } + }, + "insertPricing_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "insertPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "description": "This is a required field. This field accepts single value. propertyId", + "example": 1381146 + }, + "pricing": { + "type": "array", + "description": "Array of pricing objects", + "items": { + "type": "object", + "properties": { + "pricingLevelId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.", + "example": 3 + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId.", + "example": 639824 + }, + "chargeUsageId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance", + "example": 1 + }, + "isRenewal": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Just to specify if it is renewal rent.", + "example": 0 + }, + "chargeTimingId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing].", + "example": 303 + }, + "chargeCodeTypeId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit", + "example": 2 + }, + "chargeCodeId": { + "type": "integer", + "format": "integer", + "description": "This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.", + "example": 224711 + }, + "leaseTermMonths": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing for different terms.", + "example": 13 + }, + "leaseTermId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Lease term identifier.", + "example": 33549 + }, + "leaseStartWindowId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Lease start window identifier.", + "example": 240891 + }, + "spaceConfigurationId": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. Space configuration identifier.", + "example": 2 + }, + "leaseTermName": { + "type": "string", + "description": "This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is mandatory.", + "example": "Lease Term 2" + }, + "leaseStartRangeStart": { + "type": "integer", + "format": "integer", + "description": "This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRenewal' as true this value should always be sent as 0", + "example": 2 + }, + "leaseStartRangeEnd": { + "type": "integer", + "format": "integer", + "description": "This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0", + "example": 4 + }, + "amount": { + "type": "string", + "description": "This is a required field. This field accepts single value. Rate Amount.", + "example": "40.00" + }, + "isFullUpdate": { + "type": "string", + "description": "This is an optional field. This field accepts single value. Indicates if this is a full update operation.", + "example": "1" + } + }, + "required": [ + "pricingLevelId", + "pricingLevelReferenceId", + "chargeUsageId", + "chargeTimingId", + "chargeCodeTypeId", + "chargeCodeId", + "leaseTermName", + "amount" + ] + } + } + }, + "required": [ + "propertyId", + "pricing" + ] + } + } + } + } + }, + "sendBudgetedRent": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendBudgetedRent" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 4, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "pricingLevelId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": " This is a required field. This field accepts single value. Pricing level has two possible values, 3 for Unit type and 4 for Unit space." + }, + "pricingLevelReferenceId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 3 then pricingLevelReferenceId needs to be unit type id a nd if pricingLevelId = 4 then pricingLevelReferenceId needs to be unit space id." + }, + "amenityAmount": { + "type": "integer", + "format": "float", + "example": 20, + "description": "This is an optional field. This field accepts single value. Amenity rate amount." + }, + "amount": { + "type": "integer", + "format": "float", + "example": 20, + "description": "This is a required field. This field accepts single value. amount" + } + }, + "required": [ + "propertyId", + "pricingLevelId", + "pricingLevelReferenceId", + "amount" + ] + } + } + } + } + }, + "getAmenityReservations": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenityReservations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "amenityIds": { + "type": "integer", + "format": "integer", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "amenityReservationStatusTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getCalendarAvailability_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 7 da y range is allowed per request and that range includes the fromDate an d toDate in it." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 7 day range is allowed per request and that range includes the fromDate and toDate in it." + }, + "calendarEventCategoryIds": { + "type": "integer", + "format": "integer", + "example": "1,2", + "description": "This is an optional field. This field accepts comma seperated multiple values. Calendar Event type ids. Possible id: 1-General, 2-Resident, 3-Leasing , 4-Maintenance If no Id`s are passed only Resident and Leasing cat egories are considered by default." + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + } + } + } + }, + "getCalendarAvailability_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 123456, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 60 d ay range is allowed per request and that range includes the fromDate and toDate in it." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 60 day range is allowed per request and that range includes the fromDate and toDate in it." + }, + "tourType": { + "type": "string", + "format": "string", + "example": "SELF_GUIDED", + "description": "This is a required field. This field accepts single value. tour type: SELF_GUIDED, VIRTUAL_GUIDED,AGENT_GUIDED" + } + }, + "required": [ + "propertyId", + "fromDate", + "toDate" + ] + } + } + } + } + }, + "getFloorPlans": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getFloorPlans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "propertyFloorPlanIds": { + "type": "string", + "format": "string", + "example": "456789,123222", + "description": "This is an optional field. This field accepts comma seperated multiple values. propertyFloorPlanIds." + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Checks for the property settings manipulate floorplan data and honour those settings." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value is 1, then user should get disabled floorplans along with the enabled one." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getPetTypes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPetTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "456789,123222", + "description": "This is a required field. This field accepts comma seperated multiple values. List of comma seperated propertyIds" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getPhoneNumber": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPhoneNumber" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Array of property IDs", + "example": [ + 123456, + 789 + ] + }, + "switchCode": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "46545" + }, + "ref": { + "type": "string", + "description": "This is an optional field. This field accepts single value.", + "example": "http://google.com" + } + } + } + } + } + } + }, + "getProperties": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getProperties" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. PropertyIds" + }, + "propertyLookupCode": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is an optional field. This field accepts single value." + }, + "showAllStatus": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Show all properties with any status." + } + } + } + } + } + } + }, + "getPropertyAddOns": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAddOns" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getPropertyAnnouncements": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyAnnouncements" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getPropertyPickLists_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties" + } + } + } + } + } + } + }, + "getPropertyPickLists_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties" + } + } + } + } + } + } + }, + "getRentableItems": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getReservableAmenities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getReservableAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "amenityIds": { + "type": "integer", + "format": "integer", + "example": "12345,655", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getWebsites": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getWebsites" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. PropertyIds" + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "sendFloorplans": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendFloorplans" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This node accepts the property id on which the floorplan will get added." + }, + "name": { + "type": "string", + "format": "string", + "example": "ABC", + "description": "This is a required field. This field accepts single value. This node accepts the name of the floorplan." + }, + "description": { + "type": "string", + "format": "string", + "example": "description", + "description": "This is an optional field. This field accepts single value. This node accepts the description of the floorplan" + }, + "seoTitle": { + "type": "string", + "format": "string", + "example": "seo title", + "description": "This is an optional field. This field accepts single value. This node accepts the seoTitle of the floorplan" + }, + "seoDescription": { + "type": "string", + "format": "string", + "example": "seo description", + "description": "This is an optional field. This field accepts single value. This node accepts the seoDescription of the floorplan" + }, + "seoKeywords": { + "type": "string", + "format": "string", + "example": "seo keyword", + "description": "This is an optional field. This field accepts single value. This node accepts the seoKeywords of the floorplan" + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0, whether the floorplan needs to be published or not." + }, + "isDisabledVirtualMoveIn": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0." + }, + "minSquareFeet": { + "type": "integer", + "format": "float", + "example": 200, + "description": "This is an optional field. This field accepts single value. This node accepts the minimum square feet value of the floorplan." + }, + "maxSquareFeet": { + "type": "integer", + "format": "float", + "example": 1000, + "description": "This is an optional field. This field accepts single value. This node accepts the maximun square feet value of the floorplan." + }, + "numberOfBedRooms": { + "type": "integer", + "format": "float", + "example": 1, + "description": "This is a required field. This field accepts single value. This node accepts a total number of bedrooms." + }, + "numberOfBathRooms": { + "type": "integer", + "format": "float", + "example": 1, + "description": "This is a required field. This field accepts single value. This node accepts a total number of bathrooms." + }, + "isFeatured": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0." + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + } + } + } + }, + "sendRentableItems": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendRentableItems" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "categoryId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value." + }, + "showOnWebsite": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isMarketed": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "hasInventory": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "availabilityStatusId": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "description": { + "type": "string", + "format": "string", + "example": "FurnitureTesting", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId", + "name", + "numberOfBedRooms", + "numberOfBathRooms" + ] + } + } + } + } + }, + "getPropertyMedia": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "mediaTypeId", + "mediaSubTypeId" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "123456" + }, + "mediaTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "6" + }, + "mediaSubTypeId": { + "type": "string", + "description": "This is a required field. This field accepts single value.", + "example": "24" + }, + "referenceIds": { + "type": "string", + "description": "This is an optional field. This field accepts single value. reference id for mediaType", + "example": "987654" + } + } + } + } + } + } + }, + "sendPropertyMedia": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyMedia" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "media" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "123456" + }, + "media": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/mediaItem" + } + ] + } + } + } + } + } + } + } + }, + "updatePropertyMedia": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updatePropertyMedia" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "media" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. This field accepts single value. The unique identifier for the property.", + "example": "999999" + }, + "media": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/mediaItem" + } + ] + } + } + } + } + } + } + } + }, + "deletePropertyMedia": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response.", + "example": "1002" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "deletePropertyMedia" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "id" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. The unique identifier for the property.", + "example": "999999" + }, + "id": { + "type": "string", + "description": "Required. The unique identifier for the media.", + "example": "555555" + } + } + } + } + } + } + }, + "getPropertyMediaSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "code", + "result" + ], + "properties": { + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "propertyId", + "media" + ], + "properties": { + "propertyId": { + "type": "integer", + "description": "Property identifier", + "example": 123456 + }, + "media": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/mediaItem" + } + ] + } + } + } + } + } + } + } + }, + "mediaItem": { + "type": "object", + "required": [ + "id", + "mediaTypeId", + "mediaTypeName", + "mediaSubTypeId", + "mediaSubTypeName", + "referenceId", + "mediaProvider", + "mediaUrl" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the media", + "example": "100001" + }, + "mediaTypeId": { + "type": "string", + "description": "Type identifier for the media", + "example": "6" + }, + "mediaTypeName": { + "type": "string", + "description": "Name of the media type", + "example": "unit_floorplan_medias" + }, + "mediaSubTypeId": { + "type": "string", + "description": "Sub-type identifier for the media", + "example": "24" + }, + "mediaSubTypeName": { + "type": "string", + "description": "Name of the media sub-type", + "example": "ABC" + }, + "referenceId": { + "type": "string", + "description": "Reference identifier", + "example": "987654" + }, + "mediaProvider": { + "type": "string", + "description": "Provider of the media", + "example": "XYZ" + }, + "mediaUrl": { + "type": "string", + "description": "URL of the media", + "example": "https://www.example.com/demo1" + }, + "mediaAltText": { + "type": "string", + "description": "Alternative text for the media", + "example": "business_demo1" + }, + "name": { + "type": "string", + "description": "Name of the media", + "example": "demo_name1" + }, + "description": { + "type": "string", + "description": "Description of the media", + "example": "demo_description1" + }, + "caption": { + "type": "string", + "description": "Caption for the media", + "example": "demo_caption1" + }, + "height": { + "type": "string", + "description": "Height of the media", + "example": "800" + }, + "width": { + "type": "string", + "description": "Width of the media", + "example": "600" + }, + "mediaFormat": { + "type": "string", + "description": "Format of the media", + "example": "jpeg" + } + } + }, + "sendPropertyMediaSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "1001" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "media" + ], + "properties": { + "media": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "id", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Node number of the media in request", + "example": 1 + }, + "id": { + "type": "integer", + "description": "ID of the newly created media", + "example": 200001 + }, + "status": { + "type": "string", + "description": "Status of the media insertion", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Detailed message about the operation", + "example": "Media inserted successfully" + } + } + } + } + } + } + } + } + } + }, + "updatePropertyMediaSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "1001" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "media" + ], + "properties": { + "media": { + "type": "array", + "items": { + "type": "object", + "required": [ + "node", + "id", + "status", + "message" + ], + "properties": { + "node": { + "type": "integer", + "description": "Node number of the media in request", + "example": 1 + }, + "id": { + "type": "string", + "description": "ID of the updated media", + "example": "555555" + }, + "status": { + "type": "string", + "description": "Status of the media update", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Detailed message about the operation", + "example": "Media Updated Successfully" + } + } + } + } + } + } + } + } + } + }, + "deletePropertyMediaSuccessResponse": { + "type": "object", + "required": [ + "response" + ], + "properties": { + "response": { + "type": "object", + "required": [ + "requestId", + "code", + "result" + ], + "properties": { + "requestId": { + "type": "string", + "description": "The unique identifier for the request", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "required": [ + "status", + "message" + ], + "properties": { + "status": { + "type": "string", + "description": "Status of the delete operation", + "example": "Success" + }, + "message": { + "type": "string", + "description": "Detailed message about the operation", + "example": "Marketing Media Association deleted successfully." + } + } + } + } + } + } + }, + "getPhoneNumberSuccessResponse": { + "required": [ + "response" + ], + "type": "object", + "properties": { + "response": { + "required": [ + "requestId", + "code", + "result" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "an arbitary value sent with the request.", + "example": "15" + }, + "code": { + "type": "integer", + "description": "Response code indicating success", + "example": 200 + }, + "result": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Property ID mapped to phone number", + "example": "(315) 268-9410" + }, + "example": { + "123456": "(315) 268-9410" + } + } + } + } + } + }, + "getAmenities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + }, + "unitNumber": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Unit Number" + }, + "chargeCodeTypeIds": { + "type": "string", + "format": "string", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getMitsPropertyUnits": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getMitsPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values. PSI Property Identification number" + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for getting available units only" + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing preferences on result." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result." + }, + "showUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Unit Spaces on result." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getPropertyUnits": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,5678", + "description": "This is a required field. This field accepts comma seperated multiple values." + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "usePropertyPreferences": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If enabled then the Entrata setting \"Max Available Units per Floor P lan\" will be honored and the available units returned will be reduced. Also requires using the availableUnitsOnly parameter as true (1)." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyIds" + ] + } + } + } + } + }, + "getSpecials_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getSpecials_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getSpecials_r3": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r3" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property ID for getting Specials" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getUnitsAvailabilityAndPricing": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitsAvailabilityAndPricing" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Property Id" + }, + "floorplanId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is an optional field. This field accepts single value. Floorplan Id" + }, + "unitTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Unit Type Id" + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Property Unit Id" + }, + "availableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units" + }, + "unavailableUnitsOnly": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response." + }, + "skipPricing": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)" + }, + "showChildProperties": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result." + }, + "includeDisabledFloorplans": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result." + }, + "includeDisabledUnits": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result." + }, + "showUnitSpaces": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. showUnitSpaces" + }, + "useSpaceConfiguration": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration." + }, + "allowLeaseExpirationOverride": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If \"1\" is sent then we should override any lease expiration limits aff ecting available units returned/ If \"0\" or node is missing then do cur rent default functionality" + }, + "moveInStartDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing." + }, + "moveInEndDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "getUnitTypes": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getUnitTypes" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. propertyId" + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendAmenities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This field accepts a single integer value for Property ID" + }, + "name": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value. This accepts name of the amenity" + }, + "description": { + "type": "string", + "format": "string", + "example": "Furniture A", + "description": "This is an optional field. This field accepts single value. This accepts description of the amenity." + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This flag accepts 1 or 0 ,whether amenity needs to be published or not ." + }, + "unitSpaceId": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This accepts unit space id for the amenity." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendPropertyUnits": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPropertyUnits" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "unitNumber": { + "type": "string", + "format": "string", + "example": 20, + "description": "This is a required field. This field accepts single value. This node should accept the unitNumber." + }, + "unitPrefix": { + "type": "string", + "format": "string", + "example": "CC", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNunber prefix" + }, + "unitSuffix": { + "type": "string", + "format": "string", + "example": "BB", + "description": "This is an optional field. This field accepts single value. This node should accept the unitNumber suffix" + }, + "spaceNumber": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. This node should accept the spaceNumber on added unit." + }, + "maxOccupants": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value. This node should accepts the maxOccupants of the property units" + }, + "maxPets": { + "type": "integer", + "format": "integer", + "example": 11, + "description": "This is an optional field. This field accepts single value. This node should accepts the maxPets of the property units" + }, + "numberOfBedRooms": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This node should accepts the beds number of the property units" + }, + "numberOfBathRooms": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This node should accepts the bathRooms of the property units" + }, + "squareFeet": { + "type": "integer", + "format": "integer", + "example": 2000, + "description": "This is an optional field. This field accepts single value. This node should accept the squareFeet of the property units" + }, + "note": { + "type": "string", + "format": "string", + "example": "Testing property", + "description": "This is an optional field. This field accepts single value. This node should accept the note added for the property units" + }, + "unitGenderId": { + "type": "integer", + "format": "integer", + "example": "1", + "description": "This is an optional field. This field accepts single value. This node should accept the Id of the gender. The unitGenderId should be get from getPropertyPickLists." + } + }, + "required": [ + "unitNumber" + ] + } + } + } + } + }, + "updateAmenities": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateAmenities" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. This node should accept the amenity id which needs to be updated" + }, + "name": { + "type": "string", + "format": "string", + "example": "property amenity", + "description": "This is a required field. This field accepts single value. This node should accept the amenity name." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test amenity", + "description": "This is an optional field. This field accepts single value. This node should accept the amenity description." + }, + "isPublished": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "isFeatured": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "showOnQuote": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node indicates if the amenities are visible on quotes or not. Th is flag is supported only for property and unit space amenities." + }, + "hideDescription": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "videoUrl": { + "type": "string", + "format": "string", + "example": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4", + "description": "This is an optional field. This field accepts single value." + }, + "defaultAmenityId": { + "type": "integer", + "format": "integer", + "example": 3, + "description": "This is an optional field. This field accepts single value." + }, + "amenityId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "propertyId" + ] + } + } + } + } + }, + "sendSpecialGroup": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "specialGroup" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "This is a required field. Property ID for insert Specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "required": [ + "specialGroupName" + ], + "properties": { + "specialGroupName": { + "type": "string", + "description": "This is a required field. This accepts the Special Group name.", + "example": "Test Insert Special API" + }, + "internalDescription": { + "type": "string", + "description": "This is an optional field. Internal description not visible to residents.", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "This is an optional field. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "This is an optional field. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "This is an optional field. Determines if special is eligible to be used.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "This is an optional field. Determines if special will be shown in advertising.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised from.", + "example": "04/01/2025" + }, + "endDate": { + "type": "string", + "description": "This is an optional field. Date special will be advertised to.", + "example": "04/30/2025" + }, + "hideEndDate": { + "type": "string", + "description": "This is an optional field. Determines if special end date will be advertised.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "This is an optional field. Description shown to residents.", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "This is an optional field. Terms and conditions for specials.", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "This is an optional field. Determines if special is manual only.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "This is an optional field. Start of move-in date range.", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "This is an optional field. End of move-in date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "This is an optional field. Start of renewal date range.", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "This is an optional field. End of renewal date range.", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "This is an optional field. Allows setting limits on specials.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "This is an optional field. Limits number of specials given.", + "example": "10" + }, + "couponCode": { + "type": "string", + "description": "This is an optional field. Promotional code required during application.", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "This is an optional field. Source of promo code.", + "example": "56789" + }, + "incentiveLimit": { + "type": "string", + "description": "This is an optional field. Number of incentives resident receives.", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "This is an optional field. If specials incentive count matches limit.", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseStartWindowId" + ], + "properties": { + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "12345" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "456789" + } + } + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "This is an optional field. Comma separated recipient IDs.", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "This is an optional field. Special trigger type for prospects.", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "This is an optional field. Special trigger type for renewals.", + "example": "22" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "This is an optional field. Comma separated space configuration IDs.", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "required": [ + "specialTypeId", + "specialName" + ], + "properties": { + "specialTypeId": { + "type": "string", + "description": "This is a required field. Special type identifier.", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "This is a required field. Name of the special.", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "This is an optional field. Value of gift type special.", + "example": "0.00" + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "required": [ + "leaseTermId", + "leaseTermMonth", + "leaseStartWindowId", + "arFormulaId", + "rateAmount", + "showInEntrata", + "showOnWebsite" + ], + "properties": { + "arCodeId": { + "type": "string", + "description": "This is an optional field. AR code identifier.", + "example": "123456" + }, + "arTriggerId": { + "type": "string", + "description": "This is an optional field. AR trigger identifier.", + "example": "111" + }, + "arCodeTypeId": { + "type": "string", + "description": "This is an optional field. AR code type identifier.", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "This is an optional field. Customer relationship identifier.", + "example": "" + }, + "leaseTermId": { + "type": "string", + "description": "This is a required field. Lease term identifier.", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "This is a required field. Integer representation of lease term.", + "example": "1" + }, + "leaseStartWindowId": { + "type": "string", + "description": "This is a required field. Lease start window identifier.", + "example": "999999" + }, + "windowStartDate": { + "type": "string", + "description": "This is an optional field. Start date for lease window.", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "This is an optional field. End date for lease window.", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "This is a required field. AR formula identifier.", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "This is an optional field. Month when special starts.", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "This is a required field. Rate amount.", + "example": "100.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "This is an optional field. Increment for percent base formula.", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "This is an optional field. Additional formula information.", + "example": "0" + }, + "spaceConfigurationId": { + "type": "string", + "description": "This is an optional field. Space configuration identifier.", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "This is a required field. Display within Entrata.", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "This is a required field. Display on website.", + "enum": [ + "0", + "1" + ], + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "updateSpecialGroup": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateSpecialGroup" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId", + "specialGroup" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for updating specials", + "example": "123456" + }, + "specialGroup": { + "type": "object", + "required": [ + "specialGroupId", + "specialGroupName" + ], + "properties": { + "specialGroupId": { + "type": "string", + "description": "Required. The ID of the special group to update", + "example": "55555" + }, + "specialGroupName": { + "type": "string", + "description": "Required. Name of the special group", + "example": "Test Update Special API" + }, + "internalDescription": { + "type": "string", + "description": "Optional. Internal description not visible to residents", + "example": "Internal Desc" + }, + "floorPlanIds": { + "type": "string", + "description": "Optional. Comma separated floor plan IDs.", + "example": "1,2,3" + }, + "unitTypeIds": { + "type": "string", + "description": "Optional. Comma separated unit type IDs.", + "example": "1,2,3" + }, + "unitSpaceIds": { + "type": "string", + "description": "Optional. Comma separated unit space IDs.", + "example": "1,2,3" + }, + "isActive": { + "type": "string", + "description": "Optional. Determines if special is eligible to be used", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "isWebVisible": { + "type": "string", + "description": "Optional. Determines if special will be shown in advertising", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "startDate": { + "type": "string", + "description": "Optional. Date special will be advertised from", + "example": "MM/DD/YYYY" + }, + "endDate": { + "type": "string", + "description": "Optional. Date special will be advertised to", + "example": "MM/DD/YYYY" + }, + "hideEndDate": { + "type": "string", + "description": "Optional. Determines if special end date will be advertised", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "marketingDescription": { + "type": "string", + "description": "Optional. Description shown to residents", + "example": "Marketing Desc" + }, + "termsAndConditions": { + "type": "string", + "description": "Optional. Terms and conditions for the specials", + "example": "Terms & conditions" + }, + "isAdvertised": { + "type": "string", + "description": "Optional. Determines if special is manual only", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "moveInDateFrom": { + "type": "string", + "description": "Optional. Start of move-in date range", + "example": "MM/DD/YYYY" + }, + "moveInDateTo": { + "type": "string", + "description": "Optional. End of move-in date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateFrom": { + "type": "string", + "description": "Optional. Start of renewal date range", + "example": "MM/DD/YYYY" + }, + "renewalStartDateTo": { + "type": "string", + "description": "Optional. End of renewal date range", + "example": "MM/DD/YYYY" + }, + "limitQuantity": { + "type": "string", + "description": "Optional. Allows setting limits on specials", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "quantityBudgeted": { + "type": "string", + "description": "Optional. Number of specials to be given", + "example": "12" + }, + "couponCode": { + "type": "string", + "description": "Optional. Promotional code for special", + "example": "PROMO123" + }, + "leadSourceId": { + "type": "string", + "description": "Optional. Source ID for promo code", + "example": "123456" + }, + "incentiveLimit": { + "type": "string", + "description": "Optional. Number of incentives resident can receive", + "example": "1" + }, + "isSelectable": { + "type": "string", + "description": "Optional. If specials incentive count matches limit", + "enum": [ + "0", + "1" + ], + "example": "0" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special group. otherwise do not pass this field.", + "example": 1 + }, + "leaseTermDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "leaseTermId": { + "type": "string", + "example": "55555" + }, + "leaseStartWindowId": { + "type": "string", + "example": "456789" + } + } + } + }, + "specialRecipientDetails": { + "type": "object", + "properties": { + "specialRecipientIds": { + "type": "string", + "description": "Optional. Comma-separated recipient IDs", + "example": "2,3" + }, + "specialTriggerTypeIdProspect": { + "type": "string", + "description": "Optional. Prospect trigger type ID", + "example": "11" + }, + "specialTriggerTypeIdRenewal": { + "type": "string", + "description": "Optional. Renewal trigger type ID", + "example": "27" + } + } + }, + "specialGroupSpaceConfigurationIds": { + "type": "string", + "description": "Optional. Comma-separated space configuration IDs", + "example": "2,3" + }, + "specials": { + "type": "array", + "items": { + "type": "object", + "required": [ + "specialId", + "specialTypeId", + "specialName" + ], + "properties": { + "specialId": { + "type": "string", + "description": "Required. ID of the special", + "example": "1234567" + }, + "specialTypeId": { + "type": "string", + "description": "Required. Type ID of the special", + "example": "1" + }, + "specialName": { + "type": "string", + "description": "Required. Name of the special", + "example": "conccession1" + }, + "giftValue": { + "type": "string", + "description": "Optional. Value for gift type specials", + "example": "0.00" + }, + "isDelete": { + "type": "integer", + "description": "Optional. pass this field if only wants to delete the special. otherwise do not pass this field.", + "example": 1 + }, + "rates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "arCodeId": { + "type": "string", + "description": "Optional. AR code identifier", + "example": "444444" + }, + "arTriggerId": { + "type": "string", + "description": "Optional. AR trigger identifier", + "example": "201" + }, + "arCodeTypeId": { + "type": "string", + "description": "Optional. AR code type identifier", + "example": "2" + }, + "customerRelationshipId": { + "type": "string", + "description": "Optional. Customer relationship identifier", + "example": "0" + }, + "leaseTermId": { + "type": "string", + "description": "Optional. Lease term identifier", + "example": "55555" + }, + "leaseTermMonth": { + "type": "string", + "description": "Optional. Integer representation of lease term", + "example": "6" + }, + "leaseStartWindowId": { + "type": "string", + "description": "Optional. Lease start window identifier", + "example": "456789" + }, + "windowStartDate": { + "type": "string", + "description": "Optional. Start date for lease window", + "example": "MM/DD/YYYY" + }, + "windowEndDate": { + "type": "string", + "description": "Optional. End date for lease window", + "example": "MM/DD/YYYY" + }, + "effectiveDate": { + "type": "string", + "description": "Optional. Date rate becomes effective", + "example": "MM/DD/YYYY" + }, + "arFormulaId": { + "type": "string", + "description": "Optional. AR formula identifier", + "example": "1" + }, + "rateIntervalStart": { + "type": "string", + "description": "Optional. Month when special starts", + "example": "" + }, + "rateAmount": { + "type": "string", + "description": "Optional. Rate amount", + "example": "40.00" + }, + "rateIncreaseIncrement": { + "type": "string", + "description": "Optional. Increment for percent base formula", + "example": "" + }, + "arFormulaReferenceId": { + "type": "string", + "description": "Optional. Additional formula information", + "example": "" + }, + "spaceConfigurationId": { + "type": "string", + "description": "Optional. Space configuration identifier", + "example": "2" + }, + "showInEntrata": { + "type": "string", + "description": "Optional. Display within Entrata", + "enum": [ + "0", + "1" + ], + "example": "1" + }, + "showOnWebsite": { + "type": "string", + "description": "Optional. Display on website", + "enum": [ + "0", + "1" + ], + "example": "1" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "getSpecials_r4": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "basic" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "An arbitrary value to relate with response", + "example": "15" + }, + "method": { + "required": [ + "name", + "version", + "params" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getSpecials" + ] + }, + "version": { + "type": "string", + "enum": [ + "r4" + ] + }, + "params": { + "type": "object", + "required": [ + "propertyId" + ], + "properties": { + "propertyId": { + "type": "string", + "description": "Required. Property ID for getting Specials", + "example": "1234567" + } + } + } + } + } + } + }, + "getInvoices_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "format": "integer", + "example": "12345,4564", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "invoiceNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "paidInvoiceFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date." + }, + "paidInvoiceToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "includeVoidedPayments": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1" + }, + "includeExported": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "customerRefunds": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + } + } + } + } + } + } + }, + "getInvoices_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "ids": { + "type": "integer", + "format": "integer", + "example": "12345,4564", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "invoiceNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorIds": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "fromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice." + }, + "toDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. This is based on the Post Date of the invoice." + }, + "paidInvoiceFromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or after the given date." + }, + "paidInvoiceToDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "includeVoidedPayments": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Returns voided payment details if provided as 1" + }, + "voidedPaymentFromDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "voidedPaymentToDate": { + "type": "string", + "format": "date", + "example": "YYYY-MM-DD", + "description": "This is an optional field. This field accepts single value." + }, + "includeExported": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "customerRefunds": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value." + }, + "invoiceTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + "getPoReceivingRecords": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPoReceivingRecords" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. If \"vendorId\" is provided then \"vendorCode\" and \"purchaseOrderNumbers\" are not required." + }, + "vendorCode": { + "type": "string", + "format": "string", + "example": 12345, + "description": " This is an optional field. This field accepts single value. If \"vendorCode\" is provided then \"vendorId\" and \"purchaseOrderNumbers\" are not required." + }, + "purchaseOrderNumbers": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts comma seperated multiple values. If \"purchaseOrderNumbers\" is provided then \"vendorId\" and \"vendorCode\" are not required." + }, + "propertyIds": { + "type": "string", + "format": "string", + "example": "12345,4564", + "description": " This is an optional field. This field accepts comma seperated multiple values." + }, + "poFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year" + }, + "poToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year" + }, + "receivedFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year" + }, + "receivedToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year" + } + } + } + } + } + } + }, + "getPurchaseOrders": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,4567", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "vendorCode": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "poNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "poNumbers": { + "type": "integer", + "format": "integer", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "receivedFromDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "receivedToDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnFrom": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "createdOnTo": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "poStatusIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "poTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + }, + "purchaseOrderApprovalTypeIds": { + "type": "integer", + "format": "integer", + "example": "1,2,3", + "description": "This is an optional field. This field accepts comma seperated multiple values." + } + } + } + } + } + } + }, + "getTaxFormData": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getTaxFormData" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "startDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "generateForPropertyOwner": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then payer will render property info & If provided as \"1\" then Payer node will render the property owners info" + }, + "ownerIds": { + "type": "string", + "format": "string", + "example": 12345, + "description": "This is an optional field. This field accepts single value." + }, + "isForIndirectOwner": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided false, it will return data only for direct owners. If prov ided true, it will return data for both direct & indirect owners." + } + } + } + } + } + } + }, + "getVendorLocations": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorLocations" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "propertyIds": { + "type": "integer", + "format": "integer", + "example": "12345,56334", + "description": "This is an optional field. This field accepts comma seperated multiple values. List of comma separated propertyIds" + }, + "showAllStatus": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Boolean parameter to retrieve all vendors irrespective of status." + }, + "includeIntercompanyVendors": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. If provided as \"0\" then \"Standard\" types of Vendors will be rendered a nd if provided as \"1\" then \"Standard\" and \"Intercompany\" types of Vend ors will be returned." + }, + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorId" + }, + "vendorName": { + "type": "string", + "format": "string", + "example": "Vendor_Name", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorName" + }, + "vendorCode": { + "type": "string", + "format": "string", + "example": "123456", + "description": "This is an optional field. This field accepts single value. Provides details based on provided VendorCode" + }, + "lastModifiedOn": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": " This is an optional field. This field accepts single value. Returns results based on the LastModifiedOn date of the vendor or any of its locations, contacts, remittances or legal entities." + } + } + } + } + } + } + }, + "getVendorPickLists": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendorPickLists" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + } + } + } + } + }, + "getVendors": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "getVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorIds": { + "type": "integer", + "format": "integer", + "example": "12345,56334", + "description": "This is an optional field. This field accepts comma seperated multiple values. Once passing this parameter web service will return Vendor details for those Vendor Ids. Conditional mandatory, If vendorIds are provided t hen vendorsCodes is not required." + }, + "vendorCodes": { + "type": "string", + "format": "string", + "example": "1234,5678", + "description": "This is an optional field. This field accepts comma seperated multiple values. Conditional mandatory, If \"vendorsCodes\" are provided then \"vendorIds \" are not required." + } + } + } + } + } + } + }, + "markInvoicesExported": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "markInvoicesExported" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "lineItemId": { + "type": "integer", + "format": "integer", + "example": "17,18,19", + "description": "This is a required field. This field accepts comma seperated multiple values." + } + }, + "required": [ + "lineItemId" + ] + } + } + } + } + }, + "sendInvoices_r1": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "ApPayeeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Id of a vendor who generated the invoice." + }, + "ApPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Location Id of a vendor who generated the invoice." + }, + "InvoiceTotal": { + "type": "integer", + "format": "float", + "example": 2000, + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Total amount of invoice." + }, + "InvoiceNumber": { + "type": "string", + "format": "string", + "example": "TESTINVOICE123", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice Number." + }, + "InvoiceDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of ApHeader. Invoice date. Must be of format MM/DD/YYYY." + }, + "IsConsolidated": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApHeader." + }, + "IsOnHold": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApHeader." + }, + "PropertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "GlAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "Description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "Quantity": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "Rate": { + "type": "integer", + "format": "float", + "example": 400, + "description": "This is a required field. This field accepts single value. Child element of ApDetail." + }, + "IsWaive1099": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "FileData": { + "type": "string", + "format": "string", + "example": "FileData", + "description": "This is an optional field. This field accepts single value. Child element of File. Base64 encoded file data." + }, + "Note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is an optional field. This field accepts single value." + }, + "DueDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "endDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value." + }, + "IsPaused": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of ApBatch." + }, + "InvoiceImageUrl": { + "type": "string", + "format": "string", + "example": "https://InvoiceImageUrl", + "description": "This is an optional field. This field accepts single value. InvoiceImageUrl accepts valid URL only." + }, + "IsPosted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. IsPosted allows inserting posted invoices." + }, + "PropertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 17672, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + }, + "PropertyUnitId": { + "type": "integer", + "format": "integer", + "example": 3981490, + "description": "This is an optional field. This field accepts single value. Child element of ApDetail." + } + }, + "required": [ + "ApPayeeId", + "ApPayeeLocationId", + "InvoiceTotal", + "InvoiceDate", + "PropertyId", + "GlAccountId", + "Description", + "Rate" + ] + } + } + } + } + }, + "sendInvoices_r2": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string", + "enum": [ + "r2" + ] + }, + "params": { + "type": "object", + "properties": { + "invoiceTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Supports 1=\"Standard\", 8 = \"Catalog\" and 17 = \"Standard-Job/Contract\" types. By default type \"Standard\" is inserted." + }, + "apPayeeId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Id of a vendor who generated the invoice." + }, + "apPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor who generated the invoice." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader. This is conditionally required, depends upo n the \"Require Routing Tags on Invoices\" setting." + }, + "invoiceNumber": { + "type": "string", + "format": "string", + "example": "TESTINVOICE123", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice Number." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/YYYY format." + }, + "invoiceDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of apHeader. Invoice date. Must be of format MM/DD/YYYY." + }, + "dueDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Accepts date in MM/DD/YYYY format." + }, + "shipping": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount." + }, + "discount": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the discount amount." + }, + "salesTax": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice." + }, + "invoiceTotal": { + "type": "integer", + "format": "float", + "example": 2000, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Total amount of invoice." + }, + "note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": " This is an optional field. This field accepts single value. This field will be used to specify the additional details of the invoice." + }, + "invoiceImageUrl": { + "type": "string", + "format": "string", + "example": "Invoice Image URL", + "description": "This is an optional field. This field accepts single value. If this node is provided, it should be a valid URL." + }, + "isConsolidated": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only." + }, + "isOnHold": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apHeader. Accepts \"0\" or \"1\" Only." + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": " This is a required field. This field accepts single value. Child element of apDetail." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 17672, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 3981490, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "quantity": { + "type": "integer", + "format": "integer", + "example": 5, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "rate": { + "type": "integer", + "format": "float", + "example": 40, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "unitOfMeasureId": { + "type": "integer", + "format": "integer", + "example": 1234, + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Only valid for Catalog type invoices." + }, + "isWaive1099": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Accepts \"0\" or \"1\" Only." + }, + "poDetailId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. This node accepts \"Line Item Id\" of Purchase Order." + }, + "receivingRecordId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. Conditional Required(Node is mandatory only if the poDetailId value is provided in request). This node accepts \"Receiving Record Id\" of Purc hase Order Line Item for the \"Catalog\" type." + }, + "invoicePaymentId": { + "type": "string", + "format": "string", + "example": "1234", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 400, + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under apDetail." + }, + "fileData": { + "type": "string", + "format": "string", + "example": "FileData", + "description": "This is an optional field. This field accepts single value. Child element of file. Base64 encoded file data." + }, + "isPaused": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Child element of apBatch. Accepts \"0\" or \"1\" Only." + }, + "isPosted": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. This node specifies whether the invoice is posted or unposted. Accepts \"0\" or \"1\" Only." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "paymentNumber_001", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments." + }, + "paymentDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments. Must be of for mat MM/DD/YYYY." + }, + "paymentMemo": { + "type": "string", + "format": "string", + "example": "paymentMemo01", + "description": "This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments." + }, + "customTagId": { + "type": "integer", + "format": "integer", + "example": 180, + "description": "This is an optional field. This field accepts single value. This node accepts custom Tag Id of the invoice. If customTagId is not provided, then PO`s custom Tag Id would gets associates to invoice thr ough poDetailId node" + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType" + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 400, + "description": "This is a required field. This field accepts single value. The required node in case of jobCost invoiceType" + } + }, + "required": [ + "apPayeeId", + "apPayeeLocationId", + "invoiceNumber", + "invoiceDate", + "invoiceTotal", + "propertyId", + "glAccountId", + "description", + "rate", + "apCodeId", + "apContractId" + ] + } + } + } + } + }, + "sendPurchaseOrders": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendPurchaseOrders" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "poTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively)." + }, + "apPayeeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\"Standard\" and \"Standard-Job/ Contract\" respectively)." + }, + "apPayeeLocationId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor." + }, + "apPayeeAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader. If not passed in the request, the system d efault account will be used." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Accepts date in MM/YYYY format." + }, + "postDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Child element of apHeader." + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apHeader." + }, + "headerMemo": { + "type": "string", + "format": "string", + "example": "header memo", + "description": "This is an optional field. This field accepts single value. Child element of apHeader." + }, + "shipping": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the shipping amount." + }, + "discount": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the discount amount." + }, + "salesTax": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is an optional field. This field accepts single value. This will specify the sales tax of the invoice." + }, + "glAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail.This is required if po type is standard." + }, + "apCodeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing." + }, + "jobPhaseId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing." + }, + "apContractId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is child element of apDetails." + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "quantity": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "rate": { + "type": "integer", + "format": "float", + "example": 10, + "description": "This is a required field. This field accepts single value. Child element of apDetail." + }, + "glDimensionId": { + "type": "integer", + "format": "integer", + "example": 384, + "description": "This is an optional field. This field accepts single value. Child element of apDetail. Custom Tags." + }, + "companyDepartmentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyUnitId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "propertyBuildingId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Child element of apDetail." + }, + "isConfidential": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only." + }, + "isTaxable": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is an optional field. This field accepts single value. Accepts \"0\" or \"1\" Only." + }, + "description": { + "type": "string", + "format": "string", + "example": "Test Desc", + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "poTypeId", + "apPayeeId", + "apPayeeLocationId", + "postMonth", + "postDate", + "propertyId", + "quantity", + "rate" + ] + } + } + } + } + }, + "sendVendors": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "sendVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "businessName": { + "type": "string", + "format": "string", + "example": "Vendor name", + "description": "This is a required field. This field accepts single value." + }, + "nameOnTaxReturn": { + "type": "string", + "format": "string", + "example": "Legal entity name", + "description": "This is a required field. This field accepts single value." + }, + "remittanceName": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "apPaymentTypeId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "nameOnAccount": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)" + }, + "routingNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck). Must be numeric wi th 9 digits long." + }, + "accountNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)" + }, + "contact": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "firstName": { + "type": "string", + "format": "string", + "example": "First name", + "description": "This is a required field. This field accepts single value." + }, + "lastName": { + "type": "string", + "format": "string", + "example": "last name", + "description": "This is a required field. This field accepts single value." + }, + "name": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. Accepts the location name" + }, + "isPrimary": { + "type": "integer", + "format": "integer", + "enum": [ + 0, + 1 + ], + "description": "This is a required field. This field accepts single value." + }, + "utilityBillReceiptTypeId": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value" + }, + "externalId": { + "type": "string", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID", + "description": "This is a required field. This field accepts single value. externalId" + } + }, + "required": [ + "businessName", + "nameOnTaxReturn", + "remittanceName", + "apPaymentTypeId", + "nameOnAccount", + "routingNumber", + "accountNumber", + "contact", + "firstName", + "lastName", + "name", + "isPrimary", + "externalId" + ] + } + } + } + } + }, + "updateInvoices": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateInvoices" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. Accepts apHeader id,apDetail id" + }, + "invoicePaymentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 100, + "description": "This is a required field. This field accepts single value." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is a required field. This field accepts single value." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "65565", + "description": "This is a required field. This field accepts single value." + }, + "paymentDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value." + }, + "isOnHold": { + "type": "integer", + "format": "integer", + "example": 1, + "description": "This is an optional field. This field accepts single value. Update an invoice that is on hold, and take it off hold, and vice vers a, Allowed values ( 0, 1 )" + }, + "routingTagId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. Update the routing tag on an invoice, to another valid routing tag. Al low for not posted and off hold invoice." + } + }, + "required": [ + "id", + "invoicePaymentId", + "paymentAmount", + "paymentTypeId", + "paymentNumber", + "paymentDate", + "postMonth" + ] + } + } + } + } + }, + "updateVendors": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "updateVendors" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "vendorId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value." + }, + "nameOnTaxReturn": { + "type": "string", + "format": "string", + "example": "Legal entity name", + "description": "This is a required field. This field accepts single value" + }, + "name": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. Accepts locations name." + }, + "legalEntityName": { + "type": "string", + "format": "string", + "example": "name", + "description": "This is a required field. This field accepts single value. required if new location is inserted" + }, + "propertyId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. attribute compliance_status_id is required to make the property compli ant/non compliant, Accept integer value 2( for non-compliant) or 5 (fo r compliant) only." + }, + "remittanceName": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value." + }, + "nameOnAccount": { + "type": "string", + "format": "string", + "example": "header", + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "routingNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "accountNumber": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )" + }, + "externalId": { + "type": "string", + "format": "string", + "example": "API_VENDOR_EXTRNL_ID", + "description": "This is a required field. This field accepts single value. externalId" + }, + "defaultRoutingTagId": { + "type": "integer", + "format": "integer", + "example": 123, + "description": "This is an optional field. This field accepts single value." + } + }, + "required": [ + "vendorId", + "nameOnTaxReturn", + "name", + "legalEntityName", + "propertyId", + "remittanceName", + "nameOnAccount", + "routingNumber", + "accountNumber", + "externalId" + ] + } + } + } + } + }, + "voidApPayments": { + "required": [ + "auth", + "method" + ], + "type": "object", + "properties": { + "auth": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "apikey" + ] + } + } + }, + "requestId": { + "type": "string", + "description": "an arbitary value to relate with response." + }, + "method": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "voidApPayments" + ] + }, + "version": { + "type": "string", + "enum": [ + "r1" + ] + }, + "params": { + "type": "object", + "properties": { + "paymentId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentNumber, paymentBankAccountId, paymenttypeId, paymentAmount are not provided." + }, + "paymentNumber": { + "type": "string", + "format": "string", + "example": "123456", + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentId is no t provided then this node is required." + }, + "paymentBankAccountId": { + "type": "integer", + "format": "integer", + "example": 12345, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "paymentTypeId": { + "type": "integer", + "format": "integer", + "example": 2, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "paymentAmount": { + "type": "integer", + "format": "float", + "example": 100, + "description": "This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required." + }, + "voidDate": { + "type": "string", + "format": "date", + "example": "MM/DD/YYYY", + "description": "This is a required field. This field accepts single value. Supported date format: MM/DD/YYY, M/D/YYYY, YYYY-MM-DD." + }, + "postMonth": { + "type": "string", + "format": "date", + "example": "MM/YYYY", + "description": "This is a required field. This field accepts single value. Supported Format: MM/YYYY" + }, + "note": { + "type": "string", + "format": "string", + "example": "Test Note", + "description": "This is a required field. This field accepts single value. Memo for the payment" + } + }, + "required": [ + "voidDate", + "postMonth", + "note" + ] + } + } + } + } + } + }, + "examples": { + "getStatusSuccessExample": { + "summary": "getStatus", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "message": "Api is available and running." + } + } + } + }, + "getCompanyApplicationsSuccessExample": { + "summary": "getCompanyApplications", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "companyApplications": { + "companyApplication": [ + { + "companyApplicationId": "123", + "companyApplicationName": "Policy Documents", + "applicationQuestions": { + "applicationQuestion": [ + { + "id": 1, + "question": "Have you ever been sued for rent" + }, + { + "id": 2, + "question": "Have you ever been sued for damages" + }, + { + "id": 3, + "question": "Have you ever had any public record suits, liens, judgments or repossessions" + }, + { + "id": 4, + "question": "Do you have renters insurance" + }, + { + "id": 5, + "question": "Have you ever been evicted" + }, + { + "id": 6, + "question": "Have you ever defaulted on a lease" + }, + { + "id": 7, + "question": "Have you ever filed for bankruptcy protection" + }, + { + "id": 8, + "question": "Have you ever been convicted of a felony that involved an offense against property, persons, government officials, or that involved firearms, illegal drugs, or sex or sex crimes" + }, + { + "id": 9, + "question": "Do you smoke" + } + ] + } + }, + { + "companyApplicationId": "12626", + "companyApplicationName": "Ye Old Test", + "applicationQuestions": { + "applicationQuestion": [ + { + "id": 1, + "question": "Have you ever been sued for rent" + }, + { + "id": 2, + "question": "Have you ever been sued for damages" + }, + { + "id": 3, + "question": "Have you ever had any public record suits, liens, judgments or repossessions" + }, + { + "id": 4, + "question": "Do you have renters insurance" + }, + { + "id": 5, + "question": "Have you ever been evicted" + }, + { + "id": 6, + "question": "Have you ever defaulted on a lease" + }, + { + "id": 7, + "question": "Have you ever filed for bankruptcy protection" + }, + { + "id": 8, + "question": "Have you ever been convicted of a felony that involved an offense against property, persons, government officials, or that involved firearms, illegal drugs, or sex or sex crimes" + }, + { + "id": 9, + "question": "Do you smoke" + } + ] + } + } + ] + } + } + } + } + }, + "sendApplicantGeneralDetailsSuccessExample": { + "summary": "sendApplicantGeneralDetails", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": [ + { + "status": "Success", + "message": "General details updated successfully", + "applicantId": 20456006 + }, + { + "status": "Success", + "message": "General details updated successfully", + "applicantId": 20432743 + } + ] + } + } + }, + "sendApplicationSuccessExample": { + "summary": "sendApplication", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "application": { + "status": "Success", + "message": "Application inserted successfully.", + "applicationId": "17889726", + "applicantIds": "20238176, 20238177" + } + } + } + } + }, + "sendApplicationAddOnsSuccessExample": { + "summary": "sendApplicationAddOns", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "addOns": { + "addOn": [ + { + "status": "Success", + "message": "Addons saved Successfully.", + "id": 1304385, + "addOnId": "7162511", + "node": 1 + }, + { + "status": "Success", + "message": "Addons saved Successfully.", + "id": 1304386, + "addOnId": "7164475", + "node": 2 + }, + { + "status": "Success", + "message": "Addons saved Successfully.", + "id": 1304387, + "addOnId": "7164474", + "node": 3 + } + ] + } + } + } + } + }, + "sendApplicationEmployersSuccessExample": { + "summary": "sendApplicationEmployers", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "employers": { + "employers": [ + { + "status": "Success", + "message": "Customer employers saved Successfully.", + "id": 2042046, + "customerId": 6959803, + "incomeTypeId": 4, + "node": 1 + } + ] + } + } + } + } + }, + "sendApplicationPetsSuccessExample": { + "summary": "sendApplicationPets", + "value": { + "response": { + "requestId": "15", + "code": 300, + "result": { + "pets": { + "pet": [ + { + "status": "Success", + "message": "Customer pets saved successfully", + "id": 205354, + "customerId": 31674581, + "typeId": 15288, + "node": 1 + }, + { + "status": "Failed", + "message": "Missing value for parameter 'customerId'.", + "id": "", + "customerId": "", + "typeId": "27896", + "node": 2 + } + ] + } + } + } + } + }, + "sendApplicationVehiclesSuccessExample": { + "summary": "sendApplicationVehicles", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "vehicles": { + "vehicle": [ + { + "status": "Success", + "message": "Vehicle saved Successfully.", + "id": 56853778, + "customerId": 28138538, + "vehicleTypeId": 2, + "node": 1 + } + ] + } + } + } + } + }, + "updateApplicationSuccessExample": { + "summary": "updateApplication", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "application": { + "status": "Success", + "message": "Application updated successfully.", + "applicationId": 123456, + "applicantIds": "7893,7894" + } + } + } + } + }, + "getAccessibleClientsSuccessExample": { + "summary": "getAccessibleClients", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "orgs": [ + { + "subdomain": "am", + "id": 1668, + "name": "Account Managers" + }, + { + "subdomain": "demoold", + "id": 235, + "name": "Demo Account" + }, + { + "subdomain": "demoold-test-17898", + "id": 17898, + "name": "Demo Account Test 17898" + }, + { + "subdomain": "partnerintegrations", + "id": 100410, + "name": "Partner Integrations" + }, + { + "subdomain": "newthorneberry", + "id": 1995, + "name": "Yardi Voyager6 Demo" + } + ] + } + } + } + }, + "getAccessibleServicesSuccessExample": { + "summary": "getAccessibleServices", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "services": [ + { + "uri": "/ext/orgs/demoold/v1/status", + "service": "getStatus" + }, + { + "uri": "/ext/orgs/demoold/v1/oauth", + "service": "getAccessToken" + }, + { + "uri": "/ext/orgs/demoold/v1/oauth", + "service": "getJwtAccessToken" + }, + { + "uri": "/ext/orgs/demoold/v1/oauth", + "service": "getUserInfo" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getAmenityReservations" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getCalendarAvailability" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getFloorPlans" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getPetTypes" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getPhoneNumber" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getProperties" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getPropertyAddOns" + }, + { + "uri": "/ext/orgs/demoold/v1/properties", + "service": "getPropertyAnnouncements" + } + ] + } + } + } + }, + "getArCodesSuccessExample": { + "summary": "getArCodes", + "value": { + "response": { + "requestId": "15", + "result": { + "arcodes": { + "arcode": [ + { + "id": 152731, + "code": 3, + "name": "Amber test", + "codeType": "Other Income", + "chargeUsage": "Special", + "chargeTiming": "Month To Month Begin", + "associatedLedger": "Resident", + "debitGlAccountId": 87017, + "creditGlAccountId": 87035, + "displayAs": "test1", + "isDisabled": false, + "isEntrataDisabled": false, + "isTaxable": true + }, + { + "id": 152672, + "code": 3, + "name": "Application / Credit Check Fees", + "codeType": "Other Income", + "chargeUsage": "Base", + "chargeTiming": "Application Completed", + "associatedLedger": "Resident", + "debitGlAccountId": 87017, + "creditGlAccountId": 87030, + "displayAs": "Application / Credit Check Fees", + "isDisabled": false, + "isEntrataDisabled": false, + "isTaxable": false + }, + { + "id": 1858, + "code": 2, + "name": "AR's Rent", + "codeType": "Rent", + "chargeUsage": "Base", + "associatedLedger": "Resident", + "debitGlAccountId": 87017, + "creditGlAccountId": 87024, + "displayAs": "Monthly Rent", + "isDisabled": false, + "isEntrataDisabled": false, + "isTaxable": true + } + ] + } + } + } + } + }, + "getArPaymentsSuccessExample": { + "summary": "getArPayments", + "value": { + "requestId": "15", + "result": { + "ArPayments": { + "ArPayment": [ + { + "ArPaymentId": "22330996", + "PropertyName": "Park Avenue I", + "CustomerId": "12345", + "CustomerFirstName": "Dave", + "CustomerLastName": "Robinson", + "ExternalId": "EXT-12345", + "StreetLine1": "123 Main Street", + "StreetLine2": "Apt 4B", + "StreetLine3": "Building A", + "City": "New York", + "StateCode": "NY", + "PostalCode": "10001", + "PhoneNumber": "5551234567", + "EmailAddress": "dummy@example.com", + "UnitNumber": "111", + "PaymentAmount": "500", + "CurrencyCode": "USD", + "PaymentDate": "01/08/2013 00:00", + "PaymentType": "Cash", + "PaymentStatus": "Received", + "CapturedOn": "01/08/2013 09:30", + "DistributeOn": "01/09/2013 10:15", + "ReturnedOn": "01/10/2013 14:20", + "ArAllocations": { + "ArAllocation": [ + { + "ArTransactionId": "340302642", + "ChargeCodeId": "155594", + "ChargeCodeName": "11AR", + "AllocationDateTime": "08/11/2021", + "Amount": "50" + }, + { + "ArTransactionId": "285899560", + "ChargeCodeId": "120009", + "ChargeCodeName": "Admin Fee", + "AllocationDateTime": "08/11/2021", + "Amount": "39" + } + ] + } + }, + { + "ArPaymentId": "21833569", + "PropertyName": "Park Avenue II", + "CustomerId": "12345", + "CustomerFirstName": "Kurt", + "CustomerLastName": "Dunn", + "ExternalId": "EXT-67890", + "StreetLine1": "456 Oak Avenue", + "StreetLine2": "Suite 200", + "StreetLine3": "Floor 2", + "City": "Boston", + "StateCode": "MA", + "PostalCode": "02101", + "PhoneNumber": "5559876543", + "EmailAddress": "dummy1@example.com", + "UnitNumber": "111", + "PaymentAmount": "521.00", + "CurrencyCode": "USD", + "PaymentDate": "01/02/2013 00:00", + "PaymentType": "Cash", + "PaymentStatus": "Received", + "CapturedOn": "01/02/2013 11:45", + "DistributeOn": "01/03/2013 08:30", + "ReturnedOn": "01/04/2013 16:15", + "ArAllocations": { + "ArAllocation": [ + { + "ArTransactionId": "340302642", + "ChargeCodeId": "155594", + "ChargeCodeName": "11AR", + "AllocationDateTime": "08/11/2021", + "Amount": "50" + }, + { + "ArTransactionId": "285899560", + "ChargeCodeId": "120009", + "ChargeCodeName": "Admin Fee", + "AllocationDateTime": "08/11/2021", + "Amount": "39" + } + ] + } + } + ] + } + } + } + }, + "getArInvoicesSuccessExample": { + "summary": "getArInvoices", + "value": { + "requestId": "15", + "code": 200, + "result": { + "arInvoices": { + "arInvoice": [ + { + "id": "12345", + "propertyId": "12345", + "unitId": "12345", + "leaseId": "12345", + "invoiceNumber": "118", + "correctedArInvoiceId": 123, + "invoiceDate": "2020-02-16", + "invoiceDueDate": "2020-04-03", + "customerId": "29529791", + "customerName": "1400 Willow Council Of Co-Owners", + "streetLine1": "street 1", + "streetLine2": "street 2", + "streetLine3": "street 3", + "city": "FL", + "state": "Florida", + "postalCode": "45677", + "country": "US", + "note": "note", + "invoiceType": "Standard", + "invoiceSubTotal": "1099", + "totalTaxAmount": "44", + "arTransactions": { + "arTransaction": [ + { + "id": "12345", + "arCodeId": "215681", + "arCodeName": "00Rent0308", + "baseAmount": "95.00", + "taxRate": 10, + "taxAmount": 850, + "dueDate": "2020-02-11", + "fromDate": "2020-09-0", + "toDate": "2020-10-01", + "arPayments": { + "arPayment": [ + { + "arPaymentId": "12345", + "PaymentAmount": "120", + "PaymentDate": "2020-04-23", + "PaymentTypeId": "2", + "PaymentTypeName": "Check", + "PaymentStatusTypeId": "2", + "PaymentStatusTypeName": "Received" + }, + { + "arPaymentId": "69897", + "PaymentAmount": "95", + "PaymentDate": "2020-04-23", + "PaymentTypeId": "2", + "PaymentTypeName": "Check", + "PaymentStatusTypeId": "2", + "PaymentStatusTypeName": "Received" + } + ] + } + }, + { + "id": "78965", + "arCodeId": "205716", + "arCodeName": "00Monthly00", + "baseAmount": "120.00", + "taxRate": 10, + "taxAmount": 850, + "dueDate": "2020-02-16", + "fromDate": "2020-09-01", + "toDate": "2020-10-01", + "arPayments": { + "arPayment": [ + { + "arPaymentId": "785412", + "PaymentAmount": "120", + "PaymentDate": "2020-04-23", + "PaymentTypeId": "2", + "PaymentTypeName": "Check", + "PaymentStatusTypeId": "2", + "PaymentStatusTypeName": "Received" + }, + { + "arPaymentId": "325698", + "PaymentAmount": "95", + "PaymentDate": "2020-04-23", + "PaymentTypeId": "2", + "PaymentTypeName": "Check", + "PaymentStatusTypeId": "2", + "PaymentStatusTypeName": "Received" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "getLeaseArTransactionsSuccessExample": { + "summary": "getLeaseArTransactions", + "value": { + "requestId": "15", + "code": 200, + "result": { + "leases": { + "lease": { + "id": "14803775", + "propertyId": "172775", + "unitSpaceId": "5068340", + "customers": { + "customer": { + "id": "31094026", + "firstName": "Alfred", + "lastName": "Burge", + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/22/2025", + "bankruptcyNote": "XYZ" + } + }, + "ledgers": { + "ledger": { + "id": "11", + "name": "Resident", + "balance": "-924.88", + "pastDueBalance": "-924.88", + "writeOff": "0", + "transactions": { + "transaction": [ + { + "id": "261990729", + "transactionTypeId": "1", + "arCodeId": "1848", + "arCodeName": "Payment", + "leaseIntervalId": "22033341", + "description": {}, + "transactionDate": "08/28/2020", + "postDate": "08/28/2020", + "postMonth": "09/01/2020", + "isTemporary": "1", + "dueDate": "09/01/2020", + "arTriggerId": 902, + "balanceDue": "-12", + "amount": "-12", + "amountPaid": "0", + "scheduledChargeId": "4202932", + "creditArTransactionIds": "340292930,340302015", + "arPaymentId": 123456789 + }, + { + "id": "261506052", + "transactionTypeId": "3", + "arCodeId": "119945", + "arCodeName": "Beginning Deposit Adjustment", + "leaseIntervalId": "22033341", + "description": "Previous Deposit Held", + "transactionDate": "08/25/2020", + "postDate": "08/25/2020", + "isTemporary": "0", + "postMonth": "08/01/2020", + "dueDate": "09/01/2020", + "arTriggerId": 902, + "amount": "-456", + "amountPaid": "-456", + "creditArTransactionIds": "127705595", + "arPaymentId": 123456789 + }, + { + "id": "249405771", + "transactionTypeId": "1", + "arCodeId": "1848", + "arCodeName": "Payment", + "leaseIntervalId": "21730494", + "description": "Reversal of transaction ID:249405770 - 5", + "transactionDate": "03/04/2020", + "postDate": "03/04/2020", + "postMonth": "03/01/2020", + "isTemporary": "1", + "dueDate": "09/01/2020", + "arTriggerId": 902, + "amount": "12.88", + "amountPaid": "12.88", + "originalArTransactionId": "249405770", + "arPaymentId": 123456789 + }, + { + "id": "249405770", + "transactionTypeId": "1", + "arCodeId": "1848", + "arCodeName": "Payment", + "leaseIntervalId": "21730494", + "description": {}, + "transactionDate": "03/04/2020", + "postDate": "03/04/2020", + "postMonth": "03/01/2020", + "isTemporary": "0", + "dueDate": "09/01/2020", + "arTriggerId": 902, + "amount": "-12.88", + "amountPaid": "-12.88", + "reveseArTransactionId": "249405771", + "arPaymentId": 123456789 + }, + { + "id": "237802250", + "transactionTypeId": "9", + "arCodeId": "221075", + "arCodeName": "State Tax", + "leaseIntervalId": "21730494", + "description": "10 % tax on Broken Bones for transaction ID 237802248.", + "transactionDate": "09/18/2019", + "postDate": "09/18/2019", + "postMonth": "10/01/2019", + "isTemporary": "1", + "dueDate": "09/01/2020", + "arTriggerId": 902, + "amount": "1.29", + "amountPaid": "1.29", + "arPaymentId": 123456789 + } + ] + } + } + } + } + } + } + } + }, + "getMitsLeaseArTransactionsSuccessExample": { + "summary": "getMitsLeaseArTransactions", + "value": { + "response": { + "result": { + "ResidentTransactions": { + "Property": { + "PropertyID": { + "Identification": { + "@attributes": { + "IDType": "Property ID" + }, + "IDValue": 21618 + } + }, + "MarketingName": "Park Avenue" + }, + "RT_Customer": { + "Identification": { + "@attributes": { + "IDType": "Lease ID" + }, + "IDValue": 5309874 + }, + "Customers": { + "Customer": { + "Identification": { + "@attributes": { + "IDType": "Customer ID" + }, + "IDValue": 6377874 + }, + "Name": { + "FirstName": "Bryan", + "LastName": "Adams" + } + } + } + }, + "Unit": { + "Identification": { + "@attributes": { + "IDType": "Unit ID" + }, + "IDValue": 2188999 + }, + "MarketingName": "20-A" + }, + "RTServiceTransactions": { + "Transactions": [ + { + "Charge": { + "Detail": { + "Description": "Car Wash Income", + "TransactionDate": "2012-12-28", + "ServiceToDate": "2013-01-01", + "TransactionID": 25007747, + "ChargeCode": "CWI", + "SupplementalID": { + "Identification": { + "@attributes": { + "IDType": "Ar Code ID" + }, + "IDValue": 33279 + } + }, + "BalanceDue": "-30.00", + "Amount": "70.00", + "ReversalTranID": "1234567" + } + } + }, + { + "Charge": { + "Detail": { + "Description": "sadf - Reversal of transaction ID:258226930 - testLive", + "TransactionDate": "2012-12-28", + "ServiceToDate": "2013-01-01", + "TransactionID": 25007747, + "ChargeCode": "CWI", + "SupplementalID": { + "Identification": { + "@attributes": { + "IDType": "Ar Code ID" + }, + "IDValue": 33279 + } + }, + "BalanceDue": "-30.00", + "Amount": "70.00" + } + } + }, + { + "Payment": { + "@attributes": { + "PaymentType": "ACH" + }, + "Detail": { + "Description": "eCheck Payment ###### - Captured", + "TransactionID": 25007743, + "TransactionDate": "2012-12-28", + "AmountPaid": "-150.00", + "BalanceDue": "-100.00" + } + } + }, + { + "Charge": { + "Detail": { + "Description": "Form Fee", + "TransactionDate": "2012-12-28", + "ServiceToDate": "2013-01-01", + "TransactionID": 25007742, + "ChargeCode": "AF", + "SupplementalID": { + "Identification": { + "@attributes": { + "IDType": "Ar Code ID" + }, + "IDValue": 33280 + } + }, + "BalanceDue": "50.00", + "Amount": "100.00" + } + } + }, + { + "Charge": { + "Detail": { + "Description": "Garage Rent", + "TransactionDate": "2012-12-27", + "ServiceToDate": "2012-12-31", + "TransactionID": 25007608, + "ChargeCode": "GARRENT", + "SupplementalID": { + "Identification": { + "@attributes": { + "IDType": "Ar Code ID" + }, + "IDValue": 33281 + } + }, + "BalanceDue": "-50.00", + "Amount": "50.00" + } + } + }, + { + "Payment": { + "@attributes": { + "PaymentType": "ACH" + }, + "Detail": { + "Description": "eCheck Payment ###### - Captured", + "TransactionID": 25007749, + "TransactionDate": "2012-12-28", + "AmountPaid": "-100.00", + "BalanceDue": "-100.00" + } + } + } + ] + } + } + } + } + } + }, + "sendLeaseArTransactionReversalsSuccessExample": { + "summary": "sendLeaseArTransactionReversals", + "value": { + "response": { + "requestId": "15", + "result": { + "Transactions": { + "Transaction": [ + { + "@attributes": { + "reference_id": "12345", + "transaction_id": "34556", + "status": "success", + "message": "Transaction reversed successfully." + } + }, + { + "@attributes": { + "reference_id": "6789", + "transaction_id": "86543", + "status": "success", + "message": "Transaction reversed successfully." + } + } + ] + } + } + } + } + }, + "sendLeaseArTransactionsSuccessExample": { + "summary": "sendLeaseArTransactions", + "value": { + "response": { + "requestId": "15", + "result": { + "Transactions": { + "Transaction": [ + { + "@attributes": { + "reference_id": 79008, + "transaction_id": "100000", + "status": "Success", + "message": "Lease AR-Transaction inserted successfully." + } + }, + { + "@attributes": { + "reference_id": 79009, + "transaction_id": "100001", + "status": "Success", + "message": "Lease AR-Transaction inserted successfully." + } + }, + { + "@attributes": { + "reference_id": 79010, + "transaction_id": "100001", + "status": "Success", + "message": "Lease AR-Transaction inserted successfully." + } + } + ] + } + } + } + } + }, + "getMarketingPreferencePickListSuccessExample": { + "summary": "getMarketingPreferencePickList", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "preferences": [ + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Message Center Email", + "consentTypeId": 1 + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Lead Communication Email", + "consentTypeId": 7 + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Availability Alert Email", + "consentTypeId": 8 + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Contact Point Email", + "consentTypeId": 9 + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Property Marketing Email", + "consentTypeId": 5 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Message Center Email", + "consentTypeId": 1 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Resident Communication Email", + "consentTypeId": 4 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Rent Reminder Email", + "consentTypeId": 6 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Parcel Alert Email", + "consentTypeId": 2 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Contact Point Email", + "consentTypeId": 9 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Maintenance Update Email", + "consentTypeId": 3 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Property Marketing Email", + "consentTypeId": 5 + }, + { + "communicationChannel": "email", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Inspection Reminder Email", + "consentTypeId": 10 + }, + { + "communicationChannel": "sms", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Rent Reminder", + "consentTypeId": 2 + }, + { + "communicationChannel": "sms", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Property Notification", + "consentTypeId": 3 + }, + { + "communicationChannel": "sms", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Maintenance Notification", + "consentTypeId": 6 + }, + { + "communicationChannel": "sms", + "recipientType": "RESIDENT", + "recipientTypeId": 2, + "consentType": "Package Notification", + "consentTypeId": 27 + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Property Notification", + "consentTypeId": 3 + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Availability Alert", + "consentTypeId": 5 + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": 1, + "consentType": "Application Updates", + "consentTypeId": 29 + }, + { + "communicationChannel": "phone", + "recipientType": "LEAD", + "recipientTypeId": 1 + }, + { + "communicationChannel": "phone", + "recipientType": "RESIDENT", + "recipientTypeId": 2 + }, + { + "communicationChannel": "postal_mail", + "recipientType": "LEAD", + "recipientTypeId": 1 + }, + { + "communicationChannel": "postal_mail", + "recipientType": "RESIDENT", + "recipientTypeId": 2 + } + ], + "availabilityAlertFrequencies": [ + { + "frequencyId": 5, + "frequencyName": "Monthly" + }, + { + "frequencyId": 2, + "frequencyName": "Bi-Weekly" + }, + { + "frequencyId": 3, + "frequencyName": "Weekly" + }, + { + "frequencyId": 1, + "frequencyName": "Daily" + }, + { + "frequencyId": 4, + "frequencyName": "Bi-Monthly" + } + ] + } + } + } + }, + "getMarketingPreferencesSuccessExample": { + "summary": "getMarketingPreferences", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "customers": [ + { + "customerId": 29693427, + "preferences": [ + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Contact Point Email", + "consentTypeId": 9, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Property Marketing Email", + "consentTypeId": 5, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Lead Communication Email", + "consentTypeId": 7, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Message Center Email", + "consentTypeId": 1, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Availability Alert Email", + "consentTypeId": 8, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Application Updates", + "consentTypeId": 29, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Property Notification", + "consentTypeId": 3, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Contact Point", + "consentTypeId": 39, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Availability Alert", + "consentTypeId": 5, + "optIn": "0" + }, + { + "communicationChannel": "whatsapp", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + }, + { + "communicationChannel": "phone", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + }, + { + "communicationChannel": "postal_mail", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + } + ] + }, + { + "customerId": 28219403, + "preferences": [ + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Contact Point Email", + "consentTypeId": 9, + "optIn": "0" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Property Marketing Email", + "consentTypeId": 5, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Lead Communication Email", + "consentTypeId": 7, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Message Center Email", + "consentTypeId": 1, + "optIn": "1" + }, + { + "communicationChannel": "email", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Availability Alert Email", + "consentTypeId": 8, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Application Updates", + "consentTypeId": 29, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Property Notification", + "consentTypeId": 3, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Contact Point", + "consentTypeId": 39, + "optIn": "0" + }, + { + "communicationChannel": "sms", + "recipientType": "LEAD", + "recipientTypeId": "1", + "consentType": "Availability Alert", + "consentTypeId": 5, + "optIn": "0" + }, + { + "communicationChannel": "whatsapp", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + }, + { + "communicationChannel": "phone", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + }, + { + "communicationChannel": "postal_mail", + "recipientType": "LEAD", + "recipientTypeId": "1", + "optIn": "0" + } + ] + } + ] + } + } + } + }, + "getCustomersSuccessExample": { + "summary": "getCustomers", + "value": { + "requestId": "15", + "code": 200, + "result": { + "Customers": { + "Customer": [ + { + "LeaseId": [ + { + "Identification": [ + { + "IDValue": "5424549", + "@attributes": { + "IDType": "Lease Id", + "IDRank": "primary", + "IDScopeType": "sender", + "Status": "Current" + } + } + ] + } + ], + "CustomerType": "Primary", + "FirstName": "Amit", + "LastName": "Aryan", + "UnitNumber": "71", + "BuildingName": "ZOM 3", + "Address": "500 S 100 W", + "City": "Provo", + "State": "UT", + "PostalCode": "84601", + "Email": "amit@aryan.lcl", + "PhoneNumber": "1234567890", + "TermsApprovedDate": "06/26/2012", + "CustomerAddresses": { + "CustomerAddress": [ + { + "Address": "vcb", + "City": "vcb", + "State": "AK", + "PostalCode": "43534", + "Country": "US", + "@attributes": { + "AddressType": "Forwarding" + } + } + ] + }, + "pointsEarned": "11486", + "Vehicles": { + "Vehicle": [ + { + "Model": "aakash", + "Color": "aakash", + "Make": "aakash", + "LicensePlateNumber": "aakash", + "StateCode": "NB", + "Year": "1990" + } + ] + }, + "CustomerIdentificationValues": { + "CustomerIdentificationValue": [ + { + "Id": 6789, + "Value": "test123", + "CompanyIdentificationTypeId": 12345 + } + ] + }, + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/22/2025", + "bankruptcyNote": "XYZ", + "@attributes": { + "Id": "6526235" + } + }, + { + "LeaseId": { + "Identification": [ + { + "IDValue": "5329539", + "@attributes": { + "IDType": "Lease Id", + "IDRank": "primary", + "IDScopeType": "sender", + "Status": "Current" + } + } + ] + }, + "CustomerType": "Guarantor", + "FirstName": "Harshada", + "LastName": "Gandhi", + "UnitNumber": "15", + "BuildingName": "ZOM 3", + "Address": "500 S 100 W", + "City": "Provo", + "State": "UT", + "PostalCode": "84601", + "Email": "g@test.lcl", + "PhoneNumber": "1234567822", + "TermsApprovedDate": "01/01/2014", + "pointsEarned": "599", + "Vehicles": { + "Vehicle": [ + { + "Year": "2011" + }, + { + "Model": "21321", + "Color": "red", + "Make": "sads", + "LicensePlateNumber": "dsadas", + "Year": "2010" + } + ] + }, + "@attributes": { + "Id": "6432851", + "ExternalId": "asdasdas" + } + } + ] + } + } + } + }, + "getCustomerTestimonialsSuccessExample": { + "summary": "getCustomerTestimonials", + "value": { + "response": null, + "requestId": 15, + "result": { + "Testimonials": { + "Testimonial": [ + { + "Id": "11111", + "Name": "Testing Test ", + "Title": "well it is an awesome place to live in.", + "Testimonial": "I will recommend him to do not waste your opportunity and be here soon possible.", + "PropertyId": "11111", + "PropertyName": "test company", + "EmailAddress": "04testing15_test.lcl@r3.com", + "TestimonialDatetime": "06/03/2013 05:45:01.404402 MDT", + "TestimonialType": "APARTMENTRATINGS", + "IsRecommended": "1", + "ShowOnCorporateSites": "0", + "VacancyPublished": "0", + "ProspectPortalPublished": "1", + "FirstName": "Testing", + "LastName": "Test", + "TestimonialRatings": { + "TestimonialRating": [ + { + "Type": "Overall", + "Rating": "5" + }, + { + "Type": "Staff", + "Rating": "5" + }, + { + "Type": "Maintenance", + "Rating": "5" + }, + { + "Type": "Construction", + "Rating": "5" + }, + { + "Type": "Grounds", + "Rating": "5" + }, + { + "Type": "Noise", + "Rating": "5" + }, + { + "Type": "Parking", + "Rating": "5" + } + ] + } + } + ] + } + } + } + }, + "getTestimonialPickListsSuccessExample": { + "summary": "getTestimonialPickLists", + "value": { + "requestId": "15", + "code": 200, + "result": { + "TestimonialTypes": { + "TestimonialType": [ + { + "@attributes": { + "Id": "5", + "Name": "ApartmentRatings" + } + }, + { + "@attributes": { + "Id": "4", + "Name": "Vacancy" + } + }, + { + "@attributes": { + "Id": "13", + "Name": "GOOGLE" + } + }, + { + "@attributes": { + "Id": "10", + "Name": "YELP" + } + } + ] + }, + "TestimonialRatingTypes": { + "TestimonialRatingType": [ + { + "@attributes": { + "Id": "1", + "Name": "Parking" + } + }, + { + "@attributes": { + "Id": "2", + "Name": "Noise" + } + }, + { + "@attributes": { + "Id": "3", + "Name": "Grounds" + } + }, + { + "@attributes": { + "Id": "5", + "Name": "Construction" + } + }, + { + "@attributes": { + "Id": "6", + "Name": "Maintenance" + } + }, + { + "@attributes": { + "Id": "7", + "Name": "Staff" + } + }, + { + "@attributes": { + "Id": "8", + "Name": "Overall" + } + } + ] + } + } + } + }, + "searchCustomersSuccessExample": { + "summary": "searchCustomers", + "value": { + "response": null, + "requestId": "15", + "result": { + "customers": { + "customer": [ + { + "id": "1234", + "namePrefix": "Mr.", + "firstName": "Dave", + "middleName": "Elisabeth", + "lastName": "Robinson", + "email": "dummy@example.com", + "unitNumber": "111", + "buildingName": "Thornberry", + "address": "201 Se Scenic View Dr Df Df", + "city": "Chandler", + "state": "OR", + "postalCode": "1333", + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/22/2025", + "bankruptcyNote": "XYZ" + }, + { + "id": "4567", + "namePrefix": "Mr.", + "firstName": "Kurt", + "middleName": "Swan", + "lastName": "Dunn", + "email": "dummy1@example.com", + "unitNumber": "112", + "buildingName": "Thornberry", + "address": "4300 Pennsylvania Ave Street Road", + "city": "Abc", + "state": "TX", + "postalCode": "98456", + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/21/2025", + "bankruptcyNote": "XYZ" + } + ] + } + } + } + }, + "sendCustomerTestimonialsSuccessExample": { + "summary": "sendCustomerTestimonials", + "value": { + "response": { + "requestId": "15", + "result": { + "Testimonials": { + "Testimonial": [ + { + "@attributes": { + "node": 1, + "reference_id": 8530, + "status": "Success", + "message": "Testimonial inserted successfully." + } + } + ] + } + } + } + } + }, + "updateCustomersSuccessExample": { + "summary": "updateCustomers", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "customers": { + "customer": [ + { + "node": "1", + "referenceId": "31025784", + "status": "Success", + "message": "Customer updated successfully." + }, + { + "node": "2", + "referenceId": "29629916", + "status": "Success", + "message": "Customer updated successfully." + } + ] + } + } + } + } + }, + "updateCustomerTestimonialsSuccessExample": { + "summary": "updateCustomerTestimonials", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "Testimonials": { + "Testimonial": { + "@attributes": { + "status": "Success", + "message": "Succesfully Activated/deactivated Transmission Vendor." + } + } + } + } + } + } + }, + "updatePropertyResponseSuccessExample": { + "summary": "updatePropertyResponse", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "testimonials": { + "testimonial": { + "testimonialId": "12345", + "status": "Success", + "message": "Testimonial response updated successfully." + } + } + } + } + } + }, + "getApCodesSuccessExample": { + "summary": "getApCodes", + "value": { + "requestId": "15", + "code": 200, + "result": { + "apCodeCategories": { + "apCodeCategory": [ + { + "id": "1234", + "name": "ap category 1", + "apCodes": { + "apCode": [ + { + "id": "6789", + "name": "ap code 1", + "glAccountId": "1234", + "apCodeTypeId": "3", + "apCodeType": "Job Cost" + } + ] + } + }, + { + "id": "3456", + "name": "ap category 2", + "apCodes": { + "apCode": [ + { + "id": "6543", + "name": "ap code 2", + "glAccountId": "5678", + "apCodeTypeId": "3", + "apCodeType": "Job Cost" + }, + { + "id": "65432", + "name": "ap code 3", + "glAccountId": "5678", + "apCodeTypeId": "3", + "apCodeType": "Job Cost" + } + ] + } + } + ] + } + } + } + }, + "getBankAccountsSuccessExample": { + "summary": "getBankAccounts", + "value": { + "response": { + "requestId": "15", + "result": { + "BankAccounts": { + "BankAccount": [ + { + "Id": "11111", + "AccountName": "Park Avenue I", + "BankAccountTypeId": "8", + "PropertyBankAccounts": { + "PropertyBankAccount": [ + { + "Id": "123", + "PropertyId": "11111", + "GlAccountId": "12345", + "IsDueToFrom": "0" + }, + { + "Id": "234", + "PropertyId": "99999", + "GlAccountId": "67891", + "IsDueToFrom": "1" + }, + { + "Id": "456", + "PropertyId": "22965", + "GlAccountId": "52525", + "IsDueToFrom": "0" + } + ] + }, + "AccountType": "Account Type I", + "CheckBankName": "Park Avenue I", + "NextCheckNumber": "7" + }, + { + "Id": "22222", + "AccountName": "Park Avenue II", + "BankAccountTypeId": "8", + "PropertyBankAccounts": { + "PropertyBankAccount": [ + { + "Id": "555", + "PropertyId": "121212", + "GlAccountId": "111111", + "IsDueToFrom": "1" + }, + { + "Id": "666", + "PropertyId": "414141", + "GlAccountId": "222222", + "IsDueToFrom": "0" + }, + { + "Id": "777", + "PropertyId": "555555", + "GlAccountId": "333333", + "IsDueToFrom": "1" + } + ] + }, + "AccountType": "Account Type II", + "CheckBankName": "Park Avenue II", + "NextCheckNumber": "5" + } + ] + } + } + } + } + }, + "getBudgetActualsSuccessExample": { + "summary": "getBudgetActuals", + "value": { + "requestId": "15", + "code": 200, + "result": { + "budgetVsActuals": { + "budgetVsActual": [ + { + "accountName": "Testgldetails", + "accountId": "171693", + "mtdActualIncome": "150.00", + "mtdBudgetIncome": "10000.00", + "mtdVariance": "-9850.00", + "mtdPercentageVariance": "-98.5", + "ytdActualIncome": "0.00", + "ytdBudgetIncome": "0.00", + "ytdVariance": "0.00", + "ytdPercentageVariance": "0.00", + "annualBudgetIncome": "10000.00" + }, + { + "accountName": "Child Test", + "accountId": "171694", + "mtdActualIncome": "-500.00", + "mtdBudgetIncome": "0.00", + "mtdVariance": "-500.00", + "mtdPercentageVariance": "-100", + "ytdActualIncome": "0.00", + "ytdBudgetIncome": "0.00", + "ytdVariance": "0.00", + "ytdPercentageVariance": "0.00", + "annualBudgetIncome": "0.00" + }, + { + "accountName": "BJ Accnt", + "accountId": "171695", + "mtdActualIncome": "-14919.92", + "mtdBudgetIncome": "0.00", + "mtdVariance": "-14919.92", + "mtdPercentageVariance": "-100", + "ytdActualIncome": "-272.00", + "ytdBudgetIncome": "0.00", + "ytdVariance": "-272.00", + "ytdPercentageVariance": "-100", + "annualBudgetIncome": "0.00" + }, + { + "accountName": "testing acc", + "accountId": "171696", + "mtdActualIncome": "-100.00", + "mtdBudgetIncome": "0.00", + "mtdVariance": "-100.00", + "mtdPercentageVariance": "-100", + "ytdActualIncome": "0.00", + "ytdBudgetIncome": "0.00", + "ytdVariance": "0.00", + "ytdPercentageVariance": "0.00", + "annualBudgetIncome": "0.00" + } + ] + } + } + } + }, + "getBudgetsSuccessExample": { + "summary": "getBudgets", + "value": { + "requestId": "15", + "code": 200, + "result": { + "properties": { + "property": [ + { + "propertyId": "123", + "propertyName": "Property Name", + "budgets": { + "budget": [ + { + "id": "1234", + "budgetName": "budgetName", + "budgetStatusTypeId": "1", + "isDefault": "1", + "fiscalStartDate": "01/01/2017", + "fiscalEndDate": "04/30/2017", + "fiscalYear": "2017", + "budgetTotal": "123.123", + "glAccounts": { + "glAccount": { + "id": "154463", + "accountName": "Accelerated Rent", + "accountNumber": "4010", + "glTotals": { + "glTotal": { + "amount": "360", + "glDimensionId": "463" + } + }, + "budgetMonths": { + "budgetMonth": [ + { + "month": "01/01/2019", + "amount": "100", + "glDimensionId": "463" + }, + { + "month": "02/01/2019", + "amount": "50", + "glDimensionId": "463" + }, + { + "month": "03/01/2019", + "amount": "60", + "glDimensionId": "463" + }, + { + "month": "04/01/2019", + "amount": "70", + "glDimensionId": "463" + }, + { + "month": "05/01/2019", + "amount": "80", + "glDimensionId": "463" + } + ] + } + } + } + }, + { + "id": "1234", + "budgetName": "budgetName", + "budgetStatusTypeId": "1", + "isDefault": "0", + "fiscalStartDate": "01/01/2018", + "fiscalEndDate": "04/30/2018", + "fiscalYear": "2018", + "budgetTotal": "1234.12", + "glAccounts": { + "glAccount": { + "id": "87016", + "accountName": "Cash in Bank - Operating", + "accountNumber": "10001002", + "glTotals": { + "glTotal": { + "amount": "61.49" + } + }, + "budgetMonths": { + "budgetMonth": [ + { + "month": "01/01/2019", + "amount": "10.00" + }, + { + "month": "02/01/2019", + "amount": "20.50" + }, + { + "month": "03/01/2019", + "amount": "30.99" + } + ] + } + } + } + } + ] + } + }, + { + "propertyId": "123", + "propertyName": "Property Name", + "budgets": { + "budget": [ + { + "id": "1234", + "budgetName": "budgetName", + "budgetStatusTypeId": "1", + "isDefault": "1", + "fiscalStartDate": "01/01/2017", + "fiscalEndDate": "04/30/2017", + "fiscalYear": "2017", + "budgetTotal": "123.123", + "glAccounts": { + "glAccount": { + "id": "165422", + "accountName": "Mak- New test account", + "accountNumber": "0212313312", + "glTotals": { + "glTotal": { + "amount": "300" + } + }, + "budgetMonths": { + "budgetMonth": [ + { + "month": "01/01/2019", + "amount": "40" + }, + { + "month": "02/01/2019", + "amount": "50" + }, + { + "month": "03/01/2019", + "amount": "60" + }, + { + "month": "04/01/2019", + "amount": "70" + }, + { + "month": "05/01/2019", + "amount": "80" + } + ] + } + } + } + }, + { + "id": "xxxx", + "budgetName": "GL Dimension Test 1", + "budgetStatusTypeId": "2", + "isDefault": "0", + "fiscalStartDate": "01/01/2019", + "fiscalEndDate": "03/31/2019", + "fiscalYear": "2019", + "budgetTotal": "0.00", + "glAccounts": { + "glAccount": { + "id": {}, + "accountName": {}, + "accountNumber": {}, + "glTotals": { + "glTotal": { + "amount": "0" + } + }, + "budgetMonths": { + "budgetMonth": { + "month": {}, + "amount": "0.00" + } + } + } + } + } + ] + } + } + ] + } + } + } + }, + "getFinancialPickList_r1_SuccessExample": { + "summary": "getFinancialPickList(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "GlGroupTypes": { + "GlGroupType": [ + { + "@attributes": { + "Id": 1, + "Name": "Assets" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Liabilities" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Equity" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "Income" + } + }, + { + "@attributes": { + "Id": 5, + "Name": "Expenses" + } + } + ] + }, + "GlTreeTypes": { + "GlTreeType": [ + { + "@attributes": { + "Id": 1, + "Name": "Standard" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Affordable" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Custom Report" + } + } + ] + }, + "GlAccountTypes": { + "GlAccountType": [ + { + "@attributes": { + "Id": 201, + "Name": "Accounts Payable" + } + }, + { + "@attributes": { + "Id": 501, + "Name": "Reconciliation Adjustments" + } + }, + { + "@attributes": { + "Id": 206, + "Name": "Refunds In Transit" + } + }, + { + "@attributes": { + "Id": 401, + "Name": "Rent" + } + }, + { + "@attributes": { + "Id": 301, + "Name": "Retained Earnings" + } + }, + { + "@attributes": { + "Id": 211, + "Name": "Retention Payable" + } + } + ] + }, + "GlBooks": { + "GlBook": [ + { + "@attributes": { + "Id": 616, + "Name": "Standard" + } + }, + { + "@attributes": { + "Id": 180, + "Name": "Tax" + } + } + ] + }, + "GlBranchTypes": { + "GlBranchType": [ + { + "@attributes": { + "Id": 1, + "Name": "Standard Group" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Total Group" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Net Cash Flow Group" + } + } + ] + }, + "GlExportBatchTypes": { + "GlExportBatchType": [ + { + "@attributes": { + "Id": 88, + "Name": "AMSI" + } + }, + { + "@attributes": { + "Id": 92, + "Name": "Great Plains" + } + }, + { + "@attributes": { + "Id": 156, + "Name": "International Yardi ETL GS" + } + }, + { + "@attributes": { + "Id": 90, + "Name": "JD Edwards" + } + }, + { + "@attributes": { + "Id": 85, + "Name": "Jenark" + } + } + ] + }, + "GlHeaderStatusTypes": { + "GlHeaderStatusType": [ + { + "@attributes": { + "Id": 1, + "Name": "Posted" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Temporary" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Reversed" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "Deleted" + } + }, + { + "@attributes": { + "Id": 5, + "Name": "Routed" + } + }, + { + "@attributes": { + "Id": 6, + "Name": "Rejected" + } + } + ] + }, + "GlHeaderTypes": { + "GlHeaderType": [ + { + "@attributes": { + "Id": 1, + "Name": "Standard" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Trial Balance" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Accrual Month End" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "Cash Month End" + } + }, + { + "@attributes": { + "Id": 5, + "Name": "Year End" + } + }, + { + "@attributes": { + "Id": 6, + "Name": "Accrual PO Month End Adjustment" + } + } + ] + }, + "GlLedgerTypes": { + "GlLedgerType": [ + { + "@attributes": { + "Id": 1, + "Name": "GL" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "AR" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "AP" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "Asset" + } + } + ] + }, + "GlReconciliationStatusTypes": { + "GlReconciliationStatusTypes": [ + { + "@attributes": { + "Id": 1, + "Name": "Reconciled" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "Pending" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "Paused" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "Reopened" + } + } + ] + }, + "GlTransactionTypes": { + "GlTransactionType": [ + { + "@attributes": { + "Id": 1, + "Name": "GJ" + } + }, + { + "@attributes": { + "Id": 2, + "Name": "AP Charge" + } + }, + { + "@attributes": { + "Id": 3, + "Name": "AP Payment" + } + }, + { + "@attributes": { + "Id": 4, + "Name": "AP Allocation" + } + }, + { + "@attributes": { + "Id": 7, + "Name": "AR Charge" + } + }, + { + "@attributes": { + "Id": 8, + "Name": "AR Payment" + } + }, + { + "@attributes": { + "Id": 13, + "Name": "AR Allocation Post" + } + }, + { + "@attributes": { + "Id": 14, + "Name": "AR Allocation Deletion" + } + }, + { + "@attributes": { + "Id": 15, + "Name": "AR Deposit" + } + }, + { + "@attributes": { + "Id": 16, + "Name": "AR Deposit Reversal" + } + } + ] + }, + "Budgets": { + "Budget": [ + { + "@attributes": { + "Id": 67183, + "Name": "test budget HV", + "StatusTypeId": 4, + "IsDefault": 0, + "StatusType": "Archived" + } + } + ] + }, + "LedgerIds": { + "LedgerId": [ + { + "@attributes": { + "Id": 3, + "Name": "Military" + } + } + ] + } + } + } + } + }, + "getFinancialPickList_r2_SuccessExample": { + "summary": "getFinancialPickList(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "glGroupTypes": { + "glGroupType": [ + { + "id": 1, + "name": "Assets" + }, + { + "id": 2, + "name": "Liabilities" + }, + { + "id": 3, + "name": "Equity" + }, + { + "id": 4, + "name": "Income" + }, + { + "id": 5, + "name": "Expenses" + } + ] + }, + "glTreeTypes": { + "glTreeType": [ + { + "id": 1, + "name": "Standard" + }, + { + "id": 2, + "name": "Affordable" + }, + { + "id": 3, + "name": "Custom Report" + } + ] + }, + "glAccountTypes": { + "glAccountType": [ + { + "id": 201, + "name": "Accounts Payable" + }, + { + "id": 102, + "name": "Accounts Receivable" + }, + { + "id": 105, + "name": "Accumulated Depreciation" + }, + { + "id": 422, + "name": "Add-On Income" + } + ] + }, + "glBooks": { + "glBook": [ + { + "id": 616, + "name": "Standard" + }, + { + "id": 180, + "name": "Tax" + }, + { + "id": 834, + "name": "GAAP" + } + ] + }, + "glBranchTypes": { + "glBranchType": [ + { + "id": 1, + "name": "Standard Group" + }, + { + "id": 2, + "name": "Total Group" + }, + { + "id": 3, + "name": "Net Cash Flow Group" + } + ] + }, + "glExportBatchTypes": { + "glExportBatchType": [ + { + "id": 88, + "name": "AMSI" + }, + { + "id": 92, + "name": "Great Plains" + }, + { + "id": 156, + "name": "International Yardi ETL GS" + } + ] + }, + "glHeaderStatusTypes": { + "glHeaderStatusType": [ + { + "id": 1, + "name": "Posted" + }, + { + "id": 2, + "name": "Temporary" + }, + { + "id": 3, + "name": "Reversed" + }, + { + "id": 4, + "name": "Deleted" + }, + { + "id": 5, + "name": "Routed" + }, + { + "id": 6, + "name": "Rejected" + } + ] + }, + "glHeaderTypes": { + "glHeaderType": [ + { + "id": 1, + "name": "Standard" + }, + { + "id": 2, + "name": "Trial Balance" + }, + { + "id": 3, + "name": "Accrual Month End" + }, + { + "id": 4, + "name": "Cash Month End" + }, + { + "id": 5, + "name": "Year End" + }, + { + "id": 6, + "name": "Accrual PO Month End Adjustment" + } + ] + }, + "glLedgerTypes": { + "glLedgerType": [ + { + "id": 1, + "name": "GL" + }, + { + "id": 2, + "name": "AR" + }, + { + "id": 3, + "name": "AP" + }, + { + "id": 4, + "name": "Asset" + } + ] + }, + "glReconciliationStatusTypes": { + "glReconciliationStatusType": [ + { + "id": 1, + "name": "Reconciled" + }, + { + "id": 2, + "name": "Pending" + }, + { + "id": 3, + "name": "Paused" + }, + { + "id": 4, + "name": "Reopened" + } + ] + }, + "glTransactionTypes": { + "glTransactionType": [ + { + "id": 1, + "name": "GJ" + }, + { + "id": 2, + "name": "AP Charge" + }, + { + "id": 3, + "name": "AP Payment" + }, + { + "id": 4, + "name": "AP Allocation" + }, + { + "id": 7, + "name": "AR Charge" + }, + { + "id": 8, + "name": "AR Payment" + } + ] + }, + "budgetStatusTypeIds": { + "budgetStatusTypeId": [ + { + "id": 1, + "name": "Current" + }, + { + "id": 2, + "name": "Working" + }, + { + "id": 4, + "name": "Archived" + } + ] + }, + "owners": { + "owner": [ + { + "id": "60732", + "name": "0000CNYE1", + "propertyIds": "19463,43634,204678,229293,230705,230707,249228,259871,356952,359699,483208,486792,486797,496815,506147,508794,517628,525647" + }, + { + "id": "91141", + "name": "0000 test property", + "propertyIds": "625012" + }, + { + "id": "95467", + "name": "000 ahaitali", + "propertyIds": "18462" + } + ] + }, + "ledgerIds": { + "ledgerId": [ + { + "id": 3, + "name": "Military" + }, + { + "id": 5, + "name": "Straight Line" + }, + { + "id": 1, + "name": "Resident" + }, + { + "id": 2, + "name": "Subsidy" + }, + { + "id": 4, + "name": "Group" + } + ] + } + } + } + } + }, + "getGlTransactionsSuccessExample": { + "summary": "getGlTransactions", + "value": { + "requestId": "15", + "result": { + "properties": { + "property": { + "isCashBook": "false", + "transactions": { + "transaction": [ + { + "glTotal": { + "openingBalance": "0.00", + "debitOpeningBalance": "0.00", + "creditOpeningBalance": "0.00", + "debitClosingBalance": "6.00", + "creditClosingBalance": "-6.00", + "netChange": "0.00", + "closingBalance": "0.00" + }, + "glDetails": { + "glDetail": [ + { + "transactionDate": "2020/04/23", + "postMonth": "Oct,2013", + "postDate": "2020/04/23", + "debit": "6.00", + "credit": "0.00", + "customTagId": "123", + "customTagName": "Name", + "balance": "6.00", + "reference": "Payment Received - #12345", + "memo": "Master 07 Unit #17", + "buildingId": "12345", + "buildingNumber": "Building A", + "@attributes": { + "id": "12345", + "transactionType": "AR Payment" + } + }, + { + "transactionDate": "2020/04/23", + "postMonth": "Oct,2013", + "postDate": "2020/04/23", + "debit": "0.00", + "credit": "-6.00", + "balance": "0.00", + "reference": "Payment Received - #12345", + "memo": "Master 07 Unit #17", + "unitId": "12345", + "unitNumber": "12345", + "@attributes": { + "id": "12345", + "transactionType": "AR Payment" + } + } + ] + }, + "@attributes": { + "accountId": "1234", + "accountName": "Undeposited Funds", + "accountNumber": "1234", + "externalId": "2" + } + }, + { + "glTotal": { + "openingBalance": "-677.00", + "debitOpeningBalance": "0", + "creditOpeningBalance": "-677.00", + "debitClosingBalance": "0", + "creditClosingBalance": "-677.00", + "netChange": "0", + "closingBalance": "-677.00" + }, + "@attributes": { + "accountId": "12345", + "accountName": "Accounts Receivable", + "accountNumber": "12345", + "externalId": "2" + } + }, + { + "glTotal": { + "openingBalance": "677.00", + "debitOpeningBalance": "677.00", + "creditOpeningBalance": "0.00", + "debitClosingBalance": "683.00", + "creditClosingBalance": "-6.00", + "netChange": "0.00", + "closingBalance": "677.00" + }, + "glDetails": { + "glDetail": [ + { + "transactionDate": "2020/04/23", + "postMonth": "Oct,2013", + "postDate": "2013/10/03", + "debit": "0.00", + "credit": "-6.00", + "customTagId": "12345", + "customTagName": "Name1", + "balance": "671.00", + "reference": "Payment Received - #12345", + "memo": "Master 07 Unit #17", + "@attributes": { + "id": "12345", + "transactionType": "AR Payment" + } + }, + { + "transactionDate": "2020/04/23", + "postMonth": "Oct,2013", + "postDate": "2020/04/23", + "debit": "6.00", + "credit": "0.00", + "balance": "677.00", + "reference": "Payment Received - #12345", + "memo": "Master 07 Unit #17", + "@attributes": { + "id": "12345", + "transactionType": "AR Payment" + } + } + ] + }, + "@attributes": { + "accountId": "12345", + "accountName": "Prepaid Rent Liability", + "accountNumber": "2110" + } + }, + { + "glTotal": { + "openingBalance": "57923.01", + "debitOpeningBalance": "57923.01", + "creditOpeningBalance": "0.00", + "debitClosingBalance": "57947.97", + "creditClosingBalance": "0.00", + "netChange": "24.96", + "closingBalance": "57947.97" + }, + "glDetails": { + "glDetail": [ + { + "transactionDate": "2020/04/24", + "apDetailId": "12345", + "postMonth": "Apr,2020", + "postDate": "2020/04/24", + "debit": "10.00", + "credit": "0.00", + "balance": "57947.97", + "reference": "Inv #123", + "memo": "Test Invoice", + "vendorCode": "Corporate_1", + "vendorName": "22 Exchange", + "@attributes": { + "id": "1234567", + "transactionType": "Invoice" + } + }, + { + "@attributes": { + "id": "12345", + "transactionType": "General Journal Entry" + }, + "transactionDate": "2020/05/27", + "postMonth": "May,2020", + "postDate": "2020/05/27", + "debit": "10.00", + "credit": "0.00", + "balance": "9212.55", + "reference": "GJ#123456 - 1234", + "contractId": "9", + "contract": "22 Exchange", + "jobId": "26", + "job": "Job name", + "jobCostCodeId": "12345", + "jobCostCode": "Job Cost code" + } + ] + }, + "@attributes": { + "accountId": "12345", + "accountName": "Report Liabilities Test A/C", + "accountNumber": "00000002" + } + }, + { + "glTotal": { + "openingBalance": "-707418.13", + "debitOpeningBalance": "0.00", + "creditOpeningBalance": "-707418.13", + "debitClosingBalance": "120.00", + "creditClosingBalance": "-707560.13", + "netChange": "-22.00", + "closingBalance": "-707440.13" + }, + "glDetails": { + "glDetail": [ + { + "transactionDate": "2020/04/24", + "apDetailId": "123456", + "postMonth": "Apr,2020", + "postDate": "2020/04/24", + "debit": "0.00", + "credit": "-10.00", + "balance": "-707450.13", + "reference": "Inv #123", + "memo": "Test Ivnoice", + "vendorCode": "Corporate_1", + "vendorName": "22 Exchange", + "@attributes": { + "id": "1234567", + "transactionType": "Invoice" + } + }, + { + "@attributes": { + "id": "12346678", + "transactionType": "General Journal Entry" + }, + "transactionDate": "2020/05/27", + "postMonth": "May,2020", + "postDate": "2020/05/27", + "debit": "0.00", + "credit": "10.00", + "balance": "9212.55", + "reference": "GJ#123445 - 1234", + "contractId": "9", + "contract": "22 Exchange", + "jobId": "26", + "job": "Job name", + "jobCostCodeId": "12345", + "jobCostCode": "job cost code" + } + ] + }, + "@attributes": { + "accountId": "12345", + "accountName": "LIABILITIES & EQUITY", + "accountNumber": "123456", + "externalId": "1900000" + } + } + ] + }, + "@attributes": { + "id": "1234", + "name": "silver park apartments", + "lookupCode": "123X", + "businessUnitCode": "silver" + } + } + } + } + } + }, + "getGlTrees_r1_SuccessExample": { + "summary": "getGlTrees(r1)", + "value": { + "requestId": "15", + "result": { + "GlTrees": { + "GlTree": [ + { + "@attributes": { + "Id": "1283", + "Name": "Master GL Tree" + }, + "Properties": { + "Property": [ + { + "@attributes": { + "Id": "2652", + "Name": "123" + } + } + ] + }, + "Branches": { + "Branch": [ + { + "BranchId": "5531", + "GroupType": "Standard Group", + "IsEnabled": "1", + "ShowGroupName": "1", + "GroupName": "Assets", + "ShowSummaryRow": "1", + "Description": "Assets" + } + ] + }, + "GlAccounts": { + "GlAccount": [ + { + "@attributes": { + "Id": "87019", + "BranchId": "56125" + }, + "AccountNumber": "101-000-0", + "AccountName": "Cash in Bank - ResidentPay", + "ExternalId": "2894", + "GlGroupType": "Assets", + "GroupLocation": "Cash", + "Description": "Cash in Bank - ResidentPay", + "Status": "Enabled", + "IsSystem": "1" + }, + { + "@attributes": { + "Id": "87020", + "BranchId": "56125" + }, + "AccountNumber": "102-0", + "AccountName": "Cash in Bank - Savings", + "GlGroupType": "Assets", + "GroupLocation": "Cash", + "Description": "Cash in Bank - Savings", + "Status": "Enabled", + "IsSystem": "0" + }, + { + "@attributes": { + "Id": "87020", + "BranchId": "56125" + }, + "AccountNumber": "103-0", + "AccountName": "Security Deposit Bank Account", + "ExternalId": "2894", + "GlGroupType": "Assets", + "GroupLocation": "Cash", + "Description": "Security Deposit Bank Account", + "Status": "Enabled", + "IsSystem": "0" + } + ] + } + } + ] + } + } + } + }, + "getGlTrees_r2_SuccessExample": { + "summary": "getGlTrees(r2)", + "value": { + "requestId": "15", + "code": 200, + "result": { + "glTrees": { + "glTree": [ + { + "id": 12345, + "name": "Master GL Tree", + "isMasterGlTree": 1, + "branches": { + "branch": [ + { + "branchId": "12345", + "groupType": "Standard Group", + "isEnabled": "1", + "showGroupName": 1, + "groupName": "Cash", + "showSummaryRow": 1, + "description": "Cash" + } + ] + }, + "glAccounts": { + "glAccount": [ + { + "id": "12345", + "branchId": "12345", + "accountNumber": "12345-12345", + "accountName": "Cash in Bank - Operating", + "externalId": "12345", + "glGroupType": "Assets", + "groupLocation": "Cash", + "description": "Cash in Bank - Operating", + "status": "Enabled", + "isSystem": 1 + } + ] + } + }, + { + "id": 12345, + "name": "Modified Cash P&L", + "isMasterGlTree": 0, + "branches": { + "branch": [ + { + "branchId": "12345", + "groupType": "Standard Group", + "isEnabled": "1", + "showGroupName": 1, + "groupName": "Cash", + "showSummaryRow": 1, + "description": "Cash" + } + ] + }, + "glAccounts": { + "glAccount": [ + [ + { + "id": "12345", + "branchId": "12345", + "accountNumber": "12345-12345", + "accountName": "Cash in Bank - Operating", + "externalId": "12345", + "glGroupType": "Assets", + "groupLocation": "Cash", + "description": "Cash in Bank - Operating", + "status": "Enabled", + "isSystem": 1 + } + ] + ] + } + } + ] + } + } + } + }, + "getJobCategoriesSuccessExample": { + "summary": "getJobCategories", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "jobCategories": { + "jobCategory": [ + { + "id": "632", + "name": "Brittany's Job Type", + "glAccountId": "86997" + }, + { + "id": "604", + "name": "Carpeting Overhaul", + "glAccountId": "274694" + }, + { + "id": "7", + "name": "New Construction" + }, + { + "id": "1100", + "name": "Flooring", + "glAccountId": "303687" + } + ] + } + } + } + } + }, + "getJobCostBudgetsSuccessExample": { + "summary": "getJobCostBudgets", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "jobs": { + "job": [ + { + "propertyId": "172775", + "jobId": "1249", + "jobStatusId": "1", + "jobPhases": { + "jobPhase": [ + { + "jobPhaseId": "2700", + "jobPhaseName": "PhaseGlAccountTest", + "apCodes": [ + { + "apCode": { + "apCodeId": "176844", + "apCodeName": "1234 - Electrical", + "unitTypeBudget": "12", + "locationBudget": "0", + "generalBudget": "0", + "postMonths": { + "postMonth": [ + { + "apDetailId": "11652280", + "postMonth": "01/2021", + "monthlyAmount": "0.00", + "unitTypeId": "478700" + }, + { + "apDetailId": "11652281", + "postMonth": "01/2021", + "monthlyAmount": "0.00", + "unitTypeId": "582099" + } + ] + } + } + }, + { + "apCode": { + "apCodeId": "176529", + "apCodeName": "R Flooring", + "unitTypeBudget": "0", + "locationBudget": "0", + "generalBudget": "2500", + "postMonths": { + "postMonth": [ + { + "apDetailId": "1994301", + "postMonth": "03/2017", + "monthlyAmount": "500.00" + }, + { + "apDetailId": "1994303", + "postMonth": "04/2017", + "monthlyAmount": "500.00" + } + ] + } + } + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "getJobsSuccessExample": { + "summary": "getJobs", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "jobs": { + "job": [ + { + "id": "1001", + "name": "RP 1", + "propertyId": "12345", + "jobCategoryId": "6", + "glAccountId": "87063", + "jobStatusId": "5", + "jobStatus": "Completed", + "plannedStartDate": "03/24/2021", + "plannedCompletionDate": "03/24/2021", + "actualStartDate": "03/24/2021", + "actualCompletionDate": "03/24/2021", + "budgetTotal": "300.00", + "jobPhases": { + "jobPhase": [ + { + "id": 2671, + "name": "Phase 1", + "budget": "30.00" + }, + { + "id": 2672, + "name": "Phase 2", + "budget": "200.00" + }, + { + "id": 2673, + "name": "Phase 3", + "budget": "70.00" + } + ] + }, + "apContracts": { + "apContract": [ + { + "id": "595", + "name": "test contract 1", + "contractTotal": "300.00", + "contractVendor": "001 East Park Property", + "plannedStartDate": "03/24/2021", + "plannedCompletionDate": "03/25/2021", + "actualStartDate": "03/24/2021", + "actualCompletionDate": "03/24/2021", + "apCodes": { + "apCode": [ + { + "id": "179174", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00" + }, + { + "id": "179179", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00" + }, + { + "id": "179176", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00", + "changeOrderId": "750" + } + ] + } + } + ] + } + }, + { + "id": "1030", + "name": "New test job A", + "propertyId": "12345", + "jobCategoryId": "6", + "glAccountId": "87063", + "jobStatusId": "5", + "jobStatus": "Completed", + "plannedStartDate": "03/24/2021", + "plannedCompletionDate": "03/24/2021", + "actualStartDate": "03/24/2021", + "actualCompletionDate": "03/24/2021", + "budgetTotal": "230.00", + "jobPhases": { + "jobPhase": [ + { + "id": 2671, + "name": "Phase 1", + "budget": "30.00" + }, + { + "id": 2672, + "name": "Phase 2", + "budget": "200.00" + }, + { + "id": 2673, + "name": "Phase 3" + } + ] + }, + "apContracts": { + "apContract": [ + { + "id": "596", + "name": "test contract A", + "contractTotal": "400.00", + "contractVendor": "001 East Park Property", + "plannedStartDate": "03/24/2021", + "plannedCompletionDate": "03/25/2021", + "actualStartDate": "03/24/2021", + "actualCompletionDate": "03/24/2021", + "apCodes": { + "apCode": [ + { + "id": "179174", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00" + }, + { + "id": "179179", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00" + }, + { + "id": "179176", + "jobPhaseId": "2671", + "glAccountId": "86985", + "contractAmount": "100.00", + "changeOrderId": "751" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "getTransactionTagListsSuccessExample": { + "summary": "getTransactionTagLists", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "transactionCustomTags": { + "transactionCustomTag": [ + { + "id": 545, + "name": "021", + "code": "T0021", + "isPublished": 1 + }, + { + "id": 406, + "name": "Ak Test Tag", + "code": "AK", + "description": "Description:", + "isPublished": 1 + }, + { + "id": 321, + "name": "CustomTag02", + "description": "test1", + "isPublished": 1 + }, + { + "id": 38, + "name": "Fire Expenses", + "code": "FE12", + "description": "Expenses related to the fire", + "isPublished": 1 + }, + { + "id": 384, + "name": "PL Test Tag", + "description": "PL", + "isPublished": 1 + }, + { + "id": 180, + "name": "R test Custom Tag", + "description": "R test Custom Tag", + "isPublished": 1 + }, + { + "id": 463, + "name": "svt 01", + "isPublished": 1 + }, + { + "id": 465, + "name": "svt 02", + "isPublished": 1 + }, + { + "id": 464, + "name": "svt budget 01", + "isPublished": 1 + }, + { + "id": 1, + "name": "System", + "description": "System", + "isPublished": 1 + }, + { + "id": 3, + "name": "Tag01", + "description": "Tag01", + "isPublished": 1 + }, + { + "id": 352, + "name": "Test1", + "description": "ets", + "isPublished": 1 + }, + { + "id": 353, + "name": "Test2", + "description": "ets", + "isPublished": 1 + }, + { + "id": 400, + "name": "tttt", + "isPublished": 1 + }, + { + "id": 319, + "name": "Xento", + "description": "Tag1", + "isPublished": 1 + }, + { + "id": 322, + "name": "CustomTag03", + "description": "test2", + "isPublished": 0 + }, + { + "id": 4, + "name": "Tag02", + "description": "Tag02", + "isPublished": 0 + } + ] + }, + "transactionRoutingTags": { + "transactionRoutingTag": [ + { + "id": 112, + "name": "Ak Route Tag", + "description": "Ak Route Tag", + "isPublished": 1 + }, + { + "id": 93, + "name": "dsd", + "description": "sdsd", + "isPublished": 1 + }, + { + "id": 92, + "name": "ghghg", + "description": "ghghgh", + "isPublished": 1 + }, + { + "id": 99, + "name": "RoutingT", + "description": "Routing tag", + "isPublished": 1 + }, + { + "id": 2, + "name": "RTag01", + "description": "RTag01", + "isPublished": 1 + }, + { + "id": 1, + "name": "RTag02", + "description": "RTag02", + "isPublished": 1 + }, + { + "id": 101, + "name": "Rtag12", + "description": "12r", + "isPublished": 1 + } + ] + } + } + } + } + }, + "markGlTransactionsExportedSuccessExample": { + "summary": "markGlTransactionsExported", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "message": "Gl Transactions marked as exported successfully." + } + } + } + }, + "sendBudgetsSuccessExample": { + "summary": "sendBudgets", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "budgets": { + "budget": [ + { + "node": 1, + "status": "Success", + "message": "budget inserted successfully." + }, + { + "node": 2, + "status": "Success", + "message": "budget inserted successfully." + } + ] + } + } + } + } + }, + "sendJournalEntriesSuccessExample": { + "summary": "sendJournalEntries", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "glHeaders": { + "glHeader": [ + { + "node": "1", + "status": "Success", + "message": "JE inserted successfully", + "glHeaderId": "123456", + "jeNumber": "123456" + } + ] + } + } + } + } + }, + "updateBudgetsSuccessExample": { + "summary": "updateBudgets", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "budgets": { + "budget": [ + { + "node": 1, + "status": "Success", + "message": "Budget updated successfully." + }, + { + "node": 2, + "status": "Success", + "message": "Budget updated successfully." + } + ] + } + } + } + } + }, + "getLeadsSuccessExample": { + "summary": "getLeads", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "propertyId": "1234", + "currencyCode": "USD", + "prospects": { + "prospect": [ + { + "applicationId": "1234", + "status": "Application Approved", + "statusId": "12", + "leadSourceId": "123456", + "leadSource": "123456", + "leasingAgentId": "123456", + "leasingAgent": "123456", + "psProductId": "12", + "internetListingServiceId": "123456", + "internetListingService": "EXAMPLE.Com", + "lastUpdatedDate": "YYYY-MM-DD", + "createdOn": "YYYY-MM-DD", + "screeningResultStatus": "Fail", + "spaceConfiguration": "Private", + "lease": { + "leaseId": "1234", + "status": "Cancelled", + "leaseIntervalId": "1234", + "expectedMoveInDate": "YYYY-MM-DD", + "expectedMoveOutDate": {}, + "leaseFromDate": "YYYY-MM-DD", + "leaseToDate": {} + }, + "customers": { + "customer": [ + { + "applicantId": "1234", + "customerId": "1234", + "customerRelationshipTypeId": "1234", + "customerRelationshipType": "Primary", + "customerType": "Primary", + "namePrefix": "MR", + "firstName": "FIRST NAME", + "middleName": "MIDDLE NAME", + "lastName": "LAST NAME", + "maidenName": "MAIDEN NAME", + "nameSuffix": "JR", + "personalPhoneNumber": "1234", + "cellPhoneNumber": "1234567890", + "officePhoneNumber": "1234567890", + "faxPhoneNumber": "1234567890", + "email": "EAMIL@EXAMPLE.LCL", + "birthDate": "YYYY-MM-DD", + "addresses": { + "address": [ + { + "addressType": "Current", + "addressLine": "addressLine", + "city": "CITY", + "state": "GA", + "province": "PROVINCE", + "countryCode": "US", + "postalCode": "123456" + } + ] + }, + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/22/2025", + "bankruptcyNote": "XYZ" + } + ] + }, + "customerPreferences": { + "targetMoveInDate": "YYYY-MM-DD", + "desiredFloorplan": "One BHK - 2", + "desiredUnit": { + "propertyUnitId": "1234", + "unitNumber": "112-B", + "unitSpaceId": "1234", + "unitType": "2BHK", + "unitBedrooms": {}, + "unitBathrooms": {}, + "minSquareFeet": {}, + "maxSquareFeet": {}, + "initialRent": {}, + "marketRent": {}, + "maxOccupants": {}, + "floorplanId": {}, + "floorplanName": {}, + "squareFootType": "internal", + "unitEconomicStatus": "residential", + "unitOccupancyStatus": "vacant", + "unitLeasedStatus": "leased" + }, + "desiredMinRent": "400.00", + "desiredMaxRent": "32854.00", + "desiredNumBedrooms": {}, + "desiredNumBathrooms": {}, + "desiredLeaseTerms": "8", + "desiredLeaseTermName": "8 months", + "numberOfOccupants": "1", + "amenities": { + "propertyAmenities": { + "amenity": [ + { + "amenityType": "Apartment", + "amenity": "123", + "description": "AMENITY DESCRIPTION" + }, + { + "amenityType": "Community", + "amenity": "Clubhouse" + }, + { + "amenityType": "Apartment", + "amenity": "Dog Park" + } + ] + } + }, + "pets": { + "pet": [ + { + "petType": {}, + "count": {} + } + ] + } + }, + "events": { + "event": [ + { + "eventId": "1234", + "typeId": "2", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Email - Outgoing", + "appointmentEventId": "179963255", + "date": "YYYY-MM-DD", + "comments": "COMMENTS", + "eventReasons": "INTERESTED" + }, + { + "eventId": "1234", + "typeId": 17, + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Scheduled Appointment", + "subtypeId": 123, + "appointmentDate": "YYYY-MM-DD", + "timeFrom": "15:30:00", + "timeTo": "16:00:00", + "date": "YYYY-MM-DD", + "agentId": 1234, + "agentFirstName": "Fname", + "agentLastName": "Lname", + "eventResultId": 3451, + "eventResult": "Rescheduled", + "comments": "COMMENTS", + "eventReasons": "" + }, + { + "eventId": "1234", + "typeId": "3", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Call - Incoming", + "date": "YYYY-MM-DD", + "callData": { + "callId": "64744370", + "callFrom": "1234567890", + "ringThrough": "1234567890", + "duration": "37", + "callStatus": "Unanswered" + }, + "eventReasons": {} + }, + { + "eventId": "1234", + "typeId": "15", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Scheduled Follow-Up", + "date": "YYYY-MM-DD", + "agentId": "1234", + "agentFirstName": "call", + "agentLastName": "agent", + "comments": "Application Completed", + "eventReasons": "Manual Contact added by Contact Points because Application is completed" + }, + { + "eventId": "1234", + "typeId": "498", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Identity Verification", + "date": "2021-12-22", + "eventResultId": 2910914, + "eventResult": "Success", + "eventReasons": "Indentity Verification done by rayn taylor" + } + ] + } + } + ] + } + } + } + } + }, + "getLeadEventsSuccessExample": { + "summary": "getLeadEvents", + "value": { + "requestId": "15", + "code": 200, + "result": { + "prospects": { + "prospect": { + "applicationId": "17851835", + "events": { + "event": [ + { + "eventId": "123456", + "typeId": "1", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-09-27", + "type": "Email - Incoming", + "emailAddresses": { + "from": "rnair@xento.com", + "to": "dfgfd@rtgdfb.cvb", + "subject": "Potential lead", + "emailBody": "Incoming Email Content" + }, + "comments": "Test Attach existing lead.", + "eventResult": "Completed", + "eventReason": "Incoming Email from Marioa Jack | Result: Completed" + }, + { + "eventId": "123456", + "typeId": "2", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-12-09", + "type": "Email - Outgoing", + "emailAddresses": { + "from": "22exchange@emailrelay.com", + "to": "rm@l.lll", + "subject": "Test email from pp", + "emailBody": "Outgoing Email Content" + }, + "comments": "Test email from pp", + "eventReason": "Outgoing Email to Ramson Black" + }, + { + "eventId": "123456", + "typeId": "3", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2018-09-04", + "type": "Call - Incoming", + "callData": { + "callId": "51158467", + "callFrom": "8018556675", + "ringThrough": "8017849347", + "duration": "4", + "callStatus": "Unanswered" + }, + "eventResult": "Completed", + "eventReason": "Missed Call from Rita Lead | from Apartment.com | Duration: 04 s and Manual Contact added | Result: Cancelled Test", + "agentId": "324135", + "agentFirstName": "lead", + "agentLastName": "alert" + }, + { + "eventId": "123456", + "typeId": "4", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2018-10-30", + "type": "Call - Outgoing", + "appointmentEventId": "179336552", + "comments": "Outbound Call to Peter Dighosta via Scheduled Calls", + "eventReason": "Outgoing Call to Peter Dighosta" + }, + { + "eventId": "123456", + "typeId": "5", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-11-13", + "type": "Text - Incoming", + "appointmentEventId": "179336553", + "comments": "Test message", + "eventReason": "Text Conversation" + }, + { + "eventId": "123456", + "typeId": "6", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-10-30", + "type": "Text - Outgoing", + "appointmentEventId": "179336554", + "comments": "sms chat working for live", + "eventReason": "Outgoing Text to Hello Sms" + }, + { + "eventId": "123456", + "typeId": "7", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-10-23", + "type": "Online Chat", + "eventResult": "Interested", + "eventReason": "Online Chat with lead alert" + }, + { + "eventId": "123456", + "typeId": "8", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-09-26", + "type": "Notes", + "appointmentEventId": "179336554", + "comments": "Test email", + "eventReason": "Note updated by Leasing Center" + }, + { + "eventId": "123456", + "typeId": "17", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2019-09-20", + "type": "Scheduled Appointment", + "appointmentDate": "2019-09-15", + "timeFrom": "23:30:00", + "timeTo": "01:00:00", + "eventResultId": 2342, + "eventResult": "Completed", + "eventReason": "Schedule Appointment on 09/15/2019 from 11:30 PM MDT to 01:00 AM MDT" + }, + { + "eventId": "123456", + "typeId": "78", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "date": "2020-08-26", + "subtypeId": "524", + "Comments": "Comments", + "eventResultId": "2910793", + "eventResult": "I am very Unique fo Sho!", + "eventReason": "Tour | Result: I am very Unique fo Sho!" + }, + { + "eventId": "123456", + "typeId": "498", + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": "123456", + "type": "Identity Verification", + "date": "2021-12-22", + "eventReason": "Indentity Verification done by ryan taylor" + } + ] + } + } + } + } + } + }, + "applyQuoteSuccessExample": { + "summary": "applyQuote", + "value": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "quoteId": "123", + "message": "Quote applied successfully" + } + } + }, + "generateQuotesSuccessExample": { + "summary": "generateQuotes", + "value": { + "requestId": "15", + "code": "300", + "result": { + "quotes": { + "quote": [ + { + "node": "1", + "status": "Success", + "quoteId": "123", + "message": "Quote generated successfully." + }, + { + "node": "2", + "status": "Failed", + "message": "Quote generation failed." + } + ] + } + } + } + }, + "getLeadPickLists_r1_SuccessExample": { + "summary": "getLeadPickLists(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "EventTypes": { + "EventType": [ + { + "@attributes": { + "name": "Application", + "Id": 131, + "entrataName": "Add Applicant Application" + } + }, + { + "@attributes": { + "name": "Contact", + "Id": 145, + "entrataName": "Follow-up Event" + } + } + ] + }, + "Property": { + "18462": { + "@attributes": { + "Id": 18462 + }, + "LeasingAgents": { + "LeasingAgent": [ + { + "@attributes": { + "name": "Abby Stevens", + "Id": "175141" + } + }, + { + "@attributes": { + "name": "Adam Ponting", + "Id": "324167" + } + } + ] + }, + "LeadSources": { + "LeadSource": [ + { + "@attributes": { + "name": "Apartment Advisor", + "Id": 68509, + "WebVisible": "true" + } + }, + { + "@attributes": { + "name": "Yellow Pages", + "Id": 3591, + "WebVisible": "true" + } + } + ] + } + }, + "19463": { + "@attributes": { + "Id": 19463 + }, + "LeasingAgents": { + "LeasingAgent": [ + { + "@attributes": { + "name": "Abha Kumari", + "Id": "204658" + } + }, + { + "@attributes": { + "name": "vinod jadhav", + "Id": "180474" + } + } + ] + }, + "LeadSources": { + "LeadSource": [ + { + "@attributes": { + "name": "22exchange.com", + "Id": 71172, + "WebVisible": "true" + } + }, + { + "@attributes": { + "name": "Zillow", + "Id": 72056, + "WebVisible": "true" + } + } + ] + } + } + }, + "EventResults": { + "EventResult": [ + { + "name": "Cancelled", + "Id": 57024 + }, + { + "name": "Completed", + "Id": 57415 + }, + { + "name": "Negative", + "Id": 57028 + } + ] + }, + "LeadStatuses": { + "LeadStatus": [ + { + "@attributes": { + "Id": 21, + "name": "Renewal Proposal Generated", + "leaseIntervalTypeName": "Renewal" + } + }, + { + "@attributes": { + "Id": 18, + "name": "Lease Approved", + "leaseIntervalTypeName": "Application" + } + } + ] + } + } + } + } + }, + "getLeadPickLists_r2_SuccessExample": { + "summary": "getLeadPickLists(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "eventTypes": { + "eventType": [ + { + "@attributes": { + "name": "Application", + "id": "131", + "entrataName": "Add Applicant Application" + } + }, + { + "@attributes": { + "name": "Application", + "id": "132", + "entrataName": "Delete Applicant Application" + } + }, + { + "@attributes": { + "name": "Quote", + "id": "157", + "entrataName": "Quote Applied" + } + }, + { + "@attributes": { + "name": "other", + "id": "442", + "entrataName": "Self-Guided Tour" + } + }, + { + "@attributes": { + "name": "other", + "id": "449", + "entrataName": "Virtual Tour" + } + }, + { + "@attributes": { + "name": "Other", + "id": "498", + "entrataName": "Identity Verification" + } + } + ] + }, + "eventSubTypes": { + "eventSubType": [ + { + "@attributes": { + "name": "Leasing Appointments", + "id": 453, + "eventTypeId": 17 + } + }, + { + "@attributes": { + "name": "Self-Guided Tour", + "id": 524, + "eventTypeId": 78 + } + }, + { + "@attributes": { + "name": "Self-Guided Tour", + "id": 560, + "eventTypeId": 17 + } + }, + { + "@attributes": { + "name": "Tour", + "id": 454, + "eventTypeId": 17 + } + }, + { + "@attributes": { + "name": "Virtual Tour", + "id": 525, + "eventTypeId": 449 + } + }, + { + "@attributes": { + "name": "Virtual Tour", + "id": 525, + "eventTypeId": 17 + } + } + ] + }, + "property": { + "leasingAgents": { + "leasingAgent": [ + { + "@attributes": { + "name": "Carter Babb", + "id": "315879" + } + }, + { + "@attributes": { + "name": "Corine Bechard", + "id": "315651" + } + }, + { + "@attributes": { + "name": "John Brennan", + "id": "300525" + } + } + ] + }, + "leadSources": { + "leadSource": [ + { + "@attributes": { + "name": "Apartments.com", + "id": "27340", + "webVisible": "true", + "vanityNumber": "+1 1234564567" + } + }, + { + "@attributes": { + "name": "Banners/Signage", + "id": "63296", + "webVisible": "true", + "vanityNumber": "+1 1234564567" + } + }, + { + "@attributes": { + "name": "Campus Housing Office", + "id": "58973", + "webVisible": "true", + "vanityNumber": "+1 1234564567" + } + } + ] + }, + "quoteProvisions": { + "quoteProvision": [ + { + "@attributes": { + "id": 1193, + "name": "bumper offer, 1 month Airtel-extreme subscription free" + } + }, + { + "@attributes": { + "id": 1190, + "name": "bumper offer, 1 month Amazon subscription free" + } + }, + { + "@attributes": { + "id": 1189, + "name": "bumper offer, 1 month Netflix subscription free" + } + }, + { + "@attributes": { + "id": 1192, + "name": "bumper offer, 1 month SonyLive subscription free" + } + }, + { + "@attributes": { + "id": 1191, + "name": "bumper offer, 1 month Zee5 subscription free" + } + } + ] + }, + "@attributes": { + "id": "173769" + } + }, + "eventResults": { + "eventResult": [ + { + "@attributes": { + "name": "check-in custom", + "id": 2894233, + "eventTypeId": "9", + "defaultEventResultId": 83, + "defaultEventResult": "Check - In" + } + }, + { + "@attributes": { + "name": "Missed", + "id": 4, + "eventTypeId": "17", + "defaultEventResultId": 4, + "defaultEventResult": "Missed" + } + }, + { + "@attributes": { + "name": "Bad Credit", + "id": "139511", + "eventTypeId": "17", + "defaultEventResultId": 1, + "defaultEventResult": "Cancelled" + } + }, + { + "@attributes": { + "name": "Success", + "id": 2910915, + "eventTypeId": "498", + "defaultEventResultId": 85, + "defaultEventResult": "Success" + } + } + ] + }, + "leadStatuses": { + "leadStatus": [ + { + "@attributes": { + "id": "21", + "name": "Renewal Proposal Generated", + "leaseIntervalTypeName": "Renewal" + } + }, + { + "@attributes": { + "id": "49", + "name": "Application Started", + "leaseIntervalTypeName": "Transfer" + } + } + ] + }, + "psProducts": { + "psProduct": [ + { + "@attributes": { + "id": "7", + "name": "API Services" + } + }, + { + "@attributes": { + "id": "36", + "name": "CallTracking" + } + }, + { + "@attributes": { + "id": "58", + "name": "Entrata PaaS" + } + }, + { + "@attributes": { + "id": "19", + "name": "Guest Card Parsing" + } + }, + { + "@attributes": { + "id": "46", + "name": "Leasing Center" + } + }, + { + "@attributes": { + "id": "30", + "name": "Mobile Portal" + } + }, + { + "@attributes": { + "id": "2", + "name": "ProspectPortal" + } + } + ] + }, + "listItemTypes": { + "listItemType": [ + { + "listItems": { + "listItem": [ + { + "@attributes": { + "id": "134417", + "name": "Archived" + } + }, + { + "@attributes": { + "id": "134418", + "name": "ArchivedReasons" + } + } + ] + }, + "@attributes": { + "id": "9", + "name": "Lead Archive Reasons" + } + }, + { + "listItems": { + "listItem": [ + { + "@attributes": { + "id": "100448", + "name": "Cloned" + } + }, + { + "@attributes": { + "id": "127186", + "name": "Dislikes Community Style" + } + }, + { + "@attributes": { + "id": "100452", + "name": "Lacks Desired Community Amenity" + } + } + ] + }, + "@attributes": { + "id": "6", + "name": "Lead Cancellation" + } + }, + { + "listItems": { + "listItem": [ + { + "@attributes": { + "id": "100444", + "name": "Failed Credit" + } + }, + { + "@attributes": { + "id": "100445", + "name": "Failed Criminal" + } + }, + { + "@attributes": { + "id": "100443", + "name": "Income Too Low" + } + } + ] + }, + "@attributes": { + "id": "7", + "name": "Lead Denial Reasons" + } + } + ] + }, + "customerRelationshipTypes": { + "customerRelationshipType": [ + { + "@attributes": { + "id": "18385", + "name": "Primary", + "isDefault": "true", + "customerType": "Primary", + "customerTypeId": "1" + } + }, + { + "@attributes": { + "id": "18390", + "name": "Primary01", + "isDefault": "false", + "customerType": "Primary", + "customerTypeId": "1" + } + }, + { + "@attributes": { + "id": "18386", + "name": "Responsible", + "isDefault": "true", + "customerType": "Co-Applicant", + "customerTypeId": "2" + } + } + ] + } + } + } + } + }, + "getMitsLeadsSuccessExample": { + "summary": "getMitsLeads", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "CurrencyCode": "USD", + "LeadManagement": [ + { + "Prospects": { + "Prospect": { + "TransactionData": { + "Identification": [ + { + "IDValue": "19760815_17390875", + "Status": "Guest Card Completed", + "@attributes": { + "IDType": "Lead Number", + "IDScopeType": "sender" + } + }, + { + "IDValue": "172775", + "@attributes": { + "IDType": "PropertyID", + "IDScopeType": "sender" + } + }, + { + "IDValue": "2019-02-20T08:07:53", + "@attributes": { + "IDType": "Application Date", + "IDScopeType": "sender" + } + } + ] + }, + "LastUpdateDate": "2019-02-20T08:07:53", + "Customers": { + "Customer": { + "Identification": [ + { + "IDValue": "19760815", + "@attributes": { + "IDType": "Applicant Id", + "IDScopeType": "sender" + } + }, + { + "IDValue": "30831648", + "@attributes": { + "IDType": "Customer Id", + "IDScopeType": "sender" + } + } + ], + "Name": { + "FirstName": "Sdsad", + "LastName": "Asdsa" + }, + "Phone": { + "PhoneNumber": "2213213123", + "@attributes": { + "PhoneType": "cell" + } + } + } + }, + "CustomerPreferences": { + "TargetMoveInDate": "2019-02-20", + "DesiredLeaseTerms": "10", + "DesiredLeaseTermName": "10 Months", + "Amenities": [ + { + "Description": "Abhishek_test_amenities", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "Basket Ball Court", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "dishwasher", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "Dishwasher", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "Property_Apartment_Amenity", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "Property_Community_Amenity", + "@attributes": { + "AmenityType": "Other" + } + } + ] + }, + "Events": { + "Event": [ + { + "EventID": { + "Identification": [ + { + "IDValue": "147128113", + "@attributes": { + "IDType": "Event Id", + "IDScopeType": "sender" + } + }, + { + "IDValue": "Scheduled Follow-Up", + "@attributes": { + "IDType": "Entrata Event Type", + "IDScopeType": "sender" + } + } + ] + }, + "Agent": { + "AgentID": { + "Identification": { + "IDValue": "513102", + "@attributes": { + "IDType": "Agent Id", + "IDScopeType": "sender" + } + } + }, + "AgentName": { + "FirstName": "testa", + "LastName": "ygyugu" + } + }, + "Comments": "TestEast", + "EventReasons": "Manual Contact added by Contact Points because Guest Card is submitted", + "@attributes": { + "EventType": "Appointment", + "EventDate": "2019-02-20T08:10:27" + } + }, + { + "EventID": { + "Identification": [ + { + "IDValue": "147127875", + "@attributes": { + "IDType": "Event Id", + "IDScopeType": "sender" + } + }, + { + "IDValue": "Application Updated", + "@attributes": { + "IDType": "Entrata Event Type", + "IDScopeType": "sender" + } + } + ] + }, + "Agent": { + "AgentID": { + "Identification": { + "IDValue": "513102", + "@attributes": { + "IDType": "Agent Id", + "IDScopeType": "sender" + } + } + }, + "AgentName": { + "FirstName": "testa", + "LastName": "ygyugu" + } + }, + "EventReasons": "Guest card Updated by Entrata_5343", + "@attributes": { + "EventType": "Other", + "EventDate": "2019-02-20T08:07:53" + } + }, + { + "EventID": { + "Identification": [ + { + "IDValue": "147127874", + "@attributes": { + "IDType": "Event Id", + "IDScopeType": "sender" + } + }, + { + "IDValue": "Online Guest Card", + "@attributes": { + "IDType": "Entrata Event Type", + "IDScopeType": "sender" + } + } + ] + }, + "Agent": { + "AgentID": { + "Identification": { + "IDValue": "513102", + "@attributes": { + "IDType": "Agent Id", + "IDScopeType": "sender" + } + } + }, + "AgentName": { + "FirstName": "testa", + "LastName": "ygyugu" + } + }, + "EventReasons": "Guest Card Submitted for Sdsad Asdsa by Entrata_5343", + "@attributes": { + "EventType": "Application", + "EventDate": "2019-02-20T08:07:53" + } + }, + { + "EventID": { + "Identification": [ + { + "IDValue": "147127877", + "@attributes": { + "IDType": "Event Id", + "IDScopeType": "sender" + } + }, + { + "IDValue": "Call - Incoming", + "@attributes": { + "IDType": "Entrata Event Type", + "IDScopeType": "sender" + } + } + ] + }, + "Agent": { + "AgentID": { + "Identification": { + "IDValue": "513102", + "@attributes": { + "IDType": "Agent Id", + "IDScopeType": "sender" + } + } + }, + "AgentName": { + "FirstName": "testa", + "LastName": "ygyugu" + } + }, + "Comments": "ewewr", + "EventReasons": "Incoming Call from Sdsad Asdsa | Result: High Probability of Leasing", + "@attributes": { + "EventType": "CallFromProspect", + "EventDate": "2019-02-04T08:08:00" + } + } + ] + } + } + } + } + ] + } + } + } + }, + "getQuotesSuccessExample": { + "summary": "getQuotes", + "value": { + "requestId": "15", + "code": 200, + "result": { + "currencyCode": "USD", + "applications": { + "application": [ + { + "applicationId": "123456", + "applicationStatusId": "1", + "applicationStatus": "Started", + "quotes": { + "quote": [ + { + "id": "123456", + "moveInDate": "2020-05-13", + "createdOn": "2020-05-13 07:03:25", + "acceptedOn": "2020-05-13", + "expiresOn": "2020-05-14 07:03:25", + "isSelected": "1", + "buildingId": "12345", + "buildingName": "Building B", + "floorPlanId": "12345", + "floorPlanName": "Three Bedroom", + "unitNumber": "12", + "numberOfBedRooms": "3", + "numberOfBathRooms": "2.0000", + "leaseTerms": { + "leaseTerm": [ + { + "id": "3", + "termMonth": "12", + "quoteAmount": "5419.00" + } + ] + }, + "quoteProvisions": { + "quoteProvision": [ + { + "id": 1937, + "name": "50% discount till jun 2024" + }, + { + "id": 1938, + "name": "25% discount by Aug 2024." + } + ] + }, + "optionalItems": { + "optionalItem": [ + { + "addOnTypeId": "2", + "name": "Appliances", + "type": "Appliances", + "currentRate": "60.00", + "deposit": "89.00", + "reservationFee": "78.00" + }, + { + "addOnTypeId": "2", + "name": "Garage", + "type": "Garage", + "currentRate": "20.00", + "deposit": "90.00", + "reservationFee": "78.00" + } + ] + }, + "services": { + "service": [ + { + "addOnTypeId": "3", + "name": "Meal Plans", + "type": "Meal Plans", + "currentRate": "98.00", + "deposit": "30.00", + "reservationFee": "80.00" + }, + { + "addOnTypeId": "3", + "name": "Furnishing", + "type": "Furnishing", + "currentRate": "98.00", + "deposit": "30.00", + "OtherFee": "80.00" + } + ] + }, + "pets": { + "pet": [ + { + "petTypeId": "184368", + "petType": "german shepherd" + }, + { + "petTypeId": "184367", + "petType": "Fish" + } + ] + }, + "charges": { + "charge": [ + { + "pricingLevelId": 4, + "pricingLevel": "Space", + "pricingLevelReferenceId": 5563869, + "chargeUsageId": 1, + "chargeUsage": "Base", + "chargeTimingId": 202, + "chargeTiming": "Move-In", + "chargeCodeTypeId": 7, + "chargeCodeType": "Deposit", + "chargeCodeId": 245694, + "chargeCode": "Deposit", + "chargeAmount": "100.00", + "taxAmount": "0.00" + }, + { + "pricingLevelId": 1, + "pricingLevel": "Property", + "pricingLevelReferenceId": 1122860, + "chargeUsageId": 4, + "chargeUsage": "Add-On", + "chargeTimingId": 307, + "chargeTiming": "Monthly", + "chargeCodeTypeId": 2, + "chargeCodeType": "Rent", + "chargeCodeId": 238941, + "chargeCode": "Add on Rent", + "chargeAmount": "20.00", + "taxAmount": "0.00" + }, + { + "pricingLevelId": 1, + "pricingLevel": "Property", + "pricingLevelReferenceId": 1122860, + "chargeUsageId": 3, + "chargeUsage": "Pet", + "chargeTimingId": 307, + "chargeTiming": "Monthly", + "chargeCodeTypeId": 2, + "chargeCodeType": "Rent", + "chargeCodeId": 239026, + "chargeCode": "Pet Rent", + "chargeAmount": "15.00", + "taxAmount": "0.00" + }, + { + "pricingLevelId": 1, + "pricingLevel": "Property", + "pricingLevelReferenceId": 1122860, + "chargeUsageId": 2, + "chargeUsage": "Amenity", + "chargeTimingId": 307, + "chargeTiming": "Monthly", + "chargeCodeTypeId": 2, + "chargeCodeType": "Rent", + "chargeCodeId": 238621, + "chargeCode": "Amenity Rent", + "chargeAmount": "11.00", + "taxAmount": "0.00" + } + ] + } + }, + { + "id": "12345", + "moveInDate": "2020-05-13", + "createdOn": "2020-05-13 05:15:36", + "acceptedOn": "2020-05-13", + "expiresOn": "2020-05-14 05:15:36", + "isSelected": "0", + "buildingId": "12345", + "buildingName": "Building B", + "floorPlanId": "12345", + "floorPlanName": "Three Bedroom", + "unitNumber": "34", + "numberOfBedRooms": "3", + "numberOfBathRooms": "2.0000", + "leaseTerms": { + "leaseTerm": [ + { + "id": "2", + "termMonth": "9", + "quoteAmount": "5281.00" + } + ] + }, + "quoteProvisions": { + "quoteProvision": [ + { + "id": 1937, + "name": "50% discount till jun 2024" + }, + { + "id": 1938, + "name": "25% discount by Aug 2024." + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "sendLeadsSuccessExample": { + "summary": "sendLeads", + "value": { + "requestId": "15", + "code": 200, + "result": { + "prospects": { + "prospect": [ + { + "node": "1", + "applicationId": "18112280", + "applicantId": "20429586", + "status": "Success", + "message": "Lead inserted successfully.", + "applicants": { + "applicant": [ + { + "id": "20429586", + "firstName": "Gail", + "lastName": "Norberto" + } + ] + } + } + ] + } + } + } + }, + "sendMitsLeadsSuccessExample": { + "summary": "sendMitsLeads", + "value": { + "requestId": "15", + "result": { + "Prospects": { + "Prospect": [ + { + "@attributes": { + "node": "1", + "reference_id": "1253581", + "applicant_id": "1246084", + "status": "Success", + "message": "Lead inserted successfully." + } + }, + { + "@attributes": { + "node": "2", + "reference_id": "1253582", + "applicant_id": "1354178", + "status": "Success", + "message": "Lead inserted successfully." + } + } + ] + } + } + } + }, + "updateLeads_r1_SuccessExample": { + "summary": "updateLeads(r1)", + "value": { + "requestId": "15", + "result": { + "Prospects": { + "Prospect": [ + { + "@attributes": { + "node": "1", + "reference_id": "123456", + "applicant_id": "12345", + "status": "Success", + "message": "Lead updated successfully." + } + } + ] + } + } + } + }, + "updateLeads_r2_SuccessExample": { + "summary": "updateLeads(r2)", + "value": { + "requestId": "15", + "code": 200, + "result": { + "prospects": [ + { + "node": "1", + "status": "Success", + "message": "Lead updated successfully." + } + ] + } + } + }, + "cancelLeaseSuccessExample": { + "summary": "cancelLease", + "value": { + "requestId": "15", + "code": 200, + "result": { + "status": "success", + "message": "Lease Cancelled successfully." + } + } + }, + "getEvictedLeasesSuccessExample": { + "summary": "getEvictedLeases", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "evictedLeases": { + "summary": { + "generationTimeStamp": "06/28/2017T04:12:23", + "SourceOrganization": "Entrata Inc", + "totalProperties": "1", + "totalLeaseFiles": 37, + "TotalTenants": 60, + "TotalOpenAmount": "688929.50" + }, + "propertyFiles": { + "propertyFile": { + "property": { + "id": 123456, + "name": "13th North Parkways Property", + "address": [ + { + "@attributes": { + "addressType": "Primary" + }, + "address": "50 North 100 West", + "city": "Provo", + "country": "US", + "state": "TX", + "postalCode": "89123" + } + ], + "phone": [ + { + "@attributes": { + "phoneType": "Office" + }, + "phoneNumber": "8019013023" + }, + { + "@attributes": { + "phoneType": "Other" + }, + "phoneNumber": "(857) 757-8558" + } + ] + }, + "leaseFiles": { + "leaseFile": [ + { + "leaseId": 5715080, + "evictionStatus": "Evicted", + "moveInDate": "06/02/2014", + "evictionStartDate": "02/26/2015", + "evictionDate": "12/03/2015", + "leaseBegin": "06/02/2014", + "leaseEnd": "09/30/2023", + "monthlyRentAmount": "13.00", + "rentDueFromDate": "06/01/2014", + "rentDueToDate": "06/01/2017", + "buildingName": "Live", + "unit": { + "unitNumber": "MP4-D", + "address": { + "@attributes": { + "addressType": "Primary" + }, + "address": "MP,PM" + }, + "city": "PMPM", + "country": "US", + "state": "AL", + "postalCode": "52252" + }, + "tenants": { + "tenant": [ + { + "customerId": 6953693, + "firstName": "New", + "lastName": "Lwersafd", + "customerType": "Primary", + "phone": [ + { + "@attributes": { + "phoneType": "cell" + }, + "phoneNumber": "2133211231" + } + ], + "dateOfBirth": "12/12/1950", + "ssn": "111223333" + } + ] + }, + "transactions": { + "transaction": [ + { + "transactionId": 145837339, + "transactionDate": "06/01/2017", + "description": "Application Fee - Monthly Fee Posted from 06/01/2017 to 06/30/2017", + "transactionType": "Charge", + "transactionAmount": "3.00", + "openAmount": "3.00" + } + ] + } + } + ] + } + } + } + } + } + } + } + }, + "getExpiringLeasesSuccessExample": { + "summary": "getExpiringLeases", + "value": { + "response": { + "requestId": "15", + "result": { + "Leases": { + "Lease": [ + { + "@attributes": { + "Id": 5641482 + }, + "Resident": { + "@attributes": { + "Id": 4940016 + }, + "Name": "Sample Name", + "PhoneNumber": "1234567891", + "EmailAddress": "sample_name@example.com", + "Address": { + "StreetLine1": "Street Line1", + "StreetLine2": "Street Line1", + "City": "City Name", + "StateCode": "AE", + "PostalCode": "12345" + } + }, + "Unit": "14", + "LeaseStatus": "Current", + "LeaseStarts": "02/01/2013", + "LeaseExpires": "02/27/2013" + }, + { + "@attributes": { + "Id": 234234323 + }, + "Resident": { + "@attributes": { + "Id": 4759431 + }, + "Name": "Sample Name", + "PhoneNumber": "1234567891", + "Address": { + "StreetLine1": "Current Address", + "City": "Los Angeles", + "StateCode": "CA", + "PostalCode": "56666" + } + }, + "LeaseStatus": "Current", + "LeaseStarts": "09/06/2011", + "LeaseExpires": "02/27/2013" + }, + { + "@attributes": { + "Id": 343543434 + }, + "Resident": { + "@attributes": { + "Id": 5868583 + }, + "Name": "Sample Test", + "PhoneNumber": "123123123123", + "Address": { + "StreetLine1": "Sample Street1", + "StreetLine2": "Sample Street2", + "City": "City", + "StateCode": "AL", + "PostalCode": "54623" + } + }, + "LeaseStatus": "Notice", + "LeaseStarts": "08/09/2012", + "NoticeDate": "02/11/2014", + "LeaseExpires": "02/27/2013" + } + ] + } + } + } + } + }, + "getLeaseActivitiesSuccessExample": { + "summary": "getLeaseActivities", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "events": [ + { + "eventId": 123456, + "typeId": 3, + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": 123456, + "type": "Call - Incoming", + "getDataReferenceId": 123456, + "date": "YYYY-MM-DD", + "callData": { + "callId": "123456", + "callFrom": "+1334444444", + "ringThrough": "+1334444444", + "duration": "25", + "callStatus": "Voicemail Left", + "audioLink": "http://test.in" + }, + "eventResultId": 123456, + "eventResult": "XYZ", + "unitSpaceIds": 123456, + "eventReasons": "XYZ" + }, + { + "eventId": 123456, + "typeId": 2, + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": 123456, + "type": "Email - Outgoing", + "subtypeId": 123, + "getDataReferenceId": 123456, + "date": "YYYY-MM-DD", + "Comments": "Self-Guided Tour Scheduled", + "eventResultId": 123456, + "eventResult": "XYZ", + "unitSpaceIds": 123456, + "eventReasons": "Outgoing Email to testsf46 test" + }, + { + "eventId": 123456, + "typeId": 2, + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": 123456, + "type": "Email - Outgoing", + "subtypeId": 123, + "getDataReferenceId": 123456, + "date": "YYYY-MM-DD", + "Comments": "Test email from pp", + "eventResultId": 123456, + "eventResult": "XYZ", + "unitSpaceIds": 123456, + "eventReasons": "Outgoing Email to testsf46 test" + }, + { + "eventId": 123456, + "typeId": 17, + "leaseId": 123456, + "leaseIntervalId": 123456, + "applicantId": 123456, + "type": "Schedule appointment", + "subtypeId": 123, + "getDataReferenceId": 123456, + "date": "YYYY-MM-DD", + "appointmentEventId": 123456, + "Comments": "Test email from pp", + "eventResultId": 123456, + "eventResult": "XYZ", + "unitSpaceIds": 123456, + "eventReasons": "Schedule appointment to testsf46 test" + } + ] + } + } + } + }, + "getLeaseDetails_r1_SuccessExample": { + "summary": "getLeaseDetails(r1))", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "leaseId": 12345678, + "name": "Resident Name", + "propertyUnitId": 4115010, + "unitNumber": "A-2", + "addOns": { + "assignableItems": { + "assignableItem": [ + { + "addOnType": "Assignable Items", + "addOnCategory": "Keys", + "addOnGroup": "Keys", + "addOnName": "Keys", + "leaseStatusType": "Current", + "startDate": "01/17/2017", + "endDate": "05/15/2017", + "agent": "Agent One" + } + ] + }, + "rentableItems": { + "rentableItem": [ + { + "addOnType": "Rentable Items", + "addOnCategory": "Garage", + "addOnGroup": "Garage", + "addOnName": "Garage", + "leaseStatusType": "Future", + "startDate": "01/17/2017", + "endDate": "05/15/2017", + "agent": "Agent One" + } + ] + }, + "services": { + "service": [ + { + "addOnType": "Services", + "addOnCategory": "Full Furnishing", + "addOnGroup": "Full Furnishing", + "addOnName": "Full Furnishing", + "leaseStatusType": "Future", + "startDate": "01/17/2017", + "endDate": "05/15/2017", + "agent": "Agent One" + } + ] + } + }, + "scheduledCharges": { + "recurringCharge": [ + { + "leaseIntervalStatus": "Current", + "leaseIntervalType": "Application", + "leaseStartDate": "05/16/2016", + "leaseEndDate": "05/15/2017", + "activeScheduledCharges": { + "activeScheduledCharge": [ + { + "id": 16460069, + "arCodeId": 137782, + "chargeCode": "Bldg Maintenance CAM", + "chargeTiming": "Monthly", + "chargeUsage": "Base", + "chargeStartDate": "05/16/2016", + "chargeEndDate": "End During Move-Out", + "postedThrough": null, + "amount": " $33.00" + } + ] + } + } + ], + "oneTimeCharge": [ + { + "leaseIntervalStatus": "Current", + "leaseIntervalType": "Application", + "leaseStartDate": "05/16/2016", + "leaseEndDate": "05/15/2017", + "activeScheduledCharges": { + "activeScheduledCharge": [ + { + "id": 164698562, + "arCodeId": 142062, + "chargeCode": "123 Rent", + "chargeTiming": "Renewal Start", + "chargeUsage": "Base", + "chargeStartDate": "01/17/2017", + "postedThrough": null, + "amount": " $10.00" + } + ] + } + } + ], + "conditionalCharge": [ + { + "leaseIntervalStatus": "Current", + "leaseIntervalType": "Application", + "leaseStartDate": "05/16/2016", + "leaseEndDate": "05/15/2017", + "activeScheduledCharges": { + "activeScheduledCharge": [ + { + "id": 85623478, + "arCodeId": 179104, + "chargeCode": "10aug", + "chargeTiming": null, + "chargeUsage": "Base", + "chargeStartDate": "01/17/2017", + "postedThrough": null, + "amount": " $10.00" + } + ] + } + } + ] + } + } + } + } + }, + "getLeaseDetails_r2_SuccessExample": { + "summary": "getLeaseDetails(r2)", + "value": { + "requestId": "15", + "code": 200, + "result": { + "leases": { + "lease": { + "leaseId": "12269740", + "name": "Ggkl Kkkkk", + "propertyUnitId": "3980420", + "unitNumber": "6285-D", + "addOns": { + "rentableItems": { + "rentableItem": { + "addOnId": 85993, + "addOnType": "Rentable Items", + "addOnCategory": "Furniture", + "addOnGroup": "Furniture", + "addOnName": "love sack", + "leaseStatusType": "Past", + "startDate": "12/08/2013", + "endDate": "12/31/1969", + "agent": "sanjay dhakad" + } + } + }, + "scheduledCharges": { + "recurringCharge": [ + { + "leaseIntervalId": "123456", + "leaseIntervalStatus": "Notice", + "leaseIntervalType": "Month to Month", + "leaseStartDate": "08/01/2017", + "leaseEndDate": "11/09/2017" + }, + { + "leaseIntervalId": "123456", + "leaseIntervalStatus": "Past", + "leaseIntervalType": "Application", + "leaseStartDate": "08/25/2016", + "leaseEndDate": "07/31/2017", + "installments": { + "installment": { + "installmentName": "1st Half", + "installmentStartDate": "08/01/2016", + "installmentEndDate": "01/31/2017", + "charges": { + "charge": { + "arCodeId": "120044", + "chargeCode": "HarishRent", + "chargeTiming": "Monthly", + "chargeUsage": "Amenity", + "chargeStartDate": "08/01/2016", + "chargeEndDate": "01/31/2017", + "lastPosted": "01/01/2017", + "postedThrough": "01/31/2017", + "amount": "$222.00" + } + } + } + }, + "activeScheduledCharges": { + "activeScheduledCharge": { + "arCodeId": "1858", + "chargeCode": "AR's Rent", + "chargeTiming": "Monthly", + "chargeUsage": "Amenity", + "chargeStartDate": "08/01/2016", + "chargeEndDate": "01/31/2017", + "lastPosted": "01/01/2017", + "postedThrough": "01/31/2017", + "amount": "$10.00" + } + }, + "pastScheduledCharges": { + "pastScheduledCharge": { + "arCodeId": "120044", + "chargeCode": "HarishRent", + "chargeTiming": "Monthly", + "chargeUsage": "Amenity", + "chargeStartDate": "08/01/2016", + "postedThrough": "Deleted - Never Posted", + "amount": "$222.00" + } + } + } + ], + "oneTimeCharge": [ + { + "leaseIntervalId": "123456", + "leaseIntervalStatus": "Notice", + "leaseIntervalType": "Month to Month", + "leaseStartDate": "08/01/2017", + "leaseEndDate": "11/09/2017" + }, + { + "leaseIntervalId": "123456", + "leaseIntervalStatus": "Past", + "leaseIntervalType": "Application", + "leaseStartDate": "08/25/2016", + "leaseEndDate": "07/31/2017", + "activeScheduledCharges": { + "activeScheduledCharge": { + "arCodeId": "140465", + "chargeCode": "Adjustment", + "chargeTiming": "Application Completed", + "chargeUsage": "Base", + "chargeStartDate": "10/14/2015", + "postedThrough": {}, + "amount": "$123.45" + } + }, + "pastScheduledCharges": { + "pastScheduledCharge": { + "arCodeId": "120044", + "chargeCode": "HarishRent", + "chargeTiming": "Move In", + "chargeUsage": "Amenity", + "chargeStartDate": "08/25/2016", + "chargeEndDate": "End During Move-Out", + "lastPosted": "09/22/2017", + "postedThrough": "09/22/2017", + "amount": "$100.00" + } + } + } + ] + } + } + } + } + } + }, + "getLeaseDocumentsSuccessExample": { + "summary": "getLeaseDocuments", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "LeaseDocuments": { + "LeaseDocument": { + "3922962": { + "@attributes": { + "Id": 3922962 + }, + "AppliesTo": "All", + "Type": "Transfer Document (Transfer Document - UTS)", + "Title": "Scheduled Transfer Statement", + "Name": "transfer_statement_1419410849_1426025528.pdf", + "Path": "transfer_statement/2014/12/24/10548763/scheduled_transfer/", + "FileData": "", + "AddedOn": "12/24/2014 01:47:33" + }, + "4037161": { + "@attributes": { + "Id": 4037161 + }, + "AppliesTo": "All", + "Type": "Upload (Financial Move Out Statement - FMOS)", + "Title": "Move_Out_Statement_01-29-2015_02.00.pdf", + "Name": "Move_Out_Statement_01-29-2015_02.00.pdf", + "Path": "financial_move_out_statements/10649843/", + "FileData": "", + "AddedOn": "06/22/2016 03:52:02" + }, + "4094808": { + "@attributes": { + "Id": 4094808 + }, + "AppliesTo": "All", + "Type": "Upload (Financial Move Out Statement - FMOS)", + "Title": "Move_Out_Statement_02-12-2015_21.41.pdf", + "Name": "Move_Out_Statement_02-12-2015_21.41.pdf", + "Path": "financial_move_out_statements/10649843/", + "FileData": "", + "AddedOn": "06/22/2016 03:52:02" + } + } + } + } + } + } + }, + "getLeaseDocumentsListSuccessExample": { + "summary": "getLeaseDocumentsList", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "leaseDocuments": { + "leaseDocument": [ + { + "id": 13862207, + "type": "eSign: Lease (eSign: Renewal Lease - LP)", + "name": "lease_document_13155819_1535017430.pdf", + "title": "Renewal Offer", + "leaseId": "1234567", + "externalLeaseId": "123456" + }, + { + "id": 13862202, + "type": "Renewal Offer Accepted (Renewal Offer Accepted - ROA)", + "name": "renewal_offers_1535017403_492398410.pdf", + "title": "Renewal Offer", + "leaseId": "1234567", + "externalLeaseId": "123456" + }, + { + "id": 13862201, + "type": "Renewal Offer Sent (Renewal Offer Sent - ROS)", + "name": "renewal_offers_1535017394_1085698056.pdf", + "title": "Renewal Offer", + "leaseId": "1234567", + "externalLeaseId": "123456" + } + ] + } + } + } + } + }, + "getLeasePickListSuccessExample": { + "summary": "getLeasePickList", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "leaseStatusTypes": { + "leaseStatusType": [ + { + "@attributes": { + "id": 1, + "name": "Applicant", + "type": "NA" + } + }, + { + "@attributes": { + "id": 2, + "name": "Cancelled", + "type": "NA" + } + }, + { + "@attributes": { + "id": 3, + "name": "Future", + "type": "NA" + } + }, + { + "@attributes": { + "id": 4, + "name": "Current", + "type": "Active" + } + }, + { + "@attributes": { + "id": 5, + "name": "Notice", + "type": "Active" + } + }, + { + "@attributes": { + "id": 6, + "name": "Past", + "type": "Completed" + } + } + ] + }, + "leaseFileTypes": { + "leaseFileType": [ + { + "@attributes": { + "id": 1, + "systemCode": "LEASE", + "name": "Lease Agreement" + } + }, + { + "@attributes": { + "id": 2, + "systemCode": "LD", + "name": "Lease Document" + } + }, + { + "@attributes": { + "id": 3, + "systemCode": "PRES", + "name": "Pre-Signed" + } + }, + { + "@attributes": { + "id": 4, + "systemCode": "PS", + "name": "Partially Signed" + } + }, + { + "@attributes": { + "id": 5, + "name": "Custom Document Type" + } + } + ] + }, + "chargeTimings": { + "chargeTiming": [ + { + "@attributes": { + "id": 302, + "name": "Daily" + } + }, + { + "@attributes": { + "id": 303, + "name": "Weekly" + } + }, + { + "@attributes": { + "id": 305, + "name": "Twice Per Month" + } + }, + { + "@attributes": { + "id": 307, + "name": "Monthly" + } + } + ] + }, + "chargeCodeTypes": { + "chargeCodeType": [ + { + "@attributes": { + "id": 2, + "name": "Rent", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": 3, + "name": "Other Income", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": 4, + "name": "Expense", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": 5, + "name": "Asset", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": 6, + "name": "Equity", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": 7, + "name": "Deposit", + "allowed_charge_timing_ids": "" + } + }, + { + "@attributes": { + "id": 9, + "name": "Other Liability", + "allowed_charge_timing_ids": "307" + } + } + ] + }, + "eventTags": { + "eventTag": [ + { + "@attributes": { + "id": 702, + "name": "Amenity" + } + }, + { + "@attributes": { + "id": 700, + "name": "Tools R1 Test" + } + } + ] + } + } + } + } + }, + "getLeases_r1_SuccessExample": { + "summary": "getLeases(r1)", + "value": { + "requestId": "15", + "code": 200, + "result": { + "leases": { + "lease": [ + { + "id": "123456", + "leaseStatusTypeId": "2", + "leaseSubStatus": "Month To Month", + "leaseType": "Standard", + "transferLeaseId": "123456", + "transferLeasePropertyId": "123456", + "leaseIntervalStatus": "Notice", + "occupancyTypeId": "2", + "occupancyType": "Conventional", + "isMonthToMonth": "1", + "leaseIntervalId": "123456", + "buildingId": "1234", + "buildingName": "B1", + "floorPlanId": "123456", + "floorPlanName": "F1", + "unitId": "123456", + "unitNumberSpace": "N1", + "unitSpaceId": "123456", + "spaceConfiguration": "Private", + "terminationStartDate": "YYYY-MM-DD", + "leaseIntervals": { + "leaseInterval": [ + { + "id": "123456", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD", + "leaseIntervalTypeId": "2", + "leaseIntervalTypeName": "Month", + "leaseIntervalStatusTypeId": "2", + "leaseIntervalStatusTypeName": "Type", + "leaseApprovedOn": "YYYY-MM-DD", + "applicationCompletedOn": "YYYY-MM-DD", + "applicationId": "123" + } + ] + }, + "customers": { + "customer": [ + { + "id": "123456", + "customerType": "Primary", + "firstName": "fname", + "lastName": "lname", + "leaseCustomerStatus": "Notice", + "idType": "License", + "idNumber": "1234", + "addresses": { + "address": { + "addressType": "Current", + "email": "test@lead.lcl", + "additionalEmail": "testing@lead.lcl" + } + }, + "phone": { + "phoneType": "personal", + "phoneNumber": "1234567890", + "countryCode": 1 + }, + "moveInDate": "yyyy-mm-dd", + "moveOutDate": "yyyy-mm-dd" + } + ] + }, + "contract": { + "id": "xxxx", + "name": "New Contract", + "reservationCode": "RevCode", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD" + }, + "pets": { + "pet": [ + { + "customerId": "123456", + "petType": "Dogs", + "age": "2", + "color": "Black", + "breed": "123", + "name": "Dog", + "weight": "2", + "gender": "M", + "isAssistanceAnimal": "false", + "moveInDate": "YYYY-MM-DD" + } + ] + }, + "scheduledCharges": { + "scheduledCharge": [ + { + "id": "1234", + "leaseIntervalId": "2", + "chargeCodeId": "1234", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD", + "frequency": "Monthly", + "chargeType": "Base Rent", + "chargeCode": "Charge Code", + "amount": "20.00" + } + ] + }, + "specials": { + "special": [ + { + "id": "12019938", + "name": "Test rishi", + "type": "1", + "typeName": "Standard", + "amount": "-500.00", + "chargeTimingId": "302", + "chargeTiming": "Daily", + "status": "Available", + "leaseIntervalId": "21712576" + }, + { + "id": "12019939", + "name": "Test Gift Incentive", + "type": "2", + "typeName": "Gift Incentive", + "amount": "50.00", + "status": "Available", + "leaseIntervalId": "21712576" + } + ] + }, + "leaseActivities": { + "leasesActivity": [ + { + "date": "YYYY-MM-DD", + "eventType": "Lease From" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Lease To" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Financial Move Out" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Application", + "description": "Lease Generated On", + "comment": "Test Comment" + } + ] + }, + "roommates": { + "roommate": [ + { + "name": "Pitt, Brad", + "email": "pitt@brad.lcl", + "leaseId": "123456" + } + ] + }, + "arTransactions": { + "arTransaction": [ + { + "id": "286278118", + "transactionTypeId": "3", + "chargeCodeId": "140464", + "chargeCodeName": "sadf", + "leaseIntervalId": "22071607", + "transactionDate": "02/08/2021", + "postDate": "02/08/2021", + "postMonth": "03/01/2021", + "balanceDue": "5", + "amount": "5", + "amountPaid": "0" + }, + { + "id": "286166942", + "transactionTypeId": "3", + "chargeCodeId": "140464", + "chargeCodeName": "sadf", + "leaseIntervalId": "22071607", + "transactionDate": "02/07/2021", + "postDate": "02/07/2021", + "postMonth": "03/01/2021", + "balanceDue": "15", + "amount": "15", + "amountPaid": "0" + } + ] + } + }, + { + "id": "123456", + "leaseStatusTypeId": "2", + "leaseSubStatus": "In Collection", + "leaseType": "Standard", + "transferLeaseId": "123456", + "transferLeasePropertyId": "123456", + "leaseIntervalStatus": "Past", + "occupancyTypeId": "2", + "occupancyType": "Conventional", + "isMonthToMonth": "1", + "leaseIntervalId": "123456", + "buildingId": "1234", + "buildingName": "B1", + "floorPlanId": "123456", + "floorPlanName": "F1", + "unitId": "123456", + "unitNumberSpace": "N1", + "unitSpaceId": "123456", + "spaceConfiguration": "Private", + "collectionsStartDate": "YYYY-MM-DD", + "leaseIntervals": { + "leaseInterval": [ + { + "id": "123456", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD", + "leaseIntervalTypeId": "2", + "leaseIntervalTypeName": "Month", + "leaseIntervalStatusTypeId": "2", + "leaseIntervalStatusTypeName": "Type", + "leaseApprovedOn": "YYYY-MM-DD", + "applicationCompletedOn": "YYYY-MM-DD", + "applicationId": "123" + } + ] + }, + "customers": { + "customer": [ + { + "id": "123456", + "customerType": "Primary", + "firstName": "fname", + "lastName": "lname", + "leaseCustomerStatus": "Notice", + "dateOfBirth": "YYYY-MM-DD", + "idType": "License", + "idNumber": "1234", + "addresses": { + "address": { + "addressType": "Current", + "email": "test@lead.lcl", + "additionalEmail": "testing@lead.lcl" + } + }, + "phone": { + "phoneType": "personal", + "phoneNumber": "1234567890", + "countryCode": 1 + }, + "moveInDate": "yyyy-mm-dd", + "moveOutDate": "yyyy-mm-dd" + } + ] + }, + "contract": { + "id": "xxxx", + "name": "New Contract", + "reservationCode": "RevCode", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD" + }, + "pets": { + "pet": [ + { + "customerId": "123456", + "petType": "Dogs", + "age": "2", + "color": "Black", + "breed": "123", + "name": "Dog", + "weight": "2", + "gender": "M", + "isAssistanceAnimal": "false", + "moveInDate": "YYYY-MM-DD" + } + ] + }, + "scheduledCharges": { + "scheduledCharge": [ + { + "id": "1234", + "leaseIntervalId": "2", + "chargeCodeId": "1234", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD", + "frequency": "Monthly", + "chargeType": "Base Rent", + "chargeCode": "Charge Code", + "amount": "20.00" + } + ] + }, + "specials": { + "special": [ + { + "id": "12019938", + "name": "Test rishi", + "type": "1", + "typeName": "Standard", + "amount": "-500.00", + "chargeTimingId": "302", + "chargeTiming": "Daily", + "status": "Available", + "leaseIntervalId": "21712576" + }, + { + "id": "12019939", + "name": "Test Gift Incentive", + "type": "2", + "typeName": "Gift Incentive", + "amount": "50.00", + "status": "Available", + "leaseIntervalId": "21712576" + } + ] + }, + "leaseActivities": { + "leasesActivity": [ + { + "date": "YYYY-MM-DD", + "eventType": "Lease From" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Lease To" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Financial Move Out" + }, + { + "date": "YYYY-MM-DD", + "eventType": "Application", + "description": "Lease Generated On", + "comment": "Test Comment" + } + ] + }, + "roommates": { + "roommate": [ + { + "name": "Pitt, Brad", + "email": "pitt@brad.lcl", + "leaseId": "123456" + } + ] + }, + "arTransactions": { + "arTransaction": [ + { + "id": "286278118", + "transactionTypeId": "3", + "chargeCodeId": "140464", + "chargeCodeName": "sadf", + "leaseIntervalId": "22071607", + "transactionDate": "02/08/2021", + "postDate": "02/08/2021", + "postMonth": "03/01/2021", + "balanceDue": "5", + "amount": "5", + "amountPaid": "0" + }, + { + "id": "286166942", + "transactionTypeId": "3", + "chargeCodeId": "140464", + "chargeCodeName": "sadf", + "leaseIntervalId": "22071607", + "transactionDate": "02/07/2021", + "postDate": "02/07/2021", + "postMonth": "03/01/2021", + "balanceDue": "15", + "amount": "15", + "amountPaid": "0" + } + ] + } + } + ] + } + } + } + }, + "getLeases_r2_SuccessExample": { + "summary": "getLeases(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "currencyCode": "USD", + "leases": { + "lease": [ + { + "id": "15323250", + "leaseStatusTypeId": "3", + "propertyId": "550592", + "moveInDate": "12/11/2019", + "moveOutDate": "12/14/2019", + "transferDate": "12/14/2019", + "propertyName": "Valhalla Estates V2", + "leaseIntervalStatus": "Future", + "occupancyTypeId": "12", + "occupancyType": "Flexible", + "isMonthToMonth": 0, + "leaseIntervalId": "21917305", + "floorPlanId": "903825", + "floorPlanName": "Three Bedroom", + "paymentAllowanceType": "Allow All Payment Types", + "spaceConfiguration": "Private", + "customers": { + "customer": [ + { + "id": 31061984, + "customerType": "Primary", + "firstName": "12Dec1", + "lastName": "12Dec1", + "nameFull": "12Dec1, 12Dec1", + "emailAddress": "skondhalkar_xento.com@r.com", + "leaseCustomerStatus": "Future", + "moveInDate": "12/11/2019", + "paymentAllowanceType": "Allow All Payment Types", + "moveOutDate": "12/14/2019", + "phones": { + "phone": [ + { + "phoneTypeName": "Primary", + "phoneType": "personal", + "phoneNumber": "+1 4564565464", + "countryCode": 1 + } + ] + }, + "isActiveBankruptcy": 1, + "bankruptcyDate": "08/22/2025", + "bankruptcyNote": "XYZ" + } + ] + }, + "unitId": "4486096", + "unitSpaces": { + "unitSpace": [ + { + "unitSpaceId": 5219776, + "unitSpace": "AB1-J" + } + ] + }, + "leaseIntervals": { + "leaseInterval": [ + { + "id": 21917305, + "startDate": "12/11/2019", + "endDate": "12/14/2019", + "leaseIntervalTypeId": 1, + "leaseIntervalTypeName": "Application", + "leaseIntervalStatusTypeId": 3, + "intervalDateTime": "01/31/2022 23:16:51.110301 MST", + "applications": { + "application": [ + { + "leaseTerm": "Hospitality lease term", + "leaseIntervalTypeId": 1, + "leaseStartDate": "12/11/2019", + "leaseEndDate": "12/14/2019", + "applicationApprovedOn": "YYYY-MM-DD" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "getMitsCollectionsSuccessExample": { + "summary": "getMitsCollections", + "value": { + "response": { + "code": 200, + "result": { + "MITS-Collections": { + "Summary": { + "MITSDocVersion": "3.0", + "GenerationTimeStamp": "2020-08-19T09:05:20", + "SourceOrganization": "Entrata Inc", + "TotalProperties": "1", + "TotalLeaseFiles": 7, + "TotalTenants": 9, + "TotalOpenAmount": "5555555581301.66" + }, + "PropertyFiles": { + "PropertyFile": { + "Property": { + "Identification": { + "@attributes": { + "IDType": "Property ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 172775 + }, + "MarketingName": "0001 East Park Property", + "Address": [ + { + "@attributes": { + "AddressType": "other" + }, + "Description": "Primary address", + "Address": "4300 Pennsylvania Ave, street, road", + "City": "Dallas", + "State": "TX", + "PostalCode": "75210", + "Country": "US", + "CountyName": "Unite States " + }, + { + "@attributes": { + "AddressType": "other" + }, + "Description": "Physical address", + "Address": "Add line1, Add line2, Add line2", + "City": "Pune", + "State": "And", + "PostalCode": "411057", + "Country": "IN" + }, + { + "@attributes": { + "AddressType": "other" + }, + "Description": "Marketing address", + "Address": "1000 Yanggao N Rd, Pudong, ", + "City": "Shanghai", + "State": "Sha", + "PostalCode": "200137", + "Country": "CN", + "CountyName": "" + }, + { + "@attributes": { + "AddressType": "other" + }, + "Description": "Marketing address", + "Address": "1738 Zhongxing Rd, Huo Che Zhan, ", + "City": "\u95f8\u5317\u533a", + "State": "Sha", + "PostalCode": "200070", + "Country": "CN", + "CountyName": "1738 Zhongxing Rd" + }, + { + "@attributes": { + "AddressType": "other" + }, + "Description": "PO Box", + "Address": "Hotel in France, 7 Cours du Danube, ", + "City": "Serris", + "State": "", + "PostalCode": "77700", + "Country": "FR" + } + ], + "Phone": [ + { + "@attributes": { + "PhoneType": "office" + }, + "PhoneDescription": "Office phone number", + "PhoneNumber": "1111888888" + }, + { + "@attributes": { + "PhoneType": "fax" + }, + "PhoneDescription": "Fax number", + "PhoneNumber": "3214565661" + }, + { + "@attributes": { + "PhoneType": "other" + }, + "PhoneDescription": "Resident Office", + "PhoneNumber": "1888888888" + }, + { + "@attributes": { + "PhoneType": "other" + }, + "PhoneDescription": "Maintenance Emergency Phone Number", + "PhoneNumber": "9276546546" + }, + { + "@attributes": { + "PhoneType": "cell" + }, + "PhoneDescription": "Mobile phone number", + "PhoneNumber": "2123129888" + } + ] + }, + "PropertyClient": { + "Identification": { + "IDValue": 235, + "OrganizationName": "Demo Account" + }, + "CompanyName": "Demo Account" + }, + "LeaseFiles": { + "LeaseFile": [ + { + "Identification": { + "@attributes": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 14055346 + }, + "CollectionStatus": "true", + "CollectionStatusLastChangeDate": "2020-01-15", + "MoveInDate": "2018-01-07", + "MoveOutDate": "2019-10-15", + "NoticeToVacateDate": "2019-08-06", + "LeaseBegin": "2019-07-24", + "LeaseEnd": "2020-07-31", + "FmoProcessedOn": "2018-04-30", + "RentDueFromDate": "2018-01-08", + "RentDueToDate": "2019-03-28", + "LastPaymentDate": "2019-05-29", + "TotalLeaseOpenAmount": "262.08", + "BuildingName": "Building A", + "Unit": { + "UnitNumber": "Gx6 unit", + "Address": { + "@attributes": { + "AddressType": "other" + }, + "State": "AE", + "Country": "US" + } + }, + "Tenants": [ + { + "PersonDetails": { + "Identification": { + "@attributes": { + "IDType": "Customer ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 30279157 + }, + "Name": { + "FirstName": "0011Payment", + "LastName": "0011Ree" + }, + "Address": [ + { + "@attributes": { + "AddressType": "other" + }, + "Description": "Primary address", + "Address": "201 SE SCENIC VIEW DR, df, df", + "City": "Chandler", + "State": "--", + "PostalCode": "840956", + "Country": "CN", + "Email": "ppakhale+01@xento.com" + }, + { + "@attributes": { + "AddressType": "forwarding" + }, + "Description": "Forwarding address", + "Address": "test", + "City": "test", + "Country": "US", + "State": "ID", + "PostalCode": "12345", + "Email": "ppakhale+01@xento.com" + } + ], + "Phone": [ + { + "@attributes": { + "PhoneType": "cell" + }, + "PhoneNumber": "6505541317" + } + ] + }, + "DateOfBirth": "1988-01-08" + } + ], + "FileTransactions": [ + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 242952611 + }, + "TransDate": "2019-12-19", + "TransTypeDesc": "Accelerated Rent Income - fee posted", + "TransType": "Charge", + "TransAmount": "60.00", + "OpenAmount": "60.00" + }, + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 239054056 + }, + "TransDate": "2019-10-15", + "TransTypeDesc": "Tax1 - 20 % tax on Accelerated Rent Income for transaction ID 239054055.", + "TransType": "Charge", + "TransAmount": "8.00", + "OpenAmount": "8.00" + }, + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 239054061 + }, + "TransDate": "2019-10-01", + "TransTypeDesc": "Tax1 - 20 % tax on Replace Test1 for transaction ID 239054060.", + "TransType": "Charge", + "TransAmount": "6.00", + "OpenAmount": "6.00" + }, + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 224829494 + }, + "TransDate": "2019-03-28", + "TransTypeDesc": "Tax rJ - 10.00 % Tax on Month-to-Month Rent for transaction ID #224829493", + "TransType": "Charge", + "TransAmount": "1.00", + "OpenAmount": "1.00" + }, + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 224829493 + }, + "TransDate": "2019-03-28", + "TransTypeDesc": "Month-to-Month Rent", + "TransType": "Charge", + "TransAmount": "10.00", + "OpenAmount": "10.00" + }, + { + "Identification": { + "@attributes": { + "IDType": "Transaction ID", + "IDRank": "primary", + "IDScopeType": "sender" + }, + "IDValue": 166888502 + }, + "TransDate": "2018-03-01", + "TransTypeDesc": "TestNewRent1 - Monthly Fee Posted from 03/01/2018 to 03/31/2018 - Split into new scheduled charge for month to month interval.", + "TransType": "Charge", + "TransAmount": "4.00", + "OpenAmount": "4.00" + } + ] + } + ] + } + } + } + } + } + } + } + }, + "getMitsLeasesSuccessExample": { + "summary": "getMitsLeases", + "value": { + "response": { + "requestId": "15", + "result": { + "LeaseApplication": { + "Tenant": [ + { + "ResidentType": "Primary", + "Identification": { + "IDType": "Customer ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7572305", + "OrganizationName": "66259" + }, + "LeaseID": { + "Identification": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "123456" + } + }, + "Name": { + "FirstName": "Julanne", + "LastName": "Abernethy" + }, + "Residence": { + "Address": { + "AddressType": "current", + "Address": "2921 Sycamore Springs Drive, Unit # 103", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339", + "Email": "atest@yahoo.com" + } + }, + "Phone": { + "PhoneType": "personal", + "PhoneNumber": "2819795654" + } + }, + { + "ResidentType": "Occupant", + "Identification": { + "IDType": "Customer ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "11118770" + }, + "LeaseID": { + "Identification": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "8680525" + } + }, + "Name": { + "FirstName": "Ben", + "LastName": "Gollehon" + }, + "Residence": { + "Address": { + "AddressType": "current", + "Address": "2921 Sycamore Springs Drive, Unit # 103", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339" + } + }, + "Phone": { + "PhoneType": "personal", + "PhoneNumber": "2815077436" + } + } + ], + "LA_Lease": [ + { + "Identification": [ + { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IsMonthToMonth": "0", + "IDValue": "1234567" + }, + { + "IDType": "Lease Interval ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "5192238" + } + ], + "AccountingData": { + "ChargeSet": { + "Start": "2012-02-01", + "End": "2020-01-01", + "Frequency": "Monthly", + "Charge": { + "ChargeType": "Other", + "Identification": { + "IDType": "Charge ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7449916" + }, + "Label": "Parking", + "Amount": "10.00" + } + } + }, + "LeaseEvents": { + "LeaseEvent": [ + { + "Date": "2014-04-04", + "EventType": "Application" + }, + { + "Date": "2013-02-01", + "EventType": "LeaseSigned" + }, + { + "Date": "2012-02-01", + "EventType": "LeaseFrom" + }, + { + "Date": "2013-01-31", + "EventType": "LeaseTo" + }, + { + "Date": "2011-02-02", + "EventType": "ActualMoveIn" + }, + { + "Date": "2014-01-04", + "EventType": "MoveOutNoticeGiven" + }, + { + "Date": "2014-01-04", + "EventType": "ActualMoveOut", + "MoveOutReason": "Unit transfer." + } + ] + }, + "Property": { + "Identification": { + "IDType": "Property ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "54613", + "OrganizationName": "4218" + }, + "MarketingName": "Elm Grove - OLD", + "Address": { + "AddressType": "other", + "Description": "Primary address", + "Address": "2921 Sycamore Springs Drive", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339", + "Country": "US" + } + }, + "Status": { + "ApprovalStatus": "Current" + }, + "Unit": { + "Identification": { + "IDType": "Property Unit Id", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "123456" + }, + "MarketingName": "TEST-A", + "UnitType": "B-2/1", + "SquareFootType": "internal", + "UnitEconomicStatus": "residential", + "UnitLeasedStatus": "leased", + "NumberOccupants": { + "Total": "2", + "#text": "2" + }, + "CurrentNumberOccupants": { + "Total": "1", + "#text": "1" + }, + "Address": { + "AddressType": "property", + "Description": "Primary address", + "Address": "2921 Sycamore Springs Drive, Unit # 103", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339" + } + } + }, + { + "Identification": [ + { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IsMonthToMonth": "0", + "IDValue": "1234567" + }, + { + "IDType": "Lease Interval ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "5200661" + } + ], + "AccountingData": { + "ChargeSet": [ + { + "Start": "2013-02-16", + "Frequency": "One-Time", + "Charge": { + "ChargeType": "Other", + "Identification": { + "IDType": "Charge ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7504911" + }, + "Label": "Admin Fee", + "Amount": "75.00" + } + }, + { + "Start": "2013-02-16", + "Frequency": "Monthly", + "Charge": [ + { + "ChargeType": "Other", + "Identification": { + "IDType": "Charge ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7504910" + }, + "Label": "Application Fee", + "Amount": "35.00" + }, + { + "ChargeType": "Other", + "Identification": { + "IDType": "Charge ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7504909" + }, + "Label": "Rent", + "Amount": "825.00" + } + ] + }, + { + "Start": "2013-03-01", + "Frequency": "Monthly", + "Charge": { + "ChargeType": "Other", + "Identification": { + "IDType": "Charge ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "7504914" + }, + "Label": "Parking", + "Amount": "10.00" + } + } + ] + }, + "LeaseEvents": { + "LeaseEvent": [ + { + "Date": "2013-02-01", + "EventType": "LeaseSigned" + }, + { + "Date": "2013-02-01", + "EventType": "LeaseFrom" + }, + { + "Date": "2017-07-12", + "EventType": "Other", + "Description": "LeaseGenerated" + }, + { + "Date": "2014-01-31", + "EventType": "LeaseTo" + }, + { + "Date": "2011-02-02", + "EventType": "ActualMoveIn" + }, + { + "Date": "2014-01-04", + "EventType": "MoveOutNoticeGiven" + }, + { + "Date": "2014-01-04", + "EventType": "ActualMoveOut", + "MoveOutReason": "Unit transfer." + } + ] + }, + "Property": { + "Identification": { + "IDType": "Property ID", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "123456" + }, + "MarketingName": "Elm Grove - OLD", + "Address": { + "AddressType": "other", + "Description": "Primary address", + "Address": "2921 Sycamore Springs Drive", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339", + "Country": "US" + } + }, + "Status": { + "ApprovalStatus": "Current" + }, + "Unit": { + "Identification": { + "IDType": "Property Unit Id", + "IDRank": "primary", + "IDScopeType": "sender", + "IDValue": "1234567" + }, + "MarketingName": "TEST-B", + "UnitType": "B-2/1", + "SquareFootType": "internal", + "UnitEconomicStatus": "residential", + "UnitLeasedStatus": "leased", + "NumberOccupants": { + "Total": "2", + "#text": "2" + }, + "CurrentNumberOccupants": { + "Total": "1", + "#text": "1" + }, + "Address": { + "AddressType": "property", + "Description": "Primary address", + "Address": "2921 Sycamore Springs Drive, Unit # 103", + "City": "Kingwood", + "State": "TX", + "PostalCode": "77339" + } + } + } + ] + } + } + } + } + }, + "getParcelAlertsSuccessExample": { + "summary": "getParcelAlerts", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "packageBatches": { + "packageBatch": [ + { + "@attributes": { + "id": "248014", + "name": "dge" + }, + "totalPackages": "2", + "totalPickedUp": "0", + "totalDelivered": "0", + "totalPrint": "0", + "totalResend": "0", + "packageBatchDate": "2016-03-03", + "packages": { + "package": [ + { + "@attributes": { + "id": "1433603" + }, + "leaseId": 11165108, + "customerId": 15200439, + "customerEmailAddress": "fqe@df.coc", + "customerName": "Ergr Erggre", + "packageType": "FedEx", + "packageStatus": "Pending", + "trackingNumber": "rtjert", + "shippingVendor": "FedEx", + "emailedOn": "2016-03-03", + "packageDate": "2016-03-03" + }, + { + "@attributes": { + "id": "1433604" + }, + "leaseId": 12381561, + "customerId": 6957206, + "customerEmailAddress": "smaquinalez@propertysolutions.com", + "customerName": "Lease Term33", + "packageType": "FedEx", + "packageStatus": "Pending", + "trackingNumber": "erwerbwerb", + "shippingVendor": "FedEx", + "emailedOn": "2016-03-03", + "packageDate": "2016-03-03", + "unitSpaceId": 2615515, + "unitNumber": "1001-B" + } + ] + } + }, + { + "@attributes": { + "id": "2435", + "name": null + }, + "totalPackages": "1", + "totalPickedUp": "0", + "totalDelivered": "0", + "totalPrint": "0", + "totalResend": "0", + "packageBatchDate": "2012-12-14", + "packages": { + "package": [ + { + "@attributes": { + "id": "14098" + }, + "leaseId": 5177187, + "customerId": 6247567, + "customerEmailAddress": "kapil1@test.lcl", + "customerName": "Kapil1 Test", + "packageType": "FedEx", + "packageStatus": "Pending", + "trackingNumber": "erwerbwerb", + "shippingVendor": "FedEx", + "emailedOn": "2013-12-31", + "packageDate": "2012-12-14", + "unitSpaceId": 2340137, + "unitNumber": "156", + "printedOn": "2016-03-03" + } + ] + } + } + ] + } + } + } + } + }, + "getRentersInsurancePoliciesSuccessExample": { + "summary": "getRentersInsurancePolicies", + "value": { + "requestId": "15", + "code": 200, + "result": { + "LeaseApplication": { + "Property": { + "Identification": { + "IDValue": "42420", + "OrganizationName": "651", + "@attributes": { + "IDType": "Property ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "MarketingName": "AuraCorp2 - Crystal", + "Address": { + "Description": "Primary address", + "Address": "500 S, 100 W, 100k", + "City": "Provo", + "State": "UT", + "PostalCode": "84601", + "Country": "US", + "@attributes": { + "AddressType": "other" + } + } + }, + "Tenant": [ + { + "Identification": { + "IDValue": "6720012", + "@attributes": { + "IDType": "Customer ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "LeaseID": { + "Identification": { + "IDValue": "5545944", + "@attributes": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + } + }, + "Name": { + "FirstName": "FirstName", + "LastName": "LastName" + }, + "Residence": { + "Address": { + "Address": "500 S, 100 W, 100k", + "City": "Provo", + "State": "UT", + "PostalCode": "84601", + "CountryName": "US", + "@attributes": { + "AddressType": "current" + } + } + } + }, + { + "Identification": { + "IDValue": "6846058", + "@attributes": { + "IDType": "Customer ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "LeaseID": { + "Identification": { + "IDValue": "5645725", + "@attributes": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + } + }, + "Name": { + "FirstName": "FirstName", + "LastName": "LastName" + }, + "Residence": { + "Address": { + "Address": "500 S, 100 W, 100k", + "City": "Provo", + "State": "TX", + "PostalCode": "84601", + "CountryName": "US", + "Email": "nmohite_x.lc@r.com", + "@attributes": { + "AddressType": "current" + } + } + }, + "Phone": { + "PhoneNumber": "1112223333", + "@attributes": { + "PhoneType": "personal" + } + }, + "@attributes": { + "ResidentType": "Primary" + } + } + ], + "LA_Lease": [ + { + "Identification": { + "IDValue": "5545944", + "@attributes": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "Status": { + "ApprovalStatus": "Current" + }, + "Unit": { + "Identification": { + "IDValue": "2512028", + "@attributes": { + "IDType": "Property Unit Id", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "MarketingName": "UK16", + "UnitType": "ZOM 2", + "UnitBedrooms": "2", + "UnitBathrooms": "2", + "SquareFootType": "internal", + "UnitEconomicStatus": "residential", + "UnitLeasedStatus": "leased", + "NumberOccupants": { + "@value": "4", + "@attributes": { + "Total": "4" + } + }, + "BuildingName": "BUL113" + }, + "InsurancePolicies": { + "InsurancePolicy": { + "id": "110292", + "name": "Name", + "unitNumber": "UK16", + "leaseId": "5545944", + "customerId": "6720012", + "customerIds": "29559769,29559768,29475998", + "propertyUnitId": "123456", + "unitSpaceId": "123456", + "provider": "SSIS", + "policyNumber": "RLO1123001040", + "startDate": "05/08/2016", + "endDate": {}, + "liability": "300000", + "deductible": "80", + "personalContents": "50", + "policyTypeId": 6, + "policyTypeName": "Affordable" + } + } + }, + { + "Identification": { + "IDValue": "5645725", + "@attributes": { + "IDType": "Lease ID", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "Status": { + "ApprovalStatus": "Current" + }, + "Unit": { + "Identification": { + "IDValue": "2512032", + "@attributes": { + "IDType": "Property Unit Id", + "IDRank": "primary", + "IDScopeType": "sender" + } + }, + "MarketingName": "UK20", + "UnitType": "ZOM 2", + "UnitBedrooms": "2", + "UnitBathrooms": "2", + "SquareFootType": "internal", + "UnitEconomicStatus": "residential", + "UnitLeasedStatus": "leased", + "NumberOccupants": { + "@value": "4", + "@attributes": { + "Total": "4" + } + }, + "BuildingName": "BUL113" + }, + "InsurancePolicies": { + "InsurancePolicy": { + "id": "109813", + "name": "Name", + "unitNumber": "UK20", + "leaseId": "5645725", + "customerId": "6846058", + "customerIds": "29559769,29559768,29475998", + "propertyUnitId": "123456", + "unitSpaceId": "123456", + "provider": "SSIS", + "policyNumber": "RLO1123000954", + "startDate": "04/23/2016", + "endDate": {}, + "liability": "300000", + "deductible": "10", + "personalContents": "10", + "policyTypeId": 7, + "policyTypeName": "Custom" + } + } + } + ] + } + } + } + }, + "moveInLeaseSuccessExample": { + "summary": "moveInLease", + "value": { + "requestId": "15", + "code": 200, + "result": { + "status": "success", + "message": "Customer moved in successfully." + } + } + }, + "moveOutLeaseSuccessExample": { + "summary": "moveOutLease", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "message": "Lease moved out successfully." + } + } + } + }, + "onNoticeLeaseSuccessExample": { + "summary": "onNoticeLease", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "message": "Successfully placed lease on Notice." + } + } + } + }, + "sendLeaseActivitiesSuccessExample": { + "summary": "sendLeaseActivities", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "events": { + "event": { + "node": "1", + "leaseId": "10873580", + "status": "Success", + "message": "Event inserted successfully." + } + } + } + } + } + }, + "sendLeaseDocumentsSuccessExample": { + "summary": "sendLeaseDocuments", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "files": { + "file": [ + { + "node": "1", + "fileId": "13858364", + "fileName": "file1.pdf", + "status": "Success", + "message": "File uploaded successfully." + }, + { + "node": "2", + "fileId": "1589654", + "fileName": "file2.pdf", + "status": "Success", + "message": "File uploaded successfully." + } + ] + } + } + } + } + }, + "sendLeasesSuccessExample": { + "summary": "sendLeases", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "leases": { + "lease": [ + { + "node": "1", + "leaseId": "123456", + "status": "Success", + "message": "Lease inserted successfully." + } + ] + } + } + } + } + }, + "sendRentersInsurancePolicies_r1_SuccessExample": { + "summary": "sendRentersInsurancePolicies(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "insurancePolicies": { + "insurancePolicy": [ + { + "@attributes": { + "node": "1", + "reference_id": "123456", + "lease_id": "123456", + "customer_id": "123456", + "status": "Success", + "message": "Insurance policy updated successfully." + } + }, + { + "@attributes": { + "node": "2", + "reference_id": "123456", + "lease_id": "123456", + "customer_id": "123456", + "status": "Success", + "message": "Insurance policy inserted successfully." + } + } + ] + } + } + } + } + }, + "sendRentersInsurancePolicies_r2_SuccessExample": { + "summary": "sendRentersInsurancePolicies(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "InsurancePolicies": { + "InsurancePolicy": [ + { + "Node": "1", + "ReferenceId": "123456", + "LeaseId": "123456", + "CustomerId": "123456,123456,123456", + "Status": "Success", + "Message": "Insurance policy updated successfully." + }, + { + "Node": "2", + "ReferenceId": "123456", + "LeaseId": "123456", + "CustomerId": "123456,123456", + "Status": "Success", + "Message": "Insurance policy inserted successfully." + } + ] + } + } + } + } + }, + "sendRoommateGroups_r2_SuccessExample": { + "summary": "sendRoommateGroups(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "roommateGroups": [ + { + "node": 1, + "roommateGroupId": 12345, + "status": "Success", + "message": "Roommate Group created successfully" + }, + { + "node": 2, + "roommateGroupId": 0, + "status": "Failure", + "message": "There should be at least one roommate in this group. Invalid roommate application ids." + }, + { + "node": 3, + "roommateGroupId": 0, + "status": "Failure", + "message": "Required parameter invitorApplicationId is missing." + } + ] + } + } + } + }, + "sendScheduledChargesSuccessExample": { + "summary": "sendScheduledCharges", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "scheduledCharges": { + "scheduledCharge": [ + { + "id": "1234", + "node": "1", + "status": "Success", + "message": "Scheduled charge inserted successfully." + }, + { + "id": "0", + "node": "2", + "status": "Failure", + "message": "Failed to insert scheduled charge." + } + ] + } + } + } + } + }, + "updateLeaseSuccessExample": { + "summary": "updateLease", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "leaseId": "123456", + "message": "Lease updated successfully." + } + } + } + }, + "updateScheduledCharges_r1_SuccessExample": { + "summary": "updateScheduledCharges(r1)", + "value": { + "response": { + "requestId": "15", + "result": { + "scheduledCharges": { + "scheduledCharge": [ + { + "@attributes": { + "id": "1234", + "node": "1", + "status": "Success", + "message": "Scheduled charge updated successfully." + } + } + ] + } + } + } + } + }, + "updateScheduledCharges_r2_SuccessExample": { + "summary": "updateScheduledCharges(r2)", + "value": { + "response": { + "requestId": "15", + "code": 300, + "result": { + "scheduledCharges": { + "scheduledCharge": { + "1": { + "@attributes": { + "id": 32847564, + "node": 1, + "status": "Success", + "message": "Scheduled charge updated successfully." + } + }, + "2": { + "@attributes": { + "id": 32847923, + "node": 2, + "status": "Success", + "message": "Scheduled charge updated successfully." + } + } + } + } + } + } + } + }, + "getCallLogsSuccessExample": { + "summary": "getCallLogs", + "value": { + "requestId": "15", + "code": 200, + "result": { + "calls": { + "call": [ + { + "id": "1234", + "callerName": "test caller", + "applicationId": "1234", + "originPhoneNumber": "2342265293", + "destinationPhoneNumber": "2342265256", + "callTypeId": "21", + "callType": "Call Center Lead", + "callSourceId": "2", + "callSource": "Leasing Center", + "callResultId": "6", + "callResult": "lead", + "callState": "Non-Archived", + "callAnalyzed": "No", + "propertyId": "12345", + "voiceMailTypeId": "3", + "answerStatus": "Answered", + "leadSourceId": "45453", + "leadSourceName": "test souce", + "agentName": "agent name", + "callDuration": "00:00:18", + "callCenterTalkTime": "00:00:05" + } + ] + } + } + } + }, + "getLeasingCenterPickListsSuccessExample": { + "summary": "getLeasingCenterPickLists", + "value": { + "requestId": "15", + "code": 200, + "result": { + "callSources": { + "callSource": [ + { + "id": "1", + "name": "On-Site" + }, + { + "id": "2", + "name": "Leasing Center" + }, + { + "id": "7", + "name": "Miscellaneous" + } + ] + }, + "callTypes": { + "callType": [ + { + "id": "23", + "name": "Call Center Emergency" + }, + { + "id": "21", + "name": "Call Center Lead" + }, + { + "id": "42", + "name": "Call Center Lead via IVR" + }, + { + "id": "22", + "name": "Call Center Maintenance" + }, + { + "id": "44", + "name": "Call Center Maintenance Emergency via IVR" + }, + { + "id": "43", + "name": "Call Center Maintenance via IVR" + }, + { + "id": "10", + "name": "Call Tracker Lead" + }, + { + "id": "39", + "name": "Call Tracker Lead via IVR" + }, + { + "id": "11", + "name": "Call Tracker Maintenance" + }, + { + "id": "12", + "name": "Call Tracker Maintenance Emergency" + }, + { + "id": "41", + "name": "Call Tracker Maintenance Emergency via IVR" + }, + { + "id": "40", + "name": "Call Tracker Maintenance via IVR" + }, + { + "id": "17", + "name": "Call Tracker Vacancy Organic" + }, + { + "id": "18", + "name": "Call Tracker Vacancy Paid" + }, + { + "id": "25", + "name": "Call Tracking Office" + }, + { + "id": "47", + "name": "Corporate Care Line" + }, + { + "id": "37", + "name": "Google PPC" + }, + { + "id": "35", + "name": "Leasing Center Outbound" + }, + { + "id": "48", + "name": "Manual Followup Call" + }, + { + "id": "26", + "name": "Move-In Calls" + }, + { + "id": "20", + "name": "Outbound Property Scheduled Call" + } + ] + }, + "callResults": { + "callResult": [ + { + "id": "2", + "name": "Unknown" + }, + { + "id": "3", + "name": "No Result" + }, + { + "id": "6", + "name": "Lead" + }, + { + "id": "7", + "name": "Work Order" + }, + { + "id": "8", + "name": "Solicitor" + }, + { + "id": "9", + "name": "Vendor" + }, + { + "id": "10", + "name": "Wrong Number" + }, + { + "id": "11", + "name": "Resident" + }, + { + "id": "12", + "name": "Abandoned" + }, + { + "id": "13", + "name": "Test Call" + }, + { + "id": "29", + "name": "Support" + }, + { + "id": "141", + "name": "Market Survey" + }, + { + "id": "145", + "name": "Spam" + } + ] + } + } + } + }, + "getInspectionsSuccessExample": { + "summary": "getInspections", + "value": { + "requestId": "15", + "code": 200, + "result": { + "inspections": { + "inspection": [ + { + "id": "123456", + "propertyId": "12345", + "inspectionTypeId": "1", + "inspectionStatusTypeId": "3", + "inspectionStatusType": "Review", + "inspectionFormId": "12345", + "scheduledDate": "2020-04-24", + "dueDate": "2020-04-30", + "leaseId": "123456", + "unitSpaceId": "1234", + "note": "Test Inspection", + "locations": { + "location": [ + { + "locationId": "1234", + "locationName": "Kitchen", + "problems": { + "problem": [ + { + "problemId": "12345", + "problemName": "cabinet", + "response": "Fail", + "note": "Cabinet fail" + }, + { + "problemId": "12345", + "problemName": "Cosmetic", + "response": "Pass" + } + ] + } + }, + { + "locationId": "12345", + "locationName": "Master Bedroom", + "problems": { + "problem": [ + { + "problemId": "123456", + "problemName": "cabinet", + "response": "Pass" + }, + { + "problemId": "12345", + "problemName": "Power", + "response": "Fail", + "subProblems": { + "subProblem": [ + { + "subProblemId": "123456", + "subProblemName": "Clean" + }, + { + "subProblemId": "1234", + "subProblemName": "Repair" + }, + { + "subProblemId": "1234567", + "subProblemName": "Replace" + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": "12345", + "propertyId": "12345", + "inspectionTypeId": "1", + "inspectionStatusTypeId": "3", + "inspectionStatusType": "Review", + "inspectionFormId": "12345", + "scheduledDate": "2020-04-24", + "dueDate": "2020-04-30", + "leaseId": "12345", + "unitSpaceId": "12345", + "note": "Test Inspection", + "locations": { + "location": [ + { + "locationId": "12345", + "locationName": "Bedroom", + "problems": { + "problem": [ + { + "problemId": "12345", + "problemName": "cabinet", + "response": "Fail" + }, + { + "problemId": "12345", + "problemName": "Cosmetic", + "response": "Pass" + } + ] + } + }, + { + "locationId": "12345", + "locationName": "Master Bedroom", + "problems": { + "problem": [ + { + "problemId": "12345", + "problemName": "cabinet", + "response": "Pass" + }, + { + "problemId": "12345", + "problemName": "Power", + "response": "Pass" + }, + { + "problemId": "62387", + "problemName": "power leak", + "response": "Pass" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "getInspectionTemplatesSuccessExample": { + "summary": "getInspectionTemplates", + "value": { + "requestId": "15", + "code": 200, + "result": { + "inspectionTemplates": { + "inspectionTemplate": [ + { + "id": "1234", + "name": "Template Name", + "type": "Type", + "isActive": "true", + "allowActions": "true", + "customText": "Top Text", + "termsAndConditions": "Bottom Text", + "propertyIds": "12345,45678", + "locations": { + "location": [ + { + "maintenanceLocationId": "12345", + "locationName": "location name", + "problems": { + "problem": [ + { + "maintenanceProblemId": "123456", + "problemName": "problem name" + }, + { + "maintenanceProblemId": "67890", + "problemName": "problem name" + } + ] + } + } + ] + } + } + ] + } + } + } + }, + "getWorkOrderPickListsSuccessExample": { + "summary": "getWorkOrderPickLists", + "value": { + "requestId": "15", + "code": 200, + "result": { + "Property": { + "Locations": { + "Location": [ + { + "@attributes": { + "Id": "26900", + "Name": "Basement", + "Type": "Unit", + "IsResidentPortalEnabled": "0" + } + }, + { + "@attributes": { + "Id": "38565", + "Name": "00last location", + "Type": "Unit", + "IsResidentPortalEnabled": "0" + }, + "unitTypes": { + "unitType": [ + { + "@attributes": { + "Id": "474887", + "Name": "1" + } + } + ] + } + }, + { + "@attributes": { + "Id": "40687", + "Name": "Entry", + "Type": "Unit", + "IsResidentPortalEnabled": "0" + }, + "unitTypes": { + "unitType": [ + { + "@attributes": { + "Id": "474887", + "Name": "1" + } + } + ] + } + }, + { + "@attributes": { + "Id": "32814", + "Name": "bathroom1", + "Type": "Property", + "IsResidentPortalEnabled": "1" + } + } + ] + }, + "Priorities": { + "Priority": [ + { + "@attributes": { + "Id": "19421", + "Name": "Normal", + "Code": "" + } + }, + { + "@attributes": { + "Id": "23478", + "Name": "High", + "Code": "" + } + } + ] + }, + "StatusTypes": { + "StatusType": [ + { + "@attributes": { + "Id": "15106", + "Name": "Awaiting Parts", + "Code": "AP" + } + }, + { + "@attributes": { + "Id": "15103", + "Name": "New", + "Code": "NE" + } + } + ] + }, + "Categories": { + "Category": [ + { + "@attributes": { + "Id": "91983", + "Name": "demo" + } + }, + { + "@attributes": { + "Id": "105795", + "Name": "Building Maintenance" + } + } + ] + }, + "Problems": { + "Problem": [ + { + "locations": { + "location": [ + { + "@attributes": { + "Id": "11370" + } + } + ] + }, + "@attributes": { + "Id": "67718", + "Name": "Wet Floor", + "IsResidentPortalEnabled": "1" + }, + "subMaintenanceProblems": { + "subMaintenanceProblem": [ + { + "@attributes": { + "Id": "569575" + } + } + ] + } + }, + { + "locations": { + "location": [ + { + "@attributes": { + "Id": "11363" + } + }, + { + "@attributes": { + "Id": "11368" + } + }, + { + "@attributes": { + "Id": "11370" + } + } + ] + }, + "@attributes": { + "Id": "80235", + "Name": "Vinyl Repair Or Replace", + "CategoryId": "94586", + "IsResidentPortalEnabled": "0" + } + } + ] + }, + "@attributes": { + "Id": "22222" + } + }, + "InspectionStatuses": { + "InspectionStatus": [ + { + "@attributes": { + "Id": "1", + "Name": "Not Started" + } + }, + { + "@attributes": { + "Id": "2", + "Name": "In Progress" + } + }, + { + "@attributes": { + "Id": "3", + "Name": "Review" + } + }, + { + "@attributes": { + "Id": "4", + "Name": "Past Due" + } + }, + { + "@attributes": { + "Id": "5", + "Name": "Approved" + } + } + ] + }, + "WorkOrderTypes": { + "WorkOrderType": [ + { + "@attributes": { + "Id": "1", + "Name": "Make Ready" + } + }, + { + "@attributes": { + "Id": "2", + "Name": "Service Request" + } + }, + { + "@attributes": { + "Id": "4", + "Name": "Feature Upgrade" + } + } + ] + }, + "CompanyEmployees": { + "CompanyEmployee": [ + { + "@attributes": { + "Id": "299001", + "Name": "Andrew Marshall" + } + }, + { + "@attributes": { + "Id": "315898", + "Name": "Christopher Sabree" + } + } + ] + } + } + } + }, + "getWorkOrdersSuccessSuccessExample": { + "summary": "getWorkOrders", + "value": { + "response": { + "requestId": "15", + "result": { + "workOrders": { + "workOrder": [ + { + "maintenanceRequestId": "307132", + "propertyId": "11111", + "buildingName": "B1", + "unitNumber": "8", + "customerId": "4856298", + "nameFirst": "Cosin", + "nameLast": "Dome", + "primaryPhoneNumber": "123456789", + "alternatePhoneNumber": "12121212121", + "emailAddress": "cosin@dome.com", + "createdOn": "01/05/2012 05:22:26.184567 MST", + "assignedTo": "jiniaxena", + "maintenanceStatusId": "1234", + "maintenanceStatus": "New", + "maintenancePriorityId": 18757, + "maintenancePriority": "NOWrn Never is question", + "maintenanceCategoryId": "326584", + "maintenanceCategoryName": "test123", + "maintenanceProblemId": 338415, + "maintenanceProblem": "Problem With Lights", + "subMaintenanceProblemId": "403843", + "subMaintenanceProblemName": "Clean", + "maintenanceDescription": "Some description", + "labors": { + "labor": [ + { + "employeeName": "ABC", + "description": "sdf", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 01:11:00", + "endDateTime": "02/28/2018 01:15:00", + "totalMinutes": "4", + "perHourRate": "1.00", + "totalCharge": "0.07" + }, + { + "employeeName": "BCD", + "description": "test", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 00:00:00", + "endDateTime": "02/28/2018 00:00:00", + "totalMinutes": "612", + "perHourRate": "1.00", + "totalCharge": "10.20" + } + ], + "subTotal": { + "totalCharge": "10.27", + "totalMinutes": 616 + } + }, + "scheduledStartDate": "01/06/2012 00:00:00 MDT", + "scheduledEndDate": "01/09/2012 00:00:00 MDT", + "dueDate": "02/04/2022 18:34:11 MST", + "isFloating": "false", + "permissionToEnter": "0", + "petInfo": "Dogs,Dogs,Dogs,Dogs,Snake,Snake", + "alarmInfo": "123454", + "maintenanceRequestFrom": "Entrata PaaS", + "maintenanceRequestBy": "R R1", + "isDeleted": "0", + "childWorkOrders": { + "childWorkOrder": [ + { + "maintenanceRequestId": 5039921, + "maintenanceRequestTypeId": 1, + "parentMaintenanceRequestId": "307132", + "propertyId": 19463, + "buildingName": "B1", + "customerId": 27857569, + "assignedTo": "jiniaxena", + "nameFirst": "Abhi004", + "nameLast": "Abhi004", + "primaryPhoneNumber": "6505756195", + "createdOn": "03/22/2017 03:27:04.763014 MDT", + "updatedOn": "03/22/2017 03:27:40.109857 MDT", + "maintenanceStatusId": "1234", + "maintenanceStatus": "1test", + "maintenancePriorityId": 25358, + "maintenancePriority": "JS Testing 1", + "maintenanceProblemId": 333509, + "maintenanceProblem": "12", + "maintenanceLocationId": 36891, + "maintenanceLocation": "1234", + "labors": { + "labor": [ + { + "employeeName": "ABC", + "description": "sdf", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 01:11:00", + "endDateTime": "02/28/2018 01:15:00", + "totalMinutes": "4", + "perHourRate": "1.00", + "totalCharge": "0.07" + }, + { + "employeeName": "BCD", + "description": "test", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 00:00:00", + "endDateTime": "02/28/2018 00:00:00", + "totalMinutes": "612", + "perHourRate": "1.00", + "totalCharge": "10.20" + } + ], + "subTotal": { + "totalCharge": "10.27", + "totalMinutes": 616 + } + }, + "completedOn": "03/22/2017 03:27:46 MDT", + "entryNotes": "This is an entry note", + "scheduledEndDate": "03/23/2017 00:00:00 MDT", + "isFloating": false, + "maintenanceRequestBy": "System", + "isDeleted": "0" + } + ] + } + }, + { + "maintenanceRequestId": "393048", + "propertyId": "11111", + "buildingName": "B1", + "unitNumber": "11", + "customerId": "5595315", + "nameFirst": "John", + "nameLast": "Paul", + "primaryPhoneNumber": "123456789", + "alternatePhoneNumber": "12121212", + "emailAddress": "john@paul.com", + "createdOn": "07/17/2012 01:48:24.777203 MDT", + "assignedTo": "Ben", + "maintenanceStatusId": "1234", + "maintenanceStatus": "Completed", + "maintenancePriority": "Medium", + "maintenanceLocation": "Other Bathroom", + "maintenanceDescription": "Some descrpition", + "labors": { + "labor": [ + { + "employeeName": "ABC", + "description": "sdf", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 01:11:00", + "endDateTime": "02/28/2018 01:15:00", + "totalMinutes": "4", + "perHourRate": "1.00", + "totalCharge": "0.07" + }, + { + "employeeName": "BCD", + "description": "test", + "laborType": "Regular", + "laborTypeId": "1", + "startDateTime": "02/28/2018 00:00:00", + "endDateTime": "02/28/2018 00:00:00", + "totalMinutes": "612", + "perHourRate": "1.00", + "totalCharge": "10.20" + } + ], + "subTotal": { + "totalCharge": "10.27", + "totalMinutes": 616 + } + }, + "completedOn": "07/22/2012 01:48:24.777203 MDT", + "scheduledStartDate": "07/18/2012 00:00:00 MDT", + "scheduledEndDate": "07/19/2012 00:00:00 MDT", + "dueDate": "02/04/2022 18:34:11 MST", + "isFloating": "true", + "permissionToEnter": "0", + "petInfo": "Dogs,Dogs,Dogs,Dogs,Snake,Snake", + "alarmInfo": "123454", + "maintenanceRequestFrom": "Entrata PaaS", + "maintenanceRequestBy": "R R1", + "isDeleted": "0" + } + ] + } + } + } + } + }, + "sendWorkOrdersSuccessSuccessExample": { + "summary": "sendWorkOrders", + "value": { + "response": { + "code": 200, + "result": { + "Success": [ + { + "@attributes": { + "message": "Work order inserted successfully.", + "node": 1, + "reference_id": 4699547 + } + } + ] + } + } + } + }, + "updateWorkOrders_r1_SuccessExample": { + "summary": "updateWorkOrders(r1)", + "value": { + "response": { + "requestId": "15", + "code": 300, + "result": { + "workOrders": { + "workOrder": [ + { + "@attributes": { + "workOrderId": "1234", + "status": "Success", + "message": "Work order updated successfully." + } + }, + { + "@attributes": { + "workOrderId": "1234", + "status": "Failure", + "message": "Value for 'maintenancePriorityId' is invalid.Value for 'maintenanceProblemId' is invalid." + } + } + ] + } + } + } + } + }, + "updateWorkOrders_r2_SuccessExample": { + "summary": "updateWorkOrders(r2)", + "value": { + "response": { + "requestId": "15", + "code": 300, + "result": { + "workOrders": { + "workOrder": [ + { + "@attributes": { + "workOrderId": "1234", + "status": "Success", + "message": "Work order updated successfully." + } + }, + { + "@attributes": { + "workOrderId": "1234", + "status": "Failure", + "message": "Value for 'maintenancePriorityId' is invalid.Value for 'maintenanceProblemId' is invalid." + } + } + ] + } + } + } + } + }, + "getPricingPicklistsSuccessExample": { + "summary": "getPricingPicklists", + "value": { + "response": { + "requestId": "14", + "code": 200, + "result": { + "pricingLevels": { + "pricingLevel": [ + { + "@attributes": { + "id": "1", + "name": "Property" + } + }, + { + "@attributes": { + "id": "2", + "name": "Floor Plan" + } + }, + { + "@attributes": { + "id": "3", + "name": "Unit Type" + } + }, + { + "@attributes": { + "id": "4", + "name": "Space" + } + } + ] + }, + "chargeUsages": { + "chargeUsage": [ + { + "@attributes": { + "id": "1", + "name": "Base" + } + }, + { + "@attributes": { + "id": "2", + "name": "Amenity" + } + }, + { + "@attributes": { + "id": "3", + "name": "Pet" + } + }, + { + "@attributes": { + "id": "4", + "name": "Add Ons" + } + }, + { + "@attributes": { + "id": "6", + "name": "Special" + } + } + ] + }, + "chargeTimings": { + "chargeTiming": [ + { + "@attributes": { + "id": "102", + "name": "Application Completed" + } + }, + { + "@attributes": { + "id": "106", + "name": "Application Started" + } + }, + { + "@attributes": { + "id": "201", + "name": "One Time" + } + }, + { + "@attributes": { + "id": "202", + "name": "Move In" + } + }, + { + "@attributes": { + "id": "206", + "name": "Move Out" + } + }, + { + "@attributes": { + "id": "307", + "name": "Monthly" + } + } + ] + }, + "chargeCodeTypes": { + "chargeCodeType": [ + { + "@attributes": { + "id": "2", + "name": "Rent", + "allowed_charge_timing_ids": "307" + } + }, + { + "@attributes": { + "id": "7", + "name": "Deposit", + "allowed_charge_timing_ids": "102,201,202" + } + }, + { + "@attributes": { + "id": "4", + "name": "Expense", + "allowed_charge_timing_ids": "102,201,202,206,307" + } + }, + { + "@attributes": { + "id": "5", + "name": "Asset", + "allowed_charge_timing_ids": "102,201,202,206,307" + } + }, + { + "@attributes": { + "id": "6", + "name": "Equity", + "allowed_charge_timing_ids": "102,201,202,206,307" + } + }, + { + "@attributes": { + "id": "9", + "name": "Other Liability", + "allowed_charge_timing_ids": "102,201,202,206,307" + } + }, + { + "@attributes": { + "id": "3", + "name": "Other Income", + "allowed_charge_timing_ids": "102,201,202,206,307" + } + } + ] + } + } + } + } + }, + "getPropertyFeesSuccessExample": { + "summary": "getPropertyFees", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "propertyFees": [ + { + "propertyId": "12345", + "propertyFloorplanId": "", + "unitTypeId": "", + "unitSpaceId": "", + "entrataCategoryId": "1", + "entrataCategory": "Base", + "associatedItemId": "0", + "associatedItem": "", + "cascadeId": "1", + "cascadeReferenceId": "12345", + "cascadeReferenceName": "Demo_reference_name1", + "spaceConfigurationId": "0", + "spaceConfiguration": "", + "chargeCodeId": "1234", + "chargeCodeName": "Return Fee", + "chargeCodeDescription": "Return Fee", + "chargeCodeGroupName": "", + "leaseTermId": "0", + "leaseTerm": "", + "leaseStartWindowId": "0", + "termStartDate": "", + "termEndDate": "", + "chargeTimingId": "406", + "chargeTiming": "Return Item Fee", + "formulaId": "1", + "formulaReferenceId": "0", + "rateAmount": "50.00", + "rateIncreaseIncrement": "0.0000", + "detailedAmount": "50.00", + "isOptional": "0", + "isRefundable": "0", + "customerRelationshipId": "", + "customerRelationshipName": "" + }, + { + "propertyId": "12345", + "propertyFloorplanId": "", + "unitTypeId": "", + "unitSpaceId": "", + "entrataCategoryId": "1", + "entrataCategory": "Base", + "associatedItemId": "0", + "associatedItem": "", + "cascadeId": "1", + "cascadeReferenceId": "12345", + "cascadeReferenceName": "Demo_reference_name2", + "spaceConfigurationId": "0", + "spaceConfiguration": "", + "chargeCodeId": "1234", + "chargeCodeName": "Application Fee", + "chargeCodeDescription": "Application Fee", + "chargeCodeGroupName": "", + "leaseTermId": "0", + "leaseTerm": "", + "leaseStartWindowId": "0", + "termStartDate": "", + "termEndDate": "", + "chargeTimingId": "102", + "chargeTiming": "Application Completed", + "formulaId": "1", + "formulaReferenceId": "0", + "rateAmount": "50.00", + "rateIncreaseIncrement": "0.0000", + "detailedAmount": "50.00", + "isOptional": "0", + "isRefundable": "0", + "customerRelationshipId": "1", + "customerRelationshipName": "Primary" + } + ], + "floorPlanFees": [ + { + "propertyId": "12345", + "propertyFloorplanId": "921405", + "unitTypeId": "653938", + "unitSpaceId": "", + "entrataCategoryId": "2", + "entrataCategory": "ABC", + "associatedItemId": "1195074", + "associatedItem": "XYZ", + "cascadeId": "2", + "cascadeReferenceId": "921405", + "cascadeReferenceName": "Demo_reference_name3", + "spaceConfigurationId": "0", + "spaceConfiguration": "", + "chargeCodeId": "1234", + "chargeCodeName": "Charge code Amenity", + "chargeCodeDescription": "Charge code Amenity", + "chargeCodeGroupName": "", + "leaseTermId": "0", + "leaseTerm": "", + "leaseStartWindowId": "0", + "termStartDate": "", + "termEndDate": "", + "chargeTimingId": "307", + "chargeTiming": "Monthly", + "formulaId": "1", + "formulaReferenceId": "0", + "rateAmount": "75.00", + "rateIncreaseIncrement": "0.0000", + "detailedAmount": "75.00", + "isOptional": "0", + "isRefundable": "0", + "customerRelationshipId": "", + "customerRelationshipName": "" + } + ], + "unitTypeFees": [ + { + "propertyId": "12345", + "propertyFloorplanId": "921405", + "unitTypeId": "653938", + "unitSpaceId": "", + "entrataCategoryId": "1", + "entrataCategory": "Base", + "associatedItemId": "0", + "associatedItem": "", + "cascadeId": "3", + "cascadeReferenceId": "653938", + "cascadeReferenceName": "Demo_reference_name4", + "spaceConfigurationId": "0", + "spaceConfiguration": "", + "chargeCodeId": "12346", + "chargeCodeName": "Accelerated Rent", + "chargeCodeDescription": "Accelerated Rent", + "chargeCodeGroupName": "", + "leaseTermId": "0", + "leaseTerm": "", + "leaseStartWindowId": "0", + "termStartDate": "", + "termEndDate": "", + "chargeTimingId": "202", + "chargeTiming": "Move-In", + "formulaId": "1", + "formulaReferenceId": "0", + "rateAmount": "56.50", + "rateIncreaseIncrement": "0.0000", + "detailedAmount": "56.50", + "isOptional": "0", + "isRefundable": "0", + "customerRelationshipId": "", + "customerRelationshipName": "" + } + ] + } + } + } + }, + "insertPricingSuccessExample": { + "summary": "insertPricing", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "pricing": [ + { + "node": "1", + "reference_id": "391937229", + "status": "Success", + "is_valid": "Yes", + "message": "Rate inserted/updated successfully." + }, + { + "node": "2", + "reference_id": "391937260", + "status": "Success", + "is_valid": "Yes", + "message": "Rate inserted/updated successfully." + } + ] + } + } + } + }, + "insertPricing_r2SuccessExample": { + "summary": "insertPricing(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "pricing": [ + { + "node": "1", + "referencedId": "391937229", + "status": "Success", + "isValid": "Yes", + "message": "Rate inserted/updated successfully." + }, + { + "node": "2", + "referencedId": "391937260", + "status": "Success", + "isValid": "Yes", + "message": "Rate inserted/updated successfully." + } + ] + } + } + } + }, + "sendBudgetedRentSuccessExample": { + "summary": "sendBudgetedRent", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "pricing": [ + { + "node": 1, + "status": "Success", + "message": "Budgeted rent updated successfully." + }, + { + "node": 2, + "status": "Success", + "message": "Budgeted rent updated successfully." + } + ] + } + } + } + }, + "getAmenityReservationsSuccessExample": { + "summary": "getAmenityReservations", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "amenities": { + "amenity": [ + { + "id": "123456", + "name": "Cats", + "description": "Rent yourself a cat for a few hours.", + "isPublished": "1", + "reservations": { + "reservation": [ + { + "id": "123456", + "resident": "Transfer Test 3", + "leaseId": "123456", + "unitId": "123456", + "unitNumber": "123456", + "reservationDate": "2020-04-08", + "reserveByDay": "0", + "reservationStartTime": "03:00 PM", + "reservationEndTime": "05:00 PM", + "statusTypeId": "3", + "status": "Approved" + }, + { + "id": "123456", + "resident": "HPTestoo Testing", + "leaseId": "123456", + "buildingId": "123456", + "buildingName": "Tower A", + "unitId": "123456", + "unitNumber": "123456", + "reservationDate": "2020-04-09", + "reserveByDay": "0", + "reservationStartTime": "05:00 AM", + "reservationEndTime": "08:00 AM", + "statusTypeId": "3", + "status": "Approved" + } + ] + } + } + ] + } + } + } + } + }, + "getCalendarAvailability_r1_SuccessExample": { + "summary": "getCalendarAvailability(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "propertyCalendarSettings": { + "propertyId": "123456", + "appointmentLength": "90", + "selfGuidedTourAppointmentLength": 30, + "minLeadTimeTour": "8 Hours", + "selfGuidedTourMinLeadTime": "15 Minutes", + "availabilities": { + "availability": [ + { + "day": "Monday", + "startTime": "09:00:00MST", + "endTime": "17:00:00MST", + "simultaneousAppointmentLimit": "4" + }, + { + "day": "Wednesday", + "startTime": "21:00:00MST", + "endTime": "23:55:00MST", + "simultaneousAppointmentLimit": "3" + }, + { + "day": "Thursday", + "startTime": "21:05:00MST", + "endTime": "23:30:00MST", + "simultaneousAppointmentLimit": "2" + }, + { + "day": "Friday", + "startTime": "01:00:00MST", + "endTime": "03:00:00MST", + "simultaneousAppointmentLimit": "1" + } + ] + }, + "selfGuidedTourAvailabilities": { + "availability": [ + { + "day": "Monday", + "startTime": "06:00:00MST", + "endTime": "14:59:00MST", + "simultaneousAppointmentLimit": "No Limit" + }, + { + "day": "Tuesday", + "startTime": "00:00:00MST", + "endTime": "23:59:00MST", + "simultaneousAppointmentLimit": "No Limit" + }, + { + "day": "Wednesday", + "startTime": "00:00:00MST", + "endTime": "23:59:00MST", + "simultaneousAppointmentLimit": "No Limit" + }, + { + "day": "Thursday", + "startTime": "15:00:00MST", + "endTime": "21:55:00MST", + "simultaneousAppointmentLimit": "No Limit" + }, + { + "day": "Friday", + "startTime": "22:10:00MST", + "endTime": "23:00:00MST", + "simultaneousAppointmentLimit": "No Limit" + } + ] + } + }, + "propertyCalendarAvailability": { + "availableHours": { + "availableHour": [ + { + "date": "09/23/2019", + "startTime": "09:00:00MST", + "endTime": "17:00:00MST" + }, + { + "date": "09/25/2019", + "startTime": "21:00:00MST", + "endTime": "23:55:00MST" + }, + { + "date": "09/26/2019", + "startTime": "21:05:00MST", + "endTime": "23:30:00MST" + }, + { + "date": "09/27/2019", + "startTime": "01:00:00MST", + "endTime": "03:00:00MST" + } + ] + } + } + } + } + } + }, + "getCalendarAvailability_r2_SuccessExample": { + "summary": "getCalendarAvailability(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "availableTours": { + "availableTour": [ + { + "tourDate": "2024-08-26", + "tourTime": [ + "05:00 MDT - 06:00 MDT", + "06:00 MDT - 07:00 MDT", + "07:00 MDT - 08:00 MDT", + "08:00 MDT - 09:00 MDT", + "09:00 MDT - 10:00 MDT", + "10:00 MDT - 11:00 MDT", + "11:00 MDT - 12:00 MDT", + "12:00 MDT - 13:00 MDT", + "13:00 MDT - 14:00 MDT", + "14:00 MDT - 15:00 MDT", + "15:00 MDT - 16:00 MDT", + "16:00 MDT - 17:00 MDT", + "17:00 MDT - 18:00 MDT" + ] + }, + { + "tourDate": "2024-08-27", + "tourTime": [ + "06:00 MDT - 07:00 MDT", + "07:00 MDT - 08:00 MDT", + "08:00 MDT - 09:00 MDT", + "09:00 MDT - 10:00 MDT", + "10:00 MDT - 11:00 MDT", + "11:00 MDT - 12:00 MDT", + "12:00 MDT - 13:00 MDT", + "13:00 MDT - 14:00 MDT", + "14:00 MDT - 15:00 MDT", + "15:00 MDT - 16:00 MDT" + ] + } + ] + } + } + } + } + }, + "getFloorPlansSuccessExample": { + "summary": "getFloorPlans", + "value": { + "requestId": "15", + "result": { + "FloorPlans": { + "FloorPlan": { + "Identification": { + "IDValue": "456789", + "@attributes": { + "IDRank": "primary", + "IDScopeType": "sender", + "IDType": "Floorplan ID" + } + }, + "Name": "Floorplan 1", + "PropertyId": 123456, + "FloorplanGroups": { + "FloorplanGroup": { + "@attributes": { + "id": "256", + "name": "Test_23_test" + } + } + }, + "Comment": "test", + "UnitCount": "1", + "UnitsAvailable": "10", + "UnitTypes": { + "UnitType": [ + { + "@value": "1BHK", + "@attributes": { + "Id": "297171" + } + }, + { + "@value": "2BHK", + "@attributes": { + "Id": "297172" + } + } + ] + }, + "IsDisabled": false, + "Room": [ + { + "Count": "2", + "@attributes": { + "RoomType": "Bedroom" + } + }, + { + "Count": "1", + "@attributes": { + "RoomType": "Bathroom" + } + } + ], + "SquareFeet": { + "@attributes": { + "Max": "900", + "Min": "900" + } + }, + "MarketRent": { + "@attributes": { + "Max": "850", + "Min": "850" + } + }, + "Deposit": { + "Amount": { + "ValueRange": { + "@attributes": { + "Min": "250", + "Max": "250" + } + }, + "@attributes": { + "AmountType": "MonthMultiple" + } + }, + "@attributes": { + "DepositType": "security deposit" + } + }, + "Amenity": [ + { + "@attributes": { + "AmenityType": "AdditionalStorage" + } + }, + { + "@attributes": { + "AmenityType": "AirConditioner" + } + } + ], + "File": { + "FileType": "Floorplan", + "Description": "2D Floor Plan", + "Name": "Floorplan1.jpg", + "Caption": "Floorplan1.jpg", + "Format": "Jpg", + "Width": "480", + "Height": "640", + "Src": {}, + "@attributes": { + "FileID": "345678", + "Active": "true", + "IsDefault": true + } + } + } + } + } + } + }, + "getPetTypesSuccessExample": { + "summary": "getPetTypes", + "value": { + "response": { + "requestId": "15", + "result": { + "PetTypes": { + "Property": { + "11111": { + "@attributes": { + "id": 11111 + }, + "PetType": [ + { + "@attributes": { + "Name": "Bird", + "Id": 3428 + } + }, + { + "@attributes": { + "Name": "Cat", + "Id": 3467 + } + }, + { + "@attributes": { + "Name": "Dog", + "Id": 3445 + } + }, + { + "@attributes": { + "Name": "Fish", + "Id": 3434 + } + }, + { + "@attributes": { + "Name": "Mammals", + "Id": 34324 + } + }, + { + "@attributes": { + "Name": "Other", + "Id": 36896 + } + }, + { + "@attributes": { + "Name": "Reptile", + "Id": 34289 + } + }, + { + "@attributes": { + "Name": "Small Pet", + "Id": 34212 + } + } + ] + }, + "22222": { + "@attributes": { + "id": 22222 + }, + "PetType": [ + { + "@attributes": { + "Name": "Cat", + "Id": 3328 + } + }, + { + "@attributes": { + "Name": "Dog", + "Id": 3645 + } + }, + { + "@attributes": { + "Name": "Fish", + "Id": 7857 + } + } + ] + } + } + } + } + } + } + }, + "getPropertiesSuccessExample": { + "summary": "getProperties", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "PhysicalProperty": { + "Property": [ + { + "PropertyID": "22090", + "ParentPropertyID": 653357, + "MarketingName": "55 Hundred", + "Type": "Apartment", + "General_ID": "co405", + "YearBuilt": "2009", + "ShortDescription": { + "b": "LIVE AT THE SPEED OF LIGHT." + }, + "LongDescription": { + "b": "55 HUNDRED" + }, + "webSite": "http://www.55hundredlifestyle.com", + "Address": { + "Address": "5500 Columbia Pike", + "City": "Arlington", + "State": "VA", + "PostalCode": "22204", + "Country": "US", + "Email": "devsupport@propertysolutions.lcl", + "@attributes": { + "AddressType": "property" + } + }, + "PostMonths": { + "ArPostMonth": "01/2014", + "ApPostMonth": "01/2014", + "GlPostMonth": "01/2014" + }, + "IsDisabled": "0", + "IsFeaturedProperty": "0", + "CustomKeysData": { + "CustomKeyData": [ + { + "Key": "Key", + "Value": "KeyValue" + } + ] + } + }, + { + "PropertyID": "119717", + "MarketingName": "The Alexan", + "Type": "Apartment", + "General_ID": "ax128", + "YearBuilt": "2015", + "ShortDescription": "Coming Soon - Spring 2016! THE Alexan will consist of 365 luxury studio, one and two-bedroom rental apartments in Downtown Dallas, TX.", + "LongDescription": "Coming Soon - Spring 2016! THE Alexan will consist of 365 luxury studio, one and two-bedroom rental apartments in Downtown Dallas, TX.nWhat's old is new again. Welcome to The Alexan, where we've juxtaposed the style of classic, high-end Dallas with modern details. With close proximity to other time-honored landmarks like the Waterfall Billboard and Little Doe's Restaurant and close to UpTown and Victory Park, this club-style collection of apartments has an unbelievable 360\u00b0 view, yet blends in with the Dallas skyline. We're looking for those who appreciate craft, who appreciate the sophisticated details. When you live at The Alexan, you feel like you're living in your own private, secluded manor. It's a classic.", + "webSite": "http://www.livethealexan.com/", + "Address": { + "Address": "3333 Harry Hines Blvd", + "City": "Dallas", + "State": "TX", + "PostalCode": "75201", + "Country": "US", + "Email": "devsupport@propertysolutions.lcl", + "@attributes": { + "AddressType": "property" + } + }, + "PostMonths": { + "ArPostMonth": "10/2014", + "ApPostMonth": "10/2014", + "GlPostMonth": "10/2014" + }, + "PropertyHours": { + "HolidayHours": { + "HolidayHour": { + "Name": "Columbus Day", + "Date": "10/08/2018" + } + }, + "OfficeHours": { + "OfficeHour": { + "Day": "Monday", + "AvailabilityType": "Open", + "OpenTime": "9:00 AM", + "CloseTime": "6:30 PM", + "LunchStartTime": "1:00 PM", + "LunchEndTime": "2:00 PM" + } + }, + "PoolHours": { + "PoolHour": { + "Day": "Monday", + "OpenTime": "8:20 AM", + "CloseTime": "4:06 PM" + } + } + }, + "IsDisabled": "0", + "IsFeaturedProperty": "0", + "CustomKeysData": { + "CustomKeyData": [ + { + "Key": "Key1", + "Value": "KeyValue1" + } + ] + } + } + ] + } + } + } + } + }, + "getPropertyAddOnsSuccessExample": { + "summary": "getPropertyAddOns", + "value": { + "response": { + "requestId": "1", + "code": 200, + "result": { + "currencyCode": "USD", + "addOns": { + "addon": [ + { + "id": 319751, + "name": "1", + "addOnTypeId": "2", + "addOnCategoryId": 275, + "addOnGroupId": 11375, + "isInventory": 1, + "addOnAvailableOn": "04/19/2019", + "isWebVisible": 1, + "availability": "Vacant Ready (Unavailable)", + "reservationStartDate": "04/19/2019", + "reservationEndDate": "04/18/2020", + "holdUntilDate": "04/18/2020" + }, + { + "id": 319752, + "name": "2", + "addOnTypeId": "2", + "addOnCategoryId": 275, + "addOnGroupId": 11375, + "isInventory": 1, + "addOnAvailableOn": "04/19/2019", + "isWebVisible": 1, + "availability": "Vacant Ready (Unavailable)", + "reservationStartDate": "09/25/2020", + "reservationEndDate": "11/30/2020", + "holdUntilDate": "04/18/2020", + "rates": { + "rate": [ + { + "chargeTimingId": 211, + "chargeCodeId": 207684, + "amount": "5.00" + }, + { + "chargeTimingId": 307, + "chargeCodeId": 205430, + "amount": "9.00" + } + ] + } + } + ] + } + } + } + } + }, + "getPropertyAnnouncementsSuccessExample": { + "summary": "getPropertyAnnouncements", + "value": { + "response": { + "requestId": 15, + "result": { + "Announcements": { + "Announcement": [ + { + "@attributes": { + "Id": 111 + }, + "AnnouncementTypeId": 9, + "FrequencyId": 2, + "Title": "Test Announcement Title", + "Description": "Hello", + "StartDate": "06/16/2013", + "EndDate": "07/31/2013" + }, + { + "@attributes": { + "Id": 222 + }, + "AnnouncementTypeId": 7, + "FrequencyId": 1, + "Title": "Announcement - messages inbox", + "Description": "test first Announcement for messages", + "StartDate": "06/16/2013", + "EndDate": "06/30/2013" + } + ] + } + } + } + } + }, + "getPropertyPickLists_r1_SuccessExample": { + "summary": "getPropertyPickLists(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "company": { + "searchAreas": { + "countries": [ + { + "country": [ + { + "states": { + "state": [ + { + "@attributes": { + "Code": "AE", + "Name": "Armed Forces Europe, Middle East, Africa & Canada" + } + }, + { + "searchArea": [ + { + "@attributes": { + "Id": 1651, + "Name": "search area" + } + }, + { + "@attributes": { + "Id": 1905, + "Name": "asdasd" + } + }, + { + "@attributes": { + "Id": 1947, + "Name": "Washington DC / Alexandria", + "subSearchAreas": { + "subSearchArea": { + "@attributes": { + "Id": 1955, + "Name": "test" + } + } + } + } + } + ] + } + ] + } + }, + { + "@attributes": { + "Code": "US" + } + } + ] + }, + { + "country": [ + { + "states": { + "state": [ + { + "@attributes": { + "Code": "BC", + "Name": "British Columbia" + } + }, + { + "searchArea": [ + { + "@attributes": { + "Id": 1968, + "Name": "Testfirst", + "subSearchAreas": { + "subSearchArea": { + "@attributes": { + "Id": 1969, + "Name": "subserach" + } + } + } + } + } + ] + } + ] + } + }, + { + "@attributes": { + "Code": "CA" + } + } + ] + } + ] + } + }, + "Property": [ + { + "@attributes": { + "Id": 42420, + "Name": "AuraCorp2 - Crystal", + "IsDisabled": 0 + }, + "UnitTypes": { + "UnitType": [ + { + "@attributes": { + "Id": "474667", + "Name": "X4" + } + }, + { + "@attributes": { + "Id": "154446", + "Name": "ZOM 3" + } + }, + { + "@attributes": { + "Id": "346728", + "Name": "1BHK" + } + } + ] + }, + "PropertyBuildings": { + "PropertyBuilding": [ + { + "@attributes": { + "Id": "56180", + "Name": "BUILDING 01" + } + }, + { + "@attributes": { + "Id": "16556", + "Name": "ZOM 3" + } + } + ] + }, + "PropertyFloorplans": { + "PropertyFloorplan": [ + { + "@attributes": { + "Id": "477949", + "Name": "Exist501" + } + }, + { + "@attributes": { + "Id": "145000", + "Name": "ZOM 9" + } + }, + { + "@attributes": { + "Id": "138792", + "Name": "ZOM 1" + } + } + ] + }, + "MoveOutReasons": { + "MoveOutReason": [ + { + "@attributes": { + "Id": 1039203, + "SystemCode": "TESTING_SYSTEM_CODE", + "Name": "13th_avenue_need_big_rooms" + } + }, + { + "@attributes": { + "Id": 1039235, + "SystemCode": "TESTING_SYSTEM_CODE", + "Name": "Wants Unavailable Lease Term" + } + }, + { + "@attributes": { + "Id": 1039196, + "SystemCode": "TESTING_SYSTEM_CODE", + "Name": "help" + } + } + ] + }, + "PropertySearchAreas": { + "SearchAreas": { + "SearchArea": [ + { + "@attributes": { + "Id": 33674, + "CompanySearchAreaId": 1206 + } + } + ] + } + } + } + ] + } + } + } + }, + "getPropertyPickLists_r2_SuccessExample": { + "summary": "getPropertyPickLists(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "properties": { + "property": [ + { + "id": 172775, + "name": "0001 Ea@@st Park Prop@erty test", + "unitTypes": { + "unitType": [ + { + "id": "582099", + "name": "Unit type 2" + } + ] + }, + "propertyBuildings": { + "propertyBuilding": [ + { + "id": "56457", + "name": "Building A" + } + ] + }, + "propertyFloorplans": { + "propertyFloorplan": [ + { + "id": "1088268", + "name": "Studio" + }, + { + "id": "1064062", + "name": "Rishi Rapid Test" + } + ] + }, + "propertyFloors": { + "propertyFloor": [ + { + "id": "2662740", + "title": "Floor A" + } + ] + }, + "rentableItems": { + "rentableItem": [ + { + "id": 81449, + "name": "TempGarage" + } + ] + }, + "addOnCategories": { + "addOnCategory": [ + { + "id": 275, + "name": "Garage" + } + ] + }, + "assignableItems": { + "assignableItem": [ + { + "id": 8377, + "name": "Gym Card" + } + ] + }, + "services": { + "service": [ + { + "id": 77455, + "name": "Full Furnishing 1" + }, + { + "id": 79830, + "name": "Internet Service - Basic" + } + ] + }, + "moveOutTypes": { + "moveOutType": [ + { + "id": 1, + "name": "Eviction" + }, + { + "id": 2, + "name": "Skip" + }, + { + "id": 4, + "name": "Move Out" + } + ] + }, + "moveOutReasons": { + "moveOutReason": [ + { + "id": "49382", + "name": "Abandoned apartment", + "moveOutTypeId": 1 + } + ] + }, + "leaseTerms": { + "leaseTerm": [ + { + "leaseTermId": "17865", + "leaseTermName": "12 months", + "leaseTermStructureId": "234", + "leaseTermStructureName": "Test Term", + "webVisible": 1 + }, + { + "leaseTermId": "17866", + "leaseTermName": "18 months", + "leaseTermStructureId": "234", + "leaseTermStructureName": "Test Term", + "webVisible": 1 + }, + { + "leaseTermId": "19136", + "leaseTermName": "Fall 2020", + "leaseTermStructureId": "234", + "leaseTermStructureName": "Test Term", + "webVisible": 1, + "leaseStartWindows": { + "leaseStartWindow": [ + { + "leaseStartWindowId": 110263, + "windowStartDate": "08/01/2020", + "windowEndDate": "12/31/2020", + "academicYearId": "3" + } + ] + } + } + ] + }, + "UnitExclusionReasonTypes": { + "UnitExclusionReasonType": [ + { + "id": 2, + "name": "Hospitality Unit" + }, + { + "id": 3, + "name": "Down Unit" + } + ] + } + } + ] + }, + "searchAreaStates": { + "searchAreaState": [ + { + "state": "Armed Forces Americas (Excluding Canada)", + "stateCode": "AA", + "countryCode": "US", + "searchAreas": { + "searchArea": [ + { + "id": 2096, + "name": "subsearch1" + } + ] + } + } + ] + }, + "phoneNumberTypes": { + "phoneNumberType": [ + { + "id": 1, + "name": "Primary" + }, + { + "id": 3, + "name": "Office" + }, + { + "id": 9, + "name": "Website" + }, + { + "id": 5, + "name": "Fax" + } + ] + }, + "addressTypes": { + "addressType": [ + { + "id": 10, + "name": "Other" + }, + { + "id": 3, + "name": "PO Box" + } + ] + }, + "amenityReservationStatusTypes": { + "amenityReservationStatusType": [ + { + "id": 1, + "name": "Pending" + }, + { + "id": 2, + "name": "Rejected" + }, + { + "id": 3, + "name": "Approved" + }, + { + "id": 4, + "name": "Canceled" + } + ] + }, + "taxNumberTypes": { + "taxNumberType": [ + { + "id": 1, + "name": "Social Security Number" + }, + { + "id": 6, + "name": "Personal Public Service Number" + } + ] + }, + "companyIdentificationTypes": { + "companyIdentificationType": [ + { + "id": 18639, + "name": "Alta Identification TYpe" + }, + { + "id": 16245, + "name": "Civic Number" + }, + { + "id": 14829, + "name": "Diver's License" + } + ] + }, + "unitSpaceStatusTypes": { + "unitSpaceStatusType": [ + { + "id": 3, + "name": "Occupied No Notice" + }, + { + "id": 5, + "name": "Notice Rented" + }, + { + "id": 9, + "name": "Notice Unrented" + }, + { + "id": 8, + "name": "Vacant Rented Ready" + }, + { + "id": 6, + "name": "Vacant Rented Not Ready" + }, + { + "id": 2, + "name": "Vacant Unrented Ready" + }, + { + "id": 4, + "name": "Vacant Unrented Not Ready" + } + ] + }, + "genders": { + "gender": [ + { + "id": 1, + "name": "Male" + }, + { + "id": 2, + "name": "Female" + }, + { + "id": 3, + "name": "Co-ed" + } + ] + }, + "defaultAmenities": { + "defaultAmenity": [ + { + "id": 1966, + "name": "1 New Amenity", + "amenityTypeId": 1 + }, + { + "id": 109, + "name": "1st Floor", + "amenityTypeId": 1 + }, + { + "id": 1, + "name": "24-Hour Availability", + "amenityTypeId": 2 + } + ] + }, + "amenityTypes": { + "amenityType": [ + { + "id": 3, + "name": "Negative Features" + }, + { + "id": 1, + "name": "Apartment Amenities" + }, + { + "id": 2, + "name": "Community Amenities" + } + ] + }, + "academicYears": { + "academicYear": [ + { + "id": 3, + "name": "2016" + } + ] + } + } + } + } + }, + "getRentableItemsSuccessExample": { + "summary": "getRentableItems", + "value": { + "response": { + "requestId": "15", + "result": { + "RentableItemTypes": { + "RentableItemType": [ + { + "Id": "2628", + "Name": "Bikes", + "Description": "Motorcycles", + "Rents": { + "Rent": [ + { + "Type": "RIT", + "ChargeCode": "Rent", + "Amount": "$100.00" + } + ] + }, + "Deposits": { + "Deposit": [ + { + "Type": "RIT", + "ChargeCode": "example", + "Amount": "$55.00" + } + ] + }, + "RentableItems": { + "RentableItem": [ + { + "Id": "90613", + "Name": "Hayabuza", + "ReservationStartDate": "05/04/2013", + "ReservationEndDate": "06/30/2013", + "HoldUntil": "04/11/2013", + "Rents": { + "Rent": [ + { + "Type": "RIT", + "ChargeCode": "Rent", + "Amount": "$100.00" + }, + { + "Type": "RI", + "ChargeCode": "Expense", + "Amount": "$90.00" + } + ] + }, + "Deposits": { + "Deposit": [ + { + "Type": "RIT", + "ChargeCode": "example", + "Amount": "$55.00" + }, + { + "Type": "RI", + "ChargeCode": "Cleaning Charge", + "Amount": "$240.00" + } + ] + }, + "Description": "Suzuki" + } + ] + } + } + ] + } + } + } + } + }, + "getReservableAmenitiesSuccessExample": { + "summary": "getReservableAmenities", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "amenities": { + "amenity": [ + { + "id": "123456", + "name": "Tennis Court", + "description": "Beautiful see on the telly across the pond.", + "reservedByDay": "0", + "blockHoursByDay": "1", + "blockDays": { + "blockDay": [ + { + "day": "Sunday", + "blockHours": "12am,1am,2am,11pm" + }, + { + "day": "Monday", + "blockHours": "12am,1am,11pm" + } + ] + }, + "maxReservationDays": "30", + "maxHours": "3", + "isApprovalRequired": "0", + "isResidentVisible": "1", + "isAllowFutureResident": "0", + "rates": { + "rate": [ + { + "arCodeId": "1234", + "arCodeTypeId": "7", + "chargeTypeId": "410", + "amount": "1.00", + "active": "1", + "isPublish": "1" + }, + { + "arCodeId": "1234", + "arCodeTypeId": "3", + "chargeTypeId": "410", + "amount": "2.00", + "active": "1", + "isPublish": "0" + } + ] + } + }, + { + "id": "123456", + "name": "Game Room", + "reservedByDay": "1", + "blockHoursByDay": "0", + "blockDays": { + "blockDay": [ + { + "day": "Sunday", + "blockHours": "No Block HRS" + } + ] + }, + "maxReservationDays": "30", + "maxHours": "1", + "isApprovalRequired": "0", + "isResidentVisible": "1", + "isAllowFutureResident": "0", + "rates": { + "rate": [ + { + "arCodeId": "1234", + "arCodeTypeId": "7", + "chargeTypeId": "410", + "amount": "1.00", + "active": "1", + "isPublish": "1" + } + ] + } + }, + { + "id": "123456", + "name": "Cats", + "description": "Rent details.", + "reservedByDay": "0", + "blockHoursByDay": "0", + "blockDays": { + "blockDay": [ + { + "day": "Sunday", + "blockHours": "No Block HRS" + } + ] + }, + "maxReservationDays": "30", + "maxHours": "5", + "isApprovalRequired": "0", + "isResidentVisible": "1", + "isAllowFutureResident": "0" + } + ] + } + } + } + } + }, + "getWebsitesSuccessExample": { + "summary": "getWebsites", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "websites": { + "website": [ + { + "id": 25079, + "name": "Abhi_website", + "subdomain": "abhiwebsite", + "isCorporateWebsite": 0, + "websiteProperties": { + "websiteProperty": [ + { + "propertyId": "160681", + "propertyName": "Abhi_Test" + } + ] + }, + "websiteDomains": { + "websiteDomain": [ + { + "domain": "test12.com", + "isPrimary": 1, + "isSecure": false + } + ] + } + }, + { + "id": 27922, + "name": "abtestprop", + "subdomain": "abtestprop", + "isCorporateWebsite": 0, + "websiteProperties": { + "websiteProperty": [ + { + "propertyId": "485382", + "propertyName": "AB_TestProp" + } + ] + }, + "websiteDomains": { + "websiteDomain": [ + { + "domain": "test98.com", + "isPrimary": 1, + "isSecure": false + } + ] + } + } + ] + } + } + } + } + }, + "sendFloorplansSuccessExample": { + "summary": "sendFloorplans", + "value": { + "response": { + "requestId": "15", + "code": 300, + "result": { + "Floorplans": { + "Floorplan": [ + { + "node": 1, + "status": "Success", + "floorplanId": 1145077, + "name": "Floorplan 1", + "message": "Floorplan inserted successfully." + }, + { + "node": 2, + "status": "Success", + "floorplanId": 1145078, + "name": "Floorplan 2", + "message": "Floorplan inserted successfully." + } + ] + } + } + } + } + }, + "sendRentableItemsSuccessExample": { + "summary": "sendRentableItems", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "rentableItemTypes": { + "rentableItemType": [ + { + "node": 1, + "rentableItemTypeId": 81625, + "rentableItemIds": "7157472,7157473,7157474", + "status": "Success", + "message": "rentableItemType inserted successfully." + }, + { + "node": 2, + "rentableItemTypeId": 81626, + "rentableItemIds": "7157475,7157476,7157477", + "status": "Success", + "message": "rentableItemType inserted successfully." + } + ] + } + } + } + } + }, + "getPropertyMediaSuccessExample": { + "summary": "getPropertyMedia", + "value": { + "response": { + "code": 200, + "result": { + "propertyId": 123456, + "media": [ + { + "id": "100001", + "mediaTypeId": "6", + "mediaTypeName": "ABC", + "mediaSubTypeId": "24", + "mediaSubTypeName": "Unit Media", + "referenceId": "987654", + "mediaProvider": "XYZ", + "mediaUrl": "https://www.example.com/demo1", + "mediaAltText": "business_demo1", + "name": "demo_name1", + "description": "demo_description1", + "caption": "demo_caption1", + "height": "800", + "width": "600", + "mediaFormat": "jpeg" + }, + { + "id": "100002", + "mediaTypeId": "6", + "mediaTypeName": "PQR", + "mediaSubTypeId": "24", + "mediaSubTypeName": "Unit Media", + "referenceId": "987654", + "mediaProvider": "XYZ", + "mediaUrl": "https://www.example.com/demo2", + "mediaAltText": "business_demo2", + "name": "demo_name2", + "description": "demo_description2", + "caption": "demo_caption2", + "height": "1024", + "width": "768", + "mediaFormat": "png" + }, + { + "id": "100003", + "mediaTypeId": "6", + "mediaTypeName": "unit_floorplan_medias", + "mediaSubTypeId": "24", + "mediaSubTypeName": "Unit Media", + "referenceId": "987654", + "mediaProvider": "LMN", + "mediaUrl": "https://www.example.com/demo3", + "mediaAltText": "business_demo3", + "name": "demo_name3", + "description": "demo_description3", + "caption": "demo_caption3", + "height": "1280", + "width": "720", + "mediaFormat": "gif" + } + ] + } + } + } + }, + "sendPropertyMediaSuccessExample": { + "summary": "sendPropertyMedia", + "value": { + "response": { + "requestId": "1001", + "code": 200, + "result": { + "media": [ + { + "node": 1, + "id": 200001, + "status": "Success", + "message": "Media inserted successfully" + }, + { + "node": 2, + "id": 200002, + "status": "Success", + "message": "Media inserted successfully" + } + ] + } + } + } + }, + "updatePropertyMediaSuccessExample": { + "summary": "updatePropertyMedia", + "value": { + "response": { + "requestId": "1001", + "code": 200, + "result": { + "media": [ + { + "node": 1, + "id": "555555", + "status": "Success", + "message": "Media Updated Successfully" + }, + { + "node": 2, + "id": "666666", + "status": "Success", + "message": "Media Updated Successfully" + } + ] + } + } + } + }, + "deletePropertyMediaSuccessExample": { + "summary": "deletePropertyMedia", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "Success", + "message": "Marketing Media Association deleted successfully." + } + } + } + }, + "getPhoneNumberSuccessExample": { + "summary": "getPhoneNumber", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "123456": "(315) 268-9410" + } + } + } + }, + "getAmenitiesSuccessExample": { + "summary": "getAmenities", + "value": { + "requestId": "15", + "result": { + "Amenities": { + "PropertyAmenities": { + "Amenity": [ + { + "Name": "Property Amenity 1", + "ImageUrl": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg", + "Description": "Property level Amenity", + "Rates": { + "Rate": { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "302", + "Amount": "$300.00", + "IsPublished": "1", + "IsActive": "1", + "LeaseTermId": "18414", + "LeaseStartWindowId": "12345" + } + } + }, + "@attributes": { + "Id": "11111", + "ExternalId": "AmenityRPK", + "IsOptional": "0", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0" + } + }, + { + "Name": "Property Amenity 1", + "Description": "Property level Amenity", + "Rates": { + "Rate": [ + { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "302", + "Amount": "$300.00", + "IsPublished": "1", + "IsActive": "1", + "LeaseTermId": "18414", + "LeaseStartWindowId": "12345" + } + }, + { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "302", + "Amount": "$300.00", + "IsPublished": "0", + "IsActive": "1" + } + } + ] + }, + "@attributes": { + "Id": "22222", + "IsOptional": "0", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0" + } + } + ] + }, + "UnitAmenities": { + "Amenity": { + "Name": "Unit Amenity 1", + "ImageUrl": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg", + "Description": "Unit level Amenity", + "Units": { + "Unit": { + "Rates": { + "Rate": { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "307", + "Amount": "$500.00", + "IsPublished": "0", + "IsActive": "0", + "LeaseTermId": "18414", + "LeaseStartWindowId": "12345" + } + } + }, + "@attributes": { + "PropertyUnitId": "111111", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0", + "ShowDescription": "0", + "IncludeInRent": "0" + } + } + }, + "@attributes": { + "Id": "33333", + "IsStandardAmenity": "1", + "IsOptional": "0", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0", + "ShowDescription": "0", + "IncludeInRent": "0" + } + } + }, + "FloorplanAmenities": { + "Amenity": { + "Name": "Additional Storage", + "ImageUrl": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg", + "Description": "Floorplan Amenity", + "Floorplans": { + "Floorplan": { + "Rates": { + "Rate": { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "303", + "Amount": "$100.00", + "IsPublished": "1", + "IsActive": "1", + "LeaseTermId": "18414", + "LeaseStartWindowId": "12345" + } + } + }, + "@attributes": { + "PropertyFloorplanId": "00000", + "ExternalId": "123456", + "IsOptional": "0", + "IsPublished": "1", + "IsFeatured": "0" + } + } + }, + "@attributes": { + "Id": "0000" + } + } + }, + "UnitTypeAmenities": { + "Amenity": { + "Name": "Unit Amenity 1", + "ImageUrl": "https://medialibrarycdn.entrata.com/media_library/235/5b8f9615c76a41.21527630540.jpg", + "Description": "Unit level Amenity", + "Units": { + "Unit": { + "Rates": { + "Rate": { + "@attributes": { + "ArCodeId": "149655", + "ArCodeTypeId": "2", + "ChargeTypeId": "307", + "Amount": "$500.00", + "IsPublished": "0", + "IsActive": "0", + "LeaseTermId": "18414", + "LeaseStartWindowId": "12345" + } + } + }, + "@attributes": { + "PropertyUnitId": "111111", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0", + "ShowDescription": "0", + "IncludeInRent": "0" + } + } + }, + "@attributes": { + "Id": "33333", + "IsStandardAmenity": "1", + "IsOptional": "0", + "IsPublished": "1", + "IsFeatured": "0", + "HideRates": "0", + "ShowDescription": "0", + "IncludeInRent": "0" + } + } + } + } + } + } + }, + "getMitsPropertyUnitsSuccessExample": { + "summary": "getMitsPropertyUnits", + "value": { + "requestId": "15", + "result": { + "PhysicalProperty": { + "Management": { + "Identification": { + "IDValue": "1234", + "OrganizationName": "DB Xento Systems Pvt. Ltd." + }, + "PropertyContacts": { + "Companies": { + "Identification": { + "IDValue": "1234" + }, + "CompanyName": "DB Xento Systems Pvt. Ltd.", + "WebSite": "http://newtestinggroup.prospectportal.com" + } + } + }, + "Property": [ + { + "Identification": { + "IDValue": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "PropertyID": { + "Identification": { + "IDValue": "1234", + "OrganizationName": "TEST", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "MarketingName": "ZOMBIES", + "LegalName": "ZOMBIES", + "WebSite": "http://testrentreminderlobby.prospectportal.com", + "Address": { + "Address": "500 S, 100 W, 100k", + "City": "Provo", + "State": "UT", + "PostalCode": "84601", + "Country": "US", + "@attributes": { + "AddressType": "property" + } + }, + "Phone": [ + { + "PhoneDescription": "Office", + "PhoneNumber": "190018000", + "@attributes": { + "PhoneType": "office" + } + }, + { + "PhoneDescription": "Fax", + "PhoneNumber": "9898989898", + "@attributes": { + "PhoneType": "fax" + } + }, + { + "PhoneDescription": "Maintenance", + "PhoneNumber": "2323232323", + "@attributes": { + "PhoneType": "other" + } + }, + { + "PhoneDescription": "Maintenance Emergency", + "PhoneNumber": "8524166985", + "@attributes": { + "PhoneType": "other" + } + } + ] + }, + "ILS_Identification": { + "DaylightSaving": "0", + "TimeZone": "Central Standard Time (GMT -0600)", + "@attributes": { + "ILS_IdentificationType": "Apartment", + "RentalType": "Unspecified" + } + }, + "Information": { + "StructureType": "Unspecified", + "UnitCount": "6", + "YearBuilt": "2012", + "OfficeHour": [ + { + "OpenTime": "11:11 AM", + "CloseTime": "3:11 PM", + "Day": "Monday" + } + ], + "ShortDescription": "This is data thank you", + "LongDescription": "This is.Thank you.", + "LeaseLength": "1 month, 2 months, 3 months, 4 months, 6 months, 12 months, 18 months", + "DrivingDirections": "This characters.", + "PropertyAvailabilityURL": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234" + }, + "Fee": { + "ApplicationFee": { + "@attributes": { + "Type": "Primary Applicant", + "Amount": "30" + } + } + }, + "Concession": [ + { + "Value": "10.00", + "DescriptionHeader": "Test_Special", + "DescriptionBody": "description", + "DescriptionFooter": "footer description", + "@attributes": { + "Active": "1" + } + } + ], + "Amenity": [ + { + "Description": "24 Hour Emergency Maintenancess", + "@attributes": { + "AmenityType": "Other" + } + }, + { + "Description": "ac", + "@attributes": { + "AmenityType": "Other" + } + } + ], + "Policy": { + "Pet": [ + { + "Pets": { + "@attributes": { + "Count": "0", + "Description": "Cat", + "PetType": "Cat", + "Size": "Medium", + "Weight": "" + } + }, + "@attributes": { + "Allowed": "true" + } + } + ], + "General": "You can park your vehical anywhere except reserved parking spaces." + }, + "Building": [ + { + "Identification": { + "IDValue": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "Name": "ZOM 1", + "Description": "ZOM 1", + "UnitCount": "85", + "SquareFeet": "0", + "File": { + "FileType": "Photo", + "Name": "hotchocolate2_documentation_copy1.pdf", + "Format": "pdf", + "Src": "https://medialibrary.propertysolutions.com/media_library/1234/51cbf70a726cd636.pdf", + "Rank": "3", + "@attributes": { + "FileID": "461182", + "Active": "true" + } + } + } + ], + "Floorplan": [ + { + "Identification": { + "IDValue": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "Name": "ZOM 1", + "Comment": "ZOM 1", + "UnitCount": "0", + "FloorplanAvailabilityURL": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234/launch_guest_card/1/property_floorplan[id]/1234", + "UnitsAvailable": "102", + "DisplayedUnitsAvailable": "1", + "Room": [ + { + "Count": "1", + "Comment": "Bedroom", + "@attributes": { + "RoomType": "Bedroom" + } + }, + { + "Count": "1", + "Comment": "Bathroom", + "@attributes": { + "RoomType": "Bathroom" + } + } + ], + "SquareFeet": { + "@attributes": { + "Avg": "0", + "Max": "0", + "Min": "0" + } + }, + "MarketRent": { + "@attributes": { + "Avg": "0", + "Max": "6262", + "Min": "1040" + } + }, + "Concession": { + "Value": "10.00", + "DescriptionHeader": "Test_Special", + "DescriptionBody": "description", + "DescriptionFooter": "footer description", + "@attributes": { + "Active": "1" + } + }, + "Deposit": { + "Amount": { + "ValueRange": { + "@attributes": { + "Max": "$500.00", + "Min": "$500.00" + } + }, + "@attributes": { + "AmountType": "MonthMultiple" + } + }, + "@attributes": { + "DepositType": "security deposit" + } + }, + "File": [ + { + "FileType": "Floorplan", + "Description": "2D Floor Plan", + "Name": "5125fe314bfad415.jpg", + "Caption": "5125fe314bfad415.jpg", + "Format": "jpg", + "Src": "https://medialibrary.propertysolutions.com/media_library/1234/5125fe314bfad415.jpg", + "Width": "640", + "Height": "480", + "Rank": "1", + "@attributes": { + "FileID": "442034", + "Active": "true" + } + } + ] + } + ], + "ILS_Unit": [ + { + "Identification": { + "IDValue": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "Units": { + "Unit": { + "Identification": { + "IDValue": "1234", + "@attributes": { + "IDType": "UnitID", + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "MarketingName": "2-A", + "UnitType": "ZOM 1", + "UnitBedrooms": "3", + "UnitBathrooms": "2", + "SquareFootType": "internal", + "UnitRent": 565, + "MarketRent": 565, + "UnitOccupancyStatus": "vacant", + "UnitEconomicStatus": "Other", + "UnitEconomicStatusDescription": "Conventional", + "NumberOccupants": { + "@attributes": { + "Total": "0" + } + }, + "FloorplanName": "ZOM 1", + "BuildingName": "ShashiZom4", + "ExclusionReason": "Employee Unit", + "Address": { + "Address": "asdf, asdf", + "City": "sdf", + "State": "AL", + "PostalCode": "21345", + "Country": "US", + "@attributes": { + "AddressType": "property" + } + }, + "@attributes": { + "BuildingId": "18172", + "FloorPlanId": "1234" + } + } + }, + "EffectiveRent": "700", + "Concession": { + "Value": "10.00", + "DescriptionHeader": "Test_Special", + "DescriptionBody": "description", + "DescriptionFooter": "footer description", + "@attributes": { + "Active": "1" + } + }, + "Availability": { + "VacateDate": { + "@attributes": { + "Month": "04", + "Day": "20", + "Year": "2013" + } + }, + "VacancyClass": "Unoccupied", + "MadeReadyDate": { + "@attributes": { + "Month": "04", + "Day": "19", + "Year": "2013" + } + }, + "UnitAvailabilityURL": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234/launch_guest_card/1/property_floorplan[id]/1234/property_unit[id]/1234" + }, + "Amenity": [ + { + "Description": "Alarm", + "@attributes": { + "AmenityType": "Alarm" + } + }, + { + "Description": "test ritika unit", + "@attributes": { + "AmenityType": "Other" + } + } + ], + "File": { + "FileType": "Photo", + "Name": "hotchocolate2_documentation_copy1.pdf", + "Format": "pdf", + "Src": "https://medialibrary.propertysolutions.com/media_library/1234/51cbf70a726cd636.pdf", + "Rank": "1", + "@attributes": { + "FileID": "123456", + "Active": "true" + } + } + } + ], + "Utility": { + "Gas": { + "@attributes": { + "isPublished": "true", + "ResidentIsResponsible": "true" + } + }, + "Trash": { + "@attributes": { + "isPublished": "true", + "ResidentIsResponsible": "true" + } + }, + "Electric": { + "@attributes": { + "isPublished": "true", + "ResidentIsResponsible": "true" + } + }, + "@attributes": { + "MajorUtility": "Unspecified" + } + }, + "File": [ + { + "FileType": "Photo", + "Description": "test", + "Name": "hotchocolate2_documentation_copy1.pdf", + "Caption": "test", + "Format": "pdf", + "Src": "https://medialibrary.propertysolutions.com/media_library/1234/51cbefff0e19d993.pdf", + "Rank": "1", + "@attributes": { + "FileID": "1234", + "Active": "true" + } + } + ] + } + ] + } + } + } + }, + "getPropertyUnitsSuccessExample": { + "summary": "getPropertyUnits", + "value": { + "response": { + "requestId": 15, + "result": { + "properties": { + "property": [ + { + "propertyId": 1234, + "propertyName": "property name", + "remotePrimaryKey": "client name", + "unitCount": 6, + "buildingCount": 4, + "propertyAvailabilityURL": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234", + "units": { + "unit": { + "id": 5678, + "unitNumber": 302, + "buildingId": 34, + "buildingName": "ShashiZom4", + "floorplanId": 123, + "floorplanName": "ZOM 1", + "unitTypeId": 6789, + "unitTypeName": "ZOM 1", + "noOfBedrooms": 3, + "noOfBathrooms": 2, + "squareFeet": 1500, + "isFurnished": 1, + "isCorportateRented": 1, + "numberOccupants": 1, + "maxPets": 1, + "unitAvailabilityURL": "http://lobby.prospectportal.com/Apartments/module/property_info/property[id]/1234/launch_guest_card/1/property_floorplan[id]/1234/property_unit[id]/1234", + "unitAddress": { + "address": "500 S, 100 W, 100k", + "city": "Provo", + "state": "UT", + "postalCode": 84601, + "country": "US" + }, + "unitSpaces": { + "unitSpace": { + "unitSpaceId": 1245, + "unitNumber": "302-A", + "isAffordable": 0, + "hasPricing": 0, + "excludedReason": "Hospitality Unit", + "spaceConfiguration": "space configuration name", + "availabilityStatus": "Unoccupied", + "availableDate": "YYYY-MM-DD", + "makeReadyDate": "YYYY-MM-DD", + "rent": { + "minRent": 25000, + "maxRent": 30000, + "termRent": { + "leaseTermId": 8, + "leaseTermName": "1 month", + "startDate": "YYYY-MM-DD", + "endDate": "YYYY-MM-DD", + "amount": 0, + "isBestPrice": 1 + } + }, + "minDeposit": "6,000.00", + "maxDeposit": "7,000.00", + "reserveUntil": "", + "amenities": { + "amenity": { + "id": 234, + "name": "amenity1", + "type": "type" + } + }, + "pets": { + "pet": { + "type": "Cat", + "count": 2, + "deposit": 50, + "rent": 50, + "fee": 50, + "petCare": false, + "restrictions": "PET Allowed", + "description": "PET Allowed" + } + }, + "rentableItems": { + "rentableItem": { + "id": 1, + "name": "rentable item name" + } + }, + "assignableItems": { + "assignableItem": { + "id": 1, + "name": "assignable item name" + } + }, + "services": { + "service": { + "id": 1, + "name": "property service name" + } + } + } + }, + "customKeysData": { + "customKeyData": [ + { + "key": "TEST", + "value": "test" + }, + { + "key": "TESTD", + "value": "test" + } + ] + }, + "files": { + "file": { + "fileId": "1234", + "fileType": "Photo", + "name": "hotchocolate2_documentation_copy1.pdf", + "caption": "Unit_50405b6044b25172.jpg", + "format": "pdf", + "src": "https://medialibrary.propertysolutions.com/media_library/1234/51cbf70a726cd636.pdf", + "width": 456, + "height": 2456, + "rank": 3 + } + } + } + } + } + ] + } + } + } + } + }, + "getSpecials_r1_SuccessExample": { + "summary": "getSpecials(r1)", + "value": { + "response": { + "requestId": 15, + "result": { + "PhysicalProperty": { + "Property": { + "Identification": { + "IDValue": 21442 + }, + "PropertyID": { + "Identification": { + "IDValue": 21442, + "OrganizationName": "DB Xento Systems Pvt. Ltd." + }, + "MarketingName": "Marketing Name", + "LegalName": "Legal Name" + }, + "Concession": [ + { + "@attributes": { + "Active": 1 + }, + "Value": "10.00", + "DescriptionHeader": "Consession", + "DescriptionBody": "description body", + "DescriptionFooter": "description footer" + } + ], + "Floorplan": [ + { + "Identification": { + "IDValue": 127493 + }, + "Name": "FP", + "Comment": "FP", + "Concession": [ + { + "@attributes": { + "Active": 1 + }, + "Value": "100.00", + "DescriptionHeader": "Consession", + "DescriptionBody": "Description", + "DescriptionFooter": "Description" + } + ] + } + ], + "ILS_Unit": [ + { + "Units": { + "Unit": { + "@attributes": { + "BuildingId": null, + "FloorPlanId": 127469 + }, + "Identification": { + "@attributes": { + "IDRank": "primary", + "IDScopeType": "sender", + "IDType": "UnitID" + }, + "IDValue": 2261175 + }, + "MarketingName": "unit1" + } + }, + "Concession": [ + { + "@attributes": { + "Active": 1 + }, + "Value": "50.00", + "DescriptionHeader": "Test Special", + "DescriptionBody": "description body", + "DescriptionFooter": "description footer" + } + ] + } + ] + } + } + } + } + } + }, + "getSpecials_r2_SuccessExample": { + "summary": "getSpecials(r2)", + "value": { + "value": null, + "response": { + "requestId": 15, + "result": { + "specials": { + "propertyId": "54638", + "organizationName": "Demo Account", + "marketingName": "JJ Property (Jonathan's)", + "legalName": "JJ Property (Jonathan's)", + "propertySpecials": { + "special": { + "id": "505909", + "name": "aaa", + "description": "Through the month of January we give renters a special $300 off their first month's rent.", + "note": "Notes", + "startDate": "08/06/2018", + "endDate": "08/30/2018", + "couponCode": "GET50", + "cap": "100", + "remaining": "100", + "showOnWebsite": "1", + "isActive": "1", + "rates": { + "rate": [ + { + "chargeCodeId": "149206", + "chargeCodeTypeId": "2", + "amount": "42", + "showOnWebsite": true, + "leaseTermId": 3677 + }, + { + "chargeCodeId": "149206", + "chargeCodeTypeId": "2", + "amount": "42", + "showOnWebsite": true, + "leaseTermId": 3677 + }, + { + "chargeCodeId": "149206", + "chargeCodeTypeId": "2", + "amount": "42", + "showOnWebsite": true, + "leaseTermId": 3677 + }, + { + "chargeCodeId": "149206", + "chargeCodeTypeId": "2", + "amount": "42", + "showOnWebsite": true, + "leaseTermId": 3677 + }, + { + "chargeCodeId": "168261", + "chargeCodeTypeId": "7", + "amount": "5", + "showOnWebsite": true, + "leaseTermId": 3677 + }, + { + "chargeCodeId": "168260", + "chargeCodeTypeId": "3", + "amount": "5", + "showOnWebsite": true, + "leaseTermId": 3677 + } + ] + }, + "leaseTerms": { + "leaseTerm": [ + { + "chargeCodeTypeId": "2", + "leaseTermId": "838", + "leaseTermName": "6 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "839", + "leaseTermName": "11 Months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "840", + "leaseTermName": "12 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "841", + "leaseTermName": "16 months", + "isActive": "1" + } + ] + } + } + }, + "floorplanSpecials": { + "special": { + "id": "12015762", + "name": "TestFloorPlan", + "description": "Description", + "note": "Notes", + "startDate": "08/06/2018", + "endDate": "08/23/2018", + "couponCode": "GET50", + "cap": "10", + "remaining": "10", + "showOnWebsite": "1", + "isActive": "1", + "floorplans": { + "floorplan": { + "id": "145501", + "name": "Lincoln", + "rates": { + "rate": [ + { + "chargeCodeId": "185264", + "chargeCodeTypeId": "2", + "amount": "3" + }, + { + "chargeCodeId": "185264", + "chargeCodeTypeId": "2", + "amount": "3" + }, + { + "chargeCodeId": "185264", + "chargeCodeTypeId": "2", + "amount": "3" + }, + { + "chargeCodeId": "168261", + "chargeCodeTypeId": "7", + "amount": "4" + }, + { + "chargeCodeId": "200227", + "chargeCodeTypeId": "3", + "amount": "5" + } + ] + }, + "leaseTerms": { + "leaseTerm": [ + { + "chargeCodeTypeId": "2", + "leaseTermId": "838", + "leaseTermName": "6 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "840", + "leaseTermName": "12 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "841", + "leaseTermName": "16 months", + "isActive": "1" + } + ] + } + } + } + } + }, + "unitTypeSpecials": { + "special": { + "id": "12015763", + "name": "TestFloorPlanUnitType", + "description": "Description", + "note": "Notes", + "startDate": "08/06/2018", + "endDate": "08/31/2018", + "couponCode": "GET50", + "cap": "10", + "remaining": "10", + "showOnWebsite": "1", + "isActive": "1", + "unitTypes": { + "unitType": { + "id": "161606", + "name": "One Bedroom", + "rates": { + "rate": [ + { + "chargeCodeId": "152686", + "chargeCodeTypeId": "2", + "amount": "6" + }, + { + "chargeCodeId": "152686", + "chargeCodeTypeId": "2", + "amount": "6" + }, + { + "chargeCodeId": "152686", + "chargeCodeTypeId": "2", + "amount": "6" + }, + { + "chargeCodeId": "207614", + "chargeCodeTypeId": "7", + "amount": "12" + }, + { + "chargeCodeId": "207611", + "chargeCodeTypeId": "3", + "amount": "14" + } + ] + }, + "leaseTerms": { + "leaseTerm": [ + { + "chargeCodeTypeId": "2", + "leaseTermId": "838", + "leaseTermName": "6 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "840", + "leaseTermName": "12 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "841", + "leaseTermName": "16 months", + "isActive": "1" + } + ] + } + } + } + } + }, + "unitSpaceSpecials": { + "special": { + "id": "12015764", + "name": "TestFloorPlanUnitSpace", + "description": "Description", + "note": "Notes", + "startDate": "08/06/2018", + "endDate": "08/31/2018", + "couponCode": "GET50", + "cap": "10", + "remaining": "10", + "showOnWebsite": "1", + "isActive": "1", + "unitSpaces": { + "unitSpace": { + "id": "2421766", + "buildingId": "17642", + "buildingName": "One", + "propertyUnitId": "2409587", + "name": "88", + "rates": { + "rate": [ + { + "chargeCodeId": "208782", + "chargeCodeTypeId": "2", + "amount": "45" + }, + { + "chargeCodeId": "208782", + "chargeCodeTypeId": "2", + "amount": "45" + }, + { + "chargeCodeId": "208782", + "chargeCodeTypeId": "2", + "amount": "45" + }, + { + "chargeCodeId": "207614", + "chargeCodeTypeId": "7", + "amount": "56" + }, + { + "chargeCodeId": "168260", + "chargeCodeTypeId": "3", + "amount": "78" + } + ] + }, + "leaseTerms": { + "leaseTerm": [ + { + "chargeCodeTypeId": "2", + "leaseTermId": "838", + "leaseTermName": "6 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "840", + "leaseTermName": "12 months", + "isActive": "1" + }, + { + "chargeCodeTypeId": "2", + "leaseTermId": "841", + "leaseTermName": "16 months", + "isActive": "1" + } + ] + } + } + } + } + } + } + } + } + } + }, + "getSpecials_r3_SuccessExample": { + "summary": "getSpecials(r3)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "specials": { + "propertyId": 171712, + "organizationName": "Demo Account", + "marketingName": "14 th South Avenue", + "legalName": "14 th South Avenue", + "propertySpecials": { + "special": { + "12019486": { + "id": "12019486", + "name": "90 - 61", + "showOnWebsite": 1, + "isActive": 1, + "giftValue": "0.00" + } + } + }, + "floorplanSpecials": { + "special": { + "12033041": { + "id": "12033041", + "name": "Floor special2", + "description": "Great Deal!!! Great Deal!!! Great Deal!!! Great Deal!!! Great Deal!!!", + "startDate": "12/15/2020", + "endDate": "12/30/2020", + "showOnWebsite": 1, + "isActive": 1, + "giftValue": "200.00", + "floorplans": { + "floorplan": [ + { + "id": "935877", + "name": "Catch All Floor Plan" + } + ] + } + } + } + }, + "unitTypeSpecials": { + "special": { + "12017831": { + "id": "12017831", + "name": "unit type gift incentive", + "showOnWebsite": 1, + "isActive": 1, + "giftValue": "300.00", + "unitTypes": { + "unitType": [ + { + "id": "577608", + "name": "Alabaster" + } + ] + } + }, + "12018824": { + "id": "12018824", + "name": "Gift Card 100", + "showOnWebsite": 0, + "isActive": 1, + "giftValue": "100.00", + "unitTypes": { + "unitType": [ + { + "id": "577608", + "name": "Alabaster" + } + ] + } + }, + "12019387": { + "id": "12019387", + "name": "2019-10-07 - 2019-10-31", + "startDate": "10/07/2019", + "endDate": "10/31/2019", + "cap": "20", + "remaining": "19", + "showOnWebsite": 1, + "isActive": 1, + "giftValue": "0.00", + "unitTypes": { + "unitType": [ + { + "id": "484492", + "name": "Test 1", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "484491", + "name": "Test UI", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "484481", + "name": "1280 SQ FT", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "377032", + "name": "Unit A", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "484482", + "name": "1281 SQ FT", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "581890", + "name": "2bhk", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "581851", + "name": "U2", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "581850", + "name": "U1", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "579625", + "name": "RI Testing", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "578265", + "name": "No Units", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "578249", + "name": "+ test", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "577608", + "name": "Alabaster", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "524275", + "name": "Test Budgeted", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "517410", + "name": "Magarpatta Unit Type", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "506107", + "name": "UT 1x1", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "505548", + "name": "default", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "504688", + "name": "Rate No Units", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + }, + { + "id": "493421", + "name": "A8A South Avenue", + "rates": { + "rate": [ + { + "chargeCodeId": 207910, + "chargeCodeTypeId": 2, + "amount": 55, + "showOnWebsite": true + } + ] + } + } + ] + } + } + } + }, + "unitSpaceSpecials": { + "special": { + "12034174": { + "id": "12034174", + "name": "Test", + "showOnWebsite": 1, + "isActive": 1, + "giftValue": "400.00", + "unitSpaces": { + "unitSpace": [ + { + "id": "5164266", + "propertyUnitId": "4880109", + "name": "A3" + } + ] + } + } + } + } + } + } + } + } + }, + "getUnitsAvailabilityAndPricingSuccessExample": { + "summary": "getUnitsAvailabilityAndPricing", + "value": { + "requestId": "15", + "result": { + "Properties": { + "Property": { + "PropertyId": "1234", + "MarketingName": "Andover House", + "Floorplans": { + "Floorplan": [ + { + "Identification": { + "IDValue": "1234", + "OrganizationName": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "Name": "Fairview", + "Comment": "Fairview", + "UnitCount": "1", + "UnitsAvailable": "1", + "DisplayedUnitsAvailable": "1", + "Room": [ + { + "Description": "Bedrooms", + "Count": "1", + "Comment": "Bedrooms", + "@attributes": { + "RoomType": "Bedroom" + } + }, + { + "Description": "Bathrooms", + "Count": "1", + "Comment": "Bathrooms", + "@attributes": { + "RoomType": "Bathroom" + } + } + ], + "SquareFeet": { + "@attributes": { + "Avg": "0", + "Max": "968", + "Min": "968" + } + }, + "MarketRent": { + "@attributes": { + "Avg": "0", + "Max": "4459", + "Min": "2577" + } + }, + "Deposit": { + "Amount": { + "ValueRange": { + "@attributes": { + "Max": "$100.00", + "Min": "$100.00" + } + }, + "@attributes": { + "AmountType": "MonthMultiple" + } + }, + "@attributes": { + "DepositType": "security deposit" + } + } + }, + { + "Identification": { + "IDValue": "1234", + "OrganizationName": "1234", + "@attributes": { + "IDScopeType": "sender", + "IDRank": "primary" + } + }, + "Name": "Name", + "Comment": "Comment", + "UnitCount": "1", + "UnitsAvailable": "1", + "DisplayedUnitsAvailable": "1", + "Room": [ + { + "Description": "Bedrooms", + "Count": "1", + "Comment": "Bedrooms", + "@attributes": { + "RoomType": "Bedroom" + } + }, + { + "Description": "Bathrooms", + "Count": "1", + "Comment": "Bathrooms", + "@attributes": { + "RoomType": "Bathroom" + } + } + ], + "SquareFeet": { + "@attributes": { + "Avg": "0", + "Max": "123", + "Min": "123" + } + }, + "MarketRent": { + "@attributes": { + "Avg": "0", + "Max": "123", + "Min": "123" + } + }, + "Deposit": { + "Amount": { + "ValueRange": { + "@attributes": { + "Max": "$100.00", + "Min": "$100.00" + } + }, + "@attributes": { + "AmountType": "MonthMultiple" + } + }, + "@attributes": { + "DepositType": "security deposit" + } + } + } + ] + } + } + }, + "PropertyUnits": { + "PropertyUnit": [ + { + "UnitSpace": { + "Rent": { + "TermRent": { + "@attributes": { + "LeaseTermId": "342", + "LeaseStartWindowId": "123", + "LeaseTerm": "10 Months", + "LeaseTermName": "10 months", + "IsWebVisible": "1", + "Rent": "1,000.00", + "RateFrequency": "Monthly" + } + }, + "@attributes": { + "MinRent": "1,000.00", + "MaxRent": "1,000.00" + } + }, + "Deposit": { + "@attributes": { + "MinDeposit": "95.00", + "MaxDeposit": "565.00" + } + }, + "@attributes": { + "Id": "2224908", + "UnitNumber": "A", + "Availability": "Available", + "Status": "Vacant Ready (Available)", + "AvailableOn": "08/03/2013", + "OccupancyType": "Conventional", + "IsAffordable": "0", + "HasPricing": "1", + "Area": "1300.0000 SquareMeter" + } + } + }, + { + "UnitSpace": { + "Rent": { + "TermRent": { + "@attributes": { + "LeaseTermId": "342", + "LeaseStartWindowId": "123", + "LeaseTerm": "12 Months", + "LeaseTermName": "12 months", + "IsWebVisible": "0", + "Rent": "1,000.00", + "RateFrequency": "Monthly" + } + }, + "@attributes": { + "MinRent": "1,000.00", + "MaxRent": "1,000.00" + } + }, + "Deposit": { + "@attributes": { + "MinDeposit": "95.00", + "MaxDeposit": "565.00" + } + }, + "@attributes": { + "Id": "2224910", + "UnitNumber": "A", + "Availability": "Available", + "Status": "Vacant Ready (Available)", + "AvailableOn": "06/15/2013", + "MakeReadyDate": "06/14/2013", + "IsAffordable": "0", + "HasPricing": "1", + "Area": "1300.0000 SquareFeet" + } + } + }, + { + "UnitSpace": { + "Rent": { + "TermRent": { + "@attributes": { + "LeaseTermId": "342", + "LeaseStartWindowId": "123", + "LeaseTerm": "3 Months", + "LeaseTermName": "3 months", + "IsWebVisible": "1", + "Rent": "1,000.00", + "RateFrequency": "Monthly" + } + }, + "@attributes": { + "MinRent": "1,000.00", + "MaxRent": "1,000.00" + } + }, + "Deposit": { + "@attributes": { + "MinDeposit": "95.00", + "MaxDeposit": "565.00" + } + }, + "@attributes": { + "Id": "2224911", + "UnitNumber": "B", + "Availability": "Available", + "Status": "Vacant Ready (Available)", + "AvailableOn": "01/02/2014", + "MakeReadyDate": "07/20/2013", + "IsAffordable": "0", + "HasPricing": "1", + "Area": "1300.0000 SquareMeter" + } + } + } + ] + } + } + } + }, + "getUnitTypesSuccessExample": { + "summary": "getUnitTypes", + "value": { + "response": { + "requestId": 15, + "result": { + "property": { + "type": "Apartment", + "propertyId": "00000", + "parentPropertyId": "0000", + "marketingName": "Test", + "generalId": "0000", + "yearBuilt": "0000", + "shortDescription": "This is short description", + "longDescription": "This is Long Description" + }, + "unitTypes": { + "unitType": [ + { + "identificationType": { + "@attributes": { + "idType": "unitTypeId" + }, + "idValue": "0000" + }, + "name": "test", + "floorplan": { + "543312": { + "@attributes": { + "Id": "543312" + }, + "@value": "FPN" + } + }, + "unitBedRooms": "0", + "unitBathrooms": "0", + "minSquareFeet": "000", + "maxSquareFeet": "0000", + "minMarketRent": "0000", + "maxMarketRent": "0000", + "rent": { + "termRent": [ + { + "@attributes": { + "leaseTerm": "6 Months", + "leaseTermId": 19125, + "leaseTermName": "6 months", + "rent": "10.00", + "startDate": "MM/DD/YYYY", + "endtDate": "MM/DD/YYYY", + "spaceOption": "Private", + "isSoldOut": false + } + }, + { + "@attributes": { + "leaseTerm": "18 Months", + "leaseTermId": 19125, + "leaseTermName": "18 months", + "rent": "10.00", + "startDate": "MM/DD/YYYY", + "endtDate": "MM/DD/YYYY", + "spaceOption": "Private", + "isSoldOut": false + } + } + ] + } + } + ] + } + } + } + } + }, + "sendAmenitiesSuccessExample": { + "summary": "sendAmenities", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "propertyAmenities": [ + { + "node": 1, + "status": "Success", + "amenityId": 1200111, + "rateAssociationId": 9050818, + "name": "P Amenity 1011", + "message": "Amenity inserted successfully." + }, + { + "node": 2, + "status": "Success", + "amenityId": 1200112, + "rateAssociationId": 9050819, + "name": "P Amenity 1041", + "message": "Amenity inserted successfully." + } + ], + "unitAmenities": [ + { + "node": 1, + "status": "Success", + "amenityId": 1200113, + "rateAssociationId": 9050820, + "name": "U Amenity 1011", + "message": "Amenity inserted successfully." + }, + { + "node": 2, + "status": "Success", + "amenityId": 1200114, + "rateAssociationId": 9050821, + "name": "U Amenity 1061", + "message": "Amenity inserted successfully." + } + ] + } + } + } + }, + "sendPropertyUnitsSuccessExample": { + "summary": "sendPropertyUnits", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "units": { + "unit": [ + { + "node": 1, + "unitId": 5242133, + "unitNumber": "CC20BB", + "unitSpace": "1", + "status": "Success", + "message": "unit inserted successfully." + }, + { + "node": 2, + "unitId": 5242133, + "unitNumber": "CC20BB", + "unitSpace": "3", + "status": "Success", + "message": "unit inserted successfully." + } + ] + } + } + } + } + }, + "updateAmenitiesSuccessExample": { + "summary": "updateAmenities", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "propertyAmenities": { + "propertyAmenity": [ + { + "node": 1, + "status": "Success", + "amenityId": 147852, + "message": "Amenity updated successfully." + } + ] + }, + "floorplanAmenities": { + "floorplanAmenity": [ + { + "node": 1, + "status": "Success", + "amenityId": 1139719, + "message": "Amenity updated successfully." + } + ] + }, + "unitTypeAmenities": { + "unitTypeAmenity": [ + { + "node": 1, + "status": "Failure", + "message": "Missing value for parameter 'id'." + } + ] + }, + "unitSpaceAmenities": { + "unitSpaceAmenity": [ + { + "node": 1, + "status": "Success", + "amenityId": 1162615, + "message": "Amenity updated successfully." + } + ] + } + } + } + } + }, + "sendSpecialGroupSuccessExample": { + "summary": "sendSpecialGroup", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "success", + "specialGroupId": 12345, + "message": "Special added successfully." + } + } + } + }, + "updateSpecialGroupSuccessExample": { + "summary": "updateSpecialGroup", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "status": "success", + "specialGroupId": 12345, + "message": "Special updated successfully." + } + } + } + }, + "getSpecials_r4_SuccessExample": { + "summary": "getSpecials(r4)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "specialGroups": [ + { + "specialGroupId": "123456", + "specialGroupName": "Demo_special_group_name1", + "quantityBudgeted": null, + "quantityRemaining": null, + "isActive": "0", + "isAdvertised": "1", + "showOnWebsite": "0", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "description": null, + "internalDescription": null, + "couponCode": null, + "specialRecipientDetails": [ + { + "specialRecipientId": 2, + "specialRecipientName": "ABC" + } + ], + "limitQuantity": "0", + "termsAndConditions": null, + "leadSourceDetails": [ + { + "id": "1234567", + "name": "Dummy_name" + } + ], + "renewalLeaseStartDateRange": null, + "prospectLeaseStartDateRange": null, + "spaceConfigurationDetails": [ + { + "spaceConfigurationId": "1234567", + "spaceConfigurationName": "Dummy_name" + } + ], + "incentiveLimit": "1", + "isSelectable": "0", + "associations": { + "levelId": "1", + "levelName": "XYZ", + "unitCount": 1, + "references": [ + { + "id": "1234567", + "name": "Dummy_name" + } + ] + }, + "specialRecipientTriggerTypeDetails": [ + { + "specialRecipientTriggerTypeId": "11", + "specialRecipientTriggerTypeName": "XYZ" + } + ], + "leaseTermDetails": [ + { + "leaseTermId": "1", + "leaseTermName": "PQR", + "leaseStartWindowId": "0" + }, + { + "leaseTermId": "3", + "leaseTermName": "UVW", + "leaseStartWindowId": "0" + } + ], + "specials": [ + { + "specialId": "6666666", + "specialTypeId": "1", + "specialName": "Dummy_special_name", + "giftValue": "0.00", + "rate": [ + { + "rateId": "123456789", + "arCodeId": "213141", + "arCodeTypeName": "ABC", + "arCodeName": "XYZ", + "arTriggerId": "307", + "arTriggerName": "PQR", + "arFormulaId": "1", + "arFormulaName": "UVW", + "arFormulaReferenceId": "0", + "rateAmount": "-1.00", + "rateIncreaseIncrement": "0.000000", + "rateShowOnWebsite": "1", + "rateShowInEntrata": "1", + "spaceConfigurationId": "0", + "spaceConfigurationName": "", + "leaseTermId": "1", + "leaseTermName": "XYZ", + "leaseStartWindowId": "0", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY" + }, + { + "rateId": "123456789", + "arCodeId": "BCD", + "arCodeTypeName": "ABC", + "arCodeName": "XYZ", + "arTriggerId": "100", + "arTriggerName": "PQR", + "arFormulaId": "1", + "arFormulaName": "ABC", + "arFormulaReferenceId": "0", + "rateAmount": "-1.00", + "rateIncreaseIncrement": "0.000000", + "rateShowOnWebsite": "1", + "rateShowInEntrata": "1", + "spaceConfigurationId": "0", + "spaceConfigurationName": "", + "leaseTermId": "6", + "leaseTermName": "XYZ", + "leaseStartWindowId": "0", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY" + } + ] + } + ] + }, + { + "specialGroupId": "55555", + "specialGroupName": "Dummy_special_group_name2", + "quantityBudgeted": null, + "quantityRemaining": null, + "isActive": "1", + "isAdvertised": "1", + "showOnWebsite": "1", + "startDate": null, + "endDate": null, + "description": null, + "internalDescription": null, + "couponCode": null, + "specialRecipientDetails": [ + { + "specialRecipientId": 2, + "specialRecipientName": "XYZ" + }, + { + "specialRecipientId": 1, + "specialRecipientName": "XYZ" + }, + { + "specialRecipientId": 3, + "specialRecipientName": "XYZ" + } + ], + "limitQuantity": "0", + "termsAndConditions": null, + "leadSourceDetails": [ + { + "id": "1234567", + "name": "Dummy_name" + } + ], + "renewalLeaseStartDateRange": null, + "prospectLeaseStartDateRange": null, + "spaceConfigurationDetails": [ + { + "spaceConfigurationId": "1234567", + "spaceConfigurationName": "Dummy_name" + } + ], + "incentiveLimit": "1", + "isSelectable": "0", + "associations": { + "levelId": "1", + "levelName": "ABC", + "unitCount": 1, + "references": [ + { + "id": "123456", + "name": "ABC" + } + ] + }, + "specialRecipientTriggerTypeDetails": [ + { + "specialRecipientTriggerTypeId": "11", + "specialRecipientTriggerTypeName": "ABC" + }, + { + "specialRecipientTriggerTypeId": "27", + "specialRecipientTriggerTypeName": "XYZ" + } + ], + "leaseTermDetails": [ + { + "leaseTermId": "1", + "leaseTermName": "PQR", + "leaseStartWindowId": "0" + }, + { + "leaseTermId": "2", + "leaseTermName": "UVW", + "leaseStartWindowId": "0" + } + ], + "specials": [ + { + "specialId": "78787878", + "specialTypeId": "1", + "specialName": "XYZ", + "giftValue": "0.00", + "rate": [ + { + "rateId": "456789123", + "arCodeId": "666666", + "arCodeTypeName": "XYZ", + "arCodeName": "ABCD", + "arTriggerId": "222", + "arTriggerName": "XYZ", + "arFormulaId": "1", + "arFormulaName": "PQR", + "arFormulaReferenceId": "0", + "rateAmount": "-1.11", + "rateIncreaseIncrement": "0.000000", + "rateShowOnWebsite": "1", + "rateShowInEntrata": "1", + "spaceConfigurationId": "0", + "spaceConfigurationName": "", + "leaseTermId": "1", + "leaseTermName": "EFG", + "leaseStartWindowId": "0", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY" + }, + { + "rateId": "1234567", + "arCodeId": "666666", + "arCodeTypeName": "ABC", + "arCodeName": "BCD", + "arTriggerId": "333", + "arTriggerName": "ABC", + "arFormulaId": "1", + "arFormulaName": "PQR", + "arFormulaReferenceId": "0", + "rateAmount": "-1.11", + "rateIncreaseIncrement": "0.000000", + "rateShowOnWebsite": "1", + "rateShowInEntrata": "1", + "spaceConfigurationId": "0", + "spaceConfigurationName": "", + "leaseTermId": "6", + "leaseTermName": "XYZ", + "leaseStartWindowId": "0", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY" + } + ] + } + ] + } + ] + } + } + } + }, + "getInvoices_r1_SuccessExample": { + "summary": "getInvoices(r1)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "invoices": { + "invoice": [ + { + "id": "623413", + "isOnHold": "0", + "invoiceNumber": "55555", + "date": "10/09/2015", + "postMonth": "10/01/2015", + "dueDate": "10/30/2015", + "remittance": { + "id": "1234", + "name": "Carson Check Payment", + "apPaymentTypeId": "2", + "apPaymentType": "Check", + "streetLine1": "20500 Belshaw Ave", + "streetLine2": "Fox Street", + "streetLine3": {}, + "City": "Carson", + "stateCode": "CA", + "postalCode": "123456" + }, + "vendor": { + "id": "18418", + "name": "Test, Corporate", + "locationName": "Corporate", + "address": { + "streetLine1": "streetLine1", + "streetLine2": "streetLine2", + "city": "city", + "stateCode": "CA", + "postalCode": "123456" + } + }, + "invoicePayments": { + "invoicePayment": [ + { + "paymentId": "xxxxx", + "paymentBankId": "1234", + "paymentBankName": "Wells Fargo", + "paymentBankAccountName": "The Vista at Prima Lake - 8545", + "paymentType": "Check", + "paymentStatus": "Received", + "reconciliationStatus": "Historical", + "paymentDate": "10/09/2015", + "paymentIssuedOn": "10/09/2015", + "payeeName": "Test", + "paymentNumber": "9", + "paymentAmount": "30.00", + "postMonth": "10/01/2015", + "postDate": "10/09/2015", + "isReversed": "0", + "isQuickCheck": "0" + }, + { + "paymentId": "xxxxx", + "paymentBankId": "1234", + "paymentBankName": "Wells Fargo", + "paymentBankAccountName": "The Vista at Prima Lake - 8545", + "paymentType": "Check", + "paymentStatus": "Received", + "reconciliationStatus": "Historical", + "paymentDate": "10/09/2015", + "paymentIssuedOn": "10/09/2015", + "payeeName": "Test", + "paymentNumber": "8", + "paymentAmount": "50.00", + "postMonth": "10/01/2015", + "postDate": "10/09/2015", + "isReversed": "0", + "isQuickCheck": "0" + } + ] + }, + "amount": "$50.00", + "amountDue": "$0.00", + "note": "test", + "isPosted": "true", + "lineItems": { + "lineitem": [ + { + "id": "11648172", + "property": { + "id": "19463", + "name": "22 Exchange", + "lookupCode": "AK lookUp 22 Exchange" + }, + "glAccount": { + "id": "295527", + "name": "TestCashPositionExpenseAccount", + "accountNumber": "0000" + }, + "quantity": "1.000000", + "rate": "$-2500.00", + "amount": "$-2416.66", + "amountDue": "$-2416.66", + "shippingAmount": "$125.00", + "discountAmount": "$83.33", + "taxAmount": "$41.67", + "paymentIds": "123456,123456" + }, + { + "id": "11648173", + "property": { + "id": "19463", + "name": "22 Exchange", + "lookupCode": "AK lookUp 22 Exchange" + }, + "glAccount": { + "id": "172632", + "name": "Report Liabilities Test A/C", + "accountNumber": "00000002" + }, + "quantity": "1.000000", + "rate": "$-500.00", + "amount": "$-483.34", + "amountDue": "$-483.34", + "shippingAmount": "$25.00", + "discountAmount": "$16.67", + "taxAmount": "$8.33", + "paymentIds": "123456,123456" + } + ] + } + } + ] + } + } + } + } + }, + "getInvoices_r2_SuccessExample": { + "summary": "getInvoices(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "invoices": { + "invoice": [ + { + "id": "123456", + "isOnHold": "0", + "invoiceNumber": "INV0101", + "invoiceType": "Standard", + "date": "2020-02-11", + "postMonth": "2020-02-01", + "postStatus": "status", + "reversalInvoiceId": 233434, + "dueDate": "2020-02-12", + "postDate": "2020-02-12", + "invoiceNote": "Testing the task", + "routingTagId": "92", + "routingTagName": "ghghg", + "remittance": { + "id": "1234", + "name": "Check", + "apPaymentTypeId": "2", + "apPaymentType": "Check", + "streetLine1": "THIS IS", + "streetLine2": "REMITTANCE", + "city": "ADDRESS", + "stateCode": "UT", + "postalCode": "84043" + }, + "vendor": { + "id": "123456", + "name": "0000CNYE1, Corporate", + "locationName": "Corporate", + "locationCode": "Corporate_123", + "externalId": "ext- rpk", + "address": { + "streetLine1": "AddressLine1", + "streetLine2": "AddressLine2", + "city": "TestCity", + "stateCode": "MO", + "postalCode": "41101" + } + }, + "account": { + "id": "12345", + "accountNumber": "12345" + }, + "invoicePayments": { + "invoicePayment": [ + { + "paymentId": "xxxxx", + "paymentBankId": "1234", + "paymentBankName": "Wells Fargo", + "paymentBankAccountName": "The Vista - 8545", + "paymentType": "Check", + "paymentStatus": "Received", + "reconciliationStatus": "Historical", + "paymentDate": "2020-02-12", + "paymentIssuedOn": "2020-02-12", + "payeeName": "Test", + "paymentNumber": "9", + "paymentAmount": "30.00", + "postMonth": "2020-02-10", + "postDate": "2020-02-12", + "isReversed": "0", + "isQuickCheck": "0" + } + ] + }, + "subTotal": "1000.00", + "taxAmount": "100.00", + "shippingAmount": "0.00", + "discountAmount": "-100.00", + "amount": "1000.00", + "amountDue": "1000.00", + "note": "Testing the task", + "isPosted": "0", + "retention": "0.00", + "lineItems": { + "lineItem": [ + { + "id": "123456", + "property": { + "id": "123456", + "name": "0001 East Park Property", + "lookupCode": "12345" + }, + "glAccount": { + "id": "1234", + "name": "TestCashPositionExpenseAccount", + "accountNumber": "0000", + "secondaryNumber": "0010000", + "catalogItemName": "TestCashPositionExpenseAccount" + }, + "description": "test", + "quantity": "1", + "rate": "1000.00", + "amount": "1000.00", + "paymentIds": "1234,12345", + "amountDue": "1000.00", + "maintenanceLocationId": "40802", + "departmentId": "1982", + "departmentName": "Managerial", + "propertyBuildingNumber": "Building A", + "poNumber": "1234654", + "customTagId": "406", + "customTagName": "Ak Test Tag", + "confidential": "1", + "is1099": "1", + "billback": "0" + } + ] + } + }, + { + "id": "xxxxx", + "isOnHold": "0", + "invoiceNumber": "INV0202", + "invoiceType": "Catalog", + "date": "2020-02-11", + "postMonth": "2020-02-01", + "reversalInvoiceId": 4853217, + "dueDate": "2020-03-13", + "postDate": "2020-03-13", + "invoiceNote": "Testing the node", + "routingTagId": "99", + "routingTagName": "RoutingT", + "remittance": { + "id": 3434, + "name": "Check", + "apPaymentTypeId": 2, + "apPaymentType": "Check", + "streetLine1": "3098 Executive Parkway, Suite 200", + "city": "Lehi", + "stateCode": "UT", + "postalCode": "84043" + }, + "customer": { + "id": "28396260", + "address": { + "streetLine1": "test", + "streetLine2": "test", + "streetLine3": "test", + "postalCode": "012345", + "countryCode": "SG" + }, + "unitNumber": "2-A" + }, + "refundDetails": { + "refundPaymentType": "Check", + "description": "Kyle Testaroo", + "invoiceNumber": "Refund", + "refundProcessedOn": "2020-05-01", + "refundAmount": "1000.00", + "address": { + "streetLine1": "heyhey", + "city": "hey", + "stateCode": "NV", + "postalCode": "84606", + "countryCode": "US" + }, + "moveOutDate": "2020-06-14", + "fmoProcessedOn": "2020-06-19 13:27:22" + }, + "subTotal": "1000.00", + "taxAmount": "100.00", + "shippingAmount": "0.00", + "discountAmount": "-100.00", + "amount": "1000.00", + "amountDue": "1000.00", + "note": "Testing the node", + "isPosted": "0", + "retention": "0.00", + "lineItems": { + "lineItem": [ + { + "id": "xxxxx", + "property": { + "id": "xxxxx", + "name": "0001 East Park Property", + "lookupCode": "12345" + }, + "glAccount": { + "id": "xxxxx", + "name": "FIXED ASSETS", + "accountNumber": "1500000", + "secondaryNumber": "1500000", + "catalogItemName": "111222" + }, + "description": "test", + "quantity": "1", + "rate": "1000.00", + "unitOfMeasure": "32453", + "taxAmount": "100.00", + "subTotal": "1000.00", + "discountAmount": "-100.00", + "retention": "0.00", + "amount": "1000.00", + "amountDue": "1000.00", + "maintenanceLocationId": "40802", + "paymentIds": "1234,12345", + "departmentId": "1983", + "departmentName": "Maintenance", + "propertyBuildingNumber": "Building A", + "poNumber": "123456", + "customTagId": "38", + "customTagName": "Fire Expenses", + "confidential": "1", + "is1099": "1" + } + ] + } + }, + { + "id": "xxxxx", + "isOnHold": "0", + "invoiceNumber": "INV0303", + "invoiceType": "Standard-Job/Contract", + "date": "2020-02-11", + "postMonth": "2020-02-01", + "dueDate": "2020-02-12", + "postDate": "-2020-02-12", + "invoiceNote": "Testing the node", + "routingTagId": "2", + "routingTagName": "RTag01", + "remittance": { + "id": "xxxx", + "name": "Check", + "apPaymentTypeId": "2", + "apPaymentType": "Check", + "streetLine1": "THIS IS", + "streetLine2": "REMITTANCE", + "city": "ADDRESS", + "stateCode": "UT", + "postalCode": "84043" + }, + "vendor": { + "id": "xxxxx", + "name": "0000CNYE1, Corporate", + "locationName": "Corporate", + "locationCode": "Corporate_123", + "address": { + "streetLine1": "AddressLine1", + "streetLine2": "AddressLine2", + "city": "TestCity", + "stateCode": "MO", + "postalCode": "41101" + } + }, + "account": { + "id": "12345", + "accountNumber": "12345" + }, + "invoicePayments": { + "invoicePayment": { + "paymentId": "xxxxx", + "paymentBankId": "1234", + "paymentBankName": "Wells Fargo", + "paymentBankAccountName": "The Vista - 8545", + "paymentType": "Check", + "paymentStatus": "Received", + "reconciliationStatus": "Historical", + "paymentDate": "10/09/2015", + "paymentIssuedOn": "10/09/2015", + "payeeName": "Test", + "paymentNumber": "9", + "paymentAmount": "30.00", + "postMonth": "10/01/2015", + "postDate": "10/09/2015", + "isReversed": "0", + "isQuickCheck": "0" + } + }, + "subTotal": "1000.00", + "taxAmount": "100.00", + "shippingAmount": "100.00", + "discountAmount": "-100.00", + "amount": "1000.00", + "amountDue": "1000.00", + "note": "Testing the node", + "isPosted": "0", + "retention": "0.00", + "lineItems": { + "lineItem": [ + { + "id": "xxxxxxx", + "property": { + "id": "xxxxx", + "name": "0001 East Park Property", + "lookupCode": "12345" + }, + "glAccount": { + "id": "xxxxxx", + "name": "7BAnk2", + "accountNumber": "77777777777777777", + "catalogItemName": "010-010" + }, + "jobCostDetails": { + "jobCostCodeId": "179176", + "jobCostCodeName": "010-010", + "jobId": "119", + "jobName": "ak new job (Phase 1)", + "contractId": "1234", + "contractName": "ABCD" + }, + "description": "test", + "quantity": "1", + "rate": "900.00", + "retention": "0.00", + "amount": "1000.00", + "amountDue": "1000.00", + "maintenanceLocationId": "40802", + "paymentIds": "1234,12345", + "departmentId": "1983", + "departmentName": "Maintenance", + "propertyBuildingNumber": "Building A", + "poNumber": "123456", + "customTagId": "406", + "customTagName": "Ak Test Tag", + "confidential": "1", + "is1099": "1" + } + ] + } + } + ] + } + } + } + } + }, + "getPoReceivingRecordsSuccessExample": { + "summary": "getPoReceivingRecords", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "purchaseOrders": { + "purchaseOrder": [ + { + "purchaseOrderNumber": "123456", + "purchaseOrderPostMonth": "06/2021", + "poDetails": { + "poDetail": { + "id": "123", + "catalogItemName": "vaishali_catalog_test", + "qtyOrdered": "1", + "unitCost": "11.00", + "receivingRecords": { + "receivingRecord": [ + { + "id": "123456", + "propertyId": 172775, + "postMonthReceived": "06/2021", + "receiverName": "Admin Admin", + "assetLocation": "fixed asset1", + "qtyReceived": "1.000", + "unitCost": "11.00", + "dateReceived": "2019-08-21", + "qtyInvoiced": "1.000000" + } + ] + }, + "unreceivingRecord": [ + { + "id": 123456, + "propertyId": 172775, + "postMonthUnreceived": "05/2023", + "unreceiverName": "Admin Admin", + "qtyUnreceived": "-1.000", + "unitCost": "10.00", + "dateUnreceived": "2023-05-29", + "qtyInvoiced": 0 + } + ], + "returnRecord": [ + { + "receiverId": "1234567", + "propertyId": 172775, + "creditInvoiceId": "56567", + "qtyReturned": "-1.000", + "unitCost": "11.00", + "dateReturned": "2019-08-21", + "postMonthReturned": "06/2021", + "receiverName": "Admin Admin", + "assetLocation": "fixed asset1" + } + ], + "cancelledRecords": { + "cancelledRecord": [ + { + "id": "1234", + "propertyId": 172775, + "qtyCancelled": "1.000", + "unitCost": "35.00", + "dateCancelled": "2020-06-11", + "postMonthCancelled": "08/2015", + "cancelledBy": "ABC Services" + }, + { + "id": "12345", + "propertyId": 172775, + "qtyCancelled": "1.000", + "unitCost": "35.00", + "dateCancelled": "2020-06-11", + "postMonthCancelled": "08/2015", + "cancelledBy": "ABC Services" + } + ] + } + } + } + } + ] + } + } + } + } + }, + "getPurchaseOrdersSuccessExample": { + "summary": "getPurchaseOrders", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "purchaseOrders": { + "purchaseOrder": [ + { + "purchaseOrderNumber": "1234", + "purchaseOrderType": "Standard", + "vendor": { + "id": "67645", + "name": "22 Exchange" + }, + "vendorCode": "2423478552", + "vendorLocation": "Corporate", + "postMonth": "01/01/2019", + "postDate": "01/23/2019", + "poStatusId": "1", + "poApprovalTypeId": "1", + "routingTagId": "112", + "subTotal": "60.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "60.00", + "unitNumberId": "123456", + "poNote": "24th Jan", + "createdOn": "01/23/2019 21:58:03.698637 MST", + "attachedUrl": "https://demoold.stage.entrata.lcl/", + "lineItems": { + "lineItem": { + "id": "123456", + "glAccountId": "123456", + "glAccountNumber": "123", + "catalogItemName": "demo asset", + "catalogItemNumber": "123456", + "contractName": "Flooring contract", + "description": "Description:standard", + "orderStatus": "1", + "orderQuantity": "1.000", + "rate": "60.000", + "subTotal": "60.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "60.00", + "propertyId": "123456", + "propertyUnitNumber": "45567", + "propertyBuildingNumber": "57953", + "unitDesignation": "CORE", + "departmentId": "1982", + "customTagId": "406", + "customTagName": "abc", + "customTagCode": "A12", + "isConfidential": "1", + "invoices": { + "invoice": [ + { + "invoiceId": "7539935", + "invoiceNumber": "ABC-342" + }, + { + "invoiceId": "7539938", + "invoiceNumber": "3846_Inv" + } + ] + } + } + } + }, + { + "purchaseOrderNumber": "1234", + "purchaseOrderType": "Standard-Job/Contract", + "vendor": { + "id": "67645", + "name": "13 North Parkways" + }, + "vendorCode": "2423478552", + "vendorLocation": "Corporate", + "postMonth": "01/01/2019", + "postDate": "01/23/2019", + "poStatusId": "1", + "poApprovalTypeId": "2", + "routingTagId": "112", + "subTotal": "60.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "60.00", + "unitNumberId": "123456", + "poNote": "24th Jan", + "createdOn": "01/23/2019 21:58:03.698637 MST", + "attachedUrl": "https://demoold.stage.entrata.lcl/", + "lineItems": { + "lineItem": { + "id": "123456", + "glAccountId": "123456", + "glAccountNumber": "5570", + "catalogItemName": "test", + "contractName": "Flooring contract", + "job": "Building 1", + "description": "Description:job/contract", + "orderStatus": "1", + "orderQuantity": "1.000", + "rate": "30.000", + "subTotal": "30.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "30.00", + "propertyId": "123456", + "propertyBuildingNumber": "17672", + "departmentId": "1982", + "customTagId": "38", + "customTagName": "ABC", + "customTagCode": "B12", + "isConfidential": "1" + } + } + }, + { + "purchaseOrderNumber": "1234", + "purchaseOrderType": "Catalog", + "vendor": { + "id": "67645", + "name": "22 Exchange" + }, + "vendorLocation": "Corporate", + "postMonth": "01/01/2019", + "postDate": "01/23/2019", + "poStatusId": "1", + "poApprovalTypeId": "2", + "routingTagId": "112", + "subTotal": "60.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "60.00", + "poNote": "24th Jan", + "createdOn": "01/23/2019 21:58:03.698637 MST", + "attachedUrl": "https://demoold.stage.entrata.lcl/", + "lineItems": { + "lineItem": { + "id": "123456", + "glAccountId": "123456", + "glAccountNumber": "1631", + "catalogItemName": "New INventory", + "catalogItemNumber": "1", + "contractName": "Flooring contract", + "description": "Description:catalog", + "orderStatus": "1", + "orderQuantity": "1.000", + "unitOfMeasure": "29580", + "rate": "10.000", + "subTotal": "10.00", + "taxAmount": "0.00", + "shippingAmount": "0.00", + "discountAmount": "0.00", + "orderAmount": "10.00", + "propertyId": "123456", + "propertyBuildingNumber": "17673", + "departmentId": "1981", + "customTagId": "38", + "isConfidential": "1" + } + } + } + ] + } + } + } + } + }, + "getTaxFormDataSuccessExample": { + "summary": "getTaxFormData", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "Properties": { + "property": [ + { + "vendors": { + "vendor": [ + { + "vendorId": "68050", + "vendorType": "Individual", + "vendorTinType": "2", + "vendorTin": "930-71-6072", + "vendorBusinessNameorName": "001Test", + "nameOnTaxReturn": "Legal Entity Name", + "vendorAddress1": "Street Lines1", + "vendorAddress2": "Street Line2", + "vendorCity": "US", + "vendorState": "Marshall Islands", + "vendorZipCode": "84601", + "formType": "1099 - MISC", + "form1099Boxes": { + "form1099Box": { + "boxNumber": "1", + "boxValue": "13" + } + } + }, + { + "vendorId": "67645", + "vendorType": "Unknown", + "vendorTinType": "3", + "vendorTin": "65-1111111", + "vendorBusinessNameorName": "22 Exchange", + "nameOnTaxReturn": "Legal Entity Name", + "vendorAddress1": "22 E. Exchange St", + "vendorCity": "Akron", + "vendorState": "North Carolina", + "vendorZipCode": "44308", + "formType": "1099 - INT", + "form1099Boxes": { + "form1099Box": { + "boxNumber": "1", + "boxValue": "45" + } + } + } + ] + }, + "payers": { + "payer": [ + { + "payerType": "Business", + "payerTinType": "1", + "payerTin": "65-1111111", + "payerBusinessNameOrName": "22 Exchange Venture LLP", + "payerAddress1": "123 Main St.", + "payerCity": "Lehi", + "payerState": "Utah", + "payerZipCode": "84043" + } + ], + "@attributes": { + "isCompanyLevel": "0" + } + }, + "@attributes": { + "id": "1234" + } + }, + { + "vendors": { + "vendor": [ + { + "vendorId": "318251", + "vendorType": "Business", + "vendorTinType": "1", + "vendorTin": "12-0987654", + "vendorBusinessNameorName": "00011912016 -- AAA Electricians", + "nameOnTaxReturn": "Legal Entity Name", + "vendorAddress1": "1234 South Main", + "vendorCity": "Lehi", + "vendorState": "Utah", + "vendorZipCode": "84043", + "formType": "1099 - MISC", + "form1099Boxes": { + "form1099Box": { + "boxNumber": "1", + "boxValue": "158.79" + } + } + }, + { + "vendorId": "68050", + "vendorType": "Individual", + "vendorTinType": "2", + "vendorTin": "930-71-6072", + "vendorBusinessNameorName": "001Test", + "nameOnTaxReturn": "Legal Entity Name", + "vendorAddress1": "Street Lines1", + "vendorAddress2": "Street Line2", + "vendorCity": "US", + "vendorState": "Marshall Islands", + "vendorZipCode": "84601", + "formType": "1099 - MISC", + "form1099Boxes": { + "form1099Box": { + "boxNumber": "1", + "boxValue": "90" + } + } + } + ] + }, + "payers": { + "payer": [ + { + "payerType": "Individual", + "payerTinType": "2", + "payerTin": "123-45-5555", + "payerBusinessNameOrName": "0000CNYE" + } + ], + "@attributes": { + "isCompanyLevel": "0" + } + }, + "@attributes": { + "id": "1234" + } + } + ] + } + } + } + } + }, + "getVendorLocationsSuccessExample": { + "summary": "getVendorLocations", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "Locations": { + "Location": [ + { + "VendorId": "2726", + "VendorName": "Test for Kirk", + "Status": "Active", + "Term": "Net", + "LegalEntity": { + "@value": "Test for Kirk", + "@attributes": { + "Id": "470" + } + }, + "Properties": { + "Property": { + "@attributes": { + "Id": "19463", + "Name": "22 Exchange" + } + } + }, + "Contacts": { + "Contact": [ + { + "Name": "Check", + "StreetLine1": "125 Test", + "City": "84062", + "State": "UT", + "Country": "US", + "@attributes": { + "Type": "Vendor_Remittence" + } + }, + { + "Name": "Kirk Dunn", + "PhoneNumber": "801-358-0099", + "EmailAddress": "dunnkster@yahoo.com", + "@attributes": { + "Type": "Vendor" + } + } + ] + }, + "@attributes": { + "Id": "123", + "Name": "Corporate" + } + }, + { + "VendorId": "2727", + "VendorName": "kirk test 3", + "Status": "Active", + "Term": "Net", + "LegalEntity": { + "@value": "kirk test 3", + "@attributes": { + "Id": "471" + } + }, + "Properties": { + "Property": { + "@attributes": { + "Id": "19463", + "Name": "22 Exchange" + } + } + }, + "Contacts": { + "Contact": [ + { + "Name": "Kirk Dunn p", + "@attributes": { + "Type": "Vendor" + } + }, + { + "Name": "Check", + "@attributes": { + "Type": "Vendor_Remittence" + } + } + ] + }, + "@attributes": { + "Id": "124", + "Name": "Corporate" + } + }, + { + "VendorId": "2345", + "VendorName": "Dubai", + "Status": "Active", + "Term": "Net", + "Accounts": { + "Account": [ + { + "AccountId": "81", + "AccountNumber": "o98767865t87gu678", + "RemittanceId": "295893", + "RemittanceName": "Check", + "RemittancePaymentTypeId": "2", + "LocationName": "Corporate", + "IsAuditInvoice": "1", + "IsDisabled": "0", + "IsCaptureInvoiceTotalOnly": "0" + }, + { + "AccountId": "82", + "AccountNumber": "asdfasd", + "RemittanceId": "295894", + "RemittanceName": "Check", + "RemittancePaymentTypeId": "2", + "LocationName": "Corporate", + "IsAuditInvoice": "1", + "IsDisabled": "0", + "IsCaptureInvoiceTotalOnly": "0" + } + ] + }, + "LegalEntity": { + "@value": "Dubai", + "@attributes": { + "Id": "366" + } + }, + "Properties": { + "Property": { + "@attributes": { + "Id": "19463", + "Name": "22 Exchange" + } + } + }, + "Contacts": { + "Contact": [ + { + "Name": "Dubai", + "StreetLine1": "2413 Glen Morris", + "City": "Carrollton", + "State": "TX", + "Country": "US", + "PostalCode": "75007", + "@attributes": { + "Type": "Vendor" + } + }, + { + "Name": "Check", + "State": "AE", + "Country": "US", + "@attributes": { + "Type": "Vendor_Remittence" + } + } + ] + }, + "@attributes": { + "Id": "1702", + "Name": "Corporate" + } + } + ] + }, + "Insurances": { + "Insurance": [ + { + "VendorId": "53813", + "PolicyTypes": { + "PolicyType": { + "Type": "Workers Compensation", + "PolicyNumber": "P200", + "Expiration": "03/13/2015", + "Coverages": { + "Coverage": { + "@attributes": { + "Item": "Disease - Policy Limit", + "Amount": "200.00" + } + } + } + } + }, + "@attributes": { + "Id": "1031", + "Provider": "Provider 7" + } + }, + { + "VendorId": "55964", + "PolicyTypes": { + "PolicyType": { + "Type": "Workers Compensation", + "PolicyNumber": "P100", + "Expiration": "03/28/2015", + "Coverages": { + "Coverage": { + "@attributes": { + "Item": "Disease - Policy Limit", + "Amount": "900.00" + } + } + } + } + }, + "@attributes": { + "Id": "1032", + "Provider": "Provider 3" + } + }, + { + "VendorId": "398211", + "PolicyTypes": { + "PolicyType": { + "Type": "Criminal", + "PolicyNumber": "67", + "Expiration": "11/03/2018", + "Coverages": { + "Coverage": { + "@attributes": { + "Item": "Amount", + "Amount": "100.00" + } + } + } + } + }, + "@attributes": { + "Id": "1393699", + "Provider": "Ankita chavan check 1122" + } + }, + { + "VendorId": "398211", + "PolicyTypes": { + "PolicyType": { + "Type": "Miscellaneous Insurance", + "PolicyNumber": "12", + "Expiration": "10/28/2018", + "Coverages": { + "Coverage": { + "@attributes": { + "Item": "Amount", + "Amount": "10.00" + } + } + } + } + }, + "@attributes": { + "Id": "1393700", + "Provider": "Ankita chavan check 1122" + } + }, + { + "VendorId": "403561", + "PolicyTypes": { + "PolicyType": { + "Type": "General Liability", + "PolicyNumber": "13212", + "Expiration": "11/30/2018", + "Liability": "3110000", + "Coverages": { + "Coverage": [ + { + "@attributes": { + "Item": "Each Occurrence", + "Amount": "10.00" + } + }, + { + "@attributes": { + "Item": "Damage to Rented Premises", + "Amount": "20.00" + } + }, + { + "@attributes": { + "Item": "Medical Expense", + "Amount": "30.00" + } + }, + { + "@attributes": { + "Item": "Personal and Advertising Injury", + "Amount": "40.00" + } + }, + { + "@attributes": { + "Item": "General Aggregate", + "Amount": "50.00" + } + }, + { + "@attributes": { + "Item": "Products - Completed Ops Agg", + "Amount": "60.00" + } + } + ] + } + } + }, + "@attributes": { + "Id": "1920241", + "Provider": "Broker" + } + } + ] + } + } + } + } + }, + "getVendorPickListsSuccessExample": { + "summary": "getVendorPickLists", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "vendorCategoryTypes": { + "vendorCategoryType": [ + { + "@attributes": { + "id": "1", + "name": "Abatement Services - Asbestos" + } + }, + { + "@attributes": { + "id": "2", + "name": "Abatement Services - Lead" + } + } + ] + }, + "ownerTypes": { + "ownerType": [ + { + "@attributes": { + "id": "1", + "name": "Sole Proprietorship" + } + }, + { + "@attributes": { + "id": "2", + "name": "Partnership" + } + } + ] + }, + "apPayeeTerms": { + "apPayeeTerm": [ + { + "@attributes": { + "id": "4446", + "name": "Net 15" + } + }, + { + "@attributes": { + "id": "3762", + "name": "3%Net 30" + } + } + ] + }, + "apPayeeTypes": { + "apPayeeType": [ + { + "@attributes": { + "id": "2", + "name": "Owner" + } + }, + { + "@attributes": { + "id": "1", + "name": "Standard" + } + } + ] + }, + "apPayeeStatusTypes": { + "apPayeeStatusType": [ + { + "@attributes": { + "id": "1", + "name": "Active" + } + }, + { + "@attributes": { + "id": "2", + "name": "Inactive" + } + }, + { + "@attributes": { + "id": "3", + "name": "Locked" + } + } + ] + }, + "form1099Types": { + "form1099Type": { + "@attributes": { + "id": "1", + "name": "1099 - MISC" + } + } + }, + "form1099BoxTypes": { + "form1099BoxType": [ + { + "@attributes": { + "id": "1", + "name": "1 - Rents" + } + }, + { + "@attributes": { + "id": "2", + "name": "2 - Royalties" + } + } + ] + }, + "apRemittanceTypes": { + "apRemittanceType": [ + { + "@attributes": { + "id": "1", + "name": "Wire Transfer" + } + }, + { + "@attributes": { + "id": "2", + "name": "Check" + } + }, + { + "@attributes": { + "id": "3", + "name": "Debit Card" + } + }, + { + "@attributes": { + "id": "4", + "name": "Credit Card" + } + }, + { + "@attributes": { + "id": "5", + "name": "Ach" + } + }, + { + "@attributes": { + "id": "6", + "name": "Cash" + } + }, + { + "@attributes": { + "id": "7", + "name": "Written Check" + } + }, + { + "@attributes": { + "id": "8", + "name": "Bill Pay Ach" + } + }, + { + "@attributes": { + "id": "9", + "name": "Bill Pay Check" + } + }, + { + "@attributes": { + "id": "10", + "name": "Avid Pay" + } + } + ] + }, + "utilityBillReceiptTypes": { + "utilityBillReceiptType": [ + { + "@attributes": { + "id": "1", + "name": "Mail" + } + }, + { + "@attributes": { + "id": "2", + "name": "Client Email Upload" + } + }, + { + "@attributes": { + "id": "3", + "name": "Fax" + } + }, + { + "@attributes": { + "id": "4", + "name": "Automated" + } + }, + { + "@attributes": { + "id": "5", + "name": "Client Upload" + } + }, + { + "@attributes": { + "id": "6", + "name": "Entrata Web Retrieval" + } + }, + { + "@attributes": { + "id": "7", + "name": "Copied" + } + }, + { + "@attributes": { + "id": "8", + "name": "Estimated" + } + }, + { + "@attributes": { + "id": "9", + "name": "Client Admin Upload" + } + }, + { + "@attributes": { + "id": "10", + "name": "Entrata Ap Retrieval" + } + } + ] + }, + "bankAccountTypes": { + "bankAccountType": [ + { + "@attributes": { + "id": "1", + "name": "Business Checking" + } + }, + { + "@attributes": { + "id": "2", + "name": "Business Savings" + } + }, + { + "@attributes": { + "id": "3", + "name": "Personal Checking" + } + }, + { + "@attributes": { + "id": "4", + "name": "Personal Savings" + } + } + ] + }, + "complianceStatuses": { + "complianceStatus": [ + { + "@attributes": { + "id": "5", + "name": "Compliant" + } + }, + { + "@attributes": { + "id": "2", + "name": "Non Compliant" + } + } + ] + }, + "routingTags": { + "routingTag": [ + { + "@attributes": { + "id": "93", + "name": "routingTag1" + } + }, + { + "@attributes": { + "id": "92", + "name": "routingTag2" + } + }, + { + "@attributes": { + "id": "99", + "name": "routingTag3" + } + } + ] + }, + "unitsOfMeasure": { + "unitOfMeasure": [ + { + "@attributes": { + "id": 80, + "name": "100 Packing", + "type": "Area" + } + }, + { + "@attributes": { + "id": 29581, + "name": "565", + "type": "Area" + } + }, + { + "@attributes": { + "id": 32596, + "name": "aug 16", + "type": "Area" + } + } + ] + }, + "policies": { + "policy": [ + { + "policyTypeId": 7, + "policyTypeName": "General Liability", + "coverages": { + "coverage": [ + { + "id": 12, + "name": "Each Occurrence" + }, + { + "id": 13, + "name": "Damage to Rented Premises" + } + ] + } + }, + { + "policyTypeId": 8, + "policyTypeName": "Auto", + "coverages": { + "coverage": [ + { + "id": 18, + "name": "Combined Single Limit" + }, + { + "id": 19, + "name": "Bodily Injury (Per Person)" + } + ] + } + } + ] + } + } + } + } + }, + "getVendorsSuccessExample": { + "summary": "getVendors", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "vendors": { + "vendor": [ + { + "id": "xxxx", + "vendorName": "1st Choice Painting & Restoration, Inc.", + "vendorTypeId": "1", + "vendorType": "Standard", + "statusTypeId": "1", + "status": "Active", + "termId": "1841", + "term": "Net", + "isConsolidated": "true", + "externalId": "395382", + "isOnSite": "false", + "vendorCategoryTypeId": "6", + "vendorCategoryType": "Advertising", + "website": "https://campusapartments.qapchikne.entrata.lcl", + "notes": "Notes in Vendor Info", + "legalEntities": { + "legalEntity": [ + { + "id": "3214", + "name": "NoTR", + "taxIdNumber": "333-22-4444", + "receives1099": "true", + "form1099TypeId": "3", + "form1099Type": "1099 - DIV", + "form1099BoxTypeId": "2", + "form1099BoxType": "2-Royalties" + }, + { + "id": "7414", + "name": "1st Choice Painting & Restoration, Inc.", + "taxIdNumber": "20-4567765", + "receives1099": "false", + "form1099TypeId": "1", + "form1099Type": "1099 - MISC", + "form1099BoxTypeId": "7", + "form1099BoxType": "7-Nonemployee Compensation" + } + ] + }, + "apRemittances": { + "apRemittance": [ + { + "id": "5433", + "name": "Check Name", + "apPaymentTypeId": "5", + "apPaymentType": "Ach", + "checkAccountTypeId": "1", + "checkAccountType": "Business Checking", + "checkNameOnAccount": "Rhsaghsgfh", + "checkRoutingNumber": "965832547", + "checkAccountNumber": "6432323433", + "isDefault": "1" + }, + { + "id": "168873", + "name": "Written Check", + "apPaymentTypeId": "7", + "apPaymentType": "Written Check", + "checkAccountTypeId": "1", + "checkAccountType": "Business Checking", + "streetLine1": "Oak Woods", + "streetLine2": "Oak Woods", + "city": "Akola", + "stateCode": "LA", + "postalCode": "98568", + "isDefault": "0" + }, + { + "id": "168871", + "name": "Credit Card", + "apPaymentTypeId": "4", + "apPaymentType": "Credit Card", + "checkAccountTypeId": "1", + "checkAccountType": "Business Checking", + "isDefault": "0" + } + ] + }, + "contacts": { + "contact": [ + { + "id": "123654", + "nameFirst": "Max", + "nameLast": "Collins", + "email": "email@dot.com", + "phone": "3214567894", + "position": "Head", + "faxNumber": "2222222222" + }, + { + "id": "3233604", + "nameFirst": "Insurance", + "nameLast": "Test One", + "email": "test@example.com", + "phone": "9898989898", + "position": "Tester", + "faxNumber": "1212121212" + } + ] + }, + "locations": { + "location": [ + { + "id": "26685", + "name": "Corporate", + "vendorCode": "MangoCode", + "legalEntityId": "7414", + "apRemittanceId": "4523", + "isPrimary": "t", + "note": "Notes in locations", + "approvedForAllProperties": "0", + "propertyIds": "264438,264439,264461" + }, + { + "id": "2191205", + "name": "TestRavi", + "vendorCode": "NewCodeVendor", + "legalEntityId": "173000", + "apRemittanceId": "168871", + "isPrimary": "f", + "note": "Notes in locations", + "approvedForAllProperties": "0", + "propertyIds": "264357,156562" + }, + { + "id": "2191210", + "name": "LocName", + "vendorCode": "Navin", + "legalEntityId": "7414", + "apRemittanceId": "168873", + "isPrimary": "f", + "note": "Notes in locations", + "approvedForAllProperties": "0", + "propertyIds": "264375" + } + ] + }, + "compliances": { + "compliance": [ + { + "legalEntityId": "123456", + "legalEntity": "legalEntityName", + "propertyId": "1234", + "statusId": "5", + "status": "Compliant" + }, + { + "legalEntityId": "123456", + "legalEntity": "legalEntityName", + "propertyId": "1234", + "statusId": "2", + "status": "Non Compliant" + } + ] + }, + "accounts": { + "account": [ + { + "accountId": "123456", + "accountNumber": "123456", + "description": "Test", + "remittanceId": "260598", + "remittanceName": "Check", + "remittancePaymentTypeId": "5", + "glAccountId": "274509", + "locationName": "locationName", + "utilityBillReceiptTypeId": "1", + "isAuditInvoice": "0", + "isDisabled": "0", + "isCaptureInvoiceTotalOnly": "0" + }, + { + "accountId": "123456", + "accountNumber": "123456", + "description": "dummy description", + "remittanceId": "260598", + "remittanceName": "Check", + "remittancePaymentTypeId": "5", + "glAccountId": "274509", + "locationName": "locationName", + "propertyId": "19463", + "utilityBillReceiptTypeId": "1", + "isAuditInvoice": "0", + "isDisabled": "0", + "isCaptureInvoiceTotalOnly": "1", + "subAccounts": { + "subAccount": [ + { + "subAccountNumber": "123456", + "description": "dummy description", + "glAccountId": "1234" + }, + { + "subAccountNumber": "123456", + "description": "dummy description", + "glAccountId": "1234" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "markInvoicesExportedSuccessExample": { + "summary": "markInvoicesExported", + "value": { + "response": { + "requestId": 15, + "result": { + "success": "Invoices marked as exported successfully." + } + } + } + }, + "sendInvoices_r1_SuccessExample": { + "summary": "sendInvoices(r1)", + "value": { + "response": { + "result": { + "ApBatch": { + "@attributes": { + "reference_id": "1838" + }, + "ApHeaders": { + "ApHeader": [ + { + "@attributes": { + "invoice_number": "311", + "reference_id": "42652", + "status": "Success", + "message": "ApHeader inserted successfully." + } + }, + { + "@attributes": { + "invoice_number": "312", + "reference_id": "42653", + "status": "Success", + "message": "ApHeader inserted successfully." + } + } + ] + } + } + } + } + } + }, + "sendInvoices_r2_SuccessExample": { + "summary": "sendInvoices(r2)", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "apBatch": { + "apBatchId": 99999, + "apHeaders": { + "apHeader": [ + { + "node": 1, + "invoiceNumber": "invoiceNumberxxxx", + "apHeaderId": 111111, + "status": "Success", + "message": "ApHeader inserted successfully." + }, + { + "node": 2, + "invoiceNumber": "invoiceNumberxxxx", + "apHeaderId": 222222, + "status": "Success", + "message": "ApHeader inserted successfully." + } + ] + } + } + } + } + } + }, + "sendPurchaseOrdersSuccessExample": { + "summary": "sendPurchaseOrders", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "apHeaders": { + "apHeader": [ + { + "node": 1, + "status": "Success", + "apHeaderId": 7578703, + "poNumber": 3850, + "message": "Purchase Order inserted successfully" + }, + { + "node": 2, + "status": "Success", + "apHeaderId": 7578704, + "poNumber": 3851, + "message": "Purchase Order inserted successfully" + } + ] + } + } + } + } + }, + "sendVendorsSuccessExample": { + "summary": "sendVendors", + "value": { + "response": { + "requestId": "15", + "result": { + "vendors": { + "vendor": [ + { + "@attributes": { + "vendorId": 13019, + "status": "Success", + "message": "Vendor inserted successfully." + } + } + ] + } + } + } + } + }, + "updateInvoicesSuccessExample": { + "summary": "updateInvoices", + "value": { + "response": { + "code": 200, + "result": { + "apHeaders": { + "apHeader": [ + { + "reference_id": "3115425", + "status": "Success", + "message": "Invoice updated successfully." + } + ] + } + } + } + } + }, + "updateVendorsSuccessExample": { + "summary": "updateVendors", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "vendors": { + "vendor": { + "1": { + "@attributes": { + "reference_id": 13245, + "status": "Success", + "message": "Vendor updated successfully." + } + } + } + } + } + } + } + }, + "voidApPaymentsSuccessExample": { + "summary": "voidApPayments", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": { + "apPayments": { + "apPayment": [ + { + "node": "1", + "status": "Success", + "message": "Payment voided successfully.", + "paymentId": "123456", + "paymentNumber": "980" + }, + { + "node": "2", + "status": "Success", + "message": "Payment voided successfully.", + "paymentId": "3434455", + "paymentNumber": "178" + } + ] + } + } + } + } + }, + "generalSuccessResponse": { + "summary": "successful response", + "value": { + "response": { + "requestId": "15", + "code": 200, + "result": {} + } + } + }, + "generalErrorResponse": { + "summary": "Bad Request", + "value": { + "response": { + "requestId": "15", + "error": { + "code": 400, + "message": "error message" + } + } + } + }, + "getStatusRequest": { + "summary": "getStatus", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getStatus", + "version": "r1" + } + } + }, + "getCompanyApplicationsRequest": { + "summary": "getCompanyApplications", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCompanyApplications", + "version": "r1", + "params": { + "propertyId": 1234 + } + } + } + }, + "sendApplicantGeneralDetailsRequest": { + "summary": "sendApplicantGeneralDetails", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "1", + "method": { + "name": "sendApplicantGeneralDetails", + "version": "r1", + "params": { + "applicationId": 12345, + "propertyId": 12345, + "applicants": { + "applicant": [ + { + "applicantId": 12345, + "questions": { + "question": [ + { + "id": 12345, + "isTrue": "1", + "comments": "This is a comment" + } + ] + } + }, + { + "applicantId": 12345, + "questions": { + "question": [ + { + "id": 1, + "isTrue": "1", + "comments": "This is a comment" + } + ] + } + } + ] + } + } + } + } + }, + "sendApplicationRequest": { + "summary": "sendApplication", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendApplication", + "params": { + "propertyId": 12345, + "originatingLeadSourceId": 123456, + "leasingAgentId": 12345, + "unitSpaceId": 1234, + "moveInDate": "MM/DD/YYYY", + "floorplanId": 12345, + "leaseTermId": 1234, + "applicationStatusId": 3, + "applicants": { + "applicant": [ + { + "firstName": "abc", + "lastName": "abc", + "maternalName": "abc", + "preferredName": "abc", + "customerRelationshipTypeId": 123456, + "birthDate": "MM/DD/YYYY", + "phoneNumberTypeId": 2, + "phoneNumber": "123456789", + "email": "test@gmail.com", + "addresses": { + "address": [ + { + "addressTypeId": 11, + "addressLine1": "street 1", + "addressLine2": "street 2", + "addressLine3": "street 3", + "city": "LA", + "stateCode": "AK", + "postalCode": "12332" + } + ] + } + }, + { + "firstName": "abc", + "lastName": "abc", + "maternalName": "abc", + "preferredName": "abc", + "customerRelationshipTypeId": 123456, + "birthDate": "MM/DD/YYYY", + "phoneNumberTypeId": 2, + "phoneNumber": "123456789", + "email": "test1@gmail.com", + "addresses": { + "address": [ + { + "addressTypeId": 11, + "addressLine1": "street 1", + "addressLine2": "street2", + "addressLine3": "street3", + "city": "CA", + "stateCode": "AK", + "postalCode": "12332" + } + ] + } + } + ] + } + } + } + } + }, + "sendApplicationAddOnsRequest": { + "summary": "sendApplicationAddOns", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendApplicationAddOns", + "version": "r1", + "params": { + "applicationId": 123456, + "propertyId": 12345, + "addOns": { + "addOn": [ + { + "id": null, + "addOnId": 12345, + "addOnTypeId": 2, + "agentId": 12345, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "isDelete": "0" + }, + { + "id": null, + "addOnId": 1234, + "addOnTypeId": 1, + "agentId": 1234, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "isDelete": "0" + }, + { + "id": null, + "addOnId": 1234, + "addOnTypeId": 3, + "agentId": 1234, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "isDelete": "0" + } + ] + } + } + } + } + }, + "sendApplicationEmployersRequest": { + "summary": "sendApplicationEmployers", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "1", + "method": { + "name": "sendApplicationEmployers", + "version": "r1", + "params": { + "applicationId": 12345, + "propertyId": 12345, + "employers": { + "employer": [ + { + "id": 1234, + "incomeTypeId": 1, + "customerId": 12345, + "frequencyId": 4, + "position": "Test Test", + "institutionName": "XYZ", + "institutionPhoneNumber": "123456789", + "institutionStreetLine1": "address line 1", + "institutionStreetLine2": "address line 2", + "institutionStreetLine3": "address line 3", + "institutionCity": "City", + "institutionStateCode": "xyz", + "institutionProvince": "xyz", + "institutionPostalCode": "1111", + "institutionCountryCode": "ABC", + "amount": "5000.00", + "contactName": "People Ops team", + "contactPhone": "123456789", + "contactEmail": "hr@example.lcl", + "incomeEffectiveDate": "MM/DD/YYYY", + "dateStarted": "MM/DD/YYYY", + "dateEnded": "MM/DD/YYYY", + "isDelete": "0" + } + ] + } + } + } + } + }, + "sendApplicationPetsRequest": { + "summary": "sendApplicationPets", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendApplicationPets", + "version": "r1", + "params": { + "applicationId": 12345, + "propertyId": 12345, + "pets": { + "pet": [ + { + "id": 123, + "customerId": 123456, + "typeId": 12345, + "name": "abc", + "breed": "abc", + "gender": "F", + "color": "White", + "weight": 30.9999, + "age": 12, + "description": "abc abc", + "licenseCity": "abc", + "licenseNumber": 156, + "isAssistanceAnimal": "0", + "isPetSpayedOrNeutered": "0", + "petSpayedOrNeuteredDate": "MM/DD/YYYY", + "isHouseBroken": "1", + "specialProvisions": "test", + "isDelete": "0" + }, + { + "id": 1233, + "customerId": 1111, + "typeId": 1234, + "name": "abc", + "breed": "English", + "gender": "M", + "color": "Black", + "weight": 38.9999, + "description": "black dog", + "licenseCity": "abc", + "licenseNumber": 1.9, + "isAssistanceAnimal": "0", + "isPetSpayedOrNeutered": "0", + "petSpayedOrNeuteredDate": "MM/DD/YYYY", + "isHouseBroken": "1", + "specialProvisions": "test", + "isDelete": "0" + } + ] + } + } + } + } + }, + "sendApplicationVehiclesRequest": { + "summary": "sendApplicationVehicles", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "1", + "method": { + "name": "sendApplicationVehicles", + "version": "r1", + "params": { + "applicationId": 1234, + "propertyId": 1234, + "vehicles": { + "vehicle": [ + { + "id": 1234, + "vehicleTypeId": 2, + "customerId": 1234, + "make": "test", + "model": "Rs 200", + "year": 2017, + "color": "Blue", + "permitNumber": "M123", + "licensePlateNumber": "M1233", + "stateCode": "CA", + "province": "test", + "countryCode": "XYZ", + "notes": "test", + "isDelete": "0" + } + ] + } + } + } + } + }, + "updateApplicationRequest": { + "summary": "updateApplication", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateApplication", + "params": { + "applicationId": 1234, + "propertyId": 1234, + "applicationStatusId": 3, + "floorplanId": 1236, + "unitSpaceId": 1234, + "leaseTermId": 4, + "leasingAgentId": 12345, + "moveInDate": "MM/DD/YYYY", + "originatingLeadSourceId": 12345, + "applicants": { + "applicant": [ + { + "id": 12345, + "firstName": "abc", + "lastName": "abc", + "maternalName": "abc", + "preferredName": "abc", + "birthDate": "MM/DD/YYYY", + "customerRelationshipTypeId": 12345, + "email": "test@gmail.com", + "phoneNumberTypeId": 3, + "phoneNumber": "(123)-111-1111", + "addresses": { + "address": [ + { + "addressTypeId": 11, + "addressLine1": "addressLine1", + "addressLine2": "addressLine2", + "addressLine3": "addressLine3", + "city": "City", + "postalCode": "12345", + "stateCode": "CA" + } + ] + } + }, + { + "id": "", + "firstName": "abc", + "lastName": "abc", + "maternalName": "abc", + "preferredName": "abc", + "birthDate": "MM/DD/YYYY", + "customerRelationshipTypeId": 12345, + "email": "test@gmail.com", + "phoneNumberTypeId": 3, + "phoneNumber": "(123)-111-1111", + "addresses": { + "address": [ + { + "addressTypeId": 11, + "addressLine1": "addressLine1", + "addressLine2": "addressLine2", + "addressLine3": "addressLine3", + "city": "City", + "postalCode": "12345", + "stateCode": "CA" + } + ] + } + } + ] + } + } + } + } + }, + "getAccessibleClientsRequest": { + "summary": "getAccessibleClients", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getAccessibleClients", + "version": "r1" + } + } + }, + "getAccessibleServicesRequest": { + "summary": "getAccessibleServices", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getAccessibleServices", + "version": "r1" + } + } + }, + "getArCodesRequest": { + "summary": "getArCodes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getArCodes", + "version": "r1", + "params": { + "propertyId": 1234 + } + } + } + }, + "getLeadsRequest": { + "summary": "getLeads", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeads", + "version": "r1", + "params": { + "propertyId": 1234, + "leadId": 1234, + "name": "abc abc", + "telephone": "1234567890", + "email": "example@email.com", + "leadStatusIds": "1,2,3", + "psProductIds": "1,2,3", + "includeDemographics": "0", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "createdOnDateFrom": "MM/DD/YYYY", + "createdOnDateTo": "MM/DD/YYYY", + "eventTypeIds": "1,2,3", + "eventDateFrom": "MM/DD/YYYY", + "eventDateTo": "MM/DD/YYYY", + "excludeAmenities": "0" + } + } + } + }, + "getLeadEventsRequest": { + "summary": "getLeadEvents", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeadEvents", + "version": "r1", + "params": { + "propertyId": 1234, + "applicationId": 1234, + "eventTypeIds": "1,2,3", + "eventDateFrom": "MM/DD/YYYY", + "eventDateTo": "MM/DD/YYYY" + } + } + } + }, + "applyQuoteRequest": { + "summary": "applyQuote", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "applyQuote", + "version": "r1", + "params": { + "propertyId": 1234, + "applicationId": 1234, + "quoteId": 1234, + "leaseTermId": 1234 + } + } + } + }, + "getLeadPickListsRequest_r1": { + "summary": "getLeadPickLists(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeadPickLists", + "version": "r1", + "params": { + "propertyIds": "21452,22965" + } + } + } + }, + "getLeadPickListsRequest_r2": { + "summary": "getLeadPickLists(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeadPickLists", + "version": "r2", + "params": { + "propertyId": 1234 + } + } + } + }, + "getMitsLeadsRequest": { + "summary": "getMitsLeads", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMitsLeads", + "params": { + "propertyId": 12345, + "leadId": 12345, + "name": "abc", + "telephone": "123456789", + "email": "LeadsEmail@address.com", + "leadStatusIds": "12345,4567", + "psProductIds": "12345,12345", + "eventTypeIds": "10,15", + "sendUnitSpaces": "1", + "fromDateTime": "MM/DD/YYYY", + "toDateTime": "MM/DD/YYYY", + "eventDateFrom": "MM/DD/YYYY", + "eventDateTo": "MM/DD/YYYY", + "includeDemographics": "0" + } + } + } + }, + "getQuotesRequest": { + "summary": "getQuotes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getQuotes", + "params": { + "propertyId": 123456, + "applicationId": 12345678, + "leaseStartDate": "MM/DD/YYYY", + "quoteId": 1234, + "includeExpiredQuotes": "0" + } + } + } + }, + "sendLeadsRequest": { + "summary": "sendLeads", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendLeads", + "params": { + "propertyId": 12345, + "doNotSendConfirmationEmail": "1", + "isWaitList": "0", + "prospects": { + "prospect": { + "leadSource": { + "originatingLeadSourceId": 123, + "additionalLeadSourceIds": "123,456,789" + }, + "createdDate": "MM/DD/YYYYTHH:MM:SS", + "leasingAgentId": "1234", + "customers": { + "customer": { + "name": { + "firstName": "abc", + "lastName": "abc", + "namePrefix": "abc", + "middleName": "abc", + "maidenName": "abc", + "nameSuffix": "abc" + }, + "customerRelationshipTypeId": 1234, + "address": { + "addressLine1": "addressLine1", + "addressLine2": "addressLine2", + "addressLine3": "addressLine3", + "city": "city", + "state": "state code", + "postalCode": "12345" + }, + "phone": { + "personalPhoneNumber": "123-1456-789", + "cellPhoneNumber": "123-1456-789", + "officePhoneNumber": "123-1456-789", + "faxNumber": "123-1456-789" + }, + "email": "email@example.com", + "marketingPreferences": { + "email": { + "optInLeadCommunication": "1", + "optInMessageCenter": "0", + "optInContactPoints": "1", + "optInMarketingMessages": "0" + }, + "optInphone": "1", + "optInMail": "0" + } + } + }, + "customerPreferences": { + "desiredMoveInDate": "MM/DD/YYYY", + "desiredFloorplanId": 1234, + "desiredUnitTypeId": 1234, + "desiredUnitId": 1234, + "desiredRent": { + "min": "200", + "max": "300" + }, + "desiredNumBedrooms": "2", + "desiredNumBathrooms": "3", + "desiredLeaseTerms": "18", + "desiredLeaseTermId": "1234", + "numberOfOccupants": "1", + "comment": "customer Preferences Comment" + }, + "events": { + "event": [ + { + "type": "CallFromProspect", + "eventTypeId": "3", + "date": "MM/DD/YYYYTHH:MM:SS", + "callData": { + "callFrom": "123-1456-789", + "ringThrough": "123-1456-789", + "callStatus": "Answer", + "duration": "900", + "audioLink": "URL for the call" + } + }, + { + "type": "CallToProspect", + "eventTypeId": "5", + "date": "MM/DD/YYYY", + "callData": { + "callFrom": "123-111-1234", + "ringThrough": "123-111-1234", + "callStatus": "Answer", + "duration": "900", + "audioLink": "https://www.entrata.com" + } + }, + { + "type": "Appointment", + "eventTypeId": "17", + "subtypeId": "454", + "date": "MM/DD/YYYYTHH:MM:SS", + "appointmentDate": "MM/DD/YYYY", + "timeFrom": "HH:MM:SS", + "timeTo": "HH:MM:SS", + "eventReasons": "Appointment Title", + "comments": "Appointment comment" + }, + { + "type": "EmailFromProspect", + "eventTypeId": "1", + "date": "MM/DD/YYYYTHH:MM:SS", + "emailAddresses": { + "from": "test1@email.com", + "to": "test11@email.com", + "cc": "test11@email.com", + "bcc": "test11@email.com" + }, + "subject": "Email Subject", + "emailBody": "Email Body" + }, + { + "type": "EmailToProspect", + "eventTypeId": "2", + "date": "MM/DD/YYYYTHH:MM:SS", + "emailAddresses": { + "from": "test12@email.com", + "to": "test1@email.com", + "cc": "test02@email.com", + "bcc": "test02@email.com" + }, + "subject": "Email Subject", + "emailBody": "Email Body", + "doNotSendEmail": 1 + }, + { + "type": "Show", + "eventTypeId": "78", + "date": "MM/DD/YYYYTHH:MM:SS", + "agentId": 12345, + "unitSpaceIds": "1234,1234", + "comments": "Comments", + "eventReasonId": 1234 + }, + { + "type": "Note", + "eventTypeId": "8", + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": 1234, + "comments": "comments" + }, + { + "type": "IncomingText", + "eventTypeId": "5", + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": "1234", + "comments": "Incoming_Text" + }, + { + "type": "OutgoingText", + "eventTypeId": "6", + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": "12345", + "comments": "Outgoing_Text" + }, + { + "type": "VirtualTour", + "eventTypeId": "449", + "date": "MM/DD/YYYYTHH:MM:SS", + "agentId": "1234", + "unitSpaceIds": "1234", + "comments": "Comments", + "eventReasonId": "1234" + }, + { + "type": "SelfGuidedTour", + "eventTypeId": "442", + "date": "MM/DD/YYYYTHH:MM:SS", + "agentId": "10481", + "unitSpaceIds": "1234", + "comments": "Comments", + "eventReasonId": "1234" + } + ] + } + } + } + } + } + } + }, + "sendMitsLeadsRequest": { + "summary": "sendMitsLeads", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendMitsLeads", + "params": { + "propertyId": 1234, + "doNotSendConfirmationEmail": "0", + "isWaitList": "1", + "Prospects": { + "Prospect": [ + { + "TransactionData": { + "OriginatingLeadSource": "Phone Book", + "InternetListingService": "ILS Name" + }, + "LastUpdateDate": "MM/DD/YYYYTHH:MM:SS", + "LeasingAgentId": 12345, + "Customers": { + "Customer": { + "Name": { + "FirstName": "abc", + "LastName": "abc", + "NamePrefix": "abc", + "MiddleName": "abc", + "MaidenName": "abc", + "NameSuffix": "abc" + }, + "Phone": [ + { + "PhoneNumber": "123456789", + "@attributes": { + "PhoneType": "personal" + } + }, + { + "PhoneNumber": "123456789", + "@attributes": { + "PhoneType": "cell" + } + }, + { + "PhoneNumber": "123456789", + "@attributes": { + "PhoneType": "office" + } + } + ], + "Email": "test@email.com", + "Address": { + "AddressLine1": "AddressLine1", + "AddressLine2": "AddressLine2", + "AddressLine3": "AddressLine3", + "City": "City", + "State": "State", + "PostalCode": "12345", + "@attributes": { + "AddressType": "current" + } + } + } + }, + "CustomerPreferences": { + "TargetMoveInDate": "MM/DD/YYYY", + "DesiredFloorplan": "1 floor", + "DesiredUnit": { + "Identification": { + "IDValue": 12345, + "@attributes": { + "IDRank": "primary", + "IDScopeType": "sender", + "IDType": "property_unit_id" + } + }, + "MarketingName": "1A1-A", + "UnitType": "one", + "UnitBedrooms": 1, + "UnitBathrooms": 1, + "MinSquareFeet": "900", + "MaxSquareFeet": "1200", + "UnitRent": 50, + "MarketRent": 35, + "NumberOccupants": 5 + }, + "DesiredRent": { + "@attributes": { + "Min": "$200.00", + "Max": "$500.00" + } + }, + "DesiredNumBedrooms": { + "@attributes": { + "Exact": 1 + } + }, + "DesiredNumBathrooms": { + "@attributes": { + "Exact": 2 + } + }, + "DesiredLeaseTerms": 12, + "DesiredLeaseTermId": 12345, + "NumberOfOccupants": 1, + "Comment": "Comment" + }, + "Events": { + "Event": [ + { + "CallData": { + "CallFrom": "123456789", + "RingThrough": "123456789", + "CallStatus": "Answer", + "Duration": 900, + "AudioLink": "http://www.test.co.in" + }, + "@attributes": { + "EventDate": "MM/DD/YYYYTHH:MM:SS" + } + }, + { + "EventReasons": "Appointment Title", + "Comments": "Appointment Description", + "@attributes": { + "EventType": "Appointment", + "EventDate": "MM/DD/YYYY", + "AppointmentDate": "MM/DD/YYYY", + "TimeFrom": "HH:MMam", + "TimeTo": "HH:MMam" + } + }, + { + "Agent": { + "AgentName": { + "FirstName": "abc", + "LastName": "abc" + } + }, + "UnitSpaceIds": "1234,5678", + "Comments": "Comments", + "EventReasons": "EventResult:EventResultId", + "@attributes": { + "EventType": "Show", + "EventDate": "MM/DD/YYYYTHH:MM:SS" + } + }, + { + "EmailData": { + "EmailDate": "MM/DD/YYYYTHH:MM:SS", + "EmailAddresses": { + "EmailAddress": [ + { + "@value": "from@test.com", + "@attributes": { + "Scope": "From" + } + }, + { + "@value": "to@test.com", + "@attributes": { + "Scope": "To" + } + }, + { + "@value": "cc@test.com", + "@attributes": { + "Scope": "Cc" + } + }, + { + "@value": "bcc@test.com", + "@attributes": { + "Scope": "Bcc" + } + } + ] + }, + "Subject": "Email Subject", + "EmailBody": "Email Body" + }, + "@attributes": { + "EventType": "EmailToProspect" + } + }, + { + "EmailData": { + "EmailDate": "MM/DD/YYYYTHH:MM:SS", + "EmailAddresses": { + "EmailAddress": [ + { + "@value": "from@integration.com", + "@attributes": { + "Scope": "From" + } + }, + { + "@value": "to@test.com", + "@attributes": { + "Scope": "To" + } + }, + { + "@value": "cc@test.com", + "@attributes": { + "Scope": "Cc" + } + }, + { + "@value": "bcc@test.com", + "@attributes": { + "Scope": "Bcc" + } + } + ] + }, + "Subject": "Email Subject", + "EmailBody": "Email Body" + }, + "@attributes": { + "EventType": "EmailFromProspect" + } + } + ] + } + }, + { + "TransactionData": { + "OriginatingLeadSource": "Phone Book", + "InternetListingService": "ILS Name" + }, + "LastUpdateDate": "MM/DD/YYYYTHH:MM:SS", + "Customers": { + "Customer": { + "Name": { + "FirstName": "abc", + "LastName": "abc" + }, + "Phone": { + "PhoneNumber": "123456789", + "@attributes": { + "PhoneType": "personal" + } + }, + "Email": "test@email.com" + } + }, + "CustomerPreferences": { + "Comment": "Comment" + } + } + ] + } + } + } + } + }, + "updateLeadsRequest": { + "summary": "updateLeads", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateLeads", + "version": "r2", + "params": { + "propertyId": 123456, + "doNotSendConfirmationEmail": "1", + "prospects": { + "prospect": { + "applicationId": 123456, + "leadSource": { + "originatingLeadSourceId": 123456, + "additionalLeadSourceIds": "1234,5678", + "internetListingServiceName": "abc Name" + }, + "leasingAgentId": 12345, + "leadScore": 5, + "leadScoreMin": 1, + "leadScoreMax": 10, + "customers": { + "customer": { + "applicantId": 12345, + "name": { + "firstName": "abc", + "lastName": "abc", + "namePrefix": "abc", + "middleName": "abc", + "maidenName": "abc", + "nameSuffix": "abc" + }, + "customerRelationshipTypeId": 1234, + "address": { + "addressLine1": "abc", + "addressLine2": "abc", + "addressLine3": "abc", + "city": "XYZ", + "state": "XYZ", + "postalCode": "12345" + }, + "phone": { + "personalPhoneNumber": "123456789", + "cellPhoneNumber": "123456789", + "officePhoneNumber": "123456789", + "faxNumber": "123456789" + }, + "email": "Test@xento.lcl" + } + }, + "customerPreferences": { + "desiredMoveInDate": "MM/DD/YYYY", + "desiredFloorplanId": 123456, + "desiredUnitTypeId": 123456, + "desiredUnitId": 123456, + "desiredRent": { + "min": 123, + "max": 123 + }, + "desiredNumBedrooms": 2, + "desiredNumBathrooms": 2, + "desiredLeaseTermMonth": 2, + "desiredLeaseTermId": 12345, + "numberOfOccupants": 2 + }, + "events": { + "event": [ + { + "typeId": 3, + "eventId": 123456, + "date": "MM/DD/YYYYTHH:MM:SS", + "comments": "Comments about the call", + "callData": { + "callFrom": 123456, + "ringThrough": 12345, + "callStatus": "Answer", + "duration": 600, + "audioLink": "URL for the call" + } + }, + { + "typeId": 15, + "date": "MM/DD/YYYYTHH:MM:SS", + "leasingAgentId": 12345, + "notes": "ac99", + "comments": "aaa100", + "scheduleDateTime": "MM/DD/YYYYTHH:MM:SS" + }, + { + "typeId": 4, + "eventId": 12345, + "eventResultId": 123456, + "date": "MM/DD/YYYYTHH:MM:SS", + "comments": "Comments about the call", + "callData": { + "callFrom": "4644444444", + "ringThrough": "123654987", + "callStatus": "Answer", + "duration": 100, + "audioLink": "URL for the call" + } + }, + { + "typeId": 17, + "eventId": 1234, + "subtypeId": 525, + "date": "MM/DD/YYYYTHH:MM:SS", + "appointmentDate": "MM/DD/YYYY", + "timeFrom": "HH:MMam", + "timeTo": "HH:MMam", + "title": "Appointment Title", + "comments": "Appointment Comment", + "eventResultId": 1234, + "deleteAppointment": "0", + "unitSpaceIds": "1234,5678" + }, + { + "typeId": 2, + "date": "MM/DD/YYYYTHH:MM:SS", + "emailAddresses": { + "from": "test1123@gmail.lcl", + "to": "Test@xento.lcl", + "cc": "test11@email.lcl", + "bcc": "test11@email.lcl" + }, + "subject": "Email Subject Outgoing email", + "emailBody": "Email Body Outgoing email", + "doNotSendEmail": 1 + }, + { + "typeId": 1, + "eventId": 12345, + "date": "MM/DD/YYYYTHH:MM:SS", + "emailBody": "Email Body incoming email", + "emailNotes": "Test Email Notes" + }, + { + "typeId": 78, + "subtypeId": 524, + "eventId": 123456, + "date": "MM/DD/YYYYTHH:MM:SS", + "comments": "Tour Event 12345", + "agentId": 1234, + "unitSpaceIds": "1234,5678", + "eventResultId": 123456 + }, + { + "typeId": 8, + "eventId": 123456, + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": 123456, + "comments": "Note Event" + }, + { + "typeId": 5, + "eventId": 12345, + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": 57445, + "notes": "Incoming_Text" + }, + { + "typeId": 6, + "eventId": 12345, + "date": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": 12345, + "notes": "Outgoing_Text" + }, + { + "typeId": 123, + "eventId": 12456, + "eventResultId": 114246 + }, + { + "typeId": 123, + "eventId": 12457, + "eventResultId": 114245 + }, + { + "typeId": 123, + "date": "MM/DD/YYYYTHH:MM:SS", + "agentId": 1234, + "unitSpaceIds": "1234,5678", + "comments": "Comments", + "eventResultId": 7027 + }, + { + "typeId": 123, + "eventId": 12345, + "eventResultId": 12345 + } + ] + } + } + } + } + } + } + }, + "generateQuotesRequest": { + "summary": "generateQuotes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "generateQuotes", + "params": { + "propertyId": 1234, + "applicationId": 123, + "quotes": { + "quote": [ + { + "moveInDate": "MM/DD/YYYY", + "unitSpaceId": 123, + "leaseTermIds": "1234,5678", + "note": "Quotes added by API", + "pets": { + "pet": [ + { + "petTypeId": 123, + "count": 1 + } + ] + }, + "addOns": { + "addOn": [ + { + "addOnTypeId": 2, + "addOnId": 1234, + "agentId": 1234, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY" + } + ] + } + } + ] + } + } + } + } + }, + "getArPaymentsRequest": { + "summary": "getArPayments", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getArPayments", + "params": { + "arPaymentIds": "1234,5678", + "paymentStatusTypeIds": "1234,5678", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "isIncludeAllocations": "1" + } + } + } + }, + "getArInvoicesRequest": { + "summary": "getArInvoices", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getArInvoices", + "params": { + "propertyId": 12345, + "leaseIds": "1234,5678", + "arInvoiceId": 12345, + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY" + } + } + } + }, + "getLeaseArTransactionsRequest": { + "summary": "getLeaseArTransactions", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseArTransactions", + "version": "r1", + "params": { + "propertyId": 1234, + "leaseIds": "1234,5678", + "leaseStatusTypeIds": "3,4", + "transactionTypeIds": "12345,4567", + "arCodeIds": "1234,5678", + "showFullLedger": "1", + "residentFriendlyMode": "0", + "includeOtherIncomeLeases": "0", + "includeReversals": "1", + "transactionFromDate": "MM/DD/YYYY", + "transactionToDate": "MM/DD/YYYY", + "ledgerIds": "1234,5678" + } + } + } + }, + "getMitsLeaseArTransactionsRequest": { + "summary": "getMitsLeaseArTransactions", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMitsLeaseArTransactions", + "version": "r1", + "params": { + "propertyId": 1234, + "leaseId": 1234, + "leaseStatusTypeIds": "1234,5678", + "arCodeIds": "12345,4567", + "showFullLedger": "0", + "includeReversals": "0", + "residentFriendlyMode": "0", + "includeOtherIncomeLeases": "0", + "includePaymentsOnly": "0", + "transactionFromDate": "MM/DD/YYYY", + "transactionToDate": "MM/DD/YYYY" + } + } + } + }, + "sendLeaseArTransactionReversalsRequest": { + "summary": "sendLeaseArTransactionReversals", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendLeaseArTransactionReversals", + "params": { + "Transactions": { + "Transaction": [ + { + "TransactionId": 1234, + "TransactionAmount": "100.00" + }, + { + "TransactionId": 1234, + "TransactionAmount": "100.50" + } + ] + } + } + } + } + }, + "sendLeaseArTransactionsRequest": { + "summary": "sendLeaseArTransactions", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendLeaseArTransactions", + "params": { + "transaction": [ + { + "transactionId": 1234, + "leaseId": 1234, + "arCodeId": 11, + "arPostMonth": "MM/YYYY", + "transactionDate": "MM/DD/YYYY", + "transactionAmount": "1000.00", + "description": "Memo field", + "useApprovalRouting": "1", + "files": { + "file": { + "name": "charge_Image_1.png", + "fileData": "base64_encoded file data" + } + } + }, + { + "transactionId": 1234, + "leaseId": 1234, + "arCodeId": 22, + "transactionDate": "MM/DD/YYYY", + "transactionAmount": "2000.00", + "description": "Memo field", + "useApprovalRouting": "0", + "files": { + "file": { + "name": "charge_Image_2.png", + "fileData": "base64_encoded file data" + } + } + }, + { + "transactionId": 1234, + "leaseId": 12345, + "arCodeId": 33, + "arPostMonth": "MM/YYYY", + "transactionDate": "MM/DD/YYYY", + "transactionAmount": "300.00", + "description": "Memo field", + "useApprovalRouting": "1", + "files": { + "file": { + "name": "charge_Image_3.png", + "fileData": "base64_encoded file data" + } + } + } + ] + } + } + } + }, + "getMarketingPreferencePickListRequest": { + "summary": "getMarketingPreferencePickList", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMarketingPreferencePickList" + } + } + }, + "getMarketingPreferencesRequest": { + "summary": "getMarketingPreferences", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMarketingPreferences", + "params": { + "propertyId": 1234, + "customerIds": "1234,5678", + "recipientTypeId": "1" + } + } + } + }, + "getCustomersRequest": { + "summary": "getCustomers", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCustomers", + "params": { + "propertyId": "1234", + "customerIds": "14532,2332", + "leaseStatusTypeIds": "1,2", + "isAgreedToTermsOnly": "1", + "companyIdentificationTypeIds": "12345" + } + } + } + }, + "getCustomerTestimonialsRequest": { + "summary": "getCustomerTestimonials", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCustomerTestimonials", + "params": { + "propertyId": 11111, + "isApproved": "0", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY" + } + } + } + }, + "getTestimonialPickListsRequest": { + "summary": "getTestimonialPickLists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getTestimonialPickLists" + } + } + }, + "searchCustomersRequest": { + "summary": "searchCustomers", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "searchCustomers", + "params": { + "propertyId": 12345, + "search": "Thornberry" + } + } + } + }, + "sendCustomerTestimonialsRequest": { + "summary": "sendCustomerTestimonials", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendCustomerTestimonials", + "params": { + "PropertyId": 1234, + "Testimonials": { + "Testimonial": [ + { + "CustomerId": 12345, + "TestimonialTypeId": 1, + "Name": "abc", + "Email": "abc@abc.com", + "TestimonialDatetime": "MM/DD/YYYYTHH:MM:SS", + "PropertyResponse": "Property Response...", + "Title": "abc", + "Review": "abc", + "RecommendToFriend": "1", + "AuthorizeToShowOnCorporateSites": "1", + "AutoApproveForProspectPortal": "0", + "AutoApproveForVacancy": "0", + "IpAddress": "333.333.33.3", + "TestimonialRatings": { + "TestimonialRating": [ + { + "RatingTypeId": 1, + "Rating": 3 + }, + { + "RatingTypeId": 2, + "Rating": 5 + }, + { + "RatingTypeId": 3, + "Rating": 3 + }, + { + "RatingTypeId": 5, + "Rating": 4 + }, + { + "RatingTypeId": 6, + "Rating": 4 + }, + { + "RatingTypeId": 7, + "Rating": 4 + }, + { + "RatingTypeId": 8, + "Rating": 4 + } + ] + } + } + ] + } + } + } + } + }, + "updateCustomersRequest": { + "summary": "updateCustomers", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateCustomers", + "params": { + "customers": { + "customer": [ + { + "id": 31025784, + "firstName": "abc", + "lastName": "abc", + "namePrefix": "Ms.", + "middleName": "abc", + "maidenName": "abc", + "nameSuffix": "III", + "email": "abc@example.org", + "birthDate": "MM/DD/YYYY", + "taxNumberTypeId": 9, + "taxNumber": "123-123-123", + "addresses": { + "address": [ + { + "addressTypeId": 8, + "streetLine1": "streetLine1", + "streetLine2": "streetLine2", + "streetLine3": "streetLine3", + "city": "city", + "state": "CA", + "country": "XYZ", + "postalCode": "12345" + }, + { + "addressTypeId": 13, + "streetLine1": "streetLine1", + "streetLine2": "streetLine2", + "streetLine3": "streetLine3", + "city": "city", + "state": "state", + "country": "country", + "postalCode": "12345" + } + ] + }, + "phoneNumbers": { + "phoneNumber": [ + { + "phoneNumberTypeId": 2, + "isPrimary": "1", + "phoneNumber": "1231231234" + }, + { + "phoneNumberTypeId": 3, + "isPrimary": "0", + "phoneNumber": "123456789" + }, + { + "phoneNumberTypeId": 4, + "isPrimary": "0", + "phoneNumber": "123456789" + } + ] + }, + "companyIdentificationValues": { + "companyIdentificationValue": [ + { + "companyIdentificationTypeId": 1234, + "identificationValue": 123, + "idExpirationDate": "MM/DD/YYYY", + "stateCode": "XY", + "countryCode": "XYZ" + }, + { + "companyIdentificationTypeId": 12345, + "identificationValue": 123, + "idExpirationDate": "MM/DD/YYYY", + "stateCode": "XY", + "countryCode": "XYZ" + } + ] + } + }, + { + "id": 29629916, + "firstName": "abc", + "lastName": "abc", + "namePrefix": "abc", + "middleName": "abc", + "maidenName": "abc", + "nameSuffix": "abc", + "email": "abc@example.org", + "birthDate": "MM/DD/YYYY", + "taxNumberTypeId": 9, + "taxNumber": "123-123-123", + "addresses": { + "address": [ + { + "addressTypeId": 5, + "streetLine1": "streetLine", + "streetLine2": "streetLine", + "streetLine3": "streetLine", + "city": "city", + "state": "xyz", + "country": "country", + "postalCode": "12345" + }, + { + "addressTypeId": 8, + "streetLine1": "streetLine", + "streetLine2": "streetLine", + "streetLine3": "streetLine", + "city": "city", + "state": "state.", + "country": "country", + "postalCode": "12345" + } + ] + }, + "phoneNumbers": { + "phoneNumber": [ + { + "phoneNumberTypeId": 2, + "isPrimary": "1", + "phoneNumber": "123456789" + }, + { + "phoneNumberTypeId": 3, + "isPrimary": "0", + "phoneNumber": "123456789" + }, + { + "phoneNumberTypeId": 4, + "isPrimary": "0", + "phoneNumber": "123456789" + } + ] + }, + "companyIdentificationValues": { + "companyIdentificationValue": [ + { + "companyIdentificationTypeId": 123, + "identificationValue": "17917/91791791791/791791791/79179", + "idExpirationDate": "MM/DD/YYYY", + "stateCode": "XY", + "countryCode": "XYZ" + }, + { + "companyIdentificationTypeId": 123, + "identificationValue": "12345-26261261-2612612612-612612", + "idExpirationDate": "MM/DD/YYYY", + "stateCode": "XY", + "countryCode": "XYZ" + } + ] + } + } + ] + } + } + } + } + }, + "updateCustomerTestimonialsRequest": { + "summary": "updateCustomerTestimonials", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateCustomerTestimonials", + "params": { + "propertyId": 12345, + "transmissionVendorId": 12345, + "testimonialId": 12345, + "isPublished": "1" + } + } + } + }, + "updatePropertyResponseRequest": { + "summary": "updatePropertyResponse", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updatePropertyResponse", + "params": { + "propertyId": 1234, + "testimonialId": 1234, + "isPublish": "1", + "reviewResponse": "Test Review Response" + } + } + } + }, + "getApCodesRequest": { + "summary": "getApCodes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getApCodes", + "params": { + "glAccountIds": "12345,4567", + "apCodeTypeIds": "12345,4567" + } + } + } + }, + "getBankAccountsRequest": { + "summary": "getBankAccounts", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getBankAccounts", + "params": { + "bankAccountTypeId": 1234, + "isCreditCardAccount": "0" + } + } + } + }, + "getBudgetActualsRequest": { + "summary": "getBudgetActuals", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getBudgetActuals", + "params": { + "propertyId": 1234, + "glTreeId": 1234, + "budgetId": 1234, + "postMonthFrom": "MM/YYYY", + "postMonthTo": "MM/YYYY", + "glBookTypeIds": "12345,4567", + "budgetStatusTypeId": 1234, + "accountingMethod": "Cash" + } + } + } + }, + "getBudgetsRequest": { + "summary": "getBudgets", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getBudgets", + "params": { + "propertyIds": "12345,4567", + "budgetIds": "12345,4567", + "budgetStatusTypeIds": "12345,4567", + "fiscalYears": "YYYY,YYYY" + } + } + } + }, + "getFinancialPickListRequest_r1": { + "summary": "getFinancialPickList(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getFinancialPickList", + "version": "r1" + } + } + }, + "getFinancialPickListRequest_r2": { + "summary": "getFinancialPickList(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getFinancialPickList", + "version": "r2" + } + } + }, + "getGlTransactionsRequest": { + "summary": "getGlTransactions", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getGlTransactions", + "params": { + "propertyIds": "12345,4567", + "glAccountFrom": "1234", + "glAccountTo": "1234", + "postMonthFrom": "MM/YYYY", + "postMonthTo": "MM/YYYY", + "postDateFrom": "MM/DD/YYYY", + "postDateTo": "MM/DD/YYYY", + "isCashBook": "0", + "isDetailed": "1", + "excludeApTransactions": "1", + "excludeArTransactions": "0", + "excludeExportedTransactions": "0", + "glTreeId": 1234, + "glBookTypeIds": "1,2,3", + "transactionDateFrom": "MM/DD/YYYY", + "transactionDateTo": "MM/DD/YYYY", + "lastUpdatedOnFromDate": "MM/DD/YYYY", + "lastUpdatedOnToDate": "MM/DD/YYYY" + } + } + } + }, + "getGlTreesRequest_r1": { + "summary": "getGlTrees(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getGlTrees", + "version": "r1", + "params": { + "propertyId": 1234, + "glTreeId": 1283, + "glBranchId": 1234, + "glGroupTypeId": 1, + "glTreeTypeId": 1, + "accountNumbers": "1234,1234" + } + } + } + }, + "getGlTreesRequest_r2": { + "summary": "getGlTrees(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getGlTrees", + "version": "r2", + "params": { + "glTreeId": 1234, + "glBranchId": 1234, + "glGroupTypeId": 1, + "glTreeTypeId": 1, + "accountNumbers": "1234,1234" + } + } + } + }, + "getJobCategoriesRequest": { + "summary": "getJobCategories", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getJobCategories", + "params": { + "glAccountIds": "12345,4567" + } + } + } + }, + "getJobCostBudgetsRequest": { + "summary": "getJobCostBudgets", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getJobCostBudgets", + "params": { + "propertyIds": "12345,4567", + "jobIds": "12345,4567", + "jobStatusIds": "12345,4567", + "apCodeIds": "12345,4567", + "jobPhaseId": 123 + } + } + } + }, + "getJobsRequest": { + "summary": "getJobs", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getJobs", + "params": { + "propertyId": 12345, + "jobCategoryIds": "12345,4567", + "jobStatusIds": "12345,4567" + } + } + } + }, + "getTransactionTagListsRequest": { + "summary": "getTransactionTagLists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getTransactionTagLists" + } + } + }, + "cancelLeaseRequest": { + "summary": "cancelLease", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "cancelLease", + "params": { + "propertyId": 12345, + "leaseId": 12345 + } + } + } + }, + "getEvictedLeasesRequest": { + "summary": "getEvictedLeases", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getEvictedLeases", + "params": { + "propertyId": 1234, + "evictionStartDateFrom": "MM/DD/YYYY", + "evictionStartDateTo": "MM/DD/YYYY" + } + } + } + }, + "markGlTransactionsExportedRequest": { + "summary": "markGlTransactionsExported", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "markGlTransactionsExported", + "params": { + "glDetails": { + "glDetailId": [ + 1234, + 12345 + ] + } + } + } + } + }, + "sendBudgetsRequest": { + "summary": "sendBudgets", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendBudgets", + "params": { + "propertyId": 123456, + "budgets": { + "budget": [ + { + "budgetName": "budgets name 1", + "fiscalYear": "YYYY", + "fiscalStartMonth": "MM/YYYY", + "fiscalEndMonth": "MM/YYYY", + "glAccounts": { + "glAccount": [ + { + "id": 1234, + "budgetMonths": [ + { + "budgetMonth": "MM/YYYY", + "amount": "10.00" + }, + { + "budgetMonth": "MM/YYYY", + "amount": "10.00" + } + ] + }, + { + "id": 1235, + "budgetMonths": [ + { + "budgetMonth": "MM/YYYY", + "amount": "20.00" + }, + { + "budgetMonth": "MM/YYYY", + "amount": "20.00" + } + ] + } + ] + } + }, + { + "budgetName": "budgets name 2", + "fiscalYear": 2018, + "fiscalStartMonth": "MM/YYYY", + "fiscalEndMonth": "MM/YYYY", + "glAccounts": { + "glAccount": [ + { + "id": 1234, + "budgetMonths": [ + { + "budgetMonth": "MM/YYYY", + "amount": "10.00" + }, + { + "budgetMonth": "MM/YYYY", + "amount": "10.00" + } + ] + }, + { + "id": 1235, + "budgetMonths": [ + { + "budgetMonth": "MM/YYYY", + "amount": "20.00" + }, + { + "budgetMonth": "MM/YYYY", + "amount": "20.00" + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "sendJournalEntriesRequest": { + "summary": "sendJournalEntries", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendJournalEntries", + "params": { + "glHeaders": { + "glHeader": [ + { + "propertyId": 123456, + "glHeaderTypeId": 1, + "reference": "Enter Journal Entries", + "accountingMethod": "cash", + "glBookId": 12345, + "postDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "isReverse": "0", + "reversePostMonth": "MM/YYYY", + "routingTagId": 1234, + "notes": "Testing for journal entries", + "defaultPropertyUnitId": 123456, + "defaultPropertyBuildingId": 123456, + "defaultGlDimensionId": 123456, + "defaultJobPhaseId": 1234, + "defaultApContractId": 23, + "glDetails": { + "glDetail": [ + { + "glAccountId": 12345, + "memo": "TestJournal", + "debitAmount": "100.00", + "creditAmount": "10.00", + "propertyId": 12345, + "propertyUnitId": 123456, + "propertyBuildingId": 12345, + "unitSpaceId": 12, + "glDimensionId": 12, + "jobPhaseId": 23, + "apContractId": 123, + "apCodeId": 123 + }, + { + "glAccountId": 12345, + "memo": "Memo testing", + "debitAmount": "10.00", + "creditAmount": "100.00", + "propertyId": 12346, + "propertyUnitId": 123456, + "propertyBuildingId": 123456, + "unitSpaceId": 123, + "glDimensionId": 123, + "jobPhaseId": 123, + "apContractId": 123, + "apCodeId": 123 + } + ] + } + } + ] + } + } + } + } + }, + "updateBudgetsRequest": { + "summary": "updateBudgets", + "value": { + "requestId": "15", + "auth": { + "type": "apikey" + }, + "method": { + "name": "updateBudgets", + "params": { + "propertyId": 1234, + "budgets": { + "budget": [ + { + "budgetId": 1234, + "glAccounts": { + "glAccount": [ + { + "id": 1234, + "budgetMonths": { + "budgetMonth": [ + { + "month": "MM/YYYY", + "amount": "100.88" + }, + { + "month": "MM/YYYY", + "amount": "122.88" + } + ] + } + }, + { + "id": 1234, + "budgetMonths": { + "budgetMonth": [ + { + "month": "MM/YYYY", + "amount": "123.11" + } + ] + } + } + ] + } + }, + { + "budgetId": 1234, + "glAccounts": { + "glAccount": [ + { + "id": 1234, + "budgetMonths": { + "budgetMonth": [ + { + "month": "MM/YYYY", + "amount": "133.22" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "getExpiringLeasesRequest": { + "summary": "getExpiringLeases", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getExpiringLeases", + "params": { + "propertyId": 12345, + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "isMonthToMonth": "1", + "showNoticeLeasesOnly": "1" + } + } + } + }, + "getLeaseActivitiesRequest": { + "summary": "getLeaseActivities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseActivities", + "version": "r1", + "params": { + "propertyId": 123456, + "leaseId": 123456, + "createdOnDateFrom": "MM/DD/YYYY", + "createdOnDateTo": "MM/DD/YYYY", + "eventTypeIds": "1,2,3" + } + } + } + }, + "getLeaseDetailsRequest_r1": { + "summary": "getLeaseDetails(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseDetails", + "version": "r1", + "params": { + "propertyId": 1234, + "leaseId": 1234, + "includeAddOns": "1", + "includeCharge": "1" + } + } + } + }, + "getLeaseDetailsRequest_r2": { + "summary": "getLeaseDetails(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseDetails", + "version": "r2", + "params": { + "propertyId": 1234, + "leaseId": 1234, + "leaseStatusTypeIds": "12345,4567", + "includeAddOns": "0", + "includeCharge": "1" + } + } + } + }, + "getLeaseDocumentsRequest": { + "summary": "getLeaseDocuments", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseDocuments", + "params": { + "propertyId": 1234, + "leaseId": 1234, + "externalLeaseId": "1234", + "documentIds": "12345,4567", + "fileTypesCode": "XYZ,XYZ,XYZ", + "showDeletedFile": "1", + "addedOnFromDate": "MM/DD/YYYY" + } + } + } + }, + "getLeaseDocumentsListRequest": { + "summary": "getLeaseDocumentsList", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeaseDocumentsList", + "params": { + "propertyId": 1234, + "leaseId": 1234, + "externalLeaseId": "123", + "leaseStatusTypeIds": "12345,4567", + "fileTypesCode": "LA", + "showDeletedFile": "1" + } + } + } + }, + "getLeasePickListRequest": { + "summary": "getLeasePickList", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeasePickList" + } + } + }, + "getLeasesRequest_r1": { + "summary": "getLeases(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeases", + "version": "r1", + "params": { + "leaseIds": "12345,4567", + "propertyId": 1234, + "applicationId": 1234, + "customerId": 1234, + "unitNumber": "123-A", + "buildingName": "TEST", + "moveInDateFrom": "MM/DD/YYYY", + "moveInDateTo": "MM/DD/YYYY", + "leaseExpiringDateFrom": "MM/DD/YYYY", + "leaseExpiringDateTo": "MM/DD/YYYY", + "moveOutDateFrom": "MM/DD/YYYY", + "moveOutDateTo": "MM/DD/YYYY", + "scheduledArCodeIds": "12345,4567", + "leaseStatusTypeIds": "12345,4567", + "includeLeaseHistory": "1", + "includeOtherIncomeLeases": "1", + "residentFriendlyMode": "0", + "includeArTransactions": "1" + } + } + } + }, + "getLeasesRequest_r2": { + "summary": "getLeases(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeases", + "version": "r2", + "params": { + "leaseIds": "12345,4567", + "propertyId": 1234, + "applicationId": 1234, + "customerId": 1234, + "unitNumber": "123-A", + "buildingName": "TEST", + "moveInDateFrom": "MM/DD/YYYY", + "moveInDateTo": "MM/DD/YYYY", + "leaseExpiringDateFrom": "MM/DD/YYYY", + "leaseExpiringDateTo": "MM/DD/YYYY", + "moveOutDateFrom": "MM/DD/YYYY", + "moveOutDateTo": "MM/DD/YYYY", + "scheduledArCodeIds": "12345,4567", + "leaseStatusTypeIds": "12345,4567", + "includeLeaseHistory": "1", + "includeOtherIncomeLeases": "1", + "residentFriendlyMode": "0", + "includeDemographics": "1", + "includeArTransactions": "1" + } + } + } + }, + "getMitsCollectionsRequest": { + "summary": "getMitsCollections", + "value": { + "auth": { + "type": "apikey" + }, + "method": { + "name": "getMitsCollections", + "version": "r1", + "params": { + "propertyId": 12345, + "includeEvictions": "0", + "fromDate": "MM/DD/YYYY", + "transactionFromDate": "MM/DD/YYYY" + } + } + } + }, + "getMitsLeasesRequest": { + "summary": "getMitsLeases", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMitsLeases", + "params": { + "propertyId": 1234, + "customerId": 1234, + "buildingName": "test", + "unitNumber": "xyz", + "scheduledArCodeIds": "12345,4567", + "moveInDateFrom": "MM/DD/YYYY", + "moveInDateTo": "MM/DD/YYYY", + "leaseExpiringDateFrom": "MM/DD/YYYY", + "leaseExpiringDateTo": "MM/DD/YYYY", + "moveOutDateFrom": "MM/DD/YYYY", + "moveOutDateTo": "MM/DD/YYYY", + "includeLeaseHistory": "1", + "leaseStatusTypeIds": "12345,4567", + "sendUnitSpaces": "1", + "includeOtherIncomeLeases": "1", + "residentFriendlyMode": "1", + "preLeaseOnly": "1" + } + } + } + }, + "getParcelAlertsRequest": { + "summary": "getParcelAlerts", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getParcelAlerts", + "params": { + "propertyId": 12345, + "leaseId": 1234, + "customerId": 123, + "isActive": "0" + } + } + } + }, + "getRentersInsurancePoliciesRequest": { + "summary": "getRentersInsurancePolicies", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getRentersInsurancePolicies", + "params": { + "propertyId": 12345, + "leaseStatusTypeIds": "12345,4567", + "lastUpdatedOn": "MM/DD/YYYY" + } + } + } + }, + "moveInLeaseRequest": { + "summary": "moveInLease", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "moveInLease", + "params": { + "propertyId": 12345, + "leaseId": 12345 + } + } + } + }, + "moveOutLeaseRequest": { + "summary": "moveOutLease", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "moveOutLease", + "version": "r1", + "params": { + "propertyId": 12345, + "leaseId": 12345, + "moveOutTypeId": 12345, + "moveOutReasonId": 12345, + "noticeDate": "MM/DD/YYYY", + "moveOutDate": "MM/DD/YYYY", + "unitAvailableOnDate": "MM/DD/YYYY", + "endContinuingScheduledCharges": "1", + "postAcceleratedRent": "1", + "refundMethodId": 2, + "makeReadyEndDate": "MM/DD/YYYY", + "forwardingAddress": { + "streetLine1": "streetLine1", + "streetLine2": "streetLine1", + "streetLine3": "streetLine1", + "city": "city", + "stateCode": "XY", + "postalCode": "1234" + } + } + } + } + }, + "onNoticeLeaseRequest": { + "summary": "onNoticeLease", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "onNoticeLease", + "params": { + "propertyId": 12345, + "leaseId": 12345, + "moveOutTypeId": 1, + "moveOutReasonId": 12345, + "noticeDate": "MM/DD/YYYY", + "moveOutDate": "MM/DD/YYYY", + "unitAvailableOnDate": "MM/DD/YYYY", + "submitRefundDetails": "1", + "refundMethodId": 2, + "makeReadyEndDate": "MM/DD/YYYY", + "forwardingAddress": { + "streetLine1": "Street 1", + "streetLine2": "Street 2", + "streetLine3": "Street 3", + "city": "XY", + "stateCode": "XY", + "postalCode": "12345" + } + } + } + } + }, + "sendLeaseActivitiesRequest": { + "summary": "sendLeaseActivities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendLeaseActivities", + "params": { + "propertyId": 12345, + "events": { + "event": [ + { + "leaseId": 12345, + "eventTypeId": 8, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "comment": "19th nov" + }, + { + "leaseId": 12345, + "eventTypeId": 15, + "notes": "test note", + "leaseIntervalId": 123456, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "eventResultId": 12345, + "comment": "g110", + "customerIds": "12345,4567", + "leasingAgentId": 12345, + "scheduleDateTime": "MM/DD/YYYYTHH:MM:SS" + }, + { + "leaseId": 1234, + "eventTypeId": 123, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "hazardEndDate": "MM/DD/YYYY", + "hazardNote": "Hazard test note" + }, + { + "leaseId": 1234, + "eventTypeId": 123, + "leaseIntervalId": 123456, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "comment": "19th nov" + }, + { + "leaseId": 1234, + "eventTypeId": 4, + "leaseIntervalId": 123456, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "customerIds": "12345,4567", + "comment": "Test", + "eventResultId": 1234 + }, + { + "leaseId": 1234, + "eventTypeId": 123, + "leaseIntervalId": 123456, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "customerIds": "12345,4567", + "comment": "Test", + "eventResultId": 1234 + }, + { + "leaseId": 1234, + "eventTypeId": 123, + "leaseIntervalId": 123456, + "eventDateTime": "MM/DD/YYYYTHH:MM:SS", + "customerIds": "12345,4567", + "comment": "Test", + "eventResultId": 1234 + } + ] + } + } + } + } + }, + "sendLeasesRequest": { + "summary": "sendLeases", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendLeases", + "params": { + "propertyId": 12345, + "leases": { + "lease": [ + { + "leaseStartDate": "MM/DD/YYYY", + "leaseEndDate": "MM/DD/YYYY", + "moveInDate": "MM/DD/YYYY", + "leaseTermId": 12345, + "floorplanId": 12345, + "unitSpaceId": 12345, + "spaceConfigurationId": 12, + "leaseStartWindowId": 12345, + "occupants": { + "occupant": [ + { + "firstName": "abc", + "middleName": "abc", + "lastName": "abc", + "customerRelationshipTypeId": 12345, + "emailAddress": "test@t.com", + "birthDate": "MM/DD/YYYY", + "primaryPhoneNumber": { + "phoneNumberTypeId": 1, + "phoneNumber": "123456789" + }, + "addresses": { + "address": [ + { + "addressTypeId": 2, + "streetLine1": "abcst1", + "streetLine2": "abcst2", + "city": "city1", + "stateCode": "XY", + "postalCode": "1234" + }, + { + "addressTypeId": 123, + "streetLine1": "streetLine1", + "streetLine2": "streetLine2", + "city": "city1", + "stateCode": "XY", + "postalCode": "1234" + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "sendRentersInsurancePoliciesRequest_r1": { + "summary": "sendRentersInsurancePolicies(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendRentersInsurancePolicies", + "version": "r1", + "params": { + "propertyId": 12345, + "insurancePolicies": { + "insurancePolicy": [ + { + "id": 12345, + "leaseId": 12345, + "customerId": 12345, + "provider": "Insurance Company", + "policyNumber": 12345, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "liability": "1235.00", + "personalContents": "200.00", + "deductible": 500 + }, + { + "id": 22, + "leaseId": 12345, + "customerId": 12345, + "provider": "Insurance Company", + "policyNumber": 12345, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "liability": "1235.00", + "personalContents": "200.00", + "deductible": 200 + } + ] + } + } + } + } + }, + "sendRentersInsurancePoliciesRequest_r2": { + "summary": "sendRentersInsurancePolicies(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendRentersInsurancePolicies", + "version": "r2", + "params": { + "propertyId": 12345, + "insurancePolicies": { + "insurancePolicy": [ + { + "id": 12345, + "leaseId": 12345, + "customerIds": "12345,5644", + "provider": "AIG", + "policyNumber": 12345, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "liability": "12350000", + "personalContents": "200", + "deductible": "500", + "isCancelled": "1", + "file": { + "name": "file name with extension", + "fileDate": "base64_encoded file data" + } + }, + { + "id": 12345, + "leaseId": 12345, + "customerIds": "12345,5644", + "provider": "AIG", + "policyNumber": 12345, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "liability": "12350000", + "personalContents": "100", + "deductible": "200", + "isCancelled": "1", + "file": { + "name": "file name with extension", + "fileDate": "base64_encoded file data" + } + } + ] + } + } + } + } + }, + "sendRoommateGroups_r2_Request": { + "summary": "sendRoommateGroups(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendRoommateGroups", + "version": "r2", + "params": { + "roommateGroups": { + "roommateGroup": [ + { + "invitorApplicationId": 12345678, + "inviteeApplicationId": [ + 22222222, + 55555555, + 78787878 + ] + }, + { + "invitorApplicationId": 111111111, + "inviteeApplicationId": "" + }, + { + "inviteeApplicationId": [ + 12345678 + ] + } + ] + } + } + } + } + }, + "sendScheduledChargesRequest": { + "summary": "sendScheduledCharges", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendScheduledCharges", + "params": { + "propertyId": 1234, + "scheduledCharges": { + "scheduledCharge": [ + { + "leaseId": 1234, + "customerId": 1234, + "chargeTimingId": 307, + "chargeCodeTypeId": 1, + "chargeCodeId": 123, + "amount": "10.00", + "monthToMonthAmount": "10.00", + "monthToMonthFee": "10.00", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "lastPostedDate": "MM/DD/YYYY", + "note": "additional description", + "isCharge": "1", + "leaseIntervalId": 1234 + }, + { + "leaseId": 1234, + "customerId": 1234, + "chargeTimingId": 123, + "chargeCodeTypeId": 1, + "chargeCodeId": 1234, + "amount": "10.00", + "monthToMonthAmount": "10.00", + "monthToMonthFee": "10.00", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "lastPostedDate": "MM/DD/YYYY", + "note": "additional description", + "isCharge": "1" + } + ] + } + } + } + } + }, + "updateLeaseRequest": { + "summary": "updateLease", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateLease", + "params": { + "propertyId": 12345, + "leaseId": 12345, + "unitSpaceId": 12345, + "moveInDate": "MM/DD/YYYY", + "occupants": { + "occupant": [ + { + "occupantId": 12345, + "firstName": "abc", + "middleName": "abc", + "lastName": "abc", + "customerRelationshipTypeId": 12345, + "emailAddress": "email@address.lcl", + "dateOfBirth": "MM/DD/YYYY", + "primaryPhoneNumber": { + "phoneNumberTypeId": 12, + "phoneNumber": "123456789" + }, + "secondaryPhoneNumber": { + "phoneNumberTypeId": 12, + "phoneNumber": "123456789" + }, + "addresses": { + "address": [ + { + "addressTypeId": 12, + "country": "XY", + "streetLine1": "Street_Line_1", + "streetLine2": "Street_Line_2", + "streetLine3": "Street_Line_3", + "city": "City", + "stateCode": "XY", + "postalCode": "12345" + }, + { + "addressTypeId": 12, + "country": "XY", + "streetLine1": "Street_Line_1", + "streetLine2": "Street_Line_2", + "streetLine3": "Street_Line_3", + "city": "City", + "stateCode": "XY", + "postalCode": "12345" + } + ] + } + } + ] + } + } + } + } + }, + "updateScheduledChargesRequest_r1": { + "summary": "updateScheduledCharges(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateScheduledCharges", + "version": "r1", + "params": { + "propertyId": 12345, + "leaseId": 12345, + "customerId": 12345, + "scheduledCharges": { + "scheduledCharge": [ + { + "id": 12345, + "chargeTimingId": 123, + "chargeCodeTypeId": 2, + "chargeCodeId": 12345, + "amount": "1100.00", + "monthToMonthAmount": "1500.00", + "monthToMonthFee": "100.00", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "lastPostedDate": "MM/DD/YYYY", + "note": "additional description", + "isDeleted": "0", + "isCharge": "0" + } + ] + } + } + } + } + }, + "updateScheduledChargesRequest_r2": { + "summary": "updateScheduledCharges(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateScheduledCharges", + "version": "r2", + "params": { + "propertyId": 12345, + "scheduledCharges": { + "scheduledCharge": [ + { + "id": "80565040", + "leaseId": "14804399", + "customerId": "12345", + "chargeTimingId": "123", + "chargeCodeTypeId": "2", + "chargeCodeId": "12345", + "amount": "15.00", + "monthToMonthAmount": "1500.00", + "monthToMonthFee": "100.00", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "lastPostedDate": "MM/DD/YYYY", + "note": "additional description - 1", + "isDeleted": "0", + "isCharge": "0" + }, + { + "id": "80565040", + "leaseId": "14804399", + "customerId": "12345", + "chargeTimingId": "123", + "chargeCodeTypeId": "2", + "chargeCodeId": "12345", + "amount": "16.00", + "monthToMonthAmount": "1600.00", + "monthToMonthFee": "100.00", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "lastPostedDate": "MM/DD/YYYY", + "note": "additional description - 2", + "isDeleted": "0", + "isCharge": "0" + } + ] + } + } + } + } + }, + "getCallLogsRequest": { + "summary": "getCallLogs", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCallLogs", + "params": { + "propertyIds": "12345,6789", + "callSourceId": 3, + "callTypeIds": "12345,4567", + "callResultIds": "12345,4567", + "answerStatus": 1, + "voiceMailTypeId": 1, + "callState": 1, + "callAnalyzed": 1, + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY" + } + } + } + }, + "getLeasingCenterPickListsRequest": { + "summary": "getLeasingCenterPickLists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getLeasingCenterPickLists" + } + } + }, + "getInspectionsRequest": { + "summary": "getInspections", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getInspections", + "params": { + "propertyId": 12345, + "leaseId": 12345, + "unitSpaceId": 12345, + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "statusTypeIds": "1,2,3", + "inspectionFormId": 1234, + "inspectionTypeId": 2 + } + } + } + }, + "getInspectionTemplatesRequest": { + "summary": "getInspectionTemplates", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getInspectionTemplates", + "params": { + "propertyIds": "123456,1234", + "showDisabled": "1" + } + } + } + }, + "getWorkOrderPickListsRequest": { + "summary": "getWorkOrderPickLists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getWorkOrderPickLists", + "params": { + "propertyIds": "12345,4567" + } + } + } + }, + "getWorkOrdersRequest": { + "summary": "getWorkOrders", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getWorkOrders", + "params": { + "propertyId": 1234, + "workOrderId": 1234, + "propertyUnitId": 1234, + "vendorId": 1234, + "leaseStatusTypeIds": "1,12", + "workOrderTypeIds": "12,11,13", + "buildingName": "XYZ", + "unitNumber": "XYZ", + "maintenancePriorityId": 123, + "maintenanceCategoryId": 123, + "maintenanceProblemId": 123, + "includeDeletedWorkOrders": "0", + "includeChildWorkOrders": "1", + "createdOnFromDate": "MM/DD/YYYY", + "createdOnToDate": "MM/DD/YYYY", + "completedOnFromDate": "MM/DD/YYYY", + "completedOnToDate": "MM/DD/YYYY", + "lastUpdatedOnFromDate": "MM/DD/YYYY", + "lastUpdatedOnToDate": "MM/DD/YYYY" + } + } + } + }, + "sendWorkOrdersRequest": { + "summary": "sendWorkOrders", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendWorkOrders", + "params": { + "workOrder": { + "propertyId": 1234, + "customerId": 1234, + "leaseId": 1234, + "unitNumber": "5", + "buildingName": "abc 8", + "customerFirstName": "abc", + "customerLastName": "abc", + "mainPhoneNumber": "123456789", + "altPhoneNumber": "123456789", + "emailAddress": "test@a.com", + "isFloatingWorkOrder": "0", + "permissionToEnter": "1", + "maintenanceLocationId": 12345, + "maintenanceCategoryId": 12345, + "maintenanceProblemId": 12345, + "subMaintenanceProblemId": 1234, + "maintenancePriorityId": 12345, + "petsDescription": "no pets", + "problemDescription": "no prb description", + "assignedTo": 12345, + "scheduledStartDateTime": "MM/DD/YYYYTHH:MM:SS", + "scheduledEndDateTime": "MM/DD/YYYYTHH:MM:SS", + "dueDateTime": "MM/DD/YYYYTHH:MM:SS", + "files": { + "file": [ + { + "name": "abcd.pdf", + "note": "attachment note.", + "fileData": "base64 encoded file data" + }, + { + "name": "abcd.jpeg", + "note": "attachment note.", + "fileData": "base64 encoded file data" + } + ] + }, + "priorityOrderNum": 0 + } + } + } + } + }, + "updateWorkOrdersRequest_r1": { + "summary": "updateWorkOrders(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateWorkOrders", + "version": "r1", + "params": { + "propertyId": 12345, + "workOrder": [ + { + "workOrderId": 12345, + "maintenanceStatusTypeId": 12345, + "maintenancePriorityId": 1234, + "maintenanceLocationId": 1234, + "maintenanceCategoryId": 12345, + "maintenanceProblemId": 123, + "subMaintenanceProblemId": 1, + "scheduledStartDateTime": "MM/DD/YYYYTHH:MM:SS", + "scheduledEndDateTime": "MM/DD/YYYYTHH:MM:SS", + "unitAvailableOnDate": "MM/DD/YYYY", + "vendorId": 1234, + "parentWorkOrderId": 12345, + "mainPhoneNumber": "123456789", + "altPhoneNumber": "123456789", + "emailAddress": "you@example.com", + "problemDescription": "Some description", + "petsDescription": "Some pet description", + "completedDateTime": "YYYY-MM-DDTHH:MM:SS", + "closingComments": "The problem is resolved", + "notes": "additional description", + "assignedTo": 1234, + "dueDateTime": "MM/DD/YYYYTHH:MM:SS", + "priorityOrderNum": null, + "permissionToEnter": "1" + }, + { + "workOrderId": 1234, + "maintenanceStatusTypeId": 1234, + "maintenancePriorityId": 123, + "maintenanceLocationId": 1234, + "maintenanceCategoryId": 1234, + "maintenanceProblemId": 123, + "submaintenanceProblemId": 123, + "scheduledStartDateTime": "MM/DD/YYYYTHH:MM:SS", + "scheduledEndDateTime": "MM/DD/YYYYTHH:MM:SS", + "unitAvailableOnDate": "MM/DD/YYYY", + "vendorId": 1234, + "parentWorkOrderId": 12345, + "mainPhoneNumber": "123456789", + "altPhoneNumber": "123456789", + "emailAddress": "you@example.com", + "problemDescription": "Some description", + "petsDescription": "Some pet description", + "completedDateTime": "YYYY-MM-DDTHH:MM:SS", + "closingComments": "The problem is resolved", + "notes": "additional description", + "assignedTo": 1234, + "dueDateTime": "MM/DD/YYYYTHH:MM:SS", + "permissionToEnter": "0", + "files": { + "file": [ + { + "name": "abcd.pdf", + "note": "attachment note.", + "fileData": "base64 encoded file data" + }, + { + "name": "abcd.jpeg", + "note": "attachment note.", + "fileData": "base64 encoded file data" + } + ] + }, + "priorityOrderNum": 0 + } + ] + } + } + } + }, + "updateWorkOrdersRequest_r2": { + "summary": "updateWorkOrders(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateWorkOrders", + "version": "r2", + "params": { + "propertyId": 12345, + "workOrder": [ + { + "workOrderId": 12345, + "maintenanceStatusTypeId": 12345, + "maintenancePriorityId": 1234, + "maintenanceLocationId": 1234, + "maintenanceCategoryId": 12345, + "maintenanceProblemId": 123, + "subMaintenanceProblemId": 1, + "scheduledStartDateTime": "MM/DD/YYYYTHH:MM:SS", + "scheduledEndDateTime": "MM/DD/YYYYTHH:MM:SS", + "unitAvailableOnDate": "MM/DD/YYYY", + "vendorId": 1234, + "parentWorkOrderId": 12345, + "mainPhoneNumber": "123456789", + "altPhoneNumber": "123456789", + "emailAddress": "you@example.com", + "problemDescription": "Some description", + "petsDescription": "Some pet description", + "completedDateTime": "YYYY-MM-DDTHH:MM:SS", + "closingComments": "The problem is resolved", + "notes": "additional description", + "assignedTo": 1234, + "dueDateTime": "MM/DD/YYYYTHH:MM:SS", + "priorityOrderNum": null, + "permissionToEnter": "1" + }, + { + "workOrderId": 1234, + "maintenanceStatusTypeId": 1234, + "maintenancePriorityId": 123, + "maintenanceLocationId": 1234, + "maintenanceCategoryId": 1234, + "maintenanceProblemId": 123, + "submaintenanceProblemId": 123, + "scheduledStartDateTime": "MM/DD/YYYYTHH:MM:SS", + "scheduledEndDateTime": "MM/DD/YYYYTHH:MM:SS", + "unitAvailableOnDate": "MM/DD/YYYY", + "vendorId": 1234, + "parentWorkOrderId": 12345, + "mainPhoneNumber": "123456789", + "altPhoneNumber": "123456789", + "emailAddress": "you@example.com", + "problemDescription": "Some description", + "petsDescription": "Some pet description", + "completedDateTime": "YYYY-MM-DDTHH:MM:SS", + "closingComments": "The problem is resolved", + "notes": "additional description", + "assignedTo": 1234, + "dueDateTime": "MM/DD/YYYYTHH:MM:SS", + "permissionToEnter": "0", + "files": { + "file": [ + { + "name": "abcd.pdf", + "note": "attachment note.", + "fileData": "base64 encoded file data" + }, + { + "name": "abcd.jpeg", + "note": "attachment note.", + "fileData": "base64 encoded file data" + } + ] + }, + "priorityOrderNum": 0 + } + ] + } + } + } + }, + "getPricingPicklistsRequest": { + "summary": "getPricingPicklists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPricingPicklists", + "version": "r1", + "params": {} + } + } + }, + "getPropertyFeesRequest": { + "summary": "getPropertyFees", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPropertyFees", + "params": { + "propertyId": "12345" + } + } + } + }, + "insertPricingRequest": { + "summary": "insertPricing", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "insertPricing", + "params": { + "propertyId": 1234, + "pricing": [ + { + "pricingLevelId": 123, + "pricingLevelReferenceId": 12345, + "chargeUsageId": 1, + "chargeUsageReferenceId": 0, + "isRenewal": 0, + "chargeTimingId": 123, + "chargeCodeTypeId": 2, + "chargeCodeId": 12345, + "leaseTermMonths": 12, + "leaseTermName": "12 Months", + "leaseStartRangeStart": 0, + "leaseStartRangeEnd": 10000, + "amount": "1840.00" + }, + { + "pricingLevelId": 123, + "pricingLevelReferenceId": 12345, + "chargeUsageId": 1, + "chargeUsageReferenceId": 0, + "isRenewal": 0, + "chargeTimingId": 123, + "chargeCodeTypeId": 2, + "chargeCodeId": 12345, + "leaseTermMonths": 8, + "leaseTermName": "8 Months", + "leaseStartRangeStart": 0, + "leaseStartRangeEnd": 10000, + "amount": "1840.00" + } + ] + } + } + } + }, + "insertPricingRequest_r2": { + "summary": "insertPricing(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "insertPricing", + "version": "r2", + "params": { + "propertyId": "1381146", + "pricing": [ + { + "pricingLevelId": "3", + "pricingLevelReferenceId": "639824", + "chargeUsageId": "1", + "isRenewal": "0", + "chargeTimingId": "303", + "chargeCodeTypeId": "2", + "chargeCodeId": "224711", + "leaseTermMonths": "13", + "leaseTermId": "33549", + "leaseStartWindowId": "240891", + "spaceConfigurationId": "2", + "leaseTermName": "Lease Term 2", + "leaseStartRangeStart": "2", + "leaseStartRangeEnd": "4", + "amount": "40.00", + "isFullUpdate": "1" + }, + { + "pricingLevelId": "3", + "pricingLevelReferenceId": "639824", + "chargeUsageId": "1", + "isRenewal": "0", + "chargeTimingId": "303", + "chargeCodeTypeId": "2", + "chargeCodeId": "224711", + "leaseTermMonths": "13", + "leaseTermId": "33550", + "leaseStartWindowId": "240892", + "spaceConfigurationId": "2", + "leaseTermName": "Lease Term 3", + "leaseStartRangeStart": "2", + "leaseStartRangeEnd": "4", + "amount": "50.00", + "isFullUpdate": "1" + } + ] + } + } + } + }, + "sendBudgetedRentRequest": { + "summary": "sendBudgetedRent", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendBudgetedRent", + "version": "r1", + "params": { + "propertyId": 12345, + "pricing": [ + { + "pricingLevelId": 123, + "pricingLevelReferenceId": 12345, + "amenityAmount": "20.00", + "amount": "20.00" + }, + { + "pricingLevelId": 123, + "pricingLevelReferenceId": 12345, + "amenityAmount": "20.00", + "amount": "20.00" + } + ] + } + } + } + }, + "getAmenityReservationsRequest": { + "summary": "getAmenityReservations", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getAmenityReservations", + "params": { + "propertyId": 1234, + "amenityIds": "1234,1234", + "amenityReservationStatusTypeIds": "1,11" + } + } + } + }, + "getCalendarAvailabilityRequest_r1": { + "summary": "getCalendarAvailability(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCalendarAvailability", + "version": "r1", + "params": { + "propertyId": 12345, + "calendarEventCategoryIds": "1,2", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY" + } + } + } + }, + "getCalendarAvailabilityRequest_r2": { + "summary": "getCalendarAvailability(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getCalendarAvailability", + "version": "r2", + "params": { + "propertyId": 12345, + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "tourType": "SELF_GUIDED" + } + } + } + }, + "getFloorPlansRequest": { + "summary": "getFloorPlans", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getFloorPlans", + "params": { + "propertyId": 123456, + "propertyFloorPlanIds": "12345,4567", + "usePropertyPreferences": "1", + "includeDisabledFloorplans": "1" + } + } + } + }, + "getPetTypesRequest": { + "summary": "getPetTypes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPetTypes", + "params": { + "propertyIds": "1234,5678" + } + } + } + }, + "getPropertiesRequest": { + "summary": "getProperties", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getProperties", + "params": { + "propertyIds": "1234,5678", + "propertyLookupCode": "1234", + "showAllStatus": "1" + } + } + } + }, + "getPropertyAddOnsRequest": { + "summary": "getPropertyAddOns", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "1", + "method": { + "name": "getPropertyAddOns", + "version": "r1", + "params": { + "propertyId": 12345 + } + } + } + }, + "getPropertyAnnouncementsRequest": { + "summary": "getPropertyAnnouncements", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPropertyAnnouncements", + "params": { + "propertyId": 12345 + } + } + } + }, + "getPropertyPickListsRequest_r1": { + "summary": "getPropertyPickLists(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPropertyPickLists", + "version": "r1", + "params": { + "propertyIds": "1234,4567" + } + } + } + }, + "getPropertyPickListsRequest_r2": { + "summary": "getPropertyPickLists(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPropertyPickLists", + "version": "r2", + "params": { + "propertyIds": "1234,4567" + } + } + } + }, + "getRentableItemsRequest": { + "summary": "getRentableItems", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getRentableItems", + "params": { + "propertyId": 12345 + } + } + } + }, + "getReservableAmenitiesRequest": { + "summary": "getReservableAmenities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getReservableAmenities", + "params": { + "propertyId": 1234, + "amenityIds": "1234,1234" + } + } + } + }, + "getWebsitesRequest": { + "summary": "getWebsites", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getWebsites", + "params": { + "propertyIds": "12345,4567" + } + } + } + }, + "sendFloorplansRequest": { + "summary": "sendFloorplans", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendFloorplans", + "params": { + "propertyId": 12345, + "floorPlans": { + "floorPlan": [ + { + "name": "Floorplan 1", + "description": "description", + "seoTitle": "seo title", + "seoDescription": "seo description", + "seoKeywords": "seo keyword", + "isPublished": "1", + "isDisabledVirtualMoveIn": "0", + "minSquareFeet": "200", + "maxSquareFeet": "1000", + "numberOfBedRooms": 1, + "numberOfBathRooms": 1, + "isFeatured": "1" + }, + { + "name": "Floorplan 2", + "description": "description", + "seoTitle": "seo title", + "seoDescription": "seo description", + "seoKeywords": "seo keyword", + "isPublished": "1", + "isDisabledVirtualMoveIn": "0", + "minSquareFeet": "300", + "maxSquareFeet": "1100", + "numberOfBedRooms": 2, + "numberOfBathRooms": 2, + "isFeatured": "0" + } + ] + } + } + } + } + }, + "sendRentableItemsRequest": { + "summary": "sendRentableItems", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendRentableItems", + "params": { + "propertyId": 12345, + "rentableItemTypes": { + "rentableItemType": [ + { + "categoryId": 123, + "name": "test", + "showOnWebsite": "1", + "isMarketed": "1", + "hasInventory": "1", + "rentableItems": { + "rentableItem": [ + { + "name": "test A", + "description": "FurnitureTesting", + "availabilityStatusId": "4", + "showOnWebsite": "0" + }, + { + "name": "test B", + "description": "FurnitureTesting", + "availabilityStatusId": "2", + "showOnWebsite": "1" + }, + { + "name": "test C", + "description": "FurnitureTesting", + "availabilityStatusId": "2", + "showOnWebsite": "1" + } + ] + } + }, + { + "categoryId": 123, + "name": "Storage", + "showOnWebsite": "0", + "isMarketed": "0", + "hasInventory": "1", + "rentableItems": { + "rentableItem": [ + { + "name": "Storage A", + "description": "Storage Testing", + "availabilityStatusId": "4", + "showOnWebsite": "1" + }, + { + "name": "Storage B", + "description": "Storage Testing", + "availabilityStatusId": "2", + "showOnWebsite": "1" + }, + { + "name": "Storage C", + "description": "Storage Testing", + "availabilityStatusId": "2", + "showOnWebsite": "1" + } + ] + } + } + ] + } + } + } + } + }, + "getPropertyMediaRequest": { + "summary": "getPropertyMedia", + "value": { + "auth": { + "type": "apikey" + }, + "method": { + "name": "getPropertyMedia", + "version": "r1", + "params": { + "propertyId": "123456", + "mediaTypeId": "6", + "mediaSubTypeId": "24", + "referenceIds": "987654" + } + } + } + }, + "sendPropertyMediaRequest": { + "summary": "sendPropertyMedia", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "1001", + "method": { + "name": "sendPropertyMedia", + "params": { + "propertyId": "123456", + "media": [ + { + "mediaTypeId": 6, + "mediaSubTypeId": 24, + "referenceId": 123456, + "mediaProvider": "ABC", + "mediaUrl": "https://www.example.com/demo1", + "thumbnailUrl": "https://www.example.com/demo1_thumb", + "mediaAltText": "business_demo1", + "name": "demo_name1", + "description": "demo_description1", + "caption": "demo_caption1" + }, + { + "mediaTypeId": 6, + "mediaSubTypeId": 93, + "referenceId": 123456, + "mediaProvider": "XYZ", + "mediaUrl": "https://www.example.com/demo2", + "thumbnailUrl": "https://www.example.com/demo2_thumb", + "mediaAltText": "business_demo2", + "name": "demo_name2", + "description": "demo_description2", + "caption": "demo_caption2", + "height": 56, + "width": 23, + "mediaFormat": "jpeg" + } + ] + } + } + } + }, + "updatePropertyMediaRequest": { + "summary": "updatePropertyMedia", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "1001", + "method": { + "name": "updatePropertyMedia", + "params": { + "propertyId": "999999", + "media": [ + { + "id": "555555", + "mediaTypeId": "10", + "mediaSubTypeId": "30", + "referenceId": "888888", + "mediaProvider": "dummyProvider", + "mediaUrl": "https://dummyapi.com/media/1", + "thumbnailUrl": "https://dummyapi.com/media/thumb1", + "mediaAltText": "dummy media 1", + "name": "Sample Name 1", + "description": "Dummy description 1", + "caption": "Dummy caption 1", + "height": 400, + "width": 600, + "mediaFormat": "PNG" + }, + { + "id": "666666", + "mediaTypeId": "15", + "mediaSubTypeId": "45", + "referenceId": "777777", + "mediaProvider": "dummyProvider", + "mediaUrl": "https://dummyapi.com/media/2", + "thumbnailUrl": "https://dummyapi.com/media/thumb2", + "mediaAltText": "dummy media 2", + "name": "Sample Name 2", + "description": "Dummy description 2", + "caption": "Dummy caption 2", + "height": "500", + "width": "700", + "mediaFormat": "JPG" + } + ] + } + } + } + }, + "deletePropertyMediaRequest": { + "summary": "deletePropertyMedia", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "1002", + "method": { + "name": "deletePropertyMedia", + "version": "r1", + "params": { + "propertyId": "999999", + "id": "555555" + } + } + } + }, + "getPhoneNumberRequest": { + "summary": "getPhoneNumber", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPhoneNumber", + "params": { + "propertyIds": [ + 123456, + 789 + ], + "switchCode": "46545", + "ref": "http://google.com" + } + } + } + }, + "getAmenitiesRequest": { + "summary": "getAmenities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getAmenities", + "params": { + "propertyId": 12345, + "unitNumber": "1", + "chargeCodeTypeIds": "1,2,3" + } + } + } + }, + "getMitsPropertyUnitsRequest": { + "summary": "getMitsPropertyUnits", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getMitsPropertyUnits", + "params": { + "propertyIds": "1234,5678", + "availableUnitsOnly": "1", + "usePropertyPreferences": "1", + "includeDisabledFloorplans": "1", + "includeDisabledUnits": "0", + "showUnitSpaces": "0" + } + } + } + }, + "getPropertyUnitsRequest": { + "summary": "getPropertyUnits", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPropertyUnits", + "params": { + "propertyIds": "12345,4567", + "availableUnitsOnly": "1", + "usePropertyPreferences": "0", + "includeDisabledFloorplans": "0", + "includeDisabledUnits": "0" + } + } + } + }, + "getSpecialsRequest_r1": { + "summary": "getSpecials(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getSpecials", + "version": "r1", + "params": { + "propertyId": 12345 + } + } + } + }, + "getSpecialsRequest_r2": { + "summary": "getSpecials(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getSpecials", + "version": "r2", + "params": { + "propertyId": 12345 + } + } + } + }, + "getSpecialsRequest_r3": { + "summary": "getSpecials(r3)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getSpecials", + "version": "r3", + "params": { + "propertyId": 12345 + } + } + } + }, + "getUnitsAvailabilityAndPricingRequest": { + "summary": "getUnitsAvailabilityAndPricing", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getUnitsAvailabilityAndPricing", + "version": "r1", + "params": { + "propertyId": 1234, + "floorplanId": 1234, + "unitTypeId": 1234, + "propertyUnitId": 1234, + "availableUnitsOnly": "1", + "unavailableUnitsOnly": "0", + "skipPricing": "0", + "showChildProperties": "1", + "includeDisabledFloorplans": "1", + "includeDisabledUnits": "1", + "showUnitSpaces": "1", + "useSpaceConfiguration": "0", + "allowLeaseExpirationOverride": "1", + "moveInStartDate": "MM/DD/YYYY", + "moveInEndDate": "MM/DD/YYYY" + } + } + } + }, + "getUnitTypesRequest": { + "summary": "getUnitTypes", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getUnitTypes", + "params": { + "propertyId": 12345 + } + } + } + }, + "sendAmenitiesRequest": { + "summary": "sendAmenities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendAmenities", + "params": { + "propertyId": 123456, + "propertyAmenities": { + "propertyAmenity": [ + { + "name": "P Amenity 1011", + "description": "P Amenity 1011", + "isPublished": "1" + }, + { + "name": "P Amenity 1041", + "description": "P Amenity 1041", + "isPublished": "1" + } + ] + }, + "unitAmenities": { + "unitAmenity": [ + { + "unitSpaceId": 123456, + "name": "U Amenity 1011", + "description": "U Amenity 1011", + "isPublished": "0" + }, + { + "unitSpaceId": 123456, + "name": "U Amenity 1061", + "description": "U Amenity 1061", + "isPublished": "0" + } + ] + } + } + } + } + }, + "sendPropertyUnitsRequest": { + "summary": "sendPropertyUnits", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendPropertyUnits", + "params": { + "propertyId": 12345, + "units": { + "unit": [ + { + "unitNumber": "20", + "unitPrefix": "CC", + "unitSuffix": "BB", + "spaceNumber": 1, + "maxOccupants": 3, + "maxPets": 11, + "numberOfBedRooms": 5, + "numberOfBathRooms": 6, + "squareFeet": "2000", + "note": "Testing property", + "unitGenderId": 1, + "marketingNumber": "", + "certificateOfOccupancyDate": "MM/DD/YYYY", + "isShowOnWebsite": "0", + "propertyBuildingId": 12345, + "propertyFloorplanId": 12345, + "unitTypeId": 12345, + "propertyFloorId": 12345, + "unitExclusionReasonTypeId": 3, + "unitSpaceStatusTypeId": 4, + "leaseTermId": 123456, + "termStartDate": "MM/DD/YYYY", + "termEndDate": "MM/DD/YYYY", + "availableOn": "MM/DD/YYYY", + "makeReadyDate": "MM/DD/YYYY", + "isFurnished": "1", + "taxCreditUnitNumber": "", + "amenityIds": "123456,123456,123456", + "specialIds": "123456,123456,123456", + "countryCode": "XYZ", + "streetLine1": "Street1", + "streetLine2": "XYZ", + "streetLine3": "XYZ", + "city": "XYZ", + "stateCode": "XYZ", + "postalCode": "12345" + }, + { + "unitNumber": 20, + "unitPrefix": "CC", + "unitSuffix": "BB", + "spaceNumber": 3, + "maxOccupants": 3, + "maxPets": 11, + "numberOfBedRooms": 5, + "numberOfBathRooms": 6, + "squareFeet": "2000", + "note": "Testing property", + "unitGenderId": 1, + "marketingNumber": "", + "certificateOfOccupancyDate": "MM/DD/YYYY", + "isShowOnWebsite": "0", + "propertyBuildingId": 12345, + "propertyFloorplanId": 12345, + "unitTypeId": 12345, + "propertyFloorId": 12345, + "unitExclusionReasonTypeId": 3, + "unitSpaceStatusTypeId": 4, + "leaseTermId": 12345, + "termStartDate": "MM/DD/YYYY", + "termEndDate": "MM/DD/YYYY", + "availableOn": "MM/DD/YYYY", + "makeReadyDate": "MM/DD/YYYY", + "isFurnished": "1", + "taxCreditUnitNumber": "12345", + "amenityIds": "123456,123456,123456", + "specialIds": "123456,123456,123456", + "countryCode": "XYZ", + "streetLine1": "Street1", + "streetLine2": "XYZ", + "streetLine3": "XYZ", + "city": "XYZ", + "stateCode": "XYZ", + "postalCode": "12345" + } + ] + } + } + } + } + }, + "updateAmenitiesRequest": { + "summary": "updateAmenities", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateAmenities", + "params": { + "propertyId": 12345, + "propertyAmenities": { + "propertyAmenity": [ + { + "id": 12345, + "name": "property amenity", + "description": "P Amenity", + "isPublished": "1", + "isFeatured": "0", + "showOnQuote": "1", + "hideDescription": "1", + "videoUrl": "http://test.mp4", + "defaultAmenityId": 3, + "amenityTypeId": 2 + } + ] + }, + "floorplanAmenities": { + "floorplanAmenity": [ + { + "id": 1234, + "associatedFloorplanIds": "12345,4567", + "name": "FP Amenity", + "description": "FP Amenity", + "isPublished": "1", + "isFeatured": "0", + "hideDescription": "1", + "videoUrl": "http://test.mp4", + "defaultAmenityId": 8, + "amenityTypeId": 3 + } + ] + }, + "unitTypeAmenities": { + "unitTypeAmenity": [ + { + "id": "", + "associatedUnitTypeIds": "12345,4567", + "name": "UT amenity", + "description": "UT Amenity", + "isPublished": "1", + "isFeatured": "0", + "hideDescription": "1", + "videoUrl": "http://test.mp4", + "defaultAmenityId": 14, + "amenityTypeId": 2 + } + ] + }, + "unitSpaceAmenities": { + "unitSpaceAmenity": [ + { + "id": 123654, + "associatedUnitSpaceIds": "12345,4567", + "name": "US Amenity", + "description": "US Amenity", + "isPublished": "1", + "isFeatured": "1", + "showOnQuote": "0", + "hideDescription": "1", + "videoUrl": "http://test.mp4", + "defaultAmenityId": 8, + "amenityTypeId": 1 + } + ] + } + } + } + } + }, + "sendSpecialGroupRequest": { + "summary": "sendSpecialGroup", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "15", + "method": { + "name": "sendSpecialGroup", + "version": "r1", + "params": { + "propertyId": "123456", + "specialGroup": { + "specialGroupName": "Test Insert Special API", + "internalDescription": "Internal Desc", + "floorPlanIds": "1,2,3", + "unitTypeIds": "1,2,3", + "unitSpaceIds": "1,2,3", + "isActive": "1", + "isWebVisible": "1", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "hideEndDate": "0", + "marketingDescription": "Marketing Desc", + "termsAndConditions": "Terms & conditions", + "isAdvertised": "1", + "moveInDateFrom": "MM/DD/YYYY", + "moveInDateTo": "MM/DD/YYYY", + "renewalStartDateFrom": "MM/DD/YYYY", + "renewalStartDateTo": "MM/DD/YYYY", + "limitQuantity": "1", + "quantityBudgeted": "10", + "couponCode": "PROMO123", + "leadSourceId": "555555", + "incentiveLimit": "1", + "isSelectable": "0", + "leaseTermDetails": [ + { + "leaseTermId": "12345", + "leaseStartWindowId": "456789" + }, + { + "leaseTermId": "34567", + "leaseStartWindowId": "678912" + } + ], + "specialRecipientDetails": { + "specialRecipientIds": "2,3", + "specialTriggerTypeIdProspect": "11", + "specialTriggerTypeIdRenewal": "27" + }, + "specialGroupSpaceConfigurationIds": "2,3", + "specials": [ + { + "specialTypeId": "1", + "specialName": "conccession1", + "giftValue": "0.00", + "rates": [ + { + "arCodeId": "12345", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "", + "leaseTermId": "12345", + "leaseTermMonth": "6", + "leaseStartWindowId": "55555", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "", + "rateAmount": "100.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "0", + "spaceConfigurationId": "2", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "666666", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "", + "leaseTermId": "44444", + "leaseTermMonth": "6", + "leaseStartWindowId": "77777", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "", + "rateAmount": "100.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "0", + "spaceConfigurationId": "3", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "45678", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "", + "leaseTermId": "45678", + "leaseTermMonth": "12", + "leaseStartWindowId": "123456", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "4", + "rateAmount": "100.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "0", + "spaceConfigurationId": "2", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "123456", + "arTriggerId": "201", + "arCodeTypeId": "2", + "customerRelationshipId": "", + "leaseTermId": "12345", + "leaseTermMonth": "12", + "leaseStartWindowId": "555555", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "4", + "rateAmount": "100.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "0", + "spaceConfigurationId": "3", + "showInEntrata": "1", + "showOnWebsite": "1" + } + ] + }, + { + "specialTypeId": "2", + "specialName": "Gift1", + "giftValue": "100.00" + } + ] + } + } + } + } + }, + "updateSpecialGroupRequest": { + "summary": "updateSpecialGroup", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "15", + "method": { + "name": "updateSpecialGroup", + "version": "r1", + "params": { + "propertyId": "123456", + "specialGroup": { + "specialGroupId": "55555", + "specialGroupName": "Test Update Special API", + "internalDescription": "Internal Desc", + "floorPlanIds": "1,2,3", + "unitTypeIds": "1,2,3", + "unitSpaceIds": "1,2,3", + "isActive": "1", + "isWebVisible": "1", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "hideEndDate": "0", + "marketingDescription": "Marketing Desc", + "termsAndConditions": "Terms & conditions", + "isAdvertised": "1", + "moveInDateFrom": "MM/DD/YYYY", + "moveInDateTo": "MM/DD/YYYY", + "renewalStartDateFrom": "MM/DD/YYYY", + "renewalStartDateTo": "MM/DD/YYYY", + "limitQuantity": "1", + "quantityBudgeted": "12", + "couponCode": "PROMO123", + "leadSourceId": "666666", + "incentiveLimit": "1", + "isSelectable": "0", + "isDelete": 1, + "leaseTermDetails": [ + { + "leaseTermId": "55555", + "leaseStartWindowId": "666666" + }, + { + "leaseTermId": "12345", + "leaseStartWindowId": "123456" + } + ], + "specialRecipientDetails": { + "specialRecipientIds": "2,3", + "specialTriggerTypeIdProspect": "11", + "specialTriggerTypeIdRenewal": "27" + }, + "specialGroupSpaceConfigurationIds": "2,3", + "specials": [ + { + "specialId": "12345678", + "specialTypeId": "1", + "specialName": "conccession1", + "giftValue": "0.00", + "isDelete": 1, + "rates": [ + { + "arCodeId": "12345", + "arTriggerId": "201", + "arCodeTypeId": "2", + "customerRelationshipId": "0", + "leaseTermId": "55555", + "leaseTermMonth": "6", + "leaseStartWindowId": "123456", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "effectiveDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "", + "rateAmount": "100.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "", + "spaceConfigurationId": "2", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "123456", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "0", + "leaseTermId": "55555", + "leaseTermMonth": "6", + "leaseStartWindowId": "123456", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "effectiveDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "", + "rateAmount": "120.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "", + "spaceConfigurationId": "3", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "777777", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "0", + "leaseTermId": "55555", + "leaseTermMonth": "12", + "leaseStartWindowId": "666666", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "effectiveDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "4", + "rateAmount": "10.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "", + "spaceConfigurationId": "2", + "showInEntrata": "1", + "showOnWebsite": "1" + }, + { + "arCodeId": "456789", + "arTriggerId": "101", + "arCodeTypeId": "2", + "customerRelationshipId": "0", + "leaseTermId": "20710", + "leaseTermMonth": "12", + "leaseStartWindowId": "888888", + "windowStartDate": "MM/DD/YYYY", + "windowEndDate": "MM/DD/YYYY", + "effectiveDate": "MM/DD/YYYY", + "arFormulaId": "1", + "rateIntervalStart": "4", + "rateAmount": "20.00", + "rateIncreaseIncrement": "", + "arFormulaReferenceId": "", + "spaceConfigurationId": "3", + "showInEntrata": "1", + "showOnWebsite": "1" + } + ] + }, + { + "specialId": "78787878", + "specialTypeId": "2", + "specialName": "Gift111", + "giftValue": "50.00", + "isDelete": 1 + } + ] + } + } + } + } + }, + "getSpecialsRequest_r4": { + "summary": "getSpecials(r4)", + "value": { + "auth": { + "type": "basic" + }, + "requestId": "15", + "method": { + "name": "getSpecials", + "version": "r4", + "params": { + "propertyId": "123456" + } + } + } + }, + "getInvoicesRequest_r1": { + "summary": "getInvoices(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getInvoices", + "version": "r2", + "params": { + "ids": "12345,4567", + "invoiceNumber": "1234", + "vendorId": "12345", + "propertyIds": "12345,4567", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "paidInvoiceFromDate": "MM/DD/YYYY", + "paidInvoiceToDate": "MM/DD/YYYY", + "postMonth": "MM/DD/YYYY", + "includeVoidedPayments": "1", + "includeExported": "1", + "customerRefunds": "1" + } + } + } + }, + "getInvoicesRequest_r2": { + "summary": "getInvoices(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getInvoices", + "version": "r2", + "params": { + "ids": "12345,4567", + "invoiceNumber": "1234", + "invoiceTypeIds": "12345,4567", + "vendorIds": "12345,4567", + "propertyIds": "12345,4567", + "fromDate": "MM/DD/YYYY", + "toDate": "MM/DD/YYYY", + "paidInvoiceFromDate": "MM/DD/YYYY", + "paidInvoiceToDate": "MM/DD/YYYY", + "postMonth": "MM/DD/YYYY", + "includeVoidedPayments": "1", + "voidedPaymentFromDate": "MM/DD/YYYY", + "voidedPaymentToDate": "MM/DD/YYYY", + "includeExported": "1", + "customerRefunds": "1" + } + } + } + }, + "getPoReceivingRecordsRequest": { + "summary": "getPoReceivingRecords", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPoReceivingRecords", + "params": { + "vendorId": 1234, + "vendorCode": "234", + "purchaseOrderNumbers": "1234,1234,1234", + "poFromDate": "MM/DD/YYYY", + "poToDate": "MM/DD/YYYY", + "receivedFromDate": "MM/DD/YYYY", + "receivedToDate": "MM/DD/YYYY" + } + } + } + }, + "getPurchaseOrdersRequest": { + "summary": "getPurchaseOrders", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getPurchaseOrders", + "params": { + "propertyIds": "12345,4567", + "vendorId": 1234, + "vendorCode": "1234", + "poNumber": 1234, + "poNumbers": "12345,4567", + "receivedFromDate": "MM/DD/YYYY", + "receivedToDate": "MM/DD/YYYY", + "createdOnFrom": "MM/DD/YYYY", + "createdOnTo": "MM/DD/YYYY", + "poStatusIds": "1,3", + "poTypeIds": "1,2,4", + "purchaseOrderApprovalTypeIds": "2,3,5" + } + } + } + }, + "getTaxFormDataRequest": { + "summary": "getTaxFormData", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getTaxFormData", + "params": { + "propertyIds": "12345,4567", + "startDate": "MM/DD/YYYY", + "endDate": "MM/DD/YYYY", + "generateForPropertyOwner": "1", + "ownerIds": "12345,4567", + "isForIndirectOwner": "1" + } + } + } + }, + "getVendorLocationsRequest": { + "summary": "getVendorLocations", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getVendorLocations", + "params": { + "propertyIds": "12345,4567", + "showAllStatus": "1", + "includeIntercompanyVendors": "0", + "vendorId": 1234, + "vendorName": "Vendor_Name", + "vendorCode": "1234", + "lastModifiedOn": "MM/DD/YYYY" + } + } + } + }, + "getVendorPickListsRequest": { + "summary": "getVendorPickLists", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getVendorPickLists", + "version": "r1" + } + } + }, + "getVendorsRequest": { + "summary": "getVendors", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "getVendors", + "params": { + "vendorIds": "12345,4567", + "vendorCodes": "1234,1234" + } + } + } + }, + "markInvoicesExportedRequest": { + "summary": "markInvoicesExported", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "markInvoicesExported", + "params": { + "lineItems": { + "lineItemId": [ + 17, + 18, + 19 + ] + } + } + } + } + }, + "sendInvoicesRequest_r1": { + "summary": "sendInvoices(r1)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendInvoices", + "version": "r2", + "params": { + "ApBatch": { + "IsPaused": "0", + "IsPosted": "1", + "ApHeaders": { + "ApHeader": [ + { + "ApDetails": { + "ApDetail": [ + { + "PropertyId": "266443", + "GlAccountId": "243220", + "PropertyBuildingId": "17672", + "PropertyUnitId": "3981490", + "Description": "SendInvoices with payments", + "Rate": "9.00", + "Quantity": "1", + "IsWaive1099": "1", + "InvoicePayment": { + "InvoicePaymentId": "InvoicePayment_1", + "PaymentAmount": "9.00" + } + }, + { + "PropertyId": "266443", + "GlAccountId": "243220", + "PropertyBuildingId": "17672", + "PropertyUnitId": "3981490", + "Description": "SendInvoices with payments", + "Rate": "-2.00", + "Quantity": "1", + "IsWaive1099": "1", + "InvoicePayment": { + "InvoicePaymentId": "InvoicePayment_2", + "PaymentAmount": "-2.00" + } + } + ] + }, + "ApPayeeId": "294342", + "ApPayeeLocationId": "2184605", + "InvoiceTotal": "7.00", + "InvoiceImageUrl": "https://InvoiceImageUrl", + "Files": { + "File": { + "FileData": "FileData", + "@attributes": { + "FileName": "NewInvoice3.pdf" + } + } + }, + "InvoiceNumber": "311", + "PostMonth": "04/2017", + "InvoiceDate": "04/21/2017", + "IsConsolidated": "1", + "IsOnHold": "0", + "RoutingTagId": "22" + }, + { + "ApDetails": { + "ApDetail": [ + { + "PropertyId": 12345, + "GlAccountId": "243220", + "PropertyBuildingId": "17672", + "PropertyUnitId": "3981490", + "Description": "SendInvoices", + "Rate": "9.00", + "Quantity": "1", + "IsWaive1099": "1" + }, + { + "PropertyId": 12345, + "GlAccountId": "243220", + "PropertyBuildingId": "17672", + "PropertyUnitId": "3981490", + "Description": "SendInvoices", + "Rate": "-2.00", + "Quantity": "1", + "IsWaive1099": "1" + } + ] + }, + "ApPayeeId": "294342", + "ApPayeeLocationId": "2184605", + "InvoiceTotal": "7.00", + "InvoiceImageUrl": "https://InvoiceImageUrl", + "Files": { + "File": { + "FileData": "FileData", + "@attributes": { + "FileName": "NewInvoice3.pdf" + } + } + }, + "InvoiceNumber": "312", + "PostMonth": "04/2017", + "InvoiceDate": "04/21/2017", + "IsConsolidated": "1", + "IsOnHold": "0", + "RoutingTagId": "22" + } + ] + }, + "InvoicePayments": { + "InvoicePayment": [ + { + "InvoicePaymentId": "InvoicePayment_1", + "PaymentTypeId": "2", + "PaymentNumber": "Payment_Number", + "PaymentDate": "04/24/2017", + "PostMonth": "04/2017", + "PaymentMemo": "PaymentMemo_1" + }, + { + "InvoicePaymentId": "InvoicePayment_2", + "PaymentTypeId": "2", + "PaymentNumber": "Payment_Number", + "PaymentDate": "05/23/2017", + "PostMonth": "04/2017", + "PaymentMemo": "PaymentMemo_2" + } + ] + } + } + } + } + } + }, + "sendInvoicesRequest_r2": { + "summary": "sendInvoices(r2)", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendInvoices", + "version": "r2", + "params": { + "apBatch": { + "isPaused": "0", + "isPosted": "1", + "apHeaders": { + "apHeader": [ + { + "invoiceTypeId": 1234, + "apPayeeId": 1234, + "apPayeeAccountId": 12345, + "apPayeeLocationId": 1234, + "routingTagId": 1234, + "invoiceNumber": "ABC-123", + "postMonth": "MM/YYYY", + "invoiceDate": "MM/DD/YYYY", + "dueDate": "MM/DD/YYYY", + "shipping": 10, + "discount": 10, + "salesTax": 10, + "invoiceTotal": 10, + "note": "Invoice Note", + "invoiceImageUrl": "Invoice Image URL", + "isConsolidated": "1", + "isOnHold": "0", + "apDetails": { + "apDetail": [ + { + "propertyId": 1234, + "glAccountId": 1234, + "propertyBuildingId": 1234, + "propertyUnitId": 1234, + "description": "apDetail description", + "quantity": 2, + "rate": "10.00", + "unitOfMeasureId": 1234, + "isWaive1099": "1", + "customTagId": 180, + "apCodeId": 10, + "jobPhaseId": 123, + "apContractId": 123, + "retentionPercentage": 50, + "poDetailId": 12345, + "receivingRecordId": 1234, + "invoicePayment": { + "invoicePaymentId": 1234, + "paymentAmount": "10.00" + } + } + ] + }, + "files": { + "file": [ + { + "fileName": "file name", + "fileData": "base64 encoded invoice image file data" + } + ] + } + }, + { + "invoiceTypeId": 123, + "apPayeeId": 1234, + "apPayeeAccountId": 1234, + "apPayeeLocationId": 1234, + "routingTagId": 1234, + "invoiceNumber": 1234, + "postMonth": "MM/YYYY", + "invoiceDate": "MM/DD/YYYY", + "dueDate": "MM/DD/YYYY", + "salesTax": 10, + "discount": 10, + "shipping": 10, + "invoiceTotal": 10, + "note": "Invoice Note", + "invoiceImageUrl": "Invoice Image URL", + "isConsolidated": "1", + "isOnHold": "0", + "apDetails": { + "apDetail": [ + { + "propertyId": 12345, + "glAccountId": 1234, + "propertyBuildingId": 1234, + "propertyUnitId": 12, + "description": "apDetail description", + "rate": "50.00", + "quantity": 10, + "unitOfMeasureId": 1234, + "isWaive1099": "1", + "customTagId": 180, + "apCodeId": 123, + "jobPhaseId": 123, + "apContractId": 123, + "retentionPercentage": 50, + "poDetailId": 12345, + "receivingRecordId": 1234, + "invoicePayment": { + "invoicePaymentId": 1234, + "paymentAmount": "10.00" + } + } + ] + }, + "files": { + "file": [ + { + "fileName": "file name", + "fileData": "base64 encoded invoice image file data" + } + ] + } + } + ] + }, + "invoicePayments": { + "invoicePayment": [ + { + "invoicePaymentId": 1234, + "paymentTypeId": 1, + "paymentNumber": 12345, + "paymentDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "paymentMemo": "paymentMemo01" + }, + { + "invoicePaymentId": 1234, + "paymentTypeId": 1, + "paymentNumber": 1234, + "paymentDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "paymentMemo": "paymentMemo02" + } + ] + } + } + } + } + } + }, + "sendPurchaseOrdersRequest": { + "summary": "sendPurchaseOrders", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendPurchaseOrders", + "params": { + "apHeaders": { + "apHeader": [ + { + "poTypeId": 1, + "apPayeeId": 1234, + "propertyId": 1234, + "apPayeeLocationId": 1234, + "apPayeeAccountId": 1234, + "postMonth": "MM/YYYY", + "postDate": "MM/DD/YYYY", + "apRoutingTagId": 123, + "headerMemo": "Testing PO-1", + "shipping": 0, + "discount": 0, + "salesTax": 0, + "apDetails": { + "apDetail": [ + { + "glAccountId": 1234, + "description": "DESC1", + "quantity": 2, + "rate": "30.00", + "propertyId": 1234, + "glDimensionId": 123, + "companyDepartmentId": 1234, + "propertyUnitId": 1234, + "propertyBuildingId": 1234, + "isConfidential": 1, + "isTaxable": 1 + }, + { + "glAccountId": 12345, + "description": "DESC1", + "quantity": 2, + "rate": "40.00", + "propertyId": 1234, + "glDimensionId": null, + "companyDepartmentId": null, + "propertyUnitId": 1234, + "propertyBuildingId": 12345, + "isConfidential": 1, + "isTaxable": 1 + } + ] + } + }, + { + "poTypeId": 123, + "apPayeeId": 1234, + "propertyId": 1234, + "apPayeeLocationId": 1234, + "apPayeeAccountId": 1234, + "postMonth": "MM/YYYY", + "postDate": "MM/DD/YYYY", + "apRoutingTagId": 123, + "headerMemo": "Testing PO-2", + "shipping": 1, + "discount": 0, + "salesTax": 0, + "apDetails": { + "apDetail": [ + { + "apCodeId": 12345, + "jobPhaseId": 123, + "apContractId": 1234, + "description": "DESC1", + "quantity": 2, + "rate": "30.00", + "propertyId": 1234, + "glDimensionId": 123, + "companyDepartmentId": 1234, + "propertyUnitId": 1234, + "propertyBuildingId": 1234, + "isConfidential": 1, + "isTaxable": 1 + }, + { + "apCodeId": 1234, + "jobPhaseId": 1234, + "apContractId": 123, + "description": "DESC1", + "quantity": 2, + "rate": "40.00", + "propertyId": 1234, + "glDimensionId": 123, + "companyDepartmentId": 123, + "propertyUnitId": 123, + "propertyBuildingId": 1234, + "isConfidential": 1, + "isTaxable": 1 + } + ] + } + } + ] + } + } + } + } + }, + "sendVendorsRequest": { + "summary": "sendVendors", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "sendVendors", + "params": { + "vendors": { + "vendor": [ + { + "businessName": "Vendor name", + "nameOnTaxReturn": "Legal entity name", + "taxIdNumber": "22-12345678", + "externalId": 1234, + "note": "additional description", + "isOnSite": "0", + "defaultGlAccountId": 1234, + "isConsolidated": "1", + "isRequirePoForInvoice": "0", + "categories": { + "categoryTypeId": 13 + }, + "contacts": { + "contact": [ + { + "firstName": "abc", + "lastName": "abc", + "position": "designation", + "phone": "123456789", + "email": "test@example.com", + "isPrimary": "1" + } + ] + }, + "locations": { + "location": [ + { + "name": "Primary Location", + "vendorCode": "XYZ", + "addressLine1": "street line 1", + "addressLine2": "street line 2", + "country": "US", + "city": "Provo", + "state": "FL", + "postalCode": "12345", + "isDefault": "1", + "accounts": { + "account": [ + { + "accountNumber": "1234", + "description": "dummy description", + "glAccountId": 12345, + "propertyId": 1234, + "utilityBillReceiptTypeId": 1, + "isAuditInvoice": "0", + "isCaptureInvoiceTotalOnly": "1", + "subAccounts": { + "subAccount": [ + { + "subAccountNumber": "1234", + "description": "dummy description", + "glAccountId": 1234 + } + ] + } + } + ] + } + } + ] + }, + "insurances": { + "insurance": [ + { + "coverageName": "test", + "document": { + "propertyIds": "12345,4567", + "file": { + "fileName": "xyz.pdf", + "fileData": "base64 encoded file data." + } + }, + "policies": { + "policy": [ + { + "policyTypeId": 1, + "description": "description", + "policyNumber": 123, + "expirationDate": "MM/DD/YYYY", + "coverages": { + "coverage": [ + { + "id": 1234, + "amount": "20.00" + }, + { + "id": 1234, + "amount": "20.00" + } + ] + } + } + ] + } + } + ] + } + } + ] + } + } + } + } + }, + "updateInvoicesRequest": { + "summary": "updateInvoices", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateInvoices", + "params": { + "apHeaders": { + "apHeader": { + "id": 12345, + "isOnHold": "0", + "routingTagId": 15, + "apDetails": { + "apDetail": [ + { + "id": 12345, + "invoicePayment": { + "invoicePaymentId": 1, + "paymentAmount": "10.00" + }, + "creditAllocation": { + "creditApDetailId": 1234, + "creditAmount": "15.00" + } + }, + { + "id": 12345, + "invoicePayment": { + "invoicePaymentId": 1, + "paymentAmount": "5.00" + }, + "creditAllocation": { + "creditApDetailId": 1234, + "creditAmount": "5.00" + } + } + ] + } + } + }, + "invoicePayments": { + "invoicePayment": { + "invoicePaymentId": 1, + "paymentTypeId": 2, + "paymentNumber": 12345, + "paymentDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "paymentMemo": "Payment_Memo", + "totalPaymentAmount": "15.00" + } + }, + "creditAllocations": { + "creditAllocation": [ + { + "creditApDetailId": 1234, + "postMonth": "MM/YYYY", + "postDate": "MM/DD/YYYY" + }, + { + "creditApDetailId": 12345, + "postMonth": "MM/YYYY", + "postDate": "MM/DD/YYYY" + } + ] + } + } + } + } + }, + "updateVendorsRequest": { + "summary": "updateVendors", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "updateVendors", + "params": { + "vendors": { + "vendor": { + "vendorId": 1234, + "businessName": "Vendor Business Name", + "apPayeeTypeId": 3, + "apPayeeStatusTypeId": 1, + "apPayeeTermId": 1234, + "isConsolidated": "1", + "isOnSite": "0", + "isRequirePoForInvoice": "0", + "defaultGlAccountId": 123, + "categories": { + "categoryTypeId": [ + 13, + 4 + ] + }, + "websiteUrl": "https://www.example.com", + "externalId": 12345, + "note": "additional notes for the vendor", + "legalEntities": { + "legalEntity": [ + { + "id": 1234, + "nameOnTaxReturn": "name On TaxReturn", + "taxIdNumber": 12333331234, + "ownerTypeId": 2, + "receives1099": "0", + "form1099TypeId": 3, + "form1099BoxTypeId": 11 + }, + { + "id": 1234, + "nameOnTaxReturn": "name On TaxReturn", + "taxIdNumber": "123-12-1234", + "ownerTypeId": 2, + "receives1099": "0", + "form1099TypeId": 3, + "form1099BoxTypeId": 11 + } + ] + }, + "locations": { + "location": [ + { + "id": 1234, + "name": "XYZ", + "vendorCode": "123", + "addressLine1": "Street Line1", + "addressLine2": "Street Line2", + "city": "XYZ", + "state": "XYZ", + "postalCode": "12345", + "phone": "123456789", + "email": "test@test.lcl", + "notes": "additional comment", + "defaultRoutingTagId": 123, + "legalEntityName": "legal entity name", + "approvedForAllProperties": "0", + "properties": { + "propertyId": [ + { + "@value": 1234, + "@attributes": { + "compliance_status_id": 5 + } + }, + { + "@value": 1234, + "@attributes": { + "compliance_status_id": 2 + } + } + ] + }, + "remittances": { + "remittance": [ + { + "id": 1234, + "remittanceName": "Remittance Name", + "apPaymentTypeId": 5, + "bankAccountTypeId": 1, + "nameOnAccount": "Name on Account", + "routingNumber": "1234567", + "accountNumber": "12345678", + "addressLine1": "Address Line1", + "addressLine2": "Address Line2", + "city": "City", + "state": "AE", + "postalCode": "12345", + "isDefault": "0", + "accounts": { + "account": [ + { + "id": 1234, + "accountNumber": "1234", + "description": "Account Description", + "glAccountId": 1234, + "propertyId": 1234, + "utilityBillReceiptTypeId": 6, + "isAuditInvoice": "1", + "isCaptureInvoiceTotalOnly": "1", + "isDisabledInvoice": "0", + "subAccounts": { + "subAccount": [ + { + "id": 123, + "accountNumber": "1234", + "description": "Sub Scocunt Description", + "glAccountId": 1234 + } + ] + } + } + ] + } + } + ] + } + }, + { + "id": 123, + "name": "abc", + "vendorCode": "1234", + "addressLine1": "Street Line1", + "addressLine2": "Street Line2", + "city": "abc", + "state": "XYZ", + "postalCode": "12345", + "phone": "123456789", + "email": "test@test.lcl", + "notes": "additional comment", + "defaultRoutingTagId": 123, + "legalEntityName": "legal entity name", + "approvedForAllProperties": "0", + "properties": { + "propertyId": [ + { + "@value": 1234, + "@attributes": { + "compliance_status_id": 2, + "is_deleted": "0" + } + }, + { + "@value": 12345, + "@attributes": { + "compliance_status_id": 2, + "is_deleted": "1" + } + } + ] + }, + "remittances": { + "remittance": [ + { + "id": 1234, + "remittanceName": "Remittance Name", + "apPaymentTypeId": 1, + "bankAccountTypeId": 1, + "nameOnAccount": "Name on Account", + "routingNumber": "1234567", + "accountNumber": "1234567", + "addressLine1": "Address Line1", + "addressLine2": "Address Line2", + "city": "City", + "state": "XY", + "postalCode": "123456", + "isDefault": "0", + "accounts": { + "account": [ + { + "id": 12345, + "accountNumber": "1234567", + "description": "Account Description", + "glAccountId": 1234, + "propertyId": 1234, + "utilityBillReceiptTypeId": 6, + "isAuditInvoice": "1", + "isCaptureInvoiceTotalOnly": "1", + "isDisabledInvoice": "0", + "subAccounts": { + "subAccount": [ + { + "id": 1222, + "accountNumber": "1234", + "description": "Description", + "glAccountId": 1234 + } + ] + } + } + ] + } + } + ] + } + } + ] + }, + "contacts": { + "contact": [ + { + "id": 1233, + "firstName": "abc", + "lastName": "abc", + "position": "designation", + "phone": "123456789", + "fax": "1234", + "email": "test@example.com", + "associatedLocations": { + "locationIds": "1234,1234", + "locationNames": "location 1, location 2" + }, + "IsPrimaryForLocations": { + "locationIds": "123,123", + "locationNames": "location 1, location 2" + } + }, + { + "id": 1233, + "firstName": "abc", + "lastName": "abc", + "position": "designation", + "phone": "123456789", + "fax": "22223511321", + "email": "test@example.com", + "associatedLocations": { + "locationIds": "12345,4567", + "locationNames": "location 1, location 2" + }, + "IsPrimaryForLocations": { + "locationIds": "12345,4567", + "locationNames": "location 1, location 2" + } + } + ] + }, + "insurances": { + "insurance": [ + { + "coverageId": 1234, + "coverageName": "Coverage Name", + "legalEntityIds": "12345,4567", + "legalEntityNames": "Legal Entity Names", + "document": { + "propertyIds": "12345,4567", + "file": { + "fileName": "File Name.pdf", + "fileData": "base64 encoded file data." + } + }, + "policies": { + "policy": [ + { + "policyTypeId": 1234, + "description": "Policy Description", + "policyNumber": "Policy Number", + "expirationDate": "MM/DD/YYYY", + "coverages": { + "coverage": [ + { + "id": 23111, + "amount": "20.00" + }, + { + "id": 1234, + "amount": "20.00" + } + ] + } + } + ] + } + }, + { + "coverageId": 1233, + "coverageName": "Coverage Name", + "legalEntityIds": "12345,4567", + "legalEntityNames": "Legal Entity Names", + "document": { + "propertyIds": "12345,4567", + "file": { + "fileName": "File Name.pdf", + "fileData": "base64 encoded file data." + } + }, + "policies": { + "policy": [ + { + "policyTypeId": 1234, + "description": "Policy Description", + "policyNumber": "Policy Number", + "expirationDate": "MM/DD/YYYY", + "coverages": { + "coverage": [ + { + "id": 1234, + "amount": "20.00" + }, + { + "id": 1234, + "amount": "20.00" + } + ] + } + } + ] + } + } + ] + } + } + } + } + } + } + }, + "voidApPaymentsRequest": { + "summary": "voidApPayments", + "value": { + "auth": { + "type": "apikey" + }, + "requestId": "15", + "method": { + "name": "voidApPayments", + "params": { + "apPayments": { + "apPayment": [ + { + "paymentId": 123456, + "paymentNumber": 1234, + "paymentBankAccountId": 12345, + "paymentTypeId": 12, + "paymentAmount": "100.10", + "voidDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "note": "Test Note" + }, + { + "paymentId": 1233, + "paymentNumber": 1234, + "paymentBankAccountId": 12345, + "paymentTypeId": 2, + "paymentAmount": "90.00", + "voidDate": "MM/DD/YYYY", + "postMonth": "MM/YYYY", + "note": "memo" + } + ] + } + } + } + } + } + }, + "responses": { + "GeneralFailure": { + "description": "Failure", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + }, + "examples": { + "error": { + "$ref": "#/components/examples/generalErrorResponse" + } + } + } + } + }, + "APIHealthSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getStatusSuccessResponse" + } + ] + }, + "examples": { + "getStatusSuccessExample": { + "$ref": "#/components/examples/getStatusSuccessExample" + } + } + } + } + }, + "ApplicationsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getCompanyApplicationsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicantGeneralDetailsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicationSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicationAddOnsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicationEmployersSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicationPetsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendApplicationVehiclesSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateApplicationSuccessResponse" + } + ] + }, + "examples": { + "getCompanyApplicationsSuccessExample": { + "$ref": "#/components/examples/getCompanyApplicationsSuccessExample" + }, + "sendApplicantGeneralDetailsSuccessExample": { + "$ref": "#/components/examples/sendApplicantGeneralDetailsSuccessExample" + }, + "sendApplicationSuccessExample": { + "$ref": "#/components/examples/sendApplicationSuccessExample" + }, + "sendApplicationAddOnsSuccessExample": { + "$ref": "#/components/examples/sendApplicationAddOnsSuccessExample" + }, + "sendApplicationEmployersSuccessExample": { + "$ref": "#/components/examples/sendApplicationEmployersSuccessExample" + }, + "sendApplicationPetsSuccessExample": { + "$ref": "#/components/examples/sendApplicationPetsSuccessExample" + }, + "sendApplicationVehiclesSuccessExample": { + "$ref": "#/components/examples/sendApplicationVehiclesSuccessExample" + }, + "updateApplicationSuccessExample": { + "$ref": "#/components/examples/updateApplicationSuccessExample" + } + } + } + } + }, + "AppinfoSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getAccessibleClientsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getAccessibleServicesSuccessResponse" + } + ] + }, + "examples": { + "getAccessibleClientsSuccessExample": { + "$ref": "#/components/examples/getAccessibleClientsSuccessExample" + }, + "getAccessibleServicesSuccessExample": { + "$ref": "#/components/examples/getAccessibleServicesSuccessExample" + } + } + } + } + }, + "ArcodesSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getArCodesSuccessResponse" + } + ] + }, + "examples": { + "getArCodesSuccessExample": { + "$ref": "#/components/examples/getArCodesSuccessExample" + } + } + } + } + }, + "ArPaymentsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getArPaymentsSuccessResponse" + } + ] + }, + "examples": { + "getArPaymentsSuccessExample": { + "$ref": "#/components/examples/getArPaymentsSuccessExample" + } + } + } + } + }, + "ArTransactionsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getArInvoicesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseArTransactionsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getMitsLeaseArTransactionsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeaseArTransactionReversalsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeaseArTransactionsSuccessResponse" + } + ] + }, + "examples": { + "getArInvoicesSuccessExample": { + "$ref": "#/components/examples/getArInvoicesSuccessExample" + }, + "getLeaseArTransactionsSuccessExample": { + "$ref": "#/components/examples/getLeaseArTransactionsSuccessExample" + }, + "getMitsLeaseArTransactionsSuccessExample": { + "$ref": "#/components/examples/getMitsLeaseArTransactionsSuccessExample" + }, + "sendLeaseArTransactionReversalsSuccessExample": { + "$ref": "#/components/examples/sendLeaseArTransactionReversalsSuccessExample" + }, + "sendLeaseArTransactionsSuccessExample": { + "$ref": "#/components/examples/sendLeaseArTransactionsSuccessExample" + } + } + } + } + }, + "CommunicationsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getMarketingPreferencePickListSuccessResponse" + }, + { + "$ref": "#/components/schemas/getMarketingPreferencesSuccessResponse" + } + ] + }, + "examples": { + "getMarketingPreferencePickListSuccessExample": { + "$ref": "#/components/examples/getMarketingPreferencePickListSuccessExample" + }, + "getMarketingPreferencesSuccessExample": { + "$ref": "#/components/examples/getMarketingPreferencesSuccessExample" + } + } + } + } + }, + "CustomersSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getCustomersSuccessResponse" + }, + { + "$ref": "#/components/schemas/getCustomerTestimonialsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getTestimonialPickListsSuccessResponse" + }, + { + "$ref": "#/components/schemas/searchCustomersSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendCustomerTestimonialsSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateCustomersSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateCustomerTestimonialsSuccessResponse" + }, + { + "$ref": "#/components/schemas/updatePropertyResponseSuccessResponse" + } + ] + }, + "examples": { + "getCustomersSuccessExample": { + "$ref": "#/components/examples/getCustomersSuccessExample" + }, + "getCustomerTestimonialsSuccessExample": { + "$ref": "#/components/examples/getCustomerTestimonialsSuccessExample" + }, + "getTestimonialPickListsSuccessExample": { + "$ref": "#/components/examples/getTestimonialPickListsSuccessExample" + }, + "searchCustomersSuccessExample": { + "$ref": "#/components/examples/searchCustomersSuccessExample" + }, + "sendCustomerTestimonialsSuccessExample": { + "$ref": "#/components/examples/sendCustomerTestimonialsSuccessExample" + }, + "updateCustomersSuccessExample": { + "$ref": "#/components/examples/updateCustomersSuccessExample" + }, + "updateCustomerTestimonialsSuccessExample": { + "$ref": "#/components/examples/updateCustomerTestimonialsSuccessExample" + }, + "updatePropertyResponseSuccessExample": { + "$ref": "#/components/examples/updatePropertyResponseSuccessExample" + } + } + } + } + }, + "FinancialSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getApCodesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getBankAccountsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getBudgetActualsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getBudgetsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getFinancialPickList_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getFinancialPickList_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getGlTransactionsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getGlTrees_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getGlTrees_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getJobCategoriesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getJobCostBudgetsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getJobsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getTransactionTagListsSuccessResponse" + }, + { + "$ref": "#/components/schemas/markGlTransactionsExportedSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendBudgetsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendJournalEntriesSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateBudgetsSuccessResponse" + } + ] + }, + "examples": { + "getApCodesSuccessExample": { + "$ref": "#/components/examples/getApCodesSuccessExample" + }, + "getBankAccountsSuccessExample": { + "$ref": "#/components/examples/getBankAccountsSuccessExample" + }, + "getBudgetActualsSuccessExample": { + "$ref": "#/components/examples/getBudgetActualsSuccessExample" + }, + "getBudgetsSuccessExample": { + "$ref": "#/components/examples/getBudgetsSuccessExample" + }, + "getFinancialPickList_r1_SuccessExample": { + "$ref": "#/components/examples/getFinancialPickList_r1_SuccessExample" + }, + "getFinancialPickList_r2_SuccessExample": { + "$ref": "#/components/examples/getFinancialPickList_r2_SuccessExample" + }, + "getGlTransactionsSuccessExample": { + "$ref": "#/components/examples/getGlTransactionsSuccessExample" + }, + "getGlTrees_r1_SuccessExample": { + "$ref": "#/components/examples/getGlTrees_r1_SuccessExample" + }, + "getGlTrees_r2_SuccessExample": { + "$ref": "#/components/examples/getGlTrees_r2_SuccessExample" + }, + "getJobCategoriesSuccessExample": { + "$ref": "#/components/examples/getJobCategoriesSuccessExample" + }, + "getJobCostBudgetsSuccessExample": { + "$ref": "#/components/examples/getJobCostBudgetsSuccessExample" + }, + "getJobsSuccessExample": { + "$ref": "#/components/examples/getJobsSuccessExample" + }, + "getTransactionTagListsSuccessExample": { + "$ref": "#/components/examples/getTransactionTagListsSuccessExample" + }, + "markGlTransactionsExportedSuccessExample": { + "$ref": "#/components/examples/markGlTransactionsExportedSuccessExample" + }, + "sendBudgetsSuccessExample": { + "$ref": "#/components/examples/sendBudgetsSuccessExample" + }, + "sendJournalEntriesSuccessExample": { + "$ref": "#/components/examples/sendJournalEntriesSuccessExample" + }, + "updateBudgetsSuccessExample": { + "$ref": "#/components/examples/updateBudgetsSuccessExample" + } + } + } + } + }, + "LeadsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getLeadsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeadEventsSuccessResponse" + }, + { + "$ref": "#/components/schemas/applyQuoteSuccessResponse" + }, + { + "$ref": "#/components/schemas/generateQuotesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeadPickLists_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeadPickLists_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getMitsLeadsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getQuotesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeadsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendMitsLeadsSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateLeads_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/updateLeads_r2_SuccessResponse" + } + ] + }, + "examples": { + "getLeadsSuccessExample": { + "$ref": "#/components/examples/getLeadsSuccessExample" + }, + "getLeadEventsSuccessExample": { + "$ref": "#/components/examples/getLeadEventsSuccessExample" + }, + "applyQuoteSuccessExample": { + "$ref": "#/components/examples/applyQuoteSuccessExample" + }, + "generateQuotesSuccessExample": { + "$ref": "#/components/examples/generateQuotesSuccessExample" + }, + "getLeadPickLists_r1_SuccessExample": { + "$ref": "#/components/examples/getLeadPickLists_r1_SuccessExample" + }, + "getLeadPickLists_r2_SuccessExample": { + "$ref": "#/components/examples/getLeadPickLists_r2_SuccessExample" + }, + "getMitsLeadsSuccessExample": { + "$ref": "#/components/examples/getMitsLeadsSuccessExample" + }, + "getQuotesSuccessExample": { + "$ref": "#/components/examples/getQuotesSuccessExample" + }, + "sendLeadsSuccessExample": { + "$ref": "#/components/examples/sendLeadsSuccessExample" + }, + "sendMitsLeadsSuccessExample": { + "$ref": "#/components/examples/sendMitsLeadsSuccessExample" + }, + "updateLeads_r1_SuccessExample": { + "$ref": "#/components/examples/updateLeads_r1_SuccessExample" + }, + "updateLeads_r2_SuccessExample": { + "$ref": "#/components/examples/updateLeads_r2_SuccessExample" + } + } + } + } + }, + "LeasesSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/cancelLeaseSuccessResponse" + }, + { + "$ref": "#/components/schemas/getEvictedLeasesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getExpiringLeasesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseActivitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseDetails_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseDetails_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseDocumentsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeaseDocumentsListSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeasePickListSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeases_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeases_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getMitsCollectionsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getMitsLeasesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getParcelAlertsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getRentersInsurancePoliciesSuccessResponse" + }, + { + "$ref": "#/components/schemas/moveInLeaseSuccessResponse" + }, + { + "$ref": "#/components/schemas/moveOutLeaseSuccessResponse" + }, + { + "$ref": "#/components/schemas/onNoticeLeaseSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeaseActivitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeaseDocumentsSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendLeasesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendRentersInsurancePolicies_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendRentersInsurancePolicies_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendRoommateGroups_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendScheduledChargesSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateLeaseSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateScheduledCharges_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/updateScheduledCharges_r2_SuccessResponse" + } + ] + }, + "examples": { + "cancelLeaseSuccessExample": { + "$ref": "#/components/examples/cancelLeaseSuccessExample" + }, + "getEvictedLeasesSuccessExample": { + "$ref": "#/components/examples/getEvictedLeasesSuccessExample" + }, + "getExpiringLeasesSuccessExample": { + "$ref": "#/components/examples/getExpiringLeasesSuccessExample" + }, + "getLeaseActivitiesSuccessExample": { + "$ref": "#/components/examples/getLeaseActivitiesSuccessExample" + }, + "getLeaseDetails_r1_SuccessExample": { + "$ref": "#/components/examples/getLeaseDetails_r1_SuccessExample" + }, + "getLeaseDetails_r2_SuccessExample": { + "$ref": "#/components/examples/getLeaseDetails_r2_SuccessExample" + }, + "getLeaseDocumentsSuccessExample": { + "$ref": "#/components/examples/getLeaseDocumentsSuccessExample" + }, + "getLeaseDocumentsListSuccessExample": { + "$ref": "#/components/examples/getLeaseDocumentsListSuccessExample" + }, + "getLeasePickListSuccessExample": { + "$ref": "#/components/examples/getLeasePickListSuccessExample" + }, + "getLeases_r1_SuccessExample": { + "$ref": "#/components/examples/getLeases_r1_SuccessExample" + }, + "getLeases_r2_SuccessExample": { + "$ref": "#/components/examples/getLeases_r2_SuccessExample" + }, + "getMitsCollectionsSuccessExample": { + "$ref": "#/components/examples/getMitsCollectionsSuccessExample" + }, + "getMitsLeasesSuccessExample": { + "$ref": "#/components/examples/getMitsLeasesSuccessExample" + }, + "getParcelAlertsSuccessExample": { + "$ref": "#/components/examples/getParcelAlertsSuccessExample" + }, + "getRentersInsurancePoliciesSuccessExample": { + "$ref": "#/components/examples/getRentersInsurancePoliciesSuccessExample" + }, + "moveInLeaseSuccessExample": { + "$ref": "#/components/examples/moveInLeaseSuccessExample" + }, + "moveOutLeaseSuccessExample": { + "$ref": "#/components/examples/moveOutLeaseSuccessExample" + }, + "onNoticeLeaseSuccessExample": { + "$ref": "#/components/examples/onNoticeLeaseSuccessExample" + }, + "sendLeaseActivitiesSuccessExample": { + "$ref": "#/components/examples/sendLeaseActivitiesSuccessExample" + }, + "sendLeaseDocumentsSuccessExample": { + "$ref": "#/components/examples/sendLeaseDocumentsSuccessExample" + }, + "sendLeasesSuccessExample": { + "$ref": "#/components/examples/sendLeasesSuccessExample" + }, + "sendRentersInsurancePolicies_r1_SuccessExample": { + "$ref": "#/components/examples/sendRentersInsurancePolicies_r1_SuccessExample" + }, + "sendRentersInsurancePolicies_r2_SuccessExample": { + "$ref": "#/components/examples/sendRentersInsurancePolicies_r2_SuccessExample" + }, + "sendRoommateGroupsSuccessExample": { + "$ref": "#/components/examples/sendRoommateGroups_r2_SuccessExample" + }, + "sendScheduledChargesSuccessExample": { + "$ref": "#/components/examples/sendScheduledChargesSuccessExample" + }, + "updateLeaseSuccessExample": { + "$ref": "#/components/examples/updateLeaseSuccessExample" + }, + "updateScheduledCharges_r1_SuccessExample": { + "$ref": "#/components/examples/updateScheduledCharges_r1_SuccessExample" + }, + "updateScheduledCharges_r2_SuccessExample": { + "$ref": "#/components/examples/updateScheduledCharges_r2_SuccessExample" + } + } + } + } + }, + "LeasingCenterSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getCallLogsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getLeasingCenterPickListsSuccessResponse" + } + ] + }, + "examples": { + "getCallLogsSuccessExample": { + "$ref": "#/components/examples/getCallLogsSuccessExample" + }, + "getLeasingCenterPickListsSuccessExample": { + "$ref": "#/components/examples/getLeasingCenterPickListsSuccessExample" + } + } + } + } + }, + "MaintenanceSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getInspectionsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getInspectionTemplatesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getWorkOrderPickListsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getWorkOrdersSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendWorkOrdersSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateWorkOrders_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/updateWorkOrders_r2_SuccessResponse" + } + ] + }, + "examples": { + "getInspectionsSuccessExample": { + "$ref": "#/components/examples/getInspectionsSuccessExample" + }, + "getInspectionTemplatesSuccessExample": { + "$ref": "#/components/examples/getInspectionTemplatesSuccessExample" + }, + "getWorkOrderPickListsSuccessExample": { + "$ref": "#/components/examples/getWorkOrderPickListsSuccessExample" + }, + "getWorkOrdersSuccessSuccessExample": { + "$ref": "#/components/examples/getWorkOrdersSuccessSuccessExample" + }, + "sendWorkOrdersSuccessSuccessExample": { + "$ref": "#/components/examples/sendWorkOrdersSuccessSuccessExample" + }, + "updateWorkOrders_r1_SuccessExample": { + "$ref": "#/components/examples/updateWorkOrders_r1_SuccessExample" + }, + "updateWorkOrders_r2_SuccessExample": { + "$ref": "#/components/examples/updateWorkOrders_r2_SuccessExample" + } + } + } + } + }, + "PricingSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getPricingPicklistsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyFeesSuccessResponse" + }, + { + "$ref": "#/components/schemas/insertPricingSuccessResponse" + }, + { + "$ref": "#/components/schemas/insertPricing_r2SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendBudgetedRentSuccessResponse" + } + ] + }, + "examples": { + "getPricingPicklistsSuccessExample": { + "$ref": "#/components/examples/getPricingPicklistsSuccessExample" + }, + "getPropertyFeesSuccessExample": { + "$ref": "#/components/examples/getPropertyFeesSuccessExample" + }, + "insertPricingSuccessExample": { + "$ref": "#/components/examples/insertPricingSuccessExample" + }, + "insertPricing_r2SuccessExample": { + "$ref": "#/components/examples/insertPricing_r2SuccessExample" + }, + "sendBudgetedRentSuccessExample": { + "$ref": "#/components/examples/sendBudgetedRentSuccessExample" + } + } + } + } + }, + "PropertiesSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getAmenityReservationsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getCalendarAvailability_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getCalendarAvailability_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getFloorPlansSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPetTypesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyAddOnsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyAnnouncementsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyPickLists_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyPickLists_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getRentableItemsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getReservableAmenitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getWebsitesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendFloorplansSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendRentableItemsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyMediaSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendPropertyMediaSuccessResponse" + }, + { + "$ref": "#/components/schemas/updatePropertyMediaSuccessResponse" + }, + { + "$ref": "#/components/schemas/deletePropertyMediaSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPhoneNumberSuccessResponse" + } + ] + }, + "examples": { + "getAmenityReservationsSuccessExample": { + "$ref": "#/components/examples/getAmenityReservationsSuccessExample" + }, + "getCalendarAvailability_r1_SuccessExample": { + "$ref": "#/components/examples/getCalendarAvailability_r1_SuccessExample" + }, + "getCalendarAvailability_r2_SuccessExample": { + "$ref": "#/components/examples/getCalendarAvailability_r2_SuccessExample" + }, + "getFloorPlansSuccessExample": { + "$ref": "#/components/examples/getFloorPlansSuccessExample" + }, + "getPetTypesSuccessExample": { + "$ref": "#/components/examples/getPetTypesSuccessExample" + }, + "getPropertiesSuccessExample": { + "$ref": "#/components/examples/getPropertiesSuccessExample" + }, + "getPropertyAddOnsSuccessExample": { + "$ref": "#/components/examples/getPropertyAddOnsSuccessExample" + }, + "getPropertyAnnouncementsSuccessExample": { + "$ref": "#/components/examples/getPropertyAnnouncementsSuccessExample" + }, + "getPropertyPickLists_r1_SuccessExample": { + "$ref": "#/components/examples/getPropertyPickLists_r1_SuccessExample" + }, + "getPropertyPickLists_r2_SuccessExample": { + "$ref": "#/components/examples/getPropertyPickLists_r2_SuccessExample" + }, + "getRentableItemsSuccessExample": { + "$ref": "#/components/examples/getRentableItemsSuccessExample" + }, + "getReservableAmenitiesSuccessExample": { + "$ref": "#/components/examples/getReservableAmenitiesSuccessExample" + }, + "getWebsitesSuccessExample": { + "$ref": "#/components/examples/getWebsitesSuccessExample" + }, + "sendFloorplansSuccessExample": { + "$ref": "#/components/examples/sendFloorplansSuccessExample" + }, + "sendRentableItemsSuccessExample": { + "$ref": "#/components/examples/sendRentableItemsSuccessExample" + }, + "getPropertyMediaSuccessExample": { + "$ref": "#/components/examples/getPropertyMediaSuccessExample" + }, + "sendPropertyMediaSuccessExample": { + "$ref": "#/components/examples/sendPropertyMediaSuccessExample" + }, + "updatePropertyMediaSuccessExample": { + "$ref": "#/components/examples/updatePropertyMediaSuccessExample" + }, + "deletePropertyMediaSuccessExample": { + "$ref": "#/components/examples/deletePropertyMediaSuccessExample" + }, + "getPhoneNumberSuccessExample": { + "$ref": "#/components/examples/getPhoneNumberSuccessExample" + } + } + } + } + }, + "PropertyUnitsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getAmenitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/getMitsPropertyUnitsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPropertyUnitsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getSpecials_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getSpecials_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getSpecials_r3_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getUnitsAvailabilityAndPricingSuccessResponse" + }, + { + "$ref": "#/components/schemas/getUnitTypesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendAmenitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendPropertyUnitsSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateAmenitiesSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendSpecialGroupSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateSpecialGroupSuccessResponse" + }, + { + "$ref": "#/components/schemas/getSpecials_r4_SuccessResponse" + } + ] + }, + "examples": { + "getAmenitiesSuccessExample": { + "$ref": "#/components/examples/getAmenitiesSuccessExample" + }, + "getMitsPropertyUnitsSuccessExample": { + "$ref": "#/components/examples/getMitsPropertyUnitsSuccessExample" + }, + "getPropertyUnitsSuccessExample": { + "$ref": "#/components/examples/getPropertyUnitsSuccessExample" + }, + "getSpecials_r1_SuccessExample": { + "$ref": "#/components/examples/getSpecials_r1_SuccessExample" + }, + "getSpecials_r2_SuccessExample": { + "$ref": "#/components/examples/getSpecials_r2_SuccessExample" + }, + "getSpecials_r3_SuccessExample": { + "$ref": "#/components/examples/getSpecials_r3_SuccessExample" + }, + "getUnitsAvailabilityAndPricingSuccessExample": { + "$ref": "#/components/examples/getUnitsAvailabilityAndPricingSuccessExample" + }, + "getUnitTypesSuccessExample": { + "$ref": "#/components/examples/getUnitTypesSuccessExample" + }, + "sendAmenitiesSuccessExample": { + "$ref": "#/components/examples/sendAmenitiesSuccessExample" + }, + "sendPropertyUnitsSuccessExample": { + "$ref": "#/components/examples/sendPropertyUnitsSuccessExample" + }, + "updateAmenitiesSuccessExample": { + "$ref": "#/components/examples/updateAmenitiesSuccessExample" + }, + "sendSpecialGroupSuccessExample": { + "$ref": "#/components/examples/sendSpecialGroupSuccessExample" + }, + "updateSpecialGroupSuccessExample": { + "$ref": "#/components/examples/updateSpecialGroupSuccessExample" + }, + "getSpecials_r4_SuccessExample": { + "$ref": "#/components/examples/getSpecials_r4_SuccessExample" + } + } + } + } + }, + "VendorsSuccess": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/getInvoices_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getInvoices_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/getPoReceivingRecordsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getPurchaseOrdersSuccessResponse" + }, + { + "$ref": "#/components/schemas/getTaxFormDataSuccessResponse" + }, + { + "$ref": "#/components/schemas/getVendorLocationsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getVendorPickListsSuccessResponse" + }, + { + "$ref": "#/components/schemas/getVendorsSuccessResponse" + }, + { + "$ref": "#/components/schemas/markInvoicesExportedSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendInvoices_r1_SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendInvoices_r2_SuccessResponse" + }, + { + "$ref": "#/components/schemas/sendPurchaseOrdersSuccessResponse" + }, + { + "$ref": "#/components/schemas/sendVendorsSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateInvoicesSuccessResponse" + }, + { + "$ref": "#/components/schemas/updateVendorsSuccessResponse" + }, + { + "$ref": "#/components/schemas/voidApPaymentsSuccessResponse" + } + ] + }, + "examples": { + "getInvoices_r1_SuccessExample": { + "$ref": "#/components/examples/getInvoices_r1_SuccessExample" + }, + "getInvoices_r2_SuccessExample": { + "$ref": "#/components/examples/getInvoices_r2_SuccessExample" + }, + "getPoReceivingRecordsSuccessExample": { + "$ref": "#/components/examples/getPoReceivingRecordsSuccessExample" + }, + "getPurchaseOrdersSuccessExample": { + "$ref": "#/components/examples/getPurchaseOrdersSuccessExample" + }, + "getTaxFormDataSuccessExample": { + "$ref": "#/components/examples/getTaxFormDataSuccessExample" + }, + "getVendorLocationsSuccessExample": { + "$ref": "#/components/examples/getVendorLocationsSuccessExample" + }, + "getVendorPickListsSuccessExample": { + "$ref": "#/components/examples/getVendorPickListsSuccessExample" + }, + "getVendorsSuccessExample": { + "$ref": "#/components/examples/getVendorsSuccessExample" + }, + "markInvoicesExportedSuccessExample": { + "$ref": "#/components/examples/markInvoicesExportedSuccessExample" + }, + "sendInvoices_r1_SuccessExample": { + "$ref": "#/components/examples/sendInvoices_r1_SuccessExample" + }, + "sendInvoices_r2_SuccessExample": { + "$ref": "#/components/examples/sendInvoices_r2_SuccessExample" + }, + "sendPurchaseOrdersSuccessExample": { + "$ref": "#/components/examples/sendPurchaseOrdersSuccessExample" + }, + "sendVendorsSuccessExample": { + "$ref": "#/components/examples/sendVendorsSuccessExample" + }, + "updateInvoicesSuccessExample": { + "$ref": "#/components/examples/updateInvoicesSuccessExample" + }, + "updateVendorsSuccessExample": { + "$ref": "#/components/examples/updateVendorsSuccessExample" + }, + "voidApPaymentsSuccessExample": { + "$ref": "#/components/examples/voidApPaymentsSuccessExample" + } + } + } + } + }, + "SuccessOrFailure": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/successResponse" + }, + { + "$ref": "#/components/schemas/errorResponse" + } + ] + }, + "examples": { + "success": { + "$ref": "#/components/examples/generalSuccessResponse" + } + } + } + } + } + }, + "parameters": { + "pathParamOrgs": { + "name": "orgs", + "in": "path", + "description": "Client subdomain.", + "required": true, + "style": "simple", + "explode": false, + "schema": { + "type": "string" + } + }, + "queryParamPageNo": { + "in": "query", + "name": "page_no", + "description": "The page number of paginated respons.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + "queryParamPerPage": { + "in": "query", + "name": "per_page", + "description": "The number of items returned in the respnose", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1000 + } + }, + "headerParamXSendPaginationLinks": { + "in": "header", + "name": "X-Send-Pagination-Links", + "description": "Send Pagination Links in Response Body.", + "required": false, + "style": "simple", + "explode": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + } + }, + "securitySchemes": { + "apiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-Api-Key" + } + } + } +} \ No newline at end of file diff --git a/servers/entrata_api/arcade_entrata_api/tools/__init__.py b/servers/entrata_api/arcade_entrata_api/tools/__init__.py new file mode 100644 index 00000000..62670d31 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/tools/__init__.py @@ -0,0 +1,898 @@ +"""Arcade Starter Tools for Entrata + +DO NOT EDIT THIS MODULE DIRECTLY. + +THIS MODULE WAS AUTO-GENERATED BY TRANSPILING THE API STARTER TOOL JSON DEFINITIONS +IN THE ../wrapper_tools DIRECTORY INTO PYTHON CODE. ANY CHANGES TO THIS MODULE WILL +BE OVERWRITTEN BY THE TRANSPILER. +""" + +import asyncio +import json +from typing import Annotated, Any + +import httpx + +from arcade_tdk import tool, ToolContext + + +# Retry configuration +INITIAL_RETRY_DELAY = 0.5 # seconds + +HTTP_CLIENT = httpx.AsyncClient( + timeout=httpx.Timeout(60.0, connect=10.0), + limits=httpx.Limits(max_keepalive_connections=20, max_connections=100), + transport=httpx.AsyncHTTPTransport(retries=3), + http2=True, + follow_redirects=True, +) + + +def remove_none_values(data: dict[str, Any]) -> dict[str, Any]: + return {k: v for k, v in data.items() if v is not None} + + +async def make_request( + url: str, + method: str, + params: dict[str, Any] | None = None, + headers: dict[str, Any] | None = None, + content: str | None = None, + data: dict[str, Any] | None = None, + auth: tuple[str, str] | None = None, + max_retries: int = 3, +) -> httpx.Response: + """Make an HTTP request with retry logic for 5xx server errors.""" + for attempt in range(max_retries): + try: + response = await HTTP_CLIENT.request( + url=url, + auth=auth, + method=method, + params=params, + headers=headers, + content=content, + ) + response.raise_for_status() + except httpx.HTTPStatusError as e: + # Only retry on 5xx server errors + if e.response.status_code >= 500 and attempt < max_retries - 1: + # Exponential backoff: 0.5s, 1s, 2s + await asyncio.sleep(INITIAL_RETRY_DELAY * (2**attempt)) + continue + # Re-raise for 4xx errors or if max retries reached + raise + except httpx.RequestError as e: + # Don't retry request errors (network issues are handled by transport) + raise + else: + return response + + # This should never be reached, but satisfies type checker + raise httpx.RequestError("Max retries exceeded") # noqa: TRY003 + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def check_api_health( + context: ToolContext, + authentication_type: Annotated[ + str, "The authentication method used, typically 'apikey'." + ], + client_subdomain: Annotated[ + str, "The subdomain of the client organization to check the API health for." + ], + method_name: Annotated[ + str, "The method name for the API operation. Use 'getStatus' to check health." + ], + api_method_version: Annotated[ + str | None, + "Specify the version of the API method to use. The default and only supported value is 'r1'.", # noqa: E501 + ] = None, + response_identifier: Annotated[ + str | None, + "An arbitrary string value to link the request with its corresponding response.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Check the health status of the API service. + + Use this tool to verify the current health status of the API service. This can help in determining if the service is operational and responsive.""" # noqa: E501 + request_data: Any = { + "auth": {"type": authentication_type}, + "requestId": response_identifier, + "method": {"name": method_name, "version": api_method_version}, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/status".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def submit_application( + context: ToolContext, + application_data: Annotated[ + list[dict[str, str]], + "JSON array containing the application details to be submitted. Include all necessary information relevant to the application.", # noqa: E501 + ], + client_subdomain: Annotated[ + str, "The subdomain of the client to which the application is submitted." + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Submit an application to the specified organization. + + This tool is used to submit applications to a specified organization using the Entrata service. It should be called when an application needs to be sent for processing.""" # noqa: E501 + request_data: Any = application_data + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/applications".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_accessible_clients( + context: ToolContext, + organization_subdomain: Annotated[ + str, + "The subdomain of the client organization. Use 'rsync' as the value to access relevant client information.", # noqa: E501 + ], + request_body_data: Annotated[ + list[dict[str, str]], + "An array of JSON objects to include in the request body for additional data required by the API.", # noqa: E501 + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve accessible client information for a given organization. + + Use this tool to get information about clients accessible to an organization. Call it when you need to retrieve details about clients linked to the organization using the `rsync` value for `orgs`.""" # noqa: E501 + request_data: Any = request_body_data + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/appinfo".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), + orgs=organization_subdomain, + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_ar_codes( + context: ToolContext, + ar_codes_method_name: Annotated[ + str, + "Must be set to 'getArCodes' to specify the API method for retrieving AR codes.", # noqa: E501 + ], + authentication_type: Annotated[ + str, "Specify the authentication type, expected value is 'apikey'." + ], + client_subdomain: Annotated[ + str, "Client subdomain, used to specify the management company." + ], + api_method_version: Annotated[ + str | None, + "Specifies the version of the API method to use. Supported value is 'r1'.", + ] = None, + property_id: Annotated[ + int | None, + "Optional. Provide a valid property ID for which AR codes are required.", + ] = None, + response_identifier: Annotated[ + str | None, + "An arbitrary string value used to relate the request with the response.", + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve AR codes for a management company. + + Fetches all AR codes associated with a specific management company, useful for property management and financial operations.""" # noqa: E501 + request_data: Any = { + "auth": {"type": authentication_type}, + "requestId": response_identifier, + "method": { + "name": ar_codes_method_name, + "version": api_method_version, + "params": {"propertyId": property_id}, + }, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/arcodes".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def submit_ar_payments( + context: ToolContext, + authentication_type: Annotated[ + str, "Set the type of authentication. Accepted value: 'apikey'." + ], + client_subdomain: Annotated[ + str, "The subdomain of the client organization using the Entrata service." + ], + method_name_for_ar_payments: Annotated[ + str, + "Specifies the method name for accounts receivable payments. Use 'getArPayments' to retrieve AR payments.", # noqa: E501 + ], + api_version: Annotated[ + str | None, "Specify the version of the API to use, options: ['r1']." + ] = None, + ar_payment_ids: Annotated[ + str | None, + "Optional. Comma-separated list of accounts receivable payment IDs for processing.", # noqa: E501 + ] = None, + from_date: Annotated[ + str | None, + "Optional. Accepts a single date value that represents the starting point for the query in YYYY-MM-DD format.", # noqa: E501 + ] = None, + include_allocations: Annotated[ + int | None, + "Optional. Set to 1 to include allocations details of payment; 0 otherwise.", + ] = None, + payment_status_type_identifiers: Annotated[ + str | None, "Optional. Comma-separated IDs representing payment status types." + ] = None, + response_correlation_id: Annotated[ + str | None, "An arbitrary value used to correlate and track the response." + ] = None, + to_date: Annotated[ + str | None, + "Optional field specifying the end date for the request. Accepts a single date value.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Submits accounts receivable payments for processing. + + Use this tool to submit accounts receivable payments to Entrata for processing. It confirms the successful submission of payment data.""" # noqa: E501 + request_data: Any = { + "auth": {"type": authentication_type}, + "requestId": response_correlation_id, + "method": { + "name": method_name_for_ar_payments, + "version": api_version, + "params": { + "arPaymentIds": ar_payment_ids, + "paymentStatusTypeIds": payment_status_type_identifiers, + "fromDate": from_date, + "toDate": to_date, + "isIncludeAllocations": include_allocations, + }, + }, + } + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/arpayments".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_ar_transactions( + context: ToolContext, + ar_transactions_request_body: Annotated[ + list[dict[str, str]], + "Specify the array of transaction-related API request data in JSON format.", + ], + client_subdomain: Annotated[ + str, + "The unique subdomain identifying the client organization for which the accounts receivable transactions are being fetched.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response body, 0 to exclude.", + ] = None, + items_per_page: Annotated[ + int | None, + "Specifies the number of items returned in the response for each page of pagination.", # noqa: E501 + ] = None, + page_number: Annotated[ + int | None, "The page number to retrieve for paginated responses." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Fetches accounts receivable transactions for an organization. + + Use this tool to retrieve accounts receivable transactions by providing the organization identifier.""" # noqa: E501 + request_data: Any = ar_transactions_request_body + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/artransactions".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def send_communication_message( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain of the client organization where the communication message will be sent.", # noqa: E501 + ], + communication_messages_payload: Annotated[ + list[dict[str, str]], + "JSON array containing details for arPayment-related communications.", + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Send communication messages via the Entrata Communications API. + + This tool sends communication messages using the Entrata Communications API. It should be called when a user wants to send a message to a specified organization. The tool performs a POST request to the specified endpoint to deliver the message and receives a confirmation of the communication being sent.""" # noqa: E501 + request_data: Any = communication_messages_payload + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/communications".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def create_customer_profile( + context: ToolContext, + client_subdomain: Annotated[ + str, "The unique subdomain of the client organization in the Entrata system." + ], + customer_payment_info: Annotated[ + list[dict[str, str]], + "A JSON array containing AR payment-related information for the customer profile creation.", # noqa: E501 + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Create a new customer profile in the Entrata system. + + Use this tool to add a new customer profile to the Entrata database for a specific organization. Useful for handling customer onboarding processes.""" # noqa: E501 + request_data: Any = customer_payment_info + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/customers".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_financial_budgets( + context: ToolContext, + ar_payment_requests: Annotated[ + list[dict[str, str]], + "A list of JSON objects representing AR payment related data for processing. Each JSON object should contain details as required by the specific AR payment APIs.", # noqa: E501 + ], + client_subdomain: Annotated[ + str, + "The subdomain of the client organization for which to fetch financial budgets.", # noqa: E501 + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Fetch financial budgets for organizations. + + Use this tool to retrieve financial budget data for specified organizations through the Entrata service. Supports pagination for large data sets.""" # noqa: E501 + request_data: Any = ar_payment_requests + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/financial".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def create_lead_entry( + context: ToolContext, + client_subdomain: Annotated[ + str, "The subdomain associated with the client organization in Entrata." + ], + lead_information: Annotated[ + list[dict[str, str]], + "An array of JSON objects representing the new lead's details to be added. Each JSON object should contain properties relevant to the lead, such as name, contact information, and any other required fields.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Flag to include pagination links in the response body. Use '1' to enable and '0' to disable.", # noqa: E501 + ] = None, + number_of_items_per_page: Annotated[ + int | None, + "Specify the number of items to be returned per page in the paginated response.", # noqa: E501 + ] = None, + page_number: Annotated[ + int | None, + "The page number for paginated responses. Use this to specify which page to retrieve when dealing with paginated data.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Create a new lead entry in the Entrata system. + + Use this tool to submit a new lead's information to the Entrata system for a specified organization. This action is suitable when new leads need to be captured and stored in the system for follow-up or record-keeping.""" # noqa: E501 + request_data: Any = lead_information + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leads".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values( + {"page_no": page_number, "per_page": number_of_items_per_page} + ), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_lease_details( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain representing the client organization. Required to specify which client's data to retrieve.", # noqa: E501 + ], + lease_documents_upload: Annotated[ + list[dict[str, str]], + "Upload lease documents using a form file upload (multipart/form-data).", + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response. Use 0 to exclude them. This helps manage paginated data effectively.", # noqa: E501 + ] = None, + items_per_page: Annotated[ + int | None, + "The number of items to return per page in the response. Supports paginated data retrieval.", # noqa: E501 + ] = None, + page_number: Annotated[ + int | None, + "The page number to retrieve in a paginated response. Use this to navigate through pages of lease details.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve detailed information about leases. + + Use this tool to get detailed information about leases, including lease activities, details, documents, parcels, and more. It supports pagination for handling large datasets.""" # noqa: E501 + request_data: Any = lease_documents_upload + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leases".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def leasing_center_call_logs( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain of the client organization. This is required to identify the client's data for retrieving call logs.", # noqa: E501 + ], + request_body_payload: Annotated[ + list[dict[str, str]], + "An array of JSON objects to be included in the request. Typically used for specifying additional data or filters for the API call.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response; set to 0 to exclude them.", # noqa: E501 + ] = None, + items_per_page: Annotated[ + int | None, + "Number of items to return per page in the response. Use for pagination.", + ] = None, + page_number: Annotated[ + int | None, + "The page number to retrieve in a paginated response from the leasing center call logs.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve leasing center call logs for analysis. + + Use this tool to access call logs from the leasing center, supporting pagination for detailed data retrieval.""" # noqa: E501 + request_data: Any = request_body_payload + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leasingcenter".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def request_maintenance_service( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The unique subdomain identifier for the client organization requesting the service.", # noqa: E501 + ], + maintenance_request_details: Annotated[ + list[dict[str, str]], + "The JSON array containing details required to initiate a maintenance request. Include all necessary fields as per Entrata's API requirements.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response body, otherwise set to 0.", # noqa: E501 + ] = None, + items_per_page: Annotated[ + int | None, "Specifies the number of items to return per page in the response." + ] = None, + page_number: Annotated[ + int | None, + "The page number for paginated responses. Use to retrieve a specific page in a paginated series.", # noqa: E501 + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Request maintenance services for an organization. + + This tool calls the Entrata API to request maintenance services for a specified organization. It should be used when an entity needs to initiate a new maintenance service order.""" # noqa: E501 + request_data: Any = maintenance_request_details + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/maintenance".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def update_pricing( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain associated with the client organization for which pricing is being updated.", # noqa: E501 + ], + pricing_update_details: Annotated[ + list[dict[str, str]], + "A JSON array containing the details for pricing updates. Each element should include specifics like product ID, new price, and effective date.", # noqa: E501 + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Update pricing information for a specified organization. + + Use this tool to adjust the pricing details for an organization. This is typically called when changes in pricing need to be implemented for specific organizational needs or market conditions.""" # noqa: E501 + request_data: Any = pricing_update_details + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/pricing".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_property_details( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain representing the specific client or organization for which property details are requested.", # noqa: E501 + ], + property_request_body: Annotated[ + list[dict[str, str]], + "The JSON array containing the request details for fetching property information. This should include any necessary filters or criteria.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response; 0 to exclude them.", + ] = None, + items_per_page: Annotated[ + int | None, "Number of items to return per page in the response." + ] = None, + page_number: Annotated[ + int | None, "The current page number to retrieve in a paginated response." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve details of properties for a specific organization. + + This tool accesses property details for a specific organization using the Entrata API. It should be called when detailed property information is needed, such as for property management or listings.""" # noqa: E501 + request_data: Any = property_request_body + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/properties".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def create_property_unit( + context: ToolContext, + client_subdomain: Annotated[ + str, + "The subdomain of the client organization where the property unit should be added.", # noqa: E501 + ], + property_unit_details: Annotated[ + list[dict[str, str]], + "A JSON array containing the details of the property unit to be created, such as unit identifier, size, and location.", # noqa: E501 + ], +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Add a new property unit to the system. + + This tool creates a new property unit within the specified organization. It should be called when there is a need to register or add information about a new unit in a property management system.""" # noqa: E501 + request_data: Any = property_unit_details + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/propertyunits".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), orgs=client_subdomain + ), + method="POST", + params=remove_none_values({}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + + +@tool(requires_secrets=["ENTRATA_API_KEY", "ENTRATA_DOMAIN"]) +async def get_vendors( + context: ToolContext, + organization_subdomain: Annotated[ + str, "The subdomain representing the organization to retrieve vendors for." + ], + vendor_request_body: Annotated[ + list[dict[str, str]], + "Provide the request body as a JSON array for fetching vendor data. This should include any necessary parameters required by the API to process the vendor data request.", # noqa: E501 + ], + include_pagination_links: Annotated[ + int | None, + "Set to 1 to include pagination links in the response body, 0 to exclude.", + ] = None, + items_per_page: Annotated[ + int | None, + "The number of items to return per page in the response for pagination.", + ] = None, + page_number: Annotated[ + int | None, "The page number for pagination of the vendor list." + ] = None, +) -> Annotated[dict[str, Any], "Response from the API endpoint ''."]: + """Retrieve a list of vendors for a given organization. + + This tool fetches vendor information from Entrata for a specified organization. Use it to obtain a comprehensive list of vendors associated with an organization ID.""" # noqa: E501 + request_data: Any = vendor_request_body + if isinstance(request_data, dict): + request_data = remove_none_values(request_data) + content = json.dumps(request_data) if request_data else None + response = await make_request( + url="https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/vendors".format( # noqa: UP032 + entrata_domain=context.get_secret("ENTRATA_DOMAIN"), + orgs=organization_subdomain, + ), + method="POST", + params=remove_none_values({"page_no": page_number, "per_page": items_per_page}), + headers=remove_none_values( + { + "Content-Type": "application/json", + "X-Send-Pagination-Links": include_pagination_links, + "X-Api-Key": context.get_secret("ENTRATA_API_KEY"), + } + ), + content=content, + ) + try: + return {"response_json": response.json()} + except Exception: + return {"response_text": response.text} + diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/CheckApiHealth.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CheckApiHealth.json new file mode 100644 index 00000000..5441b07d --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CheckApiHealth.json @@ -0,0 +1,259 @@ +{ + "name": "CheckApiHealth", + "fully_qualified_name": "EntrataApi.CheckApiHealth@0.1.0", + "description": "Check the health status of the API service.\n\nUse this tool to verify the current health status of the API service. This can help in determining if the service is operational and responsive.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization to check the API health for.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "authentication_type", + "required": true, + "description": "The authentication method used, typically 'apikey'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "auth.type" + }, + { + "name": "method_name", + "required": true, + "description": "The method name for the API operation. Use 'getStatus' to check health.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getStatus" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.name" + }, + { + "name": "response_identifier", + "required": false, + "description": "An arbitrary string value to link the request with its corresponding response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestId" + }, + { + "name": "api_method_version", + "required": false, + "description": "Specify the version of the API method to use. The default and only supported value is 'r1'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.version" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/status", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "auth.type", + "tool_parameter_name": "authentication_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestId", + "tool_parameter_name": "response_identifier", + "description": "an arbitary value to relate with response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.name", + "tool_parameter_name": "method_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getStatus" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.version", + "tool_parameter_name": "api_method_version", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"This API will specify the API health status whether it is running or not.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getStatus\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n \"examples\": {\n \"getStatus\": {\n \"$ref\": \"#/components/examples/getStatusRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateCustomerProfile.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateCustomerProfile.json new file mode 100644 index 00000000..7ebd8066 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateCustomerProfile.json @@ -0,0 +1,148 @@ +{ + "name": "CreateCustomerProfile", + "fully_qualified_name": "EntrataApi.CreateCustomerProfile@0.1.0", + "description": "Create a new customer profile in the Entrata system.\n\nUse this tool to add a new customer profile to the Entrata database for a specific organization. Useful for handling customer onboarding processes.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The unique subdomain of the client organization in the Entrata system.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "customer_payment_info", + "required": true, + "description": "A JSON array containing AR payment-related information for the customer profile creation.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/customers", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "customer_payment_info", + "description": "arPayment related APIs", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678,9865\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Customer Ids\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Lease Status types\"\n },\n \"isAgreedToTermsOnly\": {\n \"type\": \"boolean\",\n \"example\": \"1\"\n },\n \"companyIdentificationTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. company Identification type IDs\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Property id\"\n },\n \"isApproved\": {\n \"type\": \"boolean\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will fetch the testimonials from this date\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will fetch the testimonials until this date\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTestimonialPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"searchCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id. This is system ID associated with each property.\"\n },\n \"search\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Thornberry\",\n \"description\": \"This is a required field. This field accepts single value. Search string accepts phone number, name, building, unit, secondary number.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"search\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"CustomerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Customer Id.\"\n },\n \"TestimonialTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. The following are valid testimonial type ids: 1 Resident testimonial 2 Employee testimonial 3 Client testimonial 4 Vacancy 5 Apartmentr atings.com 6 Yelp.com 7 atlanta.citysearch.com\"\n },\n \"Name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Bryan Murfy\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Name of a person who submitted the testi monial.\"\n },\n \"Title\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"So far a great experience\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Title of testimonial.\"\n },\n \"Review\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"This is a nice community that makes you feel like you are a valued memeber.\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Review content.\"\n },\n \"RecommendToFriend\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Do you recommend this property to any friend?.\"\n },\n \"AuthorizeToShowOnCorporateSites\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value. Child element of Testimonial. Do you authorize property manager to dis play your testimonial on its portal and affiliate websites?.\"\n },\n \"RatingTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value. The following are valid testimonial rating types ids: 1 Parking 2 No ise 3 Grounds 5 Construction 6 Maintenance 7 Staff 8 Overall\"\n },\n \"Rating\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3\",\n \"description\": \"This is a required field. This field accepts single value. Child element of TestimonialRatings. Rating value.\"\n },\n \"AutoApproveForProspectPortal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on prospect portal.\"\n },\n \"AutoApproveForVacancy\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of Testimonial. Set to 1 if want to auto approve the tes timonial and post it on vacany.com\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"TestimonialDatetime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYY\",\n \"description\": \"This is an optional field. This field accepts single value. Testimonial submission date.\"\n },\n \"TransmissionVendorId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Transmission Vendor Id\"\n },\n \"Email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"br@mycomp.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email will be required if CustomerId is not provided. Child element of Testimonial. Email of a person who submitted the testimonial.\"\n },\n \"PropertyResponse\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Property Response...\",\n \"description\": \"This is an optional field. This field accepts single value. The property`s response to the review.\"\n }\n },\n \"required\": [\n \"TestimonialTypeId\",\n \"Title\",\n \"Review\",\n \"AuthorizeToShowOnCorporateSites\",\n \"RatingTypeId\",\n \"Rating\",\n \"PropertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateCustomers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 31025784,\n \"description\": \"This is a required field. This field accepts single value. This should be the unique ID of the customer to be updated and they mu st be in at least an applicant or higher lease status.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Ephraim\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Kassulke\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"namePrefix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Ms.\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"middleName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Emie\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maidenName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MaidenName\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"nameSuffix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"III\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Carson87@example.org\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY/MM/DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"taxNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 9,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"taxNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"844-588-2283\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"3927 Austen Groves\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"43853 Thompson Rapids\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"085 Weber Streets\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Streichtown\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"country\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"US\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"state\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CA\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 22222,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPrimary\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1231231234\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"companyIdentificationTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 5587,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"identificationValue\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"688\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"idExpirationDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY/MM/DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"StateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"GN\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"countryCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Guinea\",\n \"description\": \"This is an optional field. This field accepts single value. \\\"countryCode\\\" is accepted under \\\"companyIdentificationValue\\\" node.\"\n }\n },\n \"required\": [\n \"id\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateCustomerTestimonials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"transmissionVendorId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"testimonialId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPublished\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"transmissionVendorId\",\n \"isPublished\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updatePropertyResponse\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"testimonialId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"reviewResponse\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \"Test Review Response\"\n },\n \"isPublish\": {\n \"type\": \"boolean\",\n \"example\": \"1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"testimonialId\",\n \"isPublish\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCustomers\": {\n \"$ref\": \"#/components/examples/getCustomersRequest\"\n },\n \"getCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/getCustomerTestimonialsRequest\"\n },\n \"getTestimonialPickLists\": {\n \"$ref\": \"#/components/examples/getTestimonialPickListsRequest\"\n },\n \"searchCustomers\": {\n \"$ref\": \"#/components/examples/searchCustomersRequest\"\n },\n \"sendCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/sendCustomerTestimonialsRequest\"\n },\n \"updateCustomers\": {\n \"$ref\": \"#/components/examples/updateCustomersRequest\"\n },\n \"updateCustomerTestimonials\": {\n \"$ref\": \"#/components/examples/updateCustomerTestimonialsRequest\"\n },\n \"updatePropertyResponse\": {\n \"$ref\": \"#/components/examples/updatePropertyResponseRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateLeadEntry.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateLeadEntry.json new file mode 100644 index 00000000..a8ed5300 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreateLeadEntry.json @@ -0,0 +1,253 @@ +{ + "name": "CreateLeadEntry", + "fully_qualified_name": "EntrataApi.CreateLeadEntry@0.1.0", + "description": "Create a new lead entry in the Entrata system.\n\nUse this tool to submit a new lead's information to the Entrata system for a specified organization. This action is suitable when new leads need to be captured and stored in the system for follow-up or record-keeping.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain associated with the client organization in Entrata.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "lead_information", + "required": true, + "description": "An array of JSON objects representing the new lead's details to be added. Each JSON object should contain properties relevant to the lead, such as name, contact information, and any other required fields.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number for paginated responses. Use this to specify which page to retrieve when dealing with paginated data.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "number_of_items_per_page", + "required": false, + "description": "Specify the number of items to be returned per page in the paginated response.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Flag to include pagination links in the response body. Use '1' to enable and '0' to disable.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leads", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "number_of_items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "lead_information", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leadId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts combination of Firstname & Lastname to filter leads depending on inputs.\"\n },\n \"telephone\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234567890\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts Primary/Work/Home/Mobile number as input.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"example@email.com\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leadStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"psProductIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"includeDemographics\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY. Conditional Mandatory. This node should return the application on the mentioned date range.\"\n },\n \"createdOnDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.\"\n },\n \"createdOnDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format MM/DD/YYYY. This node should return the actual application crea ted on the mentioned date range.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. In the response, events will not be returned unless we pass specific E vent Type Id(s) in this node. Accepts comma-separated values with lim it 5.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeadEvents\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required, If eventTypeIds and eventDates are not passed then applicationId is required.\"\n },\n \"eventTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"applyQuote\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"generateQuotes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This will fetch quotes associated with the property.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.\"\n },\n \"adjustmentsAndProvisionIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123,234\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. adjustmentsAndProvisionIds\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,4533\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. propertyIds\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leadId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Application Id referring PSI system\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts a combination of Firstname & Lastname. If either of one is provided, leads matching with given input will be returned in the response.\"\n },\n \"telephone\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234567890\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts Primary/Mobile/Home/Work number of prospect in any format\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"example@email.com\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts email address of prospect.\"\n },\n \"leadStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. leadStatusIds - comma seperated\"\n },\n \"psProductIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. psProductIds - comma seperated\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"10,15\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. eventTypeIds - comma seperated\"\n },\n \"sendUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. sendUnitSpaces\"\n },\n \"fromDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. This is an conditionally mandatory field.If name or telephone or email or leadId is provided then fromDate is not required.\"\n },\n \"toDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. This is an conditionally mandatory field. If name or telephone or emai l or leadId is provided then toDate is not required.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. eventDateFrom\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. eventDateTo\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getQuotes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This will fetch quotes associated with the property.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This will fetch quotes associated with the property and the application.\"\n },\n \"leaseStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Format: MM/DD/YYYY, YYYY-MM-DD, MM/DD/YY\"\n },\n \"quoteId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeExpiredQuotes\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If pass value \\\"1\\\" then expired quotes should get returned in the response.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is a required field. This field accepts a single integer value fo r Property ID.\"\n },\n \"subtypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \\\"Appointment\\\":- 453:\\\"Leasing Appointments\\\", 560:\\\"Self-Guided Tour\\\", 454:\\\" Tour\\\", 525:\\\"Virtual Tour\\\"\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendMitsLeads\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"doNotSendConfirmationEmail\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Allows restricting the guest card confirmation emails to prospect/prop erty if set to 1.\"\n },\n \"isWaitList\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. When sent as 1, Units will be listed in waitlist.\"\n },\n \"LastUpdateDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYYT HH:MM:SS\",\n \"description\": \"This is a required field. This field accepts single value. LastUpdateDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. ApplicationId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"applicationId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts the property Id value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. Accept the Application_Id(Lead_Id), can be obtained from getLeads API.\"\n },\n \"eventId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Accepts the value for Event Id.\"\n },\n \"typeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. Accepts the Event Type Id value under this node.\"\n },\n \"eventResultId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Value for event result id should be fetched from getLeadPickLists API. Depending on the Events this node should be considered mandatory.\"\n },\n \"subtypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node supports following subtypeId values, under event type \\\"Appointment\\\":- 453:\\\"Leasing Appointments\\\", 560:\\\"Self-Guided Tour\\\", 454:\\\" Tour\\\", 525:\\\"Virtual Tour\\\". And under event type \\\"Tour\\\":- 524:\\\"Self-Gui ded Tour\\\"\"\n },\n \"date\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the event date. During cloning, all the lead event dates will be set to the current date.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"applicationId\",\n \"typeId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getLeads\": {\n \"$ref\": \"#/components/examples/getLeadsRequest\"\n },\n \"getLeadEvents\": {\n \"$ref\": \"#/components/examples/getLeadEventsRequest\"\n },\n \"applyQuote\": {\n \"$ref\": \"#/components/examples/applyQuoteRequest\"\n },\n \"generateQuotes\": {\n \"$ref\": \"#/components/examples/generateQuotesRequest\"\n },\n \"getLeadPickLists_r1\": {\n \"$ref\": \"#/components/examples/getLeadPickListsRequest_r1\"\n },\n \"getLeadPickLists_r2\": {\n \"$ref\": \"#/components/examples/getLeadPickListsRequest_r2\"\n },\n \"getMitsLeads\": {\n \"$ref\": \"#/components/examples/getMitsLeadsRequest\"\n },\n \"getQuotes\": {\n \"$ref\": \"#/components/examples/getQuotesRequest\"\n },\n \"sendLeads\": {\n \"$ref\": \"#/components/examples/sendLeadsRequest\"\n },\n \"sendMitsLeads\": {\n \"$ref\": \"#/components/examples/sendMitsLeadsRequest\"\n },\n \"updateLeads\": {\n \"$ref\": \"#/components/examples/updateLeadsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreatePropertyUnit.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreatePropertyUnit.json new file mode 100644 index 00000000..a86f64e2 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/CreatePropertyUnit.json @@ -0,0 +1,148 @@ +{ + "name": "CreatePropertyUnit", + "fully_qualified_name": "EntrataApi.CreatePropertyUnit@0.1.0", + "description": "Add a new property unit to the system.\n\nThis tool creates a new property unit within the specified organization. It should be called when there is a need to register or add information about a new unit in a property management system.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization where the property unit should be added.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "property_unit_details", + "required": true, + "description": "A JSON array containing the details of the property unit to be created, such as unit identifier, size, and location.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/propertyunits", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "property_unit_details", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"unitNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Unit Number\"\n },\n \"chargeCodeTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. PSI Property Identification number\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for getting available units only\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing preferences on result.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.\"\n },\n \"showUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Unit Spaces on result.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If enabled then the Entrata setting \\\"Max Available Units per Floor P lan\\\" will be honored and the available units returned will be reduced. Also requires using the availableUnitsOnly parameter as true (1).\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r3\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property ID for getting Specials\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response\",\n \"example\": \"15\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getSpecials\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r4\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. Property ID for getting Specials\",\n \"example\": \"1234567\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getUnitsAvailabilityAndPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Floorplan Id\"\n },\n \"unitTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Unit Type Id\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Property Unit Id\"\n },\n \"availableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units\"\n },\n \"unavailableUnitsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response.\"\n },\n \"skipPricing\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)\"\n },\n \"showChildProperties\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.\"\n },\n \"includeDisabledUnits\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.\"\n },\n \"showUnitSpaces\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. showUnitSpaces\"\n },\n \"useSpaceConfiguration\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration.\"\n },\n \"allowLeaseExpirationOverride\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If \\\"1\\\" is sent then we should override any lease expiration limits aff ecting available units returned/ If \\\"0\\\" or node is missing then do cur rent default functionality\"\n },\n \"moveInStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing.\"\n },\n \"moveInEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getUnitTypes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This field accepts a single integer value for Property ID\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value. This accepts name of the amenity\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value. This accepts description of the amenity.\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0 ,whether amenity needs to be published or not .\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This accepts unit space id for the amenity.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPropertyUnits\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 20,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the unitNumber.\"\n },\n \"unitPrefix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CC\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the unitNunber prefix\"\n },\n \"unitSuffix\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"BB\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the unitNumber suffix\"\n },\n \"spaceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the spaceNumber on added unit.\"\n },\n \"maxOccupants\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the maxOccupants of the property units\"\n },\n \"maxPets\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 11,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the maxPets of the property units\"\n },\n \"numberOfBedRooms\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the beds number of the property units\"\n },\n \"numberOfBathRooms\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This node should accepts the bathRooms of the property units\"\n },\n \"squareFeet\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2000,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the squareFeet of the property units\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Testing property\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the note added for the property units\"\n },\n \"unitGenderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the Id of the gender. The unitGenderId should be get from getPropertyPickLists.\"\n }\n },\n \"required\": [\n \"unitNumber\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendSpecialGroup\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"specialGroup\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Property ID for insert Specials\",\n \"example\": \"123456\"\n },\n \"specialGroup\": {\n \"type\": \"object\",\n \"required\": [\n \"specialGroupName\"\n ],\n \"properties\": {\n \"specialGroupName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This accepts the Special Group name.\",\n \"example\": \"Test Insert Special API\"\n },\n \"internalDescription\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Internal description not visible to residents.\",\n \"example\": \"Internal Desc\"\n },\n \"floorPlanIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated floor plan IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitTypeIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated unit type IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitSpaceIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated unit space IDs.\",\n \"example\": \"1,2,3\"\n },\n \"isActive\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special is eligible to be used.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"isWebVisible\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special will be shown in advertising.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Date special will be advertised from.\",\n \"example\": \"04/01/2025\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Date special will be advertised to.\",\n \"example\": \"04/30/2025\"\n },\n \"hideEndDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special end date will be advertised.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"marketingDescription\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Description shown to residents.\",\n \"example\": \"Marketing Desc\"\n },\n \"termsAndConditions\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Terms and conditions for specials.\",\n \"example\": \"Terms & conditions\"\n },\n \"isAdvertised\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Determines if special is manual only.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start of move-in date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End of move-in date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateFrom\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start of renewal date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateTo\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End of renewal date range.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"limitQuantity\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Allows setting limits on specials.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"quantityBudgeted\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Limits number of specials given.\",\n \"example\": \"10\"\n },\n \"couponCode\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Promotional code required during application.\",\n \"example\": \"PROMO123\"\n },\n \"leadSourceId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Source of promo code.\",\n \"example\": \"56789\"\n },\n \"incentiveLimit\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Number of incentives resident receives.\",\n \"example\": \"1\"\n },\n \"isSelectable\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. If specials incentive count matches limit.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"leaseTermDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseTermId\",\n \"leaseStartWindowId\"\n ],\n \"properties\": {\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease term identifier.\",\n \"example\": \"12345\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease start window identifier.\",\n \"example\": \"456789\"\n }\n }\n }\n },\n \"specialRecipientDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"specialRecipientIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated recipient IDs.\",\n \"example\": \"2,3\"\n },\n \"specialTriggerTypeIdProspect\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Special trigger type for prospects.\",\n \"example\": \"11\"\n },\n \"specialTriggerTypeIdRenewal\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Special trigger type for renewals.\",\n \"example\": \"22\"\n }\n }\n },\n \"specialGroupSpaceConfigurationIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Comma separated space configuration IDs.\",\n \"example\": \"2,3\"\n },\n \"specials\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"specialTypeId\",\n \"specialName\"\n ],\n \"properties\": {\n \"specialTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Special type identifier.\",\n \"example\": \"1\"\n },\n \"specialName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Name of the special.\",\n \"example\": \"conccession1\"\n },\n \"giftValue\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Value of gift type special.\",\n \"example\": \"0.00\"\n },\n \"rates\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseTermId\",\n \"leaseTermMonth\",\n \"leaseStartWindowId\",\n \"arFormulaId\",\n \"rateAmount\",\n \"showInEntrata\",\n \"showOnWebsite\"\n ],\n \"properties\": {\n \"arCodeId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR code identifier.\",\n \"example\": \"123456\"\n },\n \"arTriggerId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR trigger identifier.\",\n \"example\": \"111\"\n },\n \"arCodeTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. AR code type identifier.\",\n \"example\": \"2\"\n },\n \"customerRelationshipId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Customer relationship identifier.\",\n \"example\": \"\"\n },\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease term identifier.\",\n \"example\": \"55555\"\n },\n \"leaseTermMonth\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Integer representation of lease term.\",\n \"example\": \"1\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Lease start window identifier.\",\n \"example\": \"999999\"\n },\n \"windowStartDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Start date for lease window.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"windowEndDate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. End date for lease window.\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"arFormulaId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. AR formula identifier.\",\n \"example\": \"1\"\n },\n \"rateIntervalStart\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Month when special starts.\",\n \"example\": \"\"\n },\n \"rateAmount\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Rate amount.\",\n \"example\": \"100.00\"\n },\n \"rateIncreaseIncrement\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Increment for percent base formula.\",\n \"example\": \"\"\n },\n \"arFormulaReferenceId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Additional formula information.\",\n \"example\": \"0\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. Space configuration identifier.\",\n \"example\": \"2\"\n },\n \"showInEntrata\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Display within Entrata.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"showOnWebsite\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. Display on website.\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the amenity id which needs to be updated\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"property amenity\",\n \"description\": \"This is a required field. This field accepts single value. This node should accept the amenity name.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test amenity\",\n \"description\": \"This is an optional field. This field accepts single value. This node should accept the amenity description.\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isFeatured\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showOnQuote\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node indicates if the amenities are visible on quotes or not. Th is flag is supported only for property and unit space amenities.\"\n },\n \"hideDescription\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"videoUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultAmenityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"amenityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateSpecialGroup\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"specialGroup\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. Property ID for updating specials\",\n \"example\": \"123456\"\n },\n \"specialGroup\": {\n \"type\": \"object\",\n \"required\": [\n \"specialGroupId\",\n \"specialGroupName\"\n ],\n \"properties\": {\n \"specialGroupId\": {\n \"type\": \"string\",\n \"description\": \"Required. The ID of the special group to update\",\n \"example\": \"55555\"\n },\n \"specialGroupName\": {\n \"type\": \"string\",\n \"description\": \"Required. Name of the special group\",\n \"example\": \"Test Update Special API\"\n },\n \"internalDescription\": {\n \"type\": \"string\",\n \"description\": \"Optional. Internal description not visible to residents\",\n \"example\": \"Internal Desc\"\n },\n \"floorPlanIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated floor plan IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitTypeIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated unit type IDs.\",\n \"example\": \"1,2,3\"\n },\n \"unitSpaceIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma separated unit space IDs.\",\n \"example\": \"1,2,3\"\n },\n \"isActive\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special is eligible to be used\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"isWebVisible\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special will be shown in advertising\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date special will be advertised from\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date special will be advertised to\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"hideEndDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special end date will be advertised\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"marketingDescription\": {\n \"type\": \"string\",\n \"description\": \"Optional. Description shown to residents\",\n \"example\": \"Marketing Desc\"\n },\n \"termsAndConditions\": {\n \"type\": \"string\",\n \"description\": \"Optional. Terms and conditions for the specials\",\n \"example\": \"Terms & conditions\"\n },\n \"isAdvertised\": {\n \"type\": \"string\",\n \"description\": \"Optional. Determines if special is manual only\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start of move-in date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"description\": \"Optional. End of move-in date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateFrom\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start of renewal date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"renewalStartDateTo\": {\n \"type\": \"string\",\n \"description\": \"Optional. End of renewal date range\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"limitQuantity\": {\n \"type\": \"string\",\n \"description\": \"Optional. Allows setting limits on specials\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"quantityBudgeted\": {\n \"type\": \"string\",\n \"description\": \"Optional. Number of specials to be given\",\n \"example\": \"12\"\n },\n \"couponCode\": {\n \"type\": \"string\",\n \"description\": \"Optional. Promotional code for special\",\n \"example\": \"PROMO123\"\n },\n \"leadSourceId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Source ID for promo code\",\n \"example\": \"123456\"\n },\n \"incentiveLimit\": {\n \"type\": \"string\",\n \"description\": \"Optional. Number of incentives resident can receive\",\n \"example\": \"1\"\n },\n \"isSelectable\": {\n \"type\": \"string\",\n \"description\": \"Optional. If specials incentive count matches limit\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"0\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"description\": \"Optional. pass this field if only wants to delete the special group. otherwise do not pass this field.\",\n \"example\": 1\n },\n \"leaseTermDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"leaseTermId\": {\n \"type\": \"string\",\n \"example\": \"55555\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"example\": \"456789\"\n }\n }\n }\n },\n \"specialRecipientDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"specialRecipientIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma-separated recipient IDs\",\n \"example\": \"2,3\"\n },\n \"specialTriggerTypeIdProspect\": {\n \"type\": \"string\",\n \"description\": \"Optional. Prospect trigger type ID\",\n \"example\": \"11\"\n },\n \"specialTriggerTypeIdRenewal\": {\n \"type\": \"string\",\n \"description\": \"Optional. Renewal trigger type ID\",\n \"example\": \"27\"\n }\n }\n },\n \"specialGroupSpaceConfigurationIds\": {\n \"type\": \"string\",\n \"description\": \"Optional. Comma-separated space configuration IDs\",\n \"example\": \"2,3\"\n },\n \"specials\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"specialId\",\n \"specialTypeId\",\n \"specialName\"\n ],\n \"properties\": {\n \"specialId\": {\n \"type\": \"string\",\n \"description\": \"Required. ID of the special\",\n \"example\": \"1234567\"\n },\n \"specialTypeId\": {\n \"type\": \"string\",\n \"description\": \"Required. Type ID of the special\",\n \"example\": \"1\"\n },\n \"specialName\": {\n \"type\": \"string\",\n \"description\": \"Required. Name of the special\",\n \"example\": \"conccession1\"\n },\n \"giftValue\": {\n \"type\": \"string\",\n \"description\": \"Optional. Value for gift type specials\",\n \"example\": \"0.00\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"description\": \"Optional. pass this field if only wants to delete the special. otherwise do not pass this field.\",\n \"example\": 1\n },\n \"rates\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"arCodeId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR code identifier\",\n \"example\": \"444444\"\n },\n \"arTriggerId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR trigger identifier\",\n \"example\": \"201\"\n },\n \"arCodeTypeId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR code type identifier\",\n \"example\": \"2\"\n },\n \"customerRelationshipId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Customer relationship identifier\",\n \"example\": \"0\"\n },\n \"leaseTermId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Lease term identifier\",\n \"example\": \"55555\"\n },\n \"leaseTermMonth\": {\n \"type\": \"string\",\n \"description\": \"Optional. Integer representation of lease term\",\n \"example\": \"6\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Lease start window identifier\",\n \"example\": \"456789\"\n },\n \"windowStartDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Start date for lease window\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"windowEndDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. End date for lease window\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"effectiveDate\": {\n \"type\": \"string\",\n \"description\": \"Optional. Date rate becomes effective\",\n \"example\": \"MM/DD/YYYY\"\n },\n \"arFormulaId\": {\n \"type\": \"string\",\n \"description\": \"Optional. AR formula identifier\",\n \"example\": \"1\"\n },\n \"rateIntervalStart\": {\n \"type\": \"string\",\n \"description\": \"Optional. Month when special starts\",\n \"example\": \"\"\n },\n \"rateAmount\": {\n \"type\": \"string\",\n \"description\": \"Optional. Rate amount\",\n \"example\": \"40.00\"\n },\n \"rateIncreaseIncrement\": {\n \"type\": \"string\",\n \"description\": \"Optional. Increment for percent base formula\",\n \"example\": \"\"\n },\n \"arFormulaReferenceId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Additional formula information\",\n \"example\": \"\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"string\",\n \"description\": \"Optional. Space configuration identifier\",\n \"example\": \"2\"\n },\n \"showInEntrata\": {\n \"type\": \"string\",\n \"description\": \"Optional. Display within Entrata\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n },\n \"showOnWebsite\": {\n \"type\": \"string\",\n \"description\": \"Optional. Display on website\",\n \"enum\": [\n \"0\",\n \"1\"\n ],\n \"example\": \"1\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAmenities\": {\n \"$ref\": \"#/components/examples/getAmenitiesRequest\"\n },\n \"getMitsPropertyUnits\": {\n \"$ref\": \"#/components/examples/getMitsPropertyUnitsRequest\"\n },\n \"getPropertyUnits\": {\n \"$ref\": \"#/components/examples/getPropertyUnitsRequest\"\n },\n \"getSpecials_r1\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r1\"\n },\n \"getSpecials_r2\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r2\"\n },\n \"getSpecials_r3\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r3\"\n },\n \"getSpecials_r4\": {\n \"$ref\": \"#/components/examples/getSpecialsRequest_r4\"\n },\n \"getUnitsAvailabilityAndPricing\": {\n \"$ref\": \"#/components/examples/getUnitsAvailabilityAndPricingRequest\"\n },\n \"getUnitTypes\": {\n \"$ref\": \"#/components/examples/getUnitTypesRequest\"\n },\n \"sendAmenities\": {\n \"$ref\": \"#/components/examples/sendAmenitiesRequest\"\n },\n \"sendPropertyUnits\": {\n \"$ref\": \"#/components/examples/sendPropertyUnitsRequest\"\n },\n \"sendSpecialGroup\": {\n \"$ref\": \"#/components/examples/sendSpecialGroupRequest\"\n },\n \"updateAmenities\": {\n \"$ref\": \"#/components/examples/updateAmenitiesRequest\"\n },\n \"updateSpecialGroup\": {\n \"$ref\": \"#/components/examples/updateSpecialGroupRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetAccessibleClients.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetAccessibleClients.json new file mode 100644 index 00000000..20613d89 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetAccessibleClients.json @@ -0,0 +1,148 @@ +{ + "name": "GetAccessibleClients", + "fully_qualified_name": "EntrataApi.GetAccessibleClients@0.1.0", + "description": "Retrieve accessible client information for a given organization.\n\nUse this tool to get information about clients accessible to an organization. Call it when you need to retrieve details about clients linked to the organization using the `rsync` value for `orgs`.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "organization_subdomain", + "required": true, + "description": "The subdomain of the client organization. Use 'rsync' as the value to access relevant client information.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "request_body_data", + "required": true, + "description": "An array of JSON objects to include in the request body for additional data required by the API.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/appinfo", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "organization_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "request_body_data", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAccessibleClients\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAccessibleServices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAccessibleClients\": {\n \"$ref\": \"#/components/examples/getAccessibleClientsRequest\"\n },\n \"getAccessibleServices\": {\n \"$ref\": \"#/components/examples/getAccessibleServicesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArCodes.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArCodes.json new file mode 100644 index 00000000..abde6859 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArCodes.json @@ -0,0 +1,292 @@ +{ + "name": "GetArCodes", + "fully_qualified_name": "EntrataApi.GetArCodes@0.1.0", + "description": "Retrieve AR codes for a management company.\n\nFetches all AR codes associated with a specific management company, useful for property management and financial operations.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "Client subdomain, used to specify the management company.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "authentication_type", + "required": true, + "description": "Specify the authentication type, expected value is 'apikey'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "auth.type" + }, + { + "name": "ar_codes_method_name", + "required": true, + "description": "Must be set to 'getArCodes' to specify the API method for retrieving AR codes.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArCodes" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.name" + }, + { + "name": "response_identifier", + "required": false, + "description": "An arbitrary string value used to relate the request with the response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestId" + }, + { + "name": "api_method_version", + "required": false, + "description": "Specifies the version of the API method to use. Supported value is 'r1'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.version" + }, + { + "name": "property_id", + "required": false, + "description": "Optional. Provide a valid property ID for which AR codes are required.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid." + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.propertyId" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/arcodes", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "auth.type", + "tool_parameter_name": "authentication_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestId", + "tool_parameter_name": "response_identifier", + "description": "an arbitary value to relate with response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.name", + "tool_parameter_name": "ar_codes_method_name", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArCodes" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.version", + "tool_parameter_name": "api_method_version", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.propertyId", + "tool_parameter_name": "property_id", + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. Provide a valid propertyid." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Returns all AR codes for a specified management company.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArCodes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid propertyid.\"\n }\n }\n }\n }\n }\n }\n },\n \"examples\": {\n \"getArCodes\": {\n \"$ref\": \"#/components/examples/getArCodesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArTransactions.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArTransactions.json new file mode 100644 index 00000000..05cfbbe2 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetArTransactions.json @@ -0,0 +1,253 @@ +{ + "name": "GetArTransactions", + "fully_qualified_name": "EntrataApi.GetArTransactions@0.1.0", + "description": "Fetches accounts receivable transactions for an organization.\n\nUse this tool to retrieve accounts receivable transactions by providing the organization identifier.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The unique subdomain identifying the client organization for which the accounts receivable transactions are being fetched.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "ar_transactions_request_body", + "required": true, + "description": "Specify the array of transaction-related API request data in JSON format.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arTansactions related APIs" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number to retrieve for paginated responses.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "Specifies the number of items returned in the response for each page of pagination.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response body, 0 to exclude.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/artransactions", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "ar_transactions_request_body", + "description": "arTansactions related APIs", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arTansactions related APIs" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arTansactions related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArInvoices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. leaseIds\"\n },\n \"arInvoiceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value. arInvoiceId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From date.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. To date\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. leaseIds\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.\"\n },\n \"transactionTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Type of transactions on lease. Possible values 1-12\"\n },\n \"arCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. arCodeIds\"\n },\n \"showFullLedger\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.\"\n },\n \"includeReversals\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \\\"showFullLedger\\\" must be t rue(1).\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will return transactions starting from the provided date.\"\n },\n \"transactionToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This will return transaction till the provided date.\"\n },\n \"ledgerIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. These ids we will get from getFinancialPickList.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. PropertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. leaseId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If provided API returns data as per leaseStatusTypeIds, otherwise if N ot passed or passed as NULL/blank, returns all leases except canceled.\"\n },\n \"arCodeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. arCodeIds\"\n },\n \"showFullLedger\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull full ledger history. By default i t only returns open ledger items.\"\n },\n \"includeReversals\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter return reversal transactions in API response. Also to i nclude the reversal transaction in response \\\"showFullLedger\\\" must be true(1).\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This is parameter allows you to pull ledger history as displayed under resident portal\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to get the Other income leases in the response.\"\n },\n \"includePaymentsOnly\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This parameter is used to retrieve payments transactions in the response\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionFromDate\"\n },\n \"transactionToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionToDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseArTransactionReversals\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"TransactionId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. This ID represents the \\\"reference_id\\\" provided in the sendLeaseArTrans actions response or the \\\"TransactionID\\\" provided in getMitsLeaseArTran sactions.\"\n },\n \"TransactionAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"100.50\",\n \"description\": \"This is a required field. This field accepts single value. The amount for which the original charge was posted. If the Original c harge was a negative charge, a credit, please send this amount as nega tive as well.\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"ReverseDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is an optional parameter. If a date is sent in this parameter, we will set this value as postDate for the reversed transactions.\"\n },\n \"Description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Description\",\n \"description\": \"This is an optional field. This field accepts single value. This is an optional parameter. We highly recommend that you provide a detailed description of the reason for which the charged is reversed.\"\n }\n },\n \"required\": [\n \"TransactionId\",\n \"TransactionAmount\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseArTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"transactionId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Unique Transaction ID of client system\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"2342\",\n \"description\": \"This is a required field. This field accepts single value. Lease ID\"\n },\n \"arCodeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 11,\n \"description\": \"This is a required field. This field accepts single value. Ar Code ID\"\n },\n \"transactionAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"1000.00\",\n \"description\": \"This is a required field. This field accepts single value. Transaction Amount\"\n },\n \"transactionDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. transactionDate\"\n },\n \"arPostMonth\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Charge Posting Month\"\n }\n },\n \"required\": [\n \"transactionId\",\n \"leaseId\",\n \"arCodeId\",\n \"transactionAmount\",\n \"transactionDate\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getArInvoices\": {\n \"$ref\": \"#/components/examples/getArInvoicesRequest\"\n },\n \"getLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/getLeaseArTransactionsRequest\"\n },\n \"getMitsLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/getMitsLeaseArTransactionsRequest\"\n },\n \"sendLeaseArTransactionReversals\": {\n \"$ref\": \"#/components/examples/sendLeaseArTransactionReversalsRequest\"\n },\n \"sendLeaseArTransactions\": {\n \"$ref\": \"#/components/examples/sendLeaseArTransactionsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetFinancialBudgets.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetFinancialBudgets.json new file mode 100644 index 00000000..0895a24d --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetFinancialBudgets.json @@ -0,0 +1,148 @@ +{ + "name": "GetFinancialBudgets", + "fully_qualified_name": "EntrataApi.GetFinancialBudgets@0.1.0", + "description": "Fetch financial budgets for organizations.\n\nUse this tool to retrieve financial budget data for specified organizations through the Entrata service. Supports pagination for large data sets.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization for which to fetch financial budgets.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "ar_payment_requests", + "required": true, + "description": "A list of JSON objects representing AR payment related data for processing. Each JSON object should contain details as required by the specific AR payment APIs.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/financial", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "ar_payment_requests", + "description": "arPayment related APIs", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getApCodes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glAccountIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"apCodeTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Currently supporting only job cost (3)\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBankAccounts\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"bankAccountTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts single value. Bank Account Type Identification Number\"\n },\n \"isCreditCardAccount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBudgetActuals\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"123456\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"budgetId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postMonthFrom\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. MM/YYYY\"\n },\n \"postMonthTo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. MM/YYYY\"\n },\n \"glBookTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. glBookTypeIds\"\n },\n \"budgetStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. budgetStatusTypeId\"\n },\n \"accountingMethod\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Cash\",\n \"description\": \"This is a required field. This field accepts single value. accountingMethod\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"glTreeId\",\n \"budgetId\",\n \"postMonthFrom\",\n \"postMonthTo\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. propertyIds\"\n },\n \"budgetIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. budgetIds\"\n },\n \"budgetStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1,2,4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. budgetStatusTypeIds\"\n },\n \"fiscalYears\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"YYYY,YYYY\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. fiscalYears\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. Property Id\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTransactions\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,112233\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n },\n \"glAccountFrom\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glAccountTo\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postMonthFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If no post month is provided, then the default post month of the prope rty will be used. If multiple properties are passed then the post mon th of any property would be used randomly.\"\n },\n \"postMonthTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isCashBook\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isDetailed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"glBookTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1,2,3\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"transactionDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the actual system created date of the transaction.\"\n },\n \"transactionDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This is the actual system created date of the transaction.\"\n },\n \"excludeApTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag will filter off any ap transactions from the response.\"\n },\n \"excludeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag will filter off any Ar Transactions from the response.\"\n },\n \"excludeExportedTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If passed as true (1) the API will not return any transaction that was previously marked exported using the markGlTransactionsExported API. Transaction exported under a different export format in Entrata wil l still qualify to be returned until specifically marked exported over the markGlTransactionsExported API.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTrees\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Property Id\"\n },\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Id\"\n },\n \"glBranchId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Branch Id\"\n },\n \"glGroupTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Group Type Id\"\n },\n \"glTreeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Type Id\"\n },\n \"accountNumbers\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getGlTrees\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glTreeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Id\"\n },\n \"glBranchId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Gl Branch Id\"\n },\n \"glGroupTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Group Type Id\"\n },\n \"glTreeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Gl Tree Type Id\"\n },\n \"accountNumbers\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobCategories\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glAccountIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This is the glAccount Id associated with job category\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobCostBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.\"\n },\n \"jobIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id.\"\n },\n \"jobStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept job status Id.\"\n },\n \"apCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept apCode Id\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. This node should accept job Phase Id\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getJobs\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node should accept the propertyId.\"\n },\n \"jobCategoryIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"6\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept the jobCategoryIds\"\n },\n \"jobStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"4\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. This node should accept the job statusIds.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTransactionTagLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"markGlTransactionsExported\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"glDetailId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"[\\\"123456\\\",\\\"67890\\\"]\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"glDetailId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"budgetName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"budgets name 1\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"fiscalYear\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"fiscalStartMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts fiscal start month in MM/YYYY format.\"\n },\n \"fiscalEndMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts fiscal end month in MM/YYYY format.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value. This node accepts GL account id.\"\n },\n \"budgetMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"10.00\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"budgetName\",\n \"fiscalYear\",\n \"fiscalStartMonth\",\n \"fiscalEndMonth\",\n \"id\",\n \"budgetMonth\",\n \"amount\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendJournalEntries\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"glHeaderTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. If the value for glHeaderTypeId is not provided take default as Standard\"\n },\n \"reference\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Enter Journal Entries\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"accountingMethod\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"cash\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided, the accounting method of \\\"Both\\\" is used.\"\n },\n \"glBookId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided then the default date will be the current date. The pa st date is acceptable\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If not provided then the default will be the current post month. Past post month is acceptable\"\n },\n \"isReverse\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. By default value will be false.\"\n },\n \"reversePostMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required. Based on \\\"isReverse\\\" flag.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"notes\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultPropertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultPropertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"defaultGlDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"memo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Memo\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"debitAmount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"100.00\",\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required. If the Credit amount is passed then this should be 0.\"\n },\n \"creditAmount\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"10.00\",\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required. If Debit amount is passed this should be 0\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"glDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"defaultJobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1233,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"defaultApContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 23,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 23,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"glAccountId\",\n \"glBookId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateBudgets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"month\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts budget month in MM/YYYY format.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"122.88\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"id\",\n \"month\",\n \"amount\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getApCodes\": {\n \"$ref\": \"#/components/examples/getApCodesRequest\"\n },\n \"getBankAccounts\": {\n \"$ref\": \"#/components/examples/getBankAccountsRequest\"\n },\n \"getBudgetActuals\": {\n \"$ref\": \"#/components/examples/getBudgetActualsRequest\"\n },\n \"getBudgets\": {\n \"$ref\": \"#/components/examples/getBudgetsRequest\"\n },\n \"getFinancialPickListRequest_r1\": {\n \"$ref\": \"#/components/examples/getFinancialPickListRequest_r1\"\n },\n \"getFinancialPickListRequest_r2\": {\n \"$ref\": \"#/components/examples/getFinancialPickListRequest_r2\"\n },\n \"getGlTransactionsRequest\": {\n \"$ref\": \"#/components/examples/getGlTransactionsRequest\"\n },\n \"getGlTreesRequest_r1\": {\n \"$ref\": \"#/components/examples/getGlTreesRequest_r1\"\n },\n \"getGlTreesRequest_r2\": {\n \"$ref\": \"#/components/examples/getGlTreesRequest_r2\"\n },\n \"getJobCategoriesRequest\": {\n \"$ref\": \"#/components/examples/getJobCategoriesRequest\"\n },\n \"getJobCostBudgetsRequest\": {\n \"$ref\": \"#/components/examples/getJobCostBudgetsRequest\"\n },\n \"getJobsRequest\": {\n \"$ref\": \"#/components/examples/getJobsRequest\"\n },\n \"getTransactionTagListsRequest\": {\n \"$ref\": \"#/components/examples/getTransactionTagListsRequest\"\n },\n \"markGlTransactionsExported\": {\n \"$ref\": \"#/components/examples/markGlTransactionsExportedRequest\"\n },\n \"sendBudgets\": {\n \"$ref\": \"#/components/examples/sendBudgetsRequest\"\n },\n \"sendJournalEntries\": {\n \"$ref\": \"#/components/examples/sendJournalEntriesRequest\"\n },\n \"updateBudgets\": {\n \"$ref\": \"#/components/examples/updateBudgetsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetLeaseDetails.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetLeaseDetails.json new file mode 100644 index 00000000..0e231059 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetLeaseDetails.json @@ -0,0 +1,253 @@ +{ + "name": "GetLeaseDetails", + "fully_qualified_name": "EntrataApi.GetLeaseDetails@0.1.0", + "description": "Retrieve detailed information about leases.\n\nUse this tool to get detailed information about leases, including lease activities, details, documents, parcels, and more. It supports pagination for handling large datasets.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain representing the client organization. Required to specify which client's data to retrieve.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "lease_documents_upload", + "required": true, + "description": "Upload lease documents using a form file upload (multipart/form-data).", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number to retrieve in a paginated response. Use this to navigate through pages of lease details.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "The number of items to return per page in the response. Supports paginated data retrieval.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response. Use 0 to exclude them. This helps manage paginated data effectively.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leases", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "lease_documents_upload", + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "## Note: \n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\n" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"## Note: \\n **sendLeaseDocuments** API accepts files as a form file upload, Please select the option `multipart/form-data` from the Request body dropdown to see further details.\\n To test the sendLeaseDocuments API or see the additional details, please click the `Try it out` button.\\n\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"cancelLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getEvictedLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Provide a valid propertyId.\"\n },\n \"evictionStartDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid evictionStartDateFrom.\"\n },\n \"evictionStartDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Provide a valid evictionStartDateTo\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getExpiringLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Date from which leases are required\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Date upto which leases are required\"\n },\n \"isMonthToMonth\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Is Month To Month\"\n },\n \"isWaitList\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this parameter is enabled then we will show leases with lease type status notice and the property setting HIDE_NOTICE_RESIDENTS_FROM_RENE WALS should be disabled for this, else we will return error.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseActivities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"leaseId\",\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"createdOnDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeAddOns\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeCharge\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"includeAddOns\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeCharge\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseDocuments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Lease Id - Required if externalLeaseId is not provided\"\n },\n \"externalLeaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. The remote primary key which is associated to lease. Required if leas eId is not provided.\"\n },\n \"documentIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fileTypesCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"LA\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. System code for file files\"\n },\n \"addedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If provided, this will return the documents which have AddedOn dates o n or after the date provided.\"\n },\n \"showDeletedFile\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeaseDocumentsList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"externalLeaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. This is the remote primary key that is associated to lease.\"\n },\n \"documentIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fileTypesCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"LA\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. System code for file files\"\n },\n \"showDeletedFile\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is Yes then we are returning deleted documents else not.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeasePickList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsCollections\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"includeEvictions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Include Evictions leases\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From Date\"\n },\n \"transactionFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. transactionFromDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMitsLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. customerId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"leaseIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"eventTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduledArCodeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56744\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveInDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"eventDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseExpiringDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"moveOutDateTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeOtherIncomeLeases\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"residentFriendlyMode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeLeaseHistory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeArTransactions\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This should return the Ar Transactions associated with the lease.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getParcelAlerts\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isActive\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getRentersInsurancePolicies\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. leaseStatusTypeIds\"\n },\n \"lastUpdatedOn\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. lastUpdatedOn\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"moveInLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"moveOutLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"moveOutTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutTypeId\"\n },\n \"moveOutReasonId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutReasonId\"\n },\n \"noticeDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. noticeDate\"\n },\n \"moveOutDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveOutDate\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. unitAvailableOnDate\"\n },\n \"endContinuingScheduledCharges\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. endContinuingScheduledCharges\"\n },\n \"postAcceleratedRent\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. postAcceleratedRent\"\n },\n \"refundMethodId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \" This is an optional field. This field accepts single value. refundMethodId\"\n },\n \"makeReadyEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. According to Property Preference \\\"Require Make Ready Work Order on Mov e-out,...\\\" the makeReadyEndDate is conditional mandatory.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line1\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line2\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address street_Line3\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding address`s city\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AK\",\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address`s stateCode\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 99501,\n \"description\": \"This is an optional field. This field accepts single value. Forwarding Address`s Postal Code\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"moveOutTypeId\",\n \"moveOutReasonId\",\n \"moveOutDate\",\n \"unitAvailableOnDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"onNoticeLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"moveOutTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutTypeId\"\n },\n \"moveOutReasonId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. moveOutReasonId\"\n },\n \"noticeDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. noticeDate (YYYY-MM-DD)\"\n },\n \"moveOutDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveOutDate (YYYY-MM-DD)\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. unitAvailableOnDate (YYYY-MM-DD)\"\n },\n \"makeReadyEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. According to Property Preference \\\"Require Make Ready Work Order on Mov e-out,...\\\" the makeReadyEndDate is conditional mandatory.\"\n },\n \"submitRefundDetails\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value. submitRefundDetails\"\n },\n \"refundMethodId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"refundMet hodId\\\" is required.\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 1\\\" is required.\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 2\\\" is required.\"\n },\n \"streetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"streetLie 3\\\" is required.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"city\\\" is required.\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AK\",\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"stateCode\\\" is required.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 99501,\n \"description\": \"This is an optional field. This field accepts single value. If the value of \\\"submitRefundDetails\\\" is \\\"1\\\", only then the \\\"postalCod \\\" is required.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"moveOutTypeId\",\n \"moveOutReasonId\",\n \"moveOutDate\",\n \"unitAvailableOnDate\",\n \"makeReadyEndDate\",\n \"submitRefundDetails\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseActivities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"eventTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. Acceptable values are: 8,335,4,436,5,6,15,56. 4 for \\\"Call-Outgoing\\\" , 5 for \\\"Text-Incoming\\\", 6 for \\\"Text-Outgoing\\\", 8 for \\\"Notes\\\", 335 fo r \\\"Lease Retrieved By Collections Agency\\\", 436 for \\\"Hazard Notes\\\", 15 for \\\"Scheduled Follow-Up\\\", 56 for \\\"Delinquency Notes\\\".\"\n },\n \"eventDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"09/2/2018 03:57:00 PST\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"comment\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.\"\n },\n \"hazardEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. This would give end date for the hazard note.\"\n },\n \"hazardNote\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. This would add note when creating hazard event.\"\n },\n \"leaseIntervalId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.\"\n },\n \"eventResultId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"his is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is either 4,5, or 6.\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"scheduleDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/18/2022 11:30:45\",\n \"description\": \"This is an optional field. This field accepts single value. This becomes mandatory if eventTypeId is 15.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"eventTypeId\",\n \"eventDateTime\",\n \"hazardNote\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeases\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. leaseStartDate (YYYY-MM-DD)\"\n },\n \"leaseEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. leaseEndDate (YYYY-MM-DD)\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a required field. This field accepts single value. moveInDate (YYYY-MM-DD)\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseTermId\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. floorplanId\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. unitSpaceId\"\n },\n \"spaceConfigurationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value. If the provided property is of type \\\"Student\\\", only then \\\"spaceConfigurationId\\\" is required.\"\n },\n \"leaseStartWindowId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is an optional field. This field accepts single value. If the provided property is of type \\\"Student\\\", only then \\\"leaseStartWindowId\\\" is required.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. firstName\"\n },\n \"middleName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. middleName\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. lastName\"\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. customerRelationshipTypeId\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. emailAddress\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. birthDate (YYYY-MM-DD)\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. phoneNumberTypeId\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. Primary phoneNumber\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. addressTypeId\"\n },\n \"streetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Address streetLine1\"\n },\n \"streetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. streetLine2\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"city1\",\n \"description\": \"This is a required field. This field accepts single value. city\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"AZ\",\n \"description\": \"This is a required field. This field accepts single value. stateCode\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"05559\",\n \"description\": \"This is a required field. This field accepts single value. postalCode\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseStartDate\",\n \"leaseEndDate\",\n \"moveInDate\",\n \"leaseTermId\",\n \"floorplanId\",\n \"unitSpaceId\",\n \"firstName\",\n \"lastName\",\n \"customerRelationshipTypeId\",\n \"phoneNumberTypeId\",\n \"phoneNumber\",\n \"addressTypeId\",\n \"streetLine1\",\n \"city\",\n \"stateCode\",\n \"postalCode\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Insurance policy id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. customerId\"\n },\n \"provider\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. provider\"\n },\n \"policyNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. policyNumber\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. endDate\"\n },\n \"liability\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is a required field. This field accepts single value. liability\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"customerId\",\n \"provider\",\n \"policyNumber\",\n \"startDate\",\n \"endDate\",\n \"liability\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Insurance policy id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,6789\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. customerIds\"\n },\n \"provider\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. provider\"\n },\n \"policyNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. policyNumber\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. endDate\"\n },\n \"liability\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is a required field. This field accepts single value. liability\"\n },\n \"personalContents\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is an optional field. This field accepts single value. personalContents\"\n },\n \"deductible\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12350000,\n \"description\": \"This is an optional field. This field accepts single value. deductible\"\n },\n \"isCancelled\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"customerId\",\n \"provider\",\n \"policyNumber\",\n \"startDate\",\n \"endDate\",\n \"liability\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response.\",\n \"example\": \"15\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendRoommateGroups\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"roommateGroups\"\n ],\n \"properties\": {\n \"roommateGroups\": {\n \"type\": \"object\",\n \"required\": [\n \"roommateGroup\"\n ],\n \"properties\": {\n \"roommateGroup\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"invitorApplicationId\": {\n \"type\": \"integer\",\n \"description\": \"Required field unless inviteeApplicationId is provided. This field accepts single value.\",\n \"example\": 12345678\n },\n \"inviteeApplicationId\": {\n \"oneOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\"\n },\n \"description\": \"Required field. This field accepts multiple values.\",\n \"example\": [\n 12345678,\n 55555555,\n 88888888\n ]\n },\n {\n \"type\": \"string\",\n \"description\": \"Can be empty string\",\n \"example\": \"\"\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendScheduledCharges\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 307,\n \"description\": \"This is a required field. This field accepts single value. chargeTimingId\"\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. chargeCodeTypeId\"\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. chargeCodeId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. startDate\"\n },\n \"leaseIntervalId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. leaseIntervalId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"amount\",\n \"startDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateLease\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts the single property Id that is associated with a lease.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Accepts a single lease id for updating the lease details.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is a optional field. This field accepts single value. moveInDate (YYYY-MM-DD)\"\n },\n \"occupants\": {\n \"type\": \"object\",\n \"description\": \"Optional object containing occupant details\",\n \"properties\": {\n \"occupant\": {\n \"type\": \"array\",\n \"description\": \"List of occupants\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. firstName\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. lastName\"\n }\n }\n }\n }\n }\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 8,\n \"description\": \"This is a required field. This field accepts single value. customerRelationshipTypeId\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"leaseId\",\n \"firstName\",\n \"lastName\",\n \"customerRelationshipTypeId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. scheduledChargeid\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"isDeleted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This field support value 0 and 1.\"\n }\n },\n \"required\": [\n \"id\",\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. scheduledChargeid\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. leaseId\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n },\n \"isDeleted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This field support value 0 and 1.\"\n }\n },\n \"required\": [\n \"id\",\n \"propertyId\",\n \"leaseId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"cancelLease\": {\n \"$ref\": \"#/components/examples/cancelLeaseRequest\"\n },\n \"getEvictedLeases\": {\n \"$ref\": \"#/components/examples/getEvictedLeasesRequest\"\n },\n \"getExpiringLeases\": {\n \"$ref\": \"#/components/examples/getExpiringLeasesRequest\"\n },\n \"getLeaseActivities\": {\n \"$ref\": \"#/components/examples/getLeaseActivitiesRequest\"\n },\n \"getLeaseDetails_r1\": {\n \"$ref\": \"#/components/examples/getLeaseDetailsRequest_r1\"\n },\n \"getLeaseDetails_r2\": {\n \"$ref\": \"#/components/examples/getLeaseDetailsRequest_r2\"\n },\n \"getLeaseDocuments\": {\n \"$ref\": \"#/components/examples/getLeaseDocumentsRequest\"\n },\n \"getLeaseDocumentsList\": {\n \"$ref\": \"#/components/examples/getLeaseDocumentsListRequest\"\n },\n \"getLeasePickList\": {\n \"$ref\": \"#/components/examples/getLeasePickListRequest\"\n },\n \"getLeases_r1\": {\n \"$ref\": \"#/components/examples/getLeasesRequest_r1\"\n },\n \"getLeases_r2\": {\n \"$ref\": \"#/components/examples/getLeasesRequest_r2\"\n },\n \"getMitsCollections\": {\n \"$ref\": \"#/components/examples/getMitsCollectionsRequest\"\n },\n \"getMitsLeases\": {\n \"$ref\": \"#/components/examples/getMitsLeasesRequest\"\n },\n \"getParcelAlerts\": {\n \"$ref\": \"#/components/examples/getParcelAlertsRequest\"\n },\n \"getRentersInsurancePolicies\": {\n \"$ref\": \"#/components/examples/getRentersInsurancePoliciesRequest\"\n },\n \"moveInLease\": {\n \"$ref\": \"#/components/examples/moveInLeaseRequest\"\n },\n \"moveOutLease\": {\n \"$ref\": \"#/components/examples/moveOutLeaseRequest\"\n },\n \"onNoticeLease\": {\n \"$ref\": \"#/components/examples/onNoticeLeaseRequest\"\n },\n \"sendLeaseActivities\": {\n \"$ref\": \"#/components/examples/sendLeaseActivitiesRequest\"\n },\n \"sendLeases\": {\n \"$ref\": \"#/components/examples/sendLeasesRequest\"\n },\n \"sendRentersInsurancePolicies_r1\": {\n \"$ref\": \"#/components/examples/sendRentersInsurancePoliciesRequest_r1\"\n },\n \"sendRentersInsurancePolicies_r2\": {\n \"$ref\": \"#/components/examples/sendRentersInsurancePoliciesRequest_r2\"\n },\n \"sendRoommateGroups\": {\n \"$ref\": \"#/components/examples/sendRoommateGroups_r2_Request\"\n },\n \"sendScheduledCharges\": {\n \"$ref\": \"#/components/examples/sendScheduledChargesRequest\"\n },\n \"updateLease\": {\n \"$ref\": \"#/components/examples/updateLeaseRequest\"\n },\n \"updateScheduledCharges_r1\": {\n \"$ref\": \"#/components/examples/updateScheduledChargesRequest_r1\"\n },\n \"updateScheduledCharges_r2\": {\n \"$ref\": \"#/components/examples/updateScheduledChargesRequest_r2\"\n }\n }\n },\n \"multipart/form-data\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"requestContentType\",\n \"requestBody\",\n \"file1\"\n ],\n \"properties\": {\n \"requestContentType\": {\n \"type\": \"string\",\n \"description\": \"This is required field. This field specify the content of requestBody field. This field accept fixed value as `application/json`.\",\n \"enum\": [\n \"application/json\"\n ],\n \"example\": \"application/json\"\n },\n \"requestBody\": {\n \"type\": \"object\",\n \"description\": \"This is required field. This field accept the details of lease, and ducuments being uploaded.\",\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"properties\": {\n \"auth\": {\n \"type\": \"object\",\n \"required\": [\n \"type\"\n ],\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"method\": {\n \"type\": \"object\",\n \"required\": [\n \"name\"\n ],\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendLeaseDocuments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"files\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. This is the conditionally required, if applicationId and applicantId is not provided.\"\n },\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a optional field. This field accepts single value. This is the conditionally required, if leaseId and applicantId is not provided.\"\n },\n \"applicantId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required, if leaseId and applicationId is not provided.\"\n },\n \"files\": {\n \"type\": \"object\",\n \"required\": [\n \"file\"\n ],\n \"properties\": {\n \"file\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"fileName\"\n ],\n \"properties\": {\n \"fileName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This will be the name of the file being uploaded.\",\n \"example\": \"lease.pdf\"\n },\n \"leaseFileType\": {\n \"type\": \"string\",\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required if fileTypeId is not provided. This will be the type of the file being uploaded.\",\n \"example\": \"POI\"\n },\n \"fileTypeId\": {\n \"type\": \"integer\",\n \"description\": \"This is a optional field. This field accepts single value. This is conditionally required if leaseFileType is not provided.\",\n \"example\": 12345\n },\n \"isShowInResidentPortal\": {\n \"type\": \"integer\",\n \"description\": \"This is a optional field. This will specify the visibility of uploaded document in the resident portal.\",\n \"example\": 1,\n \"enum\": [\n 0,\n 1\n ]\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"description\": \"This is a optional field. This will accepts comma separated multiple values. If provided this file will attach to the mentioned customers. if skipped, the file will be attached to all the customers of the lease.\",\n \"example\": \"1234,5678\"\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n }\n },\n \"file1\": {\n \"type\": \"string\",\n \"description\": \"This is required field. This will accept the file being uploaded to the lease. This should match and can repeate the field as per the files mentioned in the requestBody.\",\n \"format\": \"binary\"\n }\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetPropertyDetails.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetPropertyDetails.json new file mode 100644 index 00000000..dbcf1647 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetPropertyDetails.json @@ -0,0 +1,253 @@ +{ + "name": "GetPropertyDetails", + "fully_qualified_name": "EntrataApi.GetPropertyDetails@0.1.0", + "description": "Retrieve details of properties for a specific organization.\n\nThis tool accesses property details for a specific organization using the Entrata API. It should be called when detailed property information is needed, such as for property management or listings.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain representing the specific client or organization for which property details are requested.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "property_request_body", + "required": true, + "description": "The JSON array containing the request details for fetching property information. This should include any necessary filters or criteria.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The current page number to retrieve in a paginated response.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "Number of items to return per page in the response.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response; 0 to exclude them.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/properties", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "property_request_body", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getAmenityReservations\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"amenityIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"amenityReservationStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 7 da y range is allowed per request and that range includes the fromDate an d toDate in it.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 7 day range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"calendarEventCategoryIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Calendar Event type ids. Possible id: 1-General, 2-Resident, 3-Leasing , 4-Maintenance If no Id`s are passed only Resident and Leasing cat egories are considered by default.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"fromDate\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. fromDate indicates from which date we should start to include when ret urning available time periods off the property calendar. Only a 60 d ay range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. toDate indicates up till which date we should include when returning a vailable time periods off the property calendar. Only a 60 day range is allowed per request and that range includes the fromDate and toDate in it.\"\n },\n \"tourType\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"SELF_GUIDED\",\n \"description\": \"This is a required field. This field accepts single value. tour type: SELF_GUIDED, VIRTUAL_GUIDED,AGENT_GUIDED\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"fromDate\",\n \"toDate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getFloorPlans\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"propertyFloorPlanIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"456789,123222\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. propertyFloorPlanIds.\"\n },\n \"usePropertyPreferences\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Checks for the property settings manipulate floorplan data and honour those settings.\"\n },\n \"includeDisabledFloorplans\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided value is 1, then user should get disabled floorplans along with the enabled one.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPetTypes\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"456789,123222\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. List of comma seperated propertyIds\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getProperties\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. PropertyIds\"\n },\n \"propertyLookupCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showAllStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Show all properties with any status.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyAddOns\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyAnnouncements\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comman seperated list of properties\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getRentableItems\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getReservableAmenities\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"amenityIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,655\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWebsites\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. PropertyIds\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendFloorplans\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. This node accepts the property id on which the floorplan will get added.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. This node accepts the name of the floorplan.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"description\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the description of the floorplan\"\n },\n \"seoTitle\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo title\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoTitle of the floorplan\"\n },\n \"seoDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo description\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoDescription of the floorplan\"\n },\n \"seoKeywords\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"seo keyword\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the seoKeywords of the floorplan\"\n },\n \"isPublished\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0, whether the floorplan needs to be published or not.\"\n },\n \"isDisabledVirtualMoveIn\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0.\"\n },\n \"minSquareFeet\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 200,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the minimum square feet value of the floorplan.\"\n },\n \"maxSquareFeet\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1000,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the maximun square feet value of the floorplan.\"\n },\n \"numberOfBedRooms\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This node accepts a total number of bedrooms.\"\n },\n \"numberOfBathRooms\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This node accepts a total number of bathrooms.\"\n },\n \"isFeatured\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This flag accepts 1 or 0.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"name\",\n \"numberOfBedRooms\",\n \"numberOfBathRooms\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendRentableItems\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"categoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Furniture A\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"showOnWebsite\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isMarketed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"hasInventory\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"availabilityStatusId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FurnitureTesting\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"name\",\n \"numberOfBedRooms\",\n \"numberOfBathRooms\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyMedia\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"mediaTypeId\",\n \"mediaSubTypeId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"123456\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"6\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value.\",\n \"example\": \"24\"\n },\n \"referenceIds\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value. reference id for mediaType\",\n \"example\": \"987654\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPropertyMedia\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"media\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. The unique identifier for the property.\",\n \"example\": \"123456\"\n },\n \"media\": {\n \"type\": \"array\",\n \"items\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"mediaTypeId\",\n \"mediaTypeName\",\n \"mediaSubTypeId\",\n \"mediaSubTypeName\",\n \"referenceId\",\n \"mediaProvider\",\n \"mediaUrl\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier for the media\",\n \"example\": \"100001\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"Type identifier for the media\",\n \"example\": \"6\"\n },\n \"mediaTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media type\",\n \"example\": \"unit_floorplan_medias\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"Sub-type identifier for the media\",\n \"example\": \"24\"\n },\n \"mediaSubTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media sub-type\",\n \"example\": \"ABC\"\n },\n \"referenceId\": {\n \"type\": \"string\",\n \"description\": \"Reference identifier\",\n \"example\": \"987654\"\n },\n \"mediaProvider\": {\n \"type\": \"string\",\n \"description\": \"Provider of the media\",\n \"example\": \"XYZ\"\n },\n \"mediaUrl\": {\n \"type\": \"string\",\n \"description\": \"URL of the media\",\n \"example\": \"https://www.example.com/demo1\"\n },\n \"mediaAltText\": {\n \"type\": \"string\",\n \"description\": \"Alternative text for the media\",\n \"example\": \"business_demo1\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the media\",\n \"example\": \"demo_name1\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the media\",\n \"example\": \"demo_description1\"\n },\n \"caption\": {\n \"type\": \"string\",\n \"description\": \"Caption for the media\",\n \"example\": \"demo_caption1\"\n },\n \"height\": {\n \"type\": \"string\",\n \"description\": \"Height of the media\",\n \"example\": \"800\"\n },\n \"width\": {\n \"type\": \"string\",\n \"description\": \"Width of the media\",\n \"example\": \"600\"\n },\n \"mediaFormat\": {\n \"type\": \"string\",\n \"description\": \"Format of the media\",\n \"example\": \"jpeg\"\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updatePropertyMedia\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"media\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. The unique identifier for the property.\",\n \"example\": \"999999\"\n },\n \"media\": {\n \"type\": \"array\",\n \"items\": {\n \"allOf\": [\n {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"mediaTypeId\",\n \"mediaTypeName\",\n \"mediaSubTypeId\",\n \"mediaSubTypeName\",\n \"referenceId\",\n \"mediaProvider\",\n \"mediaUrl\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Unique identifier for the media\",\n \"example\": \"100001\"\n },\n \"mediaTypeId\": {\n \"type\": \"string\",\n \"description\": \"Type identifier for the media\",\n \"example\": \"6\"\n },\n \"mediaTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media type\",\n \"example\": \"unit_floorplan_medias\"\n },\n \"mediaSubTypeId\": {\n \"type\": \"string\",\n \"description\": \"Sub-type identifier for the media\",\n \"example\": \"24\"\n },\n \"mediaSubTypeName\": {\n \"type\": \"string\",\n \"description\": \"Name of the media sub-type\",\n \"example\": \"ABC\"\n },\n \"referenceId\": {\n \"type\": \"string\",\n \"description\": \"Reference identifier\",\n \"example\": \"987654\"\n },\n \"mediaProvider\": {\n \"type\": \"string\",\n \"description\": \"Provider of the media\",\n \"example\": \"XYZ\"\n },\n \"mediaUrl\": {\n \"type\": \"string\",\n \"description\": \"URL of the media\",\n \"example\": \"https://www.example.com/demo1\"\n },\n \"mediaAltText\": {\n \"type\": \"string\",\n \"description\": \"Alternative text for the media\",\n \"example\": \"business_demo1\"\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the media\",\n \"example\": \"demo_name1\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the media\",\n \"example\": \"demo_description1\"\n },\n \"caption\": {\n \"type\": \"string\",\n \"description\": \"Caption for the media\",\n \"example\": \"demo_caption1\"\n },\n \"height\": {\n \"type\": \"string\",\n \"description\": \"Height of the media\",\n \"example\": \"800\"\n },\n \"width\": {\n \"type\": \"string\",\n \"description\": \"Width of the media\",\n \"example\": \"600\"\n },\n \"mediaFormat\": {\n \"type\": \"string\",\n \"description\": \"Format of the media\",\n \"example\": \"jpeg\"\n }\n }\n }\n ]\n }\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"basic\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"An arbitrary value to relate with response.\",\n \"example\": \"1002\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"deletePropertyMedia\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\",\n \"id\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"description\": \"Required. The unique identifier for the property.\",\n \"example\": \"999999\"\n },\n \"id\": {\n \"type\": \"string\",\n \"description\": \"Required. The unique identifier for the media.\",\n \"example\": \"555555\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPhoneNumber\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"integer\"\n },\n \"description\": \"Array of property IDs\",\n \"example\": [\n 123456,\n 789\n ]\n },\n \"switchCode\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value.\",\n \"example\": \"46545\"\n },\n \"ref\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value.\",\n \"example\": \"http://google.com\"\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getAmenityReservations\": {\n \"$ref\": \"#/components/examples/getAmenityReservationsRequest\"\n },\n \"getCalendarAvailability_r1\": {\n \"$ref\": \"#/components/examples/getCalendarAvailabilityRequest_r1\"\n },\n \"getCalendarAvailability_r2\": {\n \"$ref\": \"#/components/examples/getCalendarAvailabilityRequest_r2\"\n },\n \"getFloorPlans\": {\n \"$ref\": \"#/components/examples/getFloorPlansRequest\"\n },\n \"getPetTypes\": {\n \"$ref\": \"#/components/examples/getPetTypesRequest\"\n },\n \"getProperties\": {\n \"$ref\": \"#/components/examples/getPropertiesRequest\"\n },\n \"getPropertyAddOns\": {\n \"$ref\": \"#/components/examples/getPropertyAddOnsRequest\"\n },\n \"getPropertyAnnouncements\": {\n \"$ref\": \"#/components/examples/getPropertyAnnouncementsRequest\"\n },\n \"getPropertyPickLists_r1\": {\n \"$ref\": \"#/components/examples/getPropertyPickListsRequest_r1\"\n },\n \"getPropertyPickLists_r2\": {\n \"$ref\": \"#/components/examples/getPropertyPickListsRequest_r2\"\n },\n \"getRentableItems\": {\n \"$ref\": \"#/components/examples/getRentableItemsRequest\"\n },\n \"getReservableAmenities\": {\n \"$ref\": \"#/components/examples/getReservableAmenitiesRequest\"\n },\n \"getWebsites\": {\n \"$ref\": \"#/components/examples/getWebsitesRequest\"\n },\n \"sendFloorplans\": {\n \"$ref\": \"#/components/examples/sendFloorplansRequest\"\n },\n \"sendRentableItems\": {\n \"$ref\": \"#/components/examples/sendRentableItemsRequest\"\n },\n \"getPropertyMedia\": {\n \"$ref\": \"#/components/examples/getPropertyMediaRequest\"\n },\n \"sendPropertyMedia\": {\n \"$ref\": \"#/components/examples/sendPropertyMediaRequest\"\n },\n \"updatePropertyMedia\": {\n \"$ref\": \"#/components/examples/updatePropertyMediaRequest\"\n },\n \"deletePropertyMedia\": {\n \"$ref\": \"#/components/examples/deletePropertyMediaRequest\"\n },\n \"getPhoneNumber\": {\n \"$ref\": \"#/components/examples/getPhoneNumberRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetVendors.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetVendors.json new file mode 100644 index 00000000..66257f1b --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/GetVendors.json @@ -0,0 +1,253 @@ +{ + "name": "GetVendors", + "fully_qualified_name": "EntrataApi.GetVendors@0.1.0", + "description": "Retrieve a list of vendors for a given organization.\n\nThis tool fetches vendor information from Entrata for a specified organization. Use it to obtain a comprehensive list of vendors associated with an organization ID.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "organization_subdomain", + "required": true, + "description": "The subdomain representing the organization to retrieve vendors for.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "vendor_request_body", + "required": true, + "description": "Provide the request body as a JSON array for fetching vendor data. This should include any necessary parameters required by the API to process the vendor data request.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number for pagination of the vendor list.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "The number of items to return per page in the response for pagination.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response body, 0 to exclude.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/vendors", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "organization_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "vendor_request_body", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ids\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4564\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"invoiceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"paidInvoiceFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or afte r the given date.\"\n },\n \"paidInvoiceToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeVoidedPayments\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Returns voided payment details if provided as 1\"\n },\n \"includeExported\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerRefunds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ids\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4564\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"invoiceNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. This is based on the Post Date of the invoice.\"\n },\n \"paidInvoiceFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. filters the invoices which have the payment applied to them on or after the given date.\"\n },\n \"paidInvoiceToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value. we are showing the invoices which have the payment applied to them on or before the given date.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeVoidedPayments\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Returns voided payment details if provided as 1\"\n },\n \"voidedPaymentFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"voidedPaymentToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"includeExported\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"customerRefunds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"invoiceTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPoReceivingRecords\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. If \\\"vendorId\\\" is provided then \\\"vendorCode\\\" and \\\"purchaseOrderNumbers\\\" are not required.\"\n },\n \"vendorCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. If \\\"vendorCode\\\" is provided then \\\"vendorId\\\" and \\\"purchaseOrderNumbers\\\" are not required.\"\n },\n \"purchaseOrderNumbers\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. If \\\"purchaseOrderNumbers\\\" is provided then \\\"vendorId\\\" and \\\"vendorCode\\\" are not required.\"\n },\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"12345,4564\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"poFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year\"\n },\n \"poToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. poFromDate and poToDate max range of 1 year\"\n },\n \"receivedFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year\"\n },\n \"receivedToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. if dates are provided in filter then vendorId, vendorCode or PO number s are not required, receivedFromDate and receivedToDate max range of 1 year\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPurchaseOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,4567\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"vendorCode\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poNumbers\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"receivedFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"receivedToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnFrom\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"createdOnTo\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"poStatusIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"poTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"purchaseOrderApprovalTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getTaxFormData\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"generateForPropertyOwner\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as \\\"0\\\" then payer will render property info & If provided as \\\"1\\\" then Payer node will render the property owners info\"\n },\n \"ownerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isForIndirectOwner\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided false, it will return data only for direct owners. If prov ided true, it will return data for both direct & indirect owners.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendorLocations\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56334\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. List of comma separated propertyIds\"\n },\n \"showAllStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Boolean parameter to retrieve all vendors irrespective of status.\"\n },\n \"includeIntercompanyVendors\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If provided as \\\"0\\\" then \\\"Standard\\\" types of Vendors will be rendered a nd if provided as \\\"1\\\" then \\\"Standard\\\" and \\\"Intercompany\\\" types of Vend ors will be returned.\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorId\"\n },\n \"vendorName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Vendor_Name\",\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorName\"\n },\n \"vendorCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. Provides details based on provided VendorCode\"\n },\n \"lastModifiedOn\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \" This is an optional field. This field accepts single value. Returns results based on the LastModifiedOn date of the vendor or any of its locations, contacts, remittances or legal entities.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendorPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"12345,56334\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Once passing this parameter web service will return Vendor details for those Vendor Ids. Conditional mandatory, If vendorIds are provided t hen vendorsCodes is not required.\"\n },\n \"vendorCodes\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,5678\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Conditional mandatory, If \\\"vendorsCodes\\\" are provided then \\\"vendorIds \\\" are not required.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"markInvoicesExported\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"lineItemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"17,18,19\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values.\"\n }\n },\n \"required\": [\n \"lineItemId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"ApPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Id of a vendor who generated the invoice.\"\n },\n \"ApPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Location Id of a vendor who generated the invoice.\"\n },\n \"InvoiceTotal\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 2000,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Total amount of invoice.\"\n },\n \"InvoiceNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"TESTINVOICE123\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Invoice Number.\"\n },\n \"InvoiceDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApHeader. Invoice date. Must be of format MM/DD/YYYY.\"\n },\n \"IsConsolidated\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApHeader.\"\n },\n \"IsOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApHeader.\"\n },\n \"PropertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"GlAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"Rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. Child element of ApDetail.\"\n },\n \"IsWaive1099\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"FileData\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FileData\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of File. Base64 encoded file data.\"\n },\n \"Note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"DueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"IsPaused\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApBatch.\"\n },\n \"InvoiceImageUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"https://InvoiceImageUrl\",\n \"description\": \"This is an optional field. This field accepts single value. InvoiceImageUrl accepts valid URL only.\"\n },\n \"IsPosted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. IsPosted allows inserting posted invoices.\"\n },\n \"PropertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 17672,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n },\n \"PropertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3981490,\n \"description\": \"This is an optional field. This field accepts single value. Child element of ApDetail.\"\n }\n },\n \"required\": [\n \"ApPayeeId\",\n \"ApPayeeLocationId\",\n \"InvoiceTotal\",\n \"InvoiceDate\",\n \"PropertyId\",\n \"GlAccountId\",\n \"Description\",\n \"Rate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"invoiceTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1=\\\"Standard\\\", 8 = \\\"Catalog\\\" and 17 = \\\"Standard-Job/Contract\\\" types. By default type \\\"Standard\\\" is inserted.\"\n },\n \"apPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Id of a vendor who generated the invoice.\"\n },\n \"apPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor who generated the invoice.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. This is conditionally required, depends upo n the \\\"Require Routing Tags on Invoices\\\" setting.\"\n },\n \"invoiceNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"TESTINVOICE123\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Invoice Number.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts date in MM/YYYY format.\"\n },\n \"invoiceDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Invoice date. Must be of format MM/DD/YYYY.\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Accepts date in MM/DD/YYYY format.\"\n },\n \"shipping\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the shipping amount.\"\n },\n \"discount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the discount amount.\"\n },\n \"salesTax\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.\"\n },\n \"invoiceTotal\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 2000,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Total amount of invoice.\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \" This is an optional field. This field accepts single value. This field will be used to specify the additional details of the invoice.\"\n },\n \"invoiceImageUrl\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Invoice Image URL\",\n \"description\": \"This is an optional field. This field accepts single value. If this node is provided, it should be a valid URL.\"\n },\n \"isConsolidated\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 17672,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3981490,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 5,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 40,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"unitOfMeasureId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Only valid for Catalog type invoices.\"\n },\n \"isWaive1099\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"poDetailId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts \\\"Line Item Id\\\" of Purchase Order.\"\n },\n \"receivingRecordId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Conditional Required(Node is mandatory only if the poDetailId value is provided in request). This node accepts \\\"Receiving Record Id\\\" of Purc hase Order Line Item for the \\\"Catalog\\\" type.\"\n },\n \"invoicePaymentId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under apDetail.\"\n },\n \"fileData\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"FileData\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of file. Base64 encoded file data.\"\n },\n \"isPaused\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Child element of apBatch. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isPosted\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node specifies whether the invoice is posted or unposted. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"paymentNumber_001\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.\"\n },\n \"paymentDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments. Must be of for mat MM/DD/YYYY.\"\n },\n \"paymentMemo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"paymentMemo01\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of invoicePayment under invoicePayments.\"\n },\n \"customTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 180,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts custom Tag Id of the invoice. If customTagId is not provided, then PO`s custom Tag Id would gets associates to invoice thr ough poDetailId node\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. The required node in case of jobCost invoiceType\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 400,\n \"description\": \"This is a required field. This field accepts single value. The required node in case of jobCost invoiceType\"\n }\n },\n \"required\": [\n \"apPayeeId\",\n \"apPayeeLocationId\",\n \"invoiceNumber\",\n \"invoiceDate\",\n \"invoiceTotal\",\n \"propertyId\",\n \"glAccountId\",\n \"description\",\n \"rate\",\n \"apCodeId\",\n \"apContractId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendPurchaseOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"poTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\\\"Standard\\\" and \\\"Standard-Job/ Contract\\\" respectively).\"\n },\n \"apPayeeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Supports purchase order types 4 and 19 (\\\"Standard\\\" and \\\"Standard-Job/ Contract\\\" respectively).\"\n },\n \"apPayeeLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader. Location Id of a vendor.\"\n },\n \"apPayeeAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader. If not passed in the request, the system d efault account will be used.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Accepts date in MM/YYYY format.\"\n },\n \"postDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Child element of apHeader.\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader.\"\n },\n \"headerMemo\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header memo\",\n \"description\": \"This is an optional field. This field accepts single value. Child element of apHeader.\"\n },\n \"shipping\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the shipping amount.\"\n },\n \"discount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the discount amount.\"\n },\n \"salesTax\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is an optional field. This field accepts single value. This will specify the sales tax of the invoice.\"\n },\n \"glAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.This is required if po type is standard.\"\n },\n \"apCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.\"\n },\n \"jobPhaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails. This is required if po type is job costing.\"\n },\n \"apContractId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is child element of apDetails.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"quantity\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"rate\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 10,\n \"description\": \"This is a required field. This field accepts single value. Child element of apDetail.\"\n },\n \"glDimensionId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 384,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail. Custom Tags.\"\n },\n \"companyDepartmentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"propertyBuildingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Child element of apDetail.\"\n },\n \"isConfidential\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"isTaxable\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. Accepts \\\"0\\\" or \\\"1\\\" Only.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Desc\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"poTypeId\",\n \"apPayeeId\",\n \"apPayeeLocationId\",\n \"postMonth\",\n \"postDate\",\n \"propertyId\",\n \"quantity\",\n \"rate\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"businessName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Vendor name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnTaxReturn\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Legal entity name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"remittanceName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"apPaymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnAccount\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)\"\n },\n \"routingNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck). Must be numeric wi th 9 digits long.\"\n },\n \"accountNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Required only when the payment type is ACH(eCheck)\"\n },\n \"contact\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"First name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"last name\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. Accepts the location name\"\n },\n \"isPrimary\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"utilityBillReceiptTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value\"\n },\n \"externalId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"API_VENDOR_EXTRNL_ID\",\n \"description\": \"This is a required field. This field accepts single value. externalId\"\n }\n },\n \"required\": [\n \"businessName\",\n \"nameOnTaxReturn\",\n \"remittanceName\",\n \"apPaymentTypeId\",\n \"nameOnAccount\",\n \"routingNumber\",\n \"accountNumber\",\n \"contact\",\n \"firstName\",\n \"lastName\",\n \"name\",\n \"isPrimary\",\n \"externalId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateInvoices\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. Accepts apHeader id,apDetail id\"\n },\n \"invoicePaymentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 100,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"65565\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"paymentDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isOnHold\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Update an invoice that is on hold, and take it off hold, and vice vers a, Allowed values ( 0, 1 )\"\n },\n \"routingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Update the routing tag on an invoice, to another valid routing tag. Al low for not posted and off hold invoice.\"\n }\n },\n \"required\": [\n \"id\",\n \"invoicePaymentId\",\n \"paymentAmount\",\n \"paymentTypeId\",\n \"paymentNumber\",\n \"paymentDate\",\n \"postMonth\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateVendors\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnTaxReturn\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Legal entity name\",\n \"description\": \"This is a required field. This field accepts single value\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. Accepts locations name.\"\n },\n \"legalEntityName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"name\",\n \"description\": \"This is a required field. This field accepts single value. required if new location is inserted\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. attribute compliance_status_id is required to make the property compli ant/non compliant, Accept integer value 2( for non-compliant) or 5 (fo r compliant) only.\"\n },\n \"remittanceName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"nameOnAccount\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"header\",\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"routingNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"accountNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is a required field. This field accepts single value. required, if Remittance Type is ACH (eCheck) (i.e. apPaymentTypeId = 5 )\"\n },\n \"externalId\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"API_VENDOR_EXTRNL_ID\",\n \"description\": \"This is a required field. This field accepts single value. externalId\"\n },\n \"defaultRoutingTagId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"vendorId\",\n \"nameOnTaxReturn\",\n \"name\",\n \"legalEntityName\",\n \"propertyId\",\n \"remittanceName\",\n \"nameOnAccount\",\n \"routingNumber\",\n \"accountNumber\",\n \"externalId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"voidApPayments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"paymentId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentNumber, paymentBankAccountId, paymenttypeId, paymentAmount are not provided.\"\n },\n \"paymentNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456\",\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value for paymentId is no t provided then this node is required.\"\n },\n \"paymentBankAccountId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"paymentTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"paymentAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value. This is a conditional mandatory node. If the value of paymentId is not provided then this node is required.\"\n },\n \"voidDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Supported date format: MM/DD/YYY, M/D/YYYY, YYYY-MM-DD.\"\n },\n \"postMonth\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/YYYY\",\n \"description\": \"This is a required field. This field accepts single value. Supported Format: MM/YYYY\"\n },\n \"note\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Note\",\n \"description\": \"This is a required field. This field accepts single value. Memo for the payment\"\n }\n },\n \"required\": [\n \"voidDate\",\n \"postMonth\",\n \"note\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getInvoices_r1\": {\n \"$ref\": \"#/components/examples/getInvoicesRequest_r1\"\n },\n \"getInvoices_r2\": {\n \"$ref\": \"#/components/examples/getInvoicesRequest_r2\"\n },\n \"getPoReceivingRecords\": {\n \"$ref\": \"#/components/examples/getPoReceivingRecordsRequest\"\n },\n \"getPurchaseOrders\": {\n \"$ref\": \"#/components/examples/getPurchaseOrdersRequest\"\n },\n \"getTaxFormData\": {\n \"$ref\": \"#/components/examples/getTaxFormDataRequest\"\n },\n \"getVendorLocations\": {\n \"$ref\": \"#/components/examples/getVendorLocationsRequest\"\n },\n \"getVendorPickLists\": {\n \"$ref\": \"#/components/examples/getVendorPickListsRequest\"\n },\n \"getVendors\": {\n \"$ref\": \"#/components/examples/getVendorsRequest\"\n },\n \"markInvoicesExported\": {\n \"$ref\": \"#/components/examples/markInvoicesExportedRequest\"\n },\n \"sendInvoices_r1\": {\n \"$ref\": \"#/components/examples/sendInvoicesRequest_r1\"\n },\n \"sendInvoices_r2\": {\n \"$ref\": \"#/components/examples/sendInvoicesRequest_r2\"\n },\n \"sendPurchaseOrders\": {\n \"$ref\": \"#/components/examples/sendPurchaseOrdersRequest\"\n },\n \"sendVendors\": {\n \"$ref\": \"#/components/examples/sendVendorsRequest\"\n },\n \"updateInvoices\": {\n \"$ref\": \"#/components/examples/updateInvoicesRequest\"\n },\n \"updateVendors\": {\n \"$ref\": \"#/components/examples/updateVendorsRequest\"\n },\n \"voidApPayments\": {\n \"$ref\": \"#/components/examples/voidApPaymentsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/LeasingCenterCallLogs.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/LeasingCenterCallLogs.json new file mode 100644 index 00000000..f779d252 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/LeasingCenterCallLogs.json @@ -0,0 +1,253 @@ +{ + "name": "LeasingCenterCallLogs", + "fully_qualified_name": "EntrataApi.LeasingCenterCallLogs@0.1.0", + "description": "Retrieve leasing center call logs for analysis.\n\nUse this tool to access call logs from the leasing center, supporting pagination for detailed data retrieval.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization. This is required to identify the client's data for retrieving call logs.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "request_body_payload", + "required": true, + "description": "An array of JSON objects to be included in the request. Typically used for specifying additional data or filters for the API call.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number to retrieve in a paginated response from the leasing center call logs.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "Number of items to return per page in the response. Use for pagination.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response; set to 0 to exclude them.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/leasingcenter", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "request_body_payload", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCallLogs\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"123456,5678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. This node should accept property Id`s.\"\n },\n \"callSourceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. Supported values (1, 2, 7)\"\n },\n \"callTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"3,8\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"callResultIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"8,1\",\n \"description\": \" This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"answerStatus\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \" This is an optional field. This field accepts single value. Supports only 1 (ANSWERED) & 2 (UNANSWERED)\"\n },\n \"voiceMailTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supported values are 1 (VOICE_MESSAGE) or 2 (UNPLAYED_VOICE_MESSAGE) o r 3 (NO_VOICE_MESSAGE).\"\n },\n \"callAnalyzed\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1 (ANALYZED) or 0 (NON_ANALYZED)\"\n },\n \"callState\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supports 1 (NON-ARCHIVED) or 2 (ARCHIVED).\"\n },\n \"startDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.\"\n },\n \"endDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This field accepts value in MM/DD/YYYY format.\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getLeasingCenterPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCallLogs\": {\n \"$ref\": \"#/components/examples/getCallLogsRequest\"\n },\n \"getLeasingCenterPickLists\": {\n \"$ref\": \"#/components/examples/getLeasingCenterPickListsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/RequestMaintenanceService.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/RequestMaintenanceService.json new file mode 100644 index 00000000..91e4131a --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/RequestMaintenanceService.json @@ -0,0 +1,253 @@ +{ + "name": "RequestMaintenanceService", + "fully_qualified_name": "EntrataApi.RequestMaintenanceService@0.1.0", + "description": "Request maintenance services for an organization.\n\nThis tool calls the Entrata API to request maintenance services for a specified organization. It should be used when an entity needs to initiate a new maintenance service order.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The unique subdomain identifier for the client organization requesting the service.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "maintenance_request_details", + "required": true, + "description": "The JSON array containing details required to initiate a maintenance request. Include all necessary fields as per Entrata's API requirements.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + }, + { + "name": "page_number", + "required": false, + "description": "The page number for paginated responses. Use to retrieve a specific page in a paginated series.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "inferrable": true, + "http_endpoint_parameter_name": "page_no" + }, + { + "name": "items_per_page", + "required": false, + "description": "Specifies the number of items to return per page in the response.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "inferrable": true, + "http_endpoint_parameter_name": "per_page" + }, + { + "name": "include_pagination_links", + "required": false, + "description": "Set to 1 to include pagination links in the response body, otherwise set to 0.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "inferrable": true, + "http_endpoint_parameter_name": "X-Send-Pagination-Links" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/maintenance", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "page_no", + "tool_parameter_name": "page_number", + "description": "The page number of paginated respons.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The page number of paginated respons." + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "per_page", + "tool_parameter_name": "items_per_page", + "description": "The number of items returned in the respnose", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "The number of items returned in the respnose" + }, + "accepted_as": "query", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "X-Send-Pagination-Links", + "tool_parameter_name": "include_pagination_links", + "description": "Send Pagination Links in Response Body.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "Send Pagination Links in Response Body." + }, + "accepted_as": "header", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "maintenance_request_details", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getInspections\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"YYYY-MM-DD\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"statusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values.\"\n },\n \"inspectionFormId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1234,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"inspectionTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is an optional field. This field accepts single value. Supported values are 1( ROUTINE ), 2(MOVE_IN), 3(MOVE_OUT)\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getInspectionTemplates\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.\"\n },\n \"showDisabled\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. The node accepts a boolean value and default value for this node is \\\"0\\\".\"\n }\n },\n \"required\": [\n \"propertyIds\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWorkOrderPickLists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"123456,678\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. The node accepts multiple propertyIds as the input value.\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"propertyUnitId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. propertyUnitId\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"leaseStatusTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. leaseStatusTypeIds\"\n },\n \"workOrderTypeIds\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1,2,3\",\n \"description\": \"This is an optional field. This field accepts single value. workOrderTypeIds\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. buildingName\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Unit number\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. maintenancePriorityId\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. maintenanceCategoryId\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. maintenanceProblemId\"\n },\n \"includeChildWorkOrders\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. includeChildWorkOrders\"\n },\n \"includeDeletedWorkOrders\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not.\"\n },\n \"createdOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. createdOnFromDate\"\n },\n \"createdOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. createdOnToDate\"\n },\n \"lastUpdatedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.\"\n },\n \"lastUpdatedOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.\"\n },\n \"completedOnFromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. completedOnFromDate\"\n },\n \"completedOnToDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. completedOnToDate\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Customer Id\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Lease ID\"\n },\n \"unitNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"5\",\n \"description\": \"This is an optional field. This field accepts single value. Unit mumber\"\n },\n \"customerFirstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Customer First Name\"\n },\n \"customerLastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Customer Last Name\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a required field. This field accepts single value. Permission to enter\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Maintenance Priority\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description is required if the lease has pets or if permission t o enter is denied so that a reason why entry is not permitted can be e xplained or a pet warning given.\"\n },\n \"buildingName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. buildingName\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"scheduledStartDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDateTime\"\n },\n \"scheduledEndDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDateTime\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"isFloatingWorkOrder\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \"This is an optional field. This field accepts single value. Negative numbers not allowed. This parameter is not applicable to mos t clients and should not be used without first checking with Entrata.\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"mainPhoneNumber\",\n \"permissionToEnter\",\n \"maintenanceLocationId\",\n \"maintenanceCategoryId\",\n \"maintenanceProblemId\",\n \"problemDescription\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"maintenanceStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.\"\n },\n \"completedDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"closingComments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"scheduledStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDate\"\n },\n \"scheduledEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDate\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"parentWorkOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. parentWorkOrderId\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-04-02\",\n \"description\": \"This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Negative numbers not allowed.\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a optional field. This field accepts single value. Permission to enter\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"workOrderId\",\n \"maintenanceProblemId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"updateWorkOrders\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"workOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is an optional field. This field accepts single value.\"\n },\n \"maintenanceStatusTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenancePriorityId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 100,\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"maintenanceLocationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance location\"\n },\n \"maintenanceCategoryId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance Category Id\"\n },\n \"maintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Maintenance problem\"\n },\n \"subMaintenanceProblemId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. SubMaintenance problem\"\n },\n \"mainPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456789,\n \"description\": \"This is a required field. This field accepts single value. Main contact phone number\"\n },\n \"altPhoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12121212,\n \"description\": \"This is an optional field. This field accepts single value. Alternate contact phone number\"\n },\n \"emailAddress\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is an optional field. This field accepts single value. Email Address\"\n },\n \"problemDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is a required field. This field accepts single value. Problem Description\"\n },\n \"petsDescription\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Pets Description could become required if the lease has pets or if per mission to enter is denied so that a reason why entry is not permitted can be explained or a pet warning given.\"\n },\n \"completedDateTime\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"closingComments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"scheduledStartDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 13:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledStartDate\"\n },\n \"scheduledEndDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-06-24 11:00:00 PST\",\n \"description\": \"This is an optional field. This field accepts single value. scheduledEndDate\"\n },\n \"vendorId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. vendorId\"\n },\n \"parentWorkOrderId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. parentWorkOrderId\"\n },\n \"assignedTo\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4553,\n \"description\": \"This is an optional field. This field accepts single value. assignedTo\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"06/15/2017 12:45:56\",\n \"description\": \"This is an optional field. This field accepts single value. While optional by default, dueDate could become required depending on a property setting.\"\n },\n \"unitAvailableOnDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"2017-04-02\",\n \"description\": \"This is an optional field. This field accepts single value. This will set the related unit`s available date. Only works for make ready type work orders and only if a scheduledEndDate is provided. Must be on or after the scheduledEndDate.\"\n },\n \"priorityOrderNum\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12345,\n \"description\": \" This is an optional field. This field accepts single value. Negative numbers not allowed.\"\n },\n \"permissionToEnter\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is a optional field. This field accepts single value. Permission to enter\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"workOrderId\",\n \"maintenanceProblemId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getInspections\": {\n \"$ref\": \"#/components/examples/getInspectionsRequest\"\n },\n \"getInspectionTemplates\": {\n \"$ref\": \"#/components/examples/getInspectionTemplatesRequest\"\n },\n \"getWorkOrderPickLists\": {\n \"$ref\": \"#/components/examples/getWorkOrderPickListsRequest\"\n },\n \"getWorkOrders\": {\n \"$ref\": \"#/components/examples/getWorkOrdersRequest\"\n },\n \"sendWorkOrders\": {\n \"$ref\": \"#/components/examples/sendWorkOrdersRequest\"\n },\n \"updateWorkOrders_r1\": {\n \"$ref\": \"#/components/examples/updateWorkOrdersRequest_r1\"\n },\n \"updateWorkOrders_r2\": {\n \"$ref\": \"#/components/examples/updateWorkOrdersRequest_r2\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/SendCommunicationMessage.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SendCommunicationMessage.json new file mode 100644 index 00000000..b64d0e81 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SendCommunicationMessage.json @@ -0,0 +1,148 @@ +{ + "name": "SendCommunicationMessage", + "fully_qualified_name": "EntrataApi.SendCommunicationMessage@0.1.0", + "description": "Send communication messages via the Entrata Communications API.\n\nThis tool sends communication messages using the Entrata Communications API. It should be called when a user wants to send a message to a specified organization. The tool performs a POST request to the specified endpoint to deliver the message and receives a confirmation of the communication being sent.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization where the communication message will be sent.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "communication_messages_payload", + "required": true, + "description": "JSON array containing details for arPayment-related communications.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/communications", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "communication_messages_payload", + "description": "arPayment related APIs", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "arPayment related APIs" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"arPayment related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMarketingPreferencePickList\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getMarketingPreferences\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"customerIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"1234,2342\",\n \"description\": \"This is a required field. This field accepts comma seperated multiple values. Customer Ids\"\n },\n \"recipientTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 11,\n \"description\": \"This is a required field. This field accepts single value. Possible values are 1 = Lead 2 = Resident\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"customerIds\",\n \"arCodeId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getMarketingPreferencePickList\": {\n \"$ref\": \"#/components/examples/getMarketingPreferencePickListRequest\"\n },\n \"getMarketingPreferences\": {\n \"$ref\": \"#/components/examples/getMarketingPreferencesRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitApplication.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitApplication.json new file mode 100644 index 00000000..5abcdcf6 --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitApplication.json @@ -0,0 +1,148 @@ +{ + "name": "SubmitApplication", + "fully_qualified_name": "EntrataApi.SubmitApplication@0.1.0", + "description": "Submit an application to the specified organization.\n\nThis tool is used to submit applications to a specified organization using the Entrata service. It should be called when an application needs to be sent for processing.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client to which the application is submitted.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "application_data", + "required": true, + "description": "JSON array containing the application details to be submitted. Include all necessary information relevant to the application.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Application related APIs" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/applications", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "application_data", + "description": "Application related APIs", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "Application related APIs" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Application related APIs\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getCompanyApplications\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Property Id\"\n }\n },\n \"required\": [\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicantGeneralDetails\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicantId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"isTrue\": {\n \"type\": \"integer\",\n \"enum\": [\n 0,\n 1\n ]\n },\n \"comments\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Comments\",\n \"description\": \"This is a required field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\",\n \"applicantId\",\n \"id\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplication\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"originatingLeadSourceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 445655,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1234,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 205814,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1862,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"applicationStatusId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. Acceptable values are 3 (COMPLETED ) & 4 (APPLICATION_APPROVED )\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"originatingLeadSourceId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationAddOns\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationEmployers\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer record.\"\n },\n \"incomeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If \\\"id\\\" is not provided, this parame ter is required.\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 17378378,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter. If \\\"id\\\" is not provided, this parame ter is required.\"\n },\n \"frequencyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 4,\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range which are: 3 [ weekly ], 4 [ Monthly ] and 6 [ Yearly ]\"\n },\n \"position\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Technical Manager\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Entrata Inc.\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionPhoneNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"7544898565\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.\"\n },\n \"institutionStreetLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 1\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStreetLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 2\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStreetLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"address line 3\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionCity\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"City\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionStateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionProvince\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionPostalCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"11111\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"institutionCountryCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 5000,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required.\"\n },\n \"contactName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"People Ops team\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"contactPhone\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"9954809807\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.\"\n },\n \"contactEmail\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"hr@example.lcl\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts string value\"\n },\n \"incomeEffectiveDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.\"\n },\n \"dateStarted\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.\"\n },\n \"dateEnded\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded.\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": \"1\",\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendApplicationPets\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. Required parameter, accepts integer value.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123,\n \"description\": \"This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided we will update the pet record\"\n },\n \"customerId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts single value. Conditionally required. Accepts integer value. If id is not provided, this parameter is required\"\n },\n \"typeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 17378378,\n \"description\": \"This is a required field. This field accepts single value.\"\n },\n \"name\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"breed\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"gender\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"F\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"color\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"White\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"weight\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": \"30.99\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"age\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test Description.\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"licenseCity\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"XYZ\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"licenseNumber\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"156\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isAssistanceAnimal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isPetSpayedOrNeutered\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"petSpayedOrNeuteredDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isHouseBroken\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"specialProvisions\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"Test\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"isDelete\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"vehicleTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. Indicates the type of vehicle. Possible values are 1, 2, or 3 where 1 = Primary, 2 = Secondary, and 3 = Other.\"\n }\n },\n \"required\": [\n \"vehicleTypeId\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\"\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"applicationId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node accepts application id which needs to be updated.\"\n },\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This node accepts the property id.\"\n },\n \"applicationStatusId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 3,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the status id.\"\n },\n \"floorplanId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1235,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the associated floorplan id or the floorplan which ne eds to be associated with the application.\"\n },\n \"unitSpaceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 1442,\n \"description\": \"This is an optional field. This field accepts single value. This node accept the associated unit space id or the unit space which needs to be associated with the application.\"\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 4,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the lease length.\"\n },\n \"leasingAgentId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 147896,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the associated leasing agent or the leasing agent wh ich needs to be updated.\"\n },\n \"moveInDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the move-in date. In ISO format as well.\"\n },\n \"originatingLeadSourceId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 8521,\n \"description\": \"This is an optional field. This field accepts single value. This node accepts the lead source id.\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": 7893,\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants id.\"\n },\n \"firstName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants first name.\"\n },\n \"lastName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts applicants last name.\"\n },\n \"maternalName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants maternal name.\"\n },\n \"preferredName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"ABC\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts applicants preferred name.\"\n },\n \"birthDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants birth date. Supports ISO format.\"\n },\n \"customerRelationshipTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"1264\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts customer relationship id.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"test@gmail.com\",\n \"description\": \" This is an optional field. This field accepts single value. This node accepts the applicants email.\"\n },\n \"phoneNumberTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"3\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants phone number type id. This is condition al mandatory node, if phoneNumber is provided then phoneNumberTypeId is required.\"\n },\n \"phoneNumber\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"(123)-111-1111\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts applicants phone number. This is conditional manda tory node, if value for phoneNumberTypeId is provided then this node is required.\"\n },\n \"addressTypeId\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"11\",\n \"description\": \"This is an optional field. This field accepts single value. This node accepts address type id.\"\n },\n \"addressLine1\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine1\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressLine2\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine2\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"addressLine3\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"addressLine3\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"city\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"City\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"postalCode\": {\n \"type\": \"integer\",\n \"format\": \"int64\",\n \"example\": \"12345\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n },\n \"stateCode\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"CA\",\n \"description\": \"This is an optional field. This field accepts single value.\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getCompanyApplications\": {\n \"$ref\": \"#/components/examples/getCompanyApplicationsRequest\"\n },\n \"sendApplicantGeneralDetails\": {\n \"$ref\": \"#/components/examples/sendApplicantGeneralDetailsRequest\"\n },\n \"sendApplication\": {\n \"$ref\": \"#/components/examples/sendApplicationRequest\"\n },\n \"sendApplicationAddOns\": {\n \"$ref\": \"#/components/examples/sendApplicationAddOnsRequest\"\n },\n \"sendApplicationEmployers\": {\n \"$ref\": \"#/components/examples/sendApplicationEmployersRequest\"\n },\n \"sendApplicationPets\": {\n \"$ref\": \"#/components/examples/sendApplicationPetsRequest\"\n },\n \"sendApplicationVehicles\": {\n \"$ref\": \"#/components/examples/sendApplicationVehiclesRequest\"\n },\n \"updateApplication\": {\n \"$ref\": \"#/components/examples/updateApplicationRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitArPayments.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitArPayments.json new file mode 100644 index 00000000..065cc4ac --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/SubmitArPayments.json @@ -0,0 +1,430 @@ +{ + "name": "SubmitArPayments", + "fully_qualified_name": "EntrataApi.SubmitArPayments@0.1.0", + "description": "Submits accounts receivable payments for processing.\n\nUse this tool to submit accounts receivable payments to Entrata for processing. It confirms the successful submission of payment data.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain of the client organization using the Entrata service.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "authentication_type", + "required": true, + "description": "Set the type of authentication. Accepted value: 'apikey'.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "auth.type" + }, + { + "name": "method_name_for_ar_payments", + "required": true, + "description": "Specifies the method name for accounts receivable payments. Use 'getArPayments' to retrieve AR payments.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArPayments" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.name" + }, + { + "name": "response_correlation_id", + "required": false, + "description": "An arbitrary value used to correlate and track the response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestId" + }, + { + "name": "api_version", + "required": false, + "description": "Specify the version of the API to use, options: ['r1'].", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.version" + }, + { + "name": "ar_payment_ids", + "required": false, + "description": "Optional. Comma-separated list of accounts receivable payment IDs for processing.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids." + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.arPaymentIds" + }, + { + "name": "payment_status_type_identifiers", + "required": false, + "description": "Optional. Comma-separated IDs representing payment status types.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids." + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.paymentStatusTypeIds" + }, + { + "name": "from_date", + "required": false, + "description": "Optional. Accepts a single date value that represents the starting point for the query in YYYY-MM-DD format.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. From date." + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.fromDate" + }, + { + "name": "to_date", + "required": false, + "description": "Optional field specifying the end date for the request. Accepts a single date value.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. To date" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.toDate" + }, + { + "name": "include_allocations", + "required": false, + "description": "Optional. Set to 1 to include allocations details of payment; 0 otherwise.", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment" + }, + "inferrable": true, + "http_endpoint_parameter_name": "method.params.isIncludeAllocations" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/arpayments", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "auth.type", + "tool_parameter_name": "authentication_type", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "apikey" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestId", + "tool_parameter_name": "response_correlation_id", + "description": "an arbitary value to relate with response.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "an arbitary value to relate with response." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.name", + "tool_parameter_name": "method_name_for_ar_payments", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "getArPayments" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.version", + "tool_parameter_name": "api_version", + "description": "", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": [ + "r1" + ], + "properties": null, + "inner_properties": null, + "description": "" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.arPaymentIds", + "tool_parameter_name": "ar_payment_ids", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.paymentStatusTypeIds", + "tool_parameter_name": "payment_status_type_identifiers", + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.fromDate", + "tool_parameter_name": "from_date", + "description": "This is an optional field. This field accepts single value. From date.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. From date." + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.toDate", + "tool_parameter_name": "to_date", + "description": "This is an optional field. This field accepts single value. To date", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. To date" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "method.params.isIncludeAllocations", + "tool_parameter_name": "include_allocations", + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment", + "value_schema": { + "val_type": "integer", + "inner_val_type": null, + "enum": [ + "0", + "1" + ], + "properties": null, + "inner_properties": null, + "description": "This is an optional field. This field accepts single value. This node should include allocations details of payment" + }, + "accepted_as": "body", + "required": false, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"description\": \"Retrieves AR payments details with reference to a Payment ID and for a selected date range.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getArPayments\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"arPaymentIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comma separated ar payment ids.\"\n },\n \"paymentStatusTypeIds\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": 123456,\n \"description\": \"This is an optional field. This field accepts comma seperated multiple values. Comma separated payment status type ids.\"\n },\n \"fromDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. From date.\"\n },\n \"toDate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"example\": \"MM/DD/YYYY\",\n \"description\": \"This is an optional field. This field accepts single value. To date\"\n },\n \"isIncludeAllocations\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"enum\": [\n 0,\n 1\n ],\n \"description\": \"This is an optional field. This field accepts single value. This node should include allocations details of payment\"\n }\n },\n \"required\": [\n \"applicationId\",\n \"propertyId\"\n ]\n }\n }\n }\n }\n },\n \"examples\": {\n \"getArPayments\": {\n \"$ref\": \"#/components/examples/getArPaymentsRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/arcade_entrata_api/wrapper_tools/UpdatePricing.json b/servers/entrata_api/arcade_entrata_api/wrapper_tools/UpdatePricing.json new file mode 100644 index 00000000..27111cda --- /dev/null +++ b/servers/entrata_api/arcade_entrata_api/wrapper_tools/UpdatePricing.json @@ -0,0 +1,148 @@ +{ + "name": "UpdatePricing", + "fully_qualified_name": "EntrataApi.UpdatePricing@0.1.0", + "description": "Update pricing information for a specified organization.\n\nUse this tool to adjust the pricing details for an organization. This is typically called when changes in pricing need to be implemented for specific organizational needs or market conditions.", + "toolkit": { + "name": "EntrataApi", + "description": null, + "version": "0.1.0" + }, + "input": { + "parameters": [ + { + "name": "client_subdomain", + "required": true, + "description": "The subdomain associated with the client organization for which pricing is being updated.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "inferrable": true, + "http_endpoint_parameter_name": "orgs" + }, + { + "name": "pricing_update_details", + "required": true, + "description": "A JSON array containing the details for pricing updates. Each element should include specifics like product ID, new price, and effective date.", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "inferrable": true, + "http_endpoint_parameter_name": "requestBody" + } + ] + }, + "output": { + "description": "Response from the API endpoint ''.", + "available_modes": [ + "value", + "error", + "null" + ], + "value_schema": { + "val_type": "json", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": null + } + }, + "requirements": { + "authorization": null, + "secrets": [ + { + "key": "ENTRATA_API_KEY" + }, + { + "key": "ENTRATA_DOMAIN" + } + ], + "metadata": null + }, + "deprecation_message": null, + "metadata": { + "object_type": "api_wrapper_tool", + "version": "1.1.0", + "description": "Tools that enable LLMs to interact directly with the Entrata API" + }, + "http_endpoint": { + "metadata": { + "object_type": "http_endpoint", + "version": "1.2.0", + "description": "" + }, + "url": "https://apis.{ENTRATA_DOMAIN}/ext/orgs/{orgs}/v1/pricing", + "http_method": "POST", + "headers": {}, + "parameters": [ + { + "name": "orgs", + "tool_parameter_name": "client_subdomain", + "description": "Client subdomain.", + "value_schema": { + "val_type": "string", + "inner_val_type": null, + "enum": null, + "properties": null, + "inner_properties": null, + "description": "Client subdomain." + }, + "accepted_as": "path", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + }, + { + "name": "requestBody", + "tool_parameter_name": "pricing_update_details", + "description": "", + "value_schema": { + "val_type": "array", + "inner_val_type": "json", + "enum": null, + "properties": null, + "inner_properties": {}, + "description": "" + }, + "accepted_as": "body", + "required": true, + "deprecated": false, + "default": null, + "documentation_urls": [] + } + ], + "documentation_urls": [], + "secrets": [ + { + "arcade_key": "ENTRATA_API_KEY", + "parameter_name": "X-Api-Key", + "accepted_as": "header", + "formatted_value": null, + "description": "", + "is_auth_token": false + }, + { + "arcade_key": "ENTRATA_DOMAIN", + "parameter_name": "entrata_domain", + "accepted_as": "path", + "formatted_value": null, + "description": "", + "is_auth_token": false + } + ], + "request_body_spec": "{\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPricingPicklists\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"getPropertyFees\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"required\": [\n \"propertyId\"\n ],\n \"properties\": {\n \"propertyId\": {\n \"type\": \"string\",\n \"example\": \"12345\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n }\n }\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"insertPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4,\n \"description\": \"This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.\"\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.\"\n },\n \"chargeUsageId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance\"\n },\n \"chargeUsageReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is a required field. This field accepts single value. This value needs to set if needs to update pricing any other than base rent. E.g if want to update amenity rent then chargeUsageReferenceId should amenity id. In the case of base pricing, it needs to be 0.\"\n },\n \"isRenewal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is an optional field. This field accepts single value. Just to specify if it is renewal rent.\"\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 307,\n \"description\": \"This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing]. E .g. There are a number of possible values but common is 307: Monthly 202: Move In 206: Move Out 102: Application Completed\"\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 2,\n \"description\": \"This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit\"\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.\"\n },\n \"leaseTermMonths\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 12,\n \"description\": \"This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing f or different terms. Zero means single value for all lease terms.\"\n },\n \"leaseStartRangeStart\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 0,\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRa ngeEnd:2 amount:700 Zero represents current date or unit`s available on the date [if available on a date is in future]. If sending \\\"isRenewal\\\" as true this value should always be sent as 0\"\n },\n \"leaseStartRangeEnd\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 10000,\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRange Start:0 leaseStartRangeEnd:2 amount:700. If sending \\\"isRenewal\\\" as true this value should always be sent as 0\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 1840,\n \"description\": \"This is a required field. This field accepts single value. Rate Amount.\"\n },\n \"leaseTermName\": {\n \"type\": \"string\",\n \"format\": \"string\",\n \"example\": \"chris@sam.com\",\n \"description\": \"This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is m andatory.\"\n }\n },\n \"required\": [\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"chargeUsageId\",\n \"chargeUsageReferenceId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"amount\",\n \"leaseTermName\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\",\n \"version\",\n \"params\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"insertPricing\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r2\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. propertyId\",\n \"example\": 1381146\n },\n \"pricing\": {\n \"type\": \"array\",\n \"description\": \"Array of pricing objects\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. Pricing level has four possible values, 1: property, 2: floor plan 3: Unit type 4: Unit space.\",\n \"example\": 3\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId.\",\n \"example\": 639824\n },\n \"chargeUsageId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This helps to differentiate pricing usage. 1. Base 2: Amenity 3: Pet 4: Add-Ons 5: Risk Premium 7: Maintenance\",\n \"example\": 1\n },\n \"isRenewal\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Just to specify if it is renewal rent.\",\n \"example\": 0\n },\n \"chargeTimingId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This explains when charge suppose to apply [charge trigger timing].\",\n \"example\": 303\n },\n \"chargeCodeTypeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This explains charge code types. 1: Payment 2: Rent 3: Other Income 7: Deposit\",\n \"example\": 2\n },\n \"chargeCodeId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is a required field. This field accepts single value. This is Entrata charge code id which we want to use.\",\n \"example\": 224711\n },\n \"leaseTermMonths\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Most of the cases it will be zero but if the property has the setup to have term wise pricing/rent then you can send the different pricing for different terms.\",\n \"example\": 13\n },\n \"leaseTermId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Lease term identifier.\",\n \"example\": 33549\n },\n \"leaseStartWindowId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Lease start window identifier.\",\n \"example\": 240891\n },\n \"spaceConfigurationId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. Space configuration identifier.\",\n \"example\": 2\n },\n \"leaseTermName\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. If there are multiple lease terms with same length then this node is mandatory.\",\n \"example\": \"Lease Term 2\"\n },\n \"leaseStartRangeStart\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This nodes allows to send different rent amount for different move in dates but with same intervals. Refer Property setting: Price By Lease Start Range. E.g Property has pricing setup to have 3 days interval pricing then data can looks like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700 Zero represents current date or unit's available on the date [if available on a date is in future]. If sending 'isRenewal' as true this value should always be sent as 0\",\n \"example\": 2\n },\n \"leaseStartRangeEnd\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"description\": \"This is an optional field. This field accepts single value. This nodes allows to send different rent amount for different move in dates but with the same intervals. E.g Property has pricing setup to have 3 days interval pricing then data can look like, leaseStartRangeStart:0 leaseStartRangeEnd:2 amount:700. If sending 'isRenewal' as true this value should always be sent as 0\",\n \"example\": 4\n },\n \"amount\": {\n \"type\": \"string\",\n \"description\": \"This is a required field. This field accepts single value. Rate Amount.\",\n \"example\": \"40.00\"\n },\n \"isFullUpdate\": {\n \"type\": \"string\",\n \"description\": \"This is an optional field. This field accepts single value. Indicates if this is a full update operation.\",\n \"example\": \"1\"\n }\n },\n \"required\": [\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"chargeUsageId\",\n \"chargeTimingId\",\n \"chargeCodeTypeId\",\n \"chargeCodeId\",\n \"leaseTermName\",\n \"amount\"\n ]\n }\n }\n },\n \"required\": [\n \"propertyId\",\n \"pricing\"\n ]\n }\n }\n }\n }\n },\n {\n \"required\": [\n \"auth\",\n \"method\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"auth\": {\n \"required\": [\n \"type\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"apikey\"\n ]\n }\n }\n },\n \"requestId\": {\n \"type\": \"string\",\n \"description\": \"an arbitary value to relate with response.\"\n },\n \"method\": {\n \"required\": [\n \"name\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"enum\": [\n \"sendBudgetedRent\"\n ]\n },\n \"version\": {\n \"type\": \"string\",\n \"enum\": [\n \"r1\"\n ]\n },\n \"params\": {\n \"type\": \"object\",\n \"properties\": {\n \"propertyId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 4,\n \"description\": \"This is a required field. This field accepts single value. propertyId\"\n },\n \"pricingLevelId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 123456,\n \"description\": \" This is a required field. This field accepts single value. Pricing level has two possible values, 3 for Unit type and 4 for Unit space.\"\n },\n \"pricingLevelReferenceId\": {\n \"type\": \"integer\",\n \"format\": \"integer\",\n \"example\": 1,\n \"description\": \"This is a required field. This field accepts single value. This is Entrata`s record id depending on #pricingLevelId. E.g. If pric ingLevelId = 3 then pricingLevelReferenceId needs to be unit type id a nd if pricingLevelId = 4 then pricingLevelReferenceId needs to be unit space id.\"\n },\n \"amenityAmount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 20,\n \"description\": \"This is an optional field. This field accepts single value. Amenity rate amount.\"\n },\n \"amount\": {\n \"type\": \"integer\",\n \"format\": \"float\",\n \"example\": 20,\n \"description\": \"This is a required field. This field accepts single value. amount\"\n }\n },\n \"required\": [\n \"propertyId\",\n \"pricingLevelId\",\n \"pricingLevelReferenceId\",\n \"amount\"\n ]\n }\n }\n }\n }\n }\n ]\n }\n },\n \"examples\": {\n \"getPricingPicklists\": {\n \"$ref\": \"#/components/examples/getPricingPicklistsRequest\"\n },\n \"getPropertyFees\": {\n \"$ref\": \"#/components/examples/getPropertyFeesRequest\"\n },\n \"insertPricing\": {\n \"$ref\": \"#/components/examples/insertPricingRequest\"\n },\n \"insertPricing_r2\": {\n \"$ref\": \"#/components/examples/insertPricingRequest_r2\"\n },\n \"sendBudgetedRent\": {\n \"$ref\": \"#/components/examples/sendBudgetedRentRequest\"\n }\n }\n }\n }\n}", + "use_request_body_schema_mode": false, + "validate_request_body_schema": false + } +} diff --git a/servers/entrata_api/pyproject.toml b/servers/entrata_api/pyproject.toml new file mode 100644 index 00000000..78d0aee7 --- /dev/null +++ b/servers/entrata_api/pyproject.toml @@ -0,0 +1,54 @@ +[build-system] +requires = [ "hatchling",] +build-backend = "hatchling.build" + +[project] +name = "entrata_api" +version = "0.1.0" +description = "Tools that enable LLMs to interact directly with the Entrata API" +requires-python = ">=3.10" +dependencies = [ + "arcade-tdk>=3.0.0,<4.0.0", +] +[[project.authors]] +email = "support@arcade.dev" + + +[project.optional-dependencies] +dev = [ + "arcade-mcp[evals]>=1.3.0,<2.0.0", + "arcade-serve>=3.0.0,<4.0.0", + "pytest>=8.3.0,<8.4.0", + "pytest-cov>=4.0.0,<4.1.0", + "pytest-mock>=3.11.1,<3.12.0", + "pytest-asyncio>=0.24.0,<0.25.0", + "mypy>=1.5.1,<1.6.0", + "pre-commit>=3.4.0,<3.5.0", + "tox>=4.11.1,<4.12.0", + "ruff>=0.7.4,<0.8.0", +] + +# Tell Arcade.dev that this package is a toolkit +[project.entry-points.arcade_toolkits] +toolkit_name = "entrata_api" + +[tool.mypy] +files = [ "entrata_api/**/*.py",] +python_version = "3.10" +disallow_untyped_defs = "True" +disallow_any_unimported = "True" +no_implicit_optional = "True" +check_untyped_defs = "True" +warn_return_any = "True" +warn_unused_ignores = "True" +show_error_codes = "True" +ignore_missing_imports = "True" + +[tool.pytest.ini_options] +testpaths = [ "tests",] + +[tool.coverage.report] +skip_empty = true + +[tool.hatch.build.targets.wheel] +packages = [ "entrata_api",] \ No newline at end of file diff --git a/servers/entrata_api/tests/__init__.py b/servers/entrata_api/tests/__init__.py new file mode 100644 index 00000000..e69de29b From 8b363eeda04405b44acb45161e50eb7cf4d6858e Mon Sep 17 00:00:00 2001 From: Renato Byrro Date: Fri, 7 Nov 2025 18:54:03 -0300 Subject: [PATCH 2/2] update pyproject --- servers/entrata_api/pyproject.toml | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/servers/entrata_api/pyproject.toml b/servers/entrata_api/pyproject.toml index 78d0aee7..3af4b21c 100644 --- a/servers/entrata_api/pyproject.toml +++ b/servers/entrata_api/pyproject.toml @@ -3,12 +3,14 @@ requires = [ "hatchling",] build-backend = "hatchling.build" [project] -name = "entrata_api" +name = "arcade_entrata_api" version = "0.1.0" description = "Tools that enable LLMs to interact directly with the Entrata API" requires-python = ">=3.10" dependencies = [ "arcade-tdk>=3.0.0,<4.0.0", + "httpx[http2]>=0.27.2,<1.0.0", + "jsonschema>=4.0.0,<5.0.0", ] [[project.authors]] email = "support@arcade.dev" @@ -16,7 +18,7 @@ email = "support@arcade.dev" [project.optional-dependencies] dev = [ - "arcade-mcp[evals]>=1.3.0,<2.0.0", + "arcade-mcp[all]>=1.2.0,<2.0.0", "arcade-serve>=3.0.0,<4.0.0", "pytest>=8.3.0,<8.4.0", "pytest-cov>=4.0.0,<4.1.0", @@ -30,10 +32,15 @@ dev = [ # Tell Arcade.dev that this package is a toolkit [project.entry-points.arcade_toolkits] -toolkit_name = "entrata_api" +toolkit_name = "arcade_entrata_api" +# Use local path sources for arcade libs when working locally +[tool.uv.sources] +arcade-mcp = { path = "../../../arcade-mcp", editable = true } +arcade-serve = { path = "../../../arcade-mcp/libs/arcade-serve/", editable = true } +arcade-tdk = { path = "../../../arcade-mcp/libs/arcade-tdk/", editable = true } [tool.mypy] -files = [ "entrata_api/**/*.py",] +files = [ "arcade_entrata_api/**/*.py",] python_version = "3.10" disallow_untyped_defs = "True" disallow_any_unimported = "True" @@ -51,4 +58,4 @@ testpaths = [ "tests",] skip_empty = true [tool.hatch.build.targets.wheel] -packages = [ "entrata_api",] \ No newline at end of file +packages = [ "arcade_entrata_api",] \ No newline at end of file