Skip to content
/
Create 'Realestate'

Objects (2.0.0)

The 'Objects' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Parkingspot

Operations

Apartmenttargetaudience

Operations

Parkingspotvacancynotation

Operations

Industrialpremises

Operations

Industrialpremisesvacancylossnotation

Operations

Industrialpremisestargetaudience

Operations

Outdoorsectionterms

Operations

Industrialpremisesvacancynotation

Operations

Outdoorsectiontargetaudience

Operations

Commonarea

Operations

Industrialpremisesterms

Operations

Parkingspotvacancylossnotation

Operations

Outdoorsectionvacancynotation

Operations

Parkingspottargetaudience

Operations

Apartmentterms

Operations

Apartmentvacancylossnotation

Operations

Outdoorsectionvacancylossnotation

Operations

Parkingspotterms

Operations

Brfapartment

Operations

Apartment

Operations

Apartmentvacancynotation

Operations

Outdoorsection

Operations

Componentmodel

Operations

Componenttype

Operations

Parkinglot

Operations

Realestate

Operations

Bulk write 'Realestate'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
type_codeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum513520580581829610100613620110
communityobject or null(Community)
non_financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

outdoor_section_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
popular_namestring or null<= 255 characters
sold_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date, non_financial_responsibility_to, financial_responsibility_to

ownership_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum1234
parking_spot_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
owned_byobject or null(Company)
public_usageboolean
purchased_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date, financial_responsibility_from, non_financial_responsibility_from

primary_financial_handlerobject or null(Company)
registered_land_areanumber or null(float)
financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

customer_communication_configurationobject or null(Customercommunicationconfiguration)
registered_water_areanumber or null(float)
organizationobject or null(Organization)
block_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
industrial_premises_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
custom_idstring or null<= 128 characters
apartment_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
non_financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

main_addressobject or null(Address)
landlordobject or null(Company)
financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

custom_dimension_valuestring or null<= 255 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/objects/structural/realestate/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "type_code": 513,
      "community": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "non_financial_responsibility_to": "2019-08-24",
      "outdoor_section_contract_cancellation_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string",
      "popular_name": "string",
      "sold_date": "2019-08-24",
      "ownership_type": 1,
      "parking_spot_contract_cancellation_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "owned_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "public_usage": true,
      "purchased_date": "2019-08-24",
      "primary_financial_handler": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "registered_land_area": 0.1,
      "financial_responsibility_from": "2019-08-24",
      "customer_communication_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "registered_water_area": 0.1,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "block_contract_cancellation_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "industrial_premises_contract_cancellation_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "apartment_contract_cancellation_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "non_financial_responsibility_from": "2019-08-24",
      "main_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "landlord": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "financial_responsibility_to": "2019-08-24",
      "custom_dimension_value": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

pending_monitor_approval_amountanyread-only
type_codeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum513520580581829610100613620110
communityobject or null(Community)
non_financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

calculated_land_areanumber(float)read-only
calculated_usable_area_rentablenumber(float)read-only
created_atstring(date-time)read-only
outdoor_section_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
popular_namestring or null<= 255 characters
sold_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date, non_financial_responsibility_to, financial_responsibility_to

ownership_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum1234
parking_spot_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
owned_byobject or null(Company)
public_usageboolean
purchased_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date, financial_responsibility_from, non_financial_responsibility_from

primary_financial_handlerobject or null(Company)
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
tagsanyread-only
registered_land_areanumber or null(float)
customer_columnsanyread-only
financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

customer_communication_configurationobject or null(Customercommunicationconfiguration)
registered_water_areanumber or null(float)
organizationobject or null(Organization)
block_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
calculated_base_rent_vat_quotanumber(float)read-only
industrial_premises_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
custom_idstring or null<= 128 characters
apartment_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
non_financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

main_addressobject or null(Address)
landlordobject or null(Company)
financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

custom_dimension_valuestring or null<= 255 characters
]
Response
application/json
[
  {
    "pending_monitor_approval_amount": null,
    "type_code": 513,
    "community": { … },
    "non_financial_responsibility_to": "2019-08-24",
    "calculated_land_area": 0.1,
    "calculated_usable_area_rentable": 0.1,
    "created_at": "2019-08-24T14:15:22Z",
    "outdoor_section_contract_cancellation_configuration": { … },
    "name": "string",
    "popular_name": "string",
    "sold_date": "2019-08-24",
    "ownership_type": 1,
    "parking_spot_contract_cancellation_configuration": { … },
    "owned_by": { … },
    "public_usage": true,
    "purchased_date": "2019-08-24",
    "primary_financial_handler": { … },
    "calculated_usable_area_rentable_base_rent_vat": 0.1,
    "tags": null,
    "registered_land_area": 0.1,
    "customer_columns": null,
    "financial_responsibility_from": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_communication_configuration": { … },
    "registered_water_area": 0.1,
    "organization": { … },
    "block_contract_cancellation_configuration": { … },
    "calculated_base_rent_vat_quota": 0.1,
    "industrial_premises_contract_cancellation_configuration": { … },
    "custom_id": "string",
    "apartment_contract_cancellation_configuration": { … },
    "non_financial_responsibility_from": "2019-08-24",
    "main_address": { … },
    "landlord": { … },
    "financial_responsibility_to": "2019-08-24",
    "custom_dimension_value": "string"
  }
]

Create 'Realestate'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
namestring<= 255 charactersrequired
type_codeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum513520580581829610100613620110
communityobject or null(Community)
non_financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

outdoor_section_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
popular_namestring or null<= 255 characters
sold_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date, non_financial_responsibility_to, financial_responsibility_to

ownership_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum1234
parking_spot_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
owned_byobject or null(Company)
public_usageboolean
purchased_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date, financial_responsibility_from, non_financial_responsibility_from

primary_financial_handlerobject or null(Company)
registered_land_areanumber or null(float)
financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

customer_communication_configurationobject or null(Customercommunicationconfiguration)
registered_water_areanumber or null(float)
organizationobject or null(Organization)
block_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
industrial_premises_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
custom_idstring or null<= 128 characters
apartment_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
non_financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

main_addressobject or null(Address)
landlordobject or null(Company)
financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

custom_dimension_valuestring or null<= 255 characters
curl -i -X POST \
  https://dev.api.pigello.io/objects/structural/realestate/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "type_code": 513,
    "community": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "non_financial_responsibility_to": "2019-08-24",
    "outdoor_section_contract_cancellation_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "name": "string",
    "popular_name": "string",
    "sold_date": "2019-08-24",
    "ownership_type": 1,
    "parking_spot_contract_cancellation_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "owned_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "public_usage": true,
    "purchased_date": "2019-08-24",
    "primary_financial_handler": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "registered_land_area": 0.1,
    "financial_responsibility_from": "2019-08-24",
    "customer_communication_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "registered_water_area": 0.1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "block_contract_cancellation_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "industrial_premises_contract_cancellation_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "apartment_contract_cancellation_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "non_financial_responsibility_from": "2019-08-24",
    "main_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "landlord": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "financial_responsibility_to": "2019-08-24",
    "custom_dimension_value": "string"
  }'

Responses

Successful creation

Bodyapplication/json
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

pending_monitor_approval_amountanyread-only
type_codeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum513520580581829610100613620110
communityobject or null(Community)
non_financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

calculated_land_areanumber(float)read-only
calculated_usable_area_rentablenumber(float)read-only
created_atstring(date-time)read-only
outdoor_section_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
popular_namestring or null<= 255 characters
sold_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date, non_financial_responsibility_to, financial_responsibility_to

ownership_typeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum1234
parking_spot_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
owned_byobject or null(Company)
public_usageboolean
purchased_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date, financial_responsibility_from, non_financial_responsibility_from

primary_financial_handlerobject or null(Company)
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
tagsanyread-only
registered_land_areanumber or null(float)
customer_columnsanyread-only
financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

customer_communication_configurationobject or null(Customercommunicationconfiguration)
registered_water_areanumber or null(float)
organizationobject or null(Organization)
block_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
calculated_base_rent_vat_quotanumber(float)read-only
industrial_premises_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
custom_idstring or null<= 128 characters
apartment_contract_cancellation_configurationobject or null(Contractcancellationconfiguration)
non_financial_responsibility_fromstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: purchased_date

main_addressobject or null(Address)
landlordobject or null(Company)
financial_responsibility_tostring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: sold_date

custom_dimension_valuestring or null<= 255 characters
Response
application/json
{
  "pending_monitor_approval_amount": null,
  "type_code": 513,
  "community": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "non_financial_responsibility_to": "2019-08-24",
  "calculated_land_area": 0.1,
  "calculated_usable_area_rentable": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "outdoor_section_contract_cancellation_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "popular_name": "string",
  "sold_date": "2019-08-24",
  "ownership_type": 1,
  "parking_spot_contract_cancellation_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "owned_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "public_usage": true,
  "purchased_date": "2019-08-24",
  "primary_financial_handler": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "tags": null,
  "registered_land_area": 0.1,
  "customer_columns": null,
  "financial_responsibility_from": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer_communication_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registered_water_area": 0.1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract_cancellation_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "calculated_base_rent_vat_quota": 0.1,
  "industrial_premises_contract_cancellation_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "apartment_contract_cancellation_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "non_financial_responsibility_from": "2019-08-24",
  "main_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "landlord": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "financial_responsibility_to": "2019-08-24",
  "custom_dimension_value": "string"
}

Delete 'Realestate'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/objects/structural/realestate/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful deletion

Response
No content

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.