Skip to content

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

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Bulk write 'Taxationsubrecord'

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 [
for_yearinteger(int32)[ 1900 .. 9000 ]required
pre_adjusted_valuenumber(float)required
valuenumber(float)required
taxation_recordobject(Taxationrecord)required
taxation_record.​idstring(uuid)
structure_operation_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
value_adjustment_motivationstring or null
spaces_areanumber or null(float)
organizationobject or null(Organization)
taxation_unit_numberstring or null
value_adjustment_codestring or null
consider_under_constructionboolean
custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

value_yearinteger or null(int32)[ 1900 .. 9000 ]
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

yearly_rentnumber or null(float)
]
curl -i -X POST \
  https://dev.api.pigello.io/objects/taxations/taxationsubrecord/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 '[
    {
      "value_adjustment_motivation": "string",
      "spaces_area": 0.1,
      "for_year": 1900,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "taxation_unit_number": "string",
      "value_adjustment_code": "string",
      "pre_adjusted_value": 0.1,
      "consider_under_construction": true,
      "custom_id": "string",
      "parking_lot": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "value": 0.1,
      "taxation_record": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "value_year": 1900,
      "structure_operation_type": 0,
      "outdoor_area": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "building": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "yearly_rent": 0.1
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
for_yearinteger(int32)[ 1900 .. 9000 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

pre_adjusted_valuenumber(float)required
valuenumber(float)required
taxation_recordobject(Taxationrecord)required
taxation_record.​idstring(uuid)
structure_operation_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
value_adjustment_motivationstring or null
tagsanyread-only
spaces_areanumber or null(float)
organizationobject or null(Organization)
taxation_unit_numberstring or null
value_adjustment_codestring or null
consider_under_constructionboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

value_yearinteger or null(int32)[ 1900 .. 9000 ]
customer_columnsanyread-only
tax_valueanyread-only
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

pending_monitor_approval_amountanyread-only
taxation_typeanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

yearly_rentnumber or null(float)
]
Response
application/json
[
  {
    "value_adjustment_motivation": "string",
    "tags": null,
    "spaces_area": 0.1,
    "for_year": 1900,
    "organization": { … },
    "taxation_unit_number": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "value_adjustment_code": "string",
    "pre_adjusted_value": 0.1,
    "consider_under_construction": true,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "parking_lot": { … },
    "value": 0.1,
    "taxation_record": { … },
    "value_year": 1900,
    "structure_operation_type": 0,
    "customer_columns": null,
    "tax_value": null,
    "outdoor_area": { … },
    "pending_monitor_approval_amount": null,
    "taxation_type": null,
    "building": { … },
    "yearly_rent": 0.1
  }
]

List 'Taxationsubrecord'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
buildingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

consider_under_constructionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

for_yearany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

outdoor_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

parking_lotany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

pre_adjusted_valueany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

spaces_areaany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

structure_operation_typeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

taxation_recordany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

taxation_unit_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

valueany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

value_adjustment_codeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

value_adjustment_motivationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

value_yearany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

yearly_rentany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/objects/taxations/taxationsubrecord/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -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 query

Bodyapplication/jsonArray [
for_yearinteger(int32)[ 1900 .. 9000 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

pre_adjusted_valuenumber(float)required
valuenumber(float)required
taxation_recordobject(Taxationrecord)required
taxation_record.​idstring(uuid)
structure_operation_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
value_adjustment_motivationstring or null
tagsanyread-only
spaces_areanumber or null(float)
organizationobject or null(Organization)
taxation_unit_numberstring or null
value_adjustment_codestring or null
consider_under_constructionboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

value_yearinteger or null(int32)[ 1900 .. 9000 ]
customer_columnsanyread-only
tax_valueanyread-only
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

pending_monitor_approval_amountanyread-only
taxation_typeanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

yearly_rentnumber or null(float)
]
Response
application/json
[
  {
    "value_adjustment_motivation": "string",
    "tags": null,
    "spaces_area": 0.1,
    "for_year": 1900,
    "organization": { … },
    "taxation_unit_number": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "value_adjustment_code": "string",
    "pre_adjusted_value": 0.1,
    "consider_under_construction": true,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "parking_lot": { … },
    "value": 0.1,
    "taxation_record": { … },
    "value_year": 1900,
    "structure_operation_type": 0,
    "customer_columns": null,
    "tax_value": null,
    "outdoor_area": { … },
    "pending_monitor_approval_amount": null,
    "taxation_type": null,
    "building": { … },
    "yearly_rent": 0.1
  }
]

Create 'Taxationsubrecord'

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
for_yearinteger(int32)[ 1900 .. 9000 ]required
pre_adjusted_valuenumber(float)required
valuenumber(float)required
taxation_recordobject(Taxationrecord)required
taxation_record.​idstring(uuid)
structure_operation_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
value_adjustment_motivationstring or null
spaces_areanumber or null(float)
organizationobject or null(Organization)
taxation_unit_numberstring or null
value_adjustment_codestring or null
consider_under_constructionboolean
custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

value_yearinteger or null(int32)[ 1900 .. 9000 ]
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

yearly_rentnumber or null(float)
curl -i -X POST \
  https://dev.api.pigello.io/objects/taxations/taxationsubrecord/ \
  -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 '{
    "value_adjustment_motivation": "string",
    "spaces_area": 0.1,
    "for_year": 1900,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "taxation_unit_number": "string",
    "value_adjustment_code": "string",
    "pre_adjusted_value": 0.1,
    "consider_under_construction": true,
    "custom_id": "string",
    "parking_lot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "value": 0.1,
    "taxation_record": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "value_year": 1900,
    "structure_operation_type": 0,
    "outdoor_area": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "building": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "yearly_rent": 0.1
  }'

Responses

Successful creation

Bodyapplication/json
for_yearinteger(int32)[ 1900 .. 9000 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

pre_adjusted_valuenumber(float)required
valuenumber(float)required
taxation_recordobject(Taxationrecord)required
taxation_record.​idstring(uuid)
structure_operation_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
value_adjustment_motivationstring or null
tagsanyread-only
spaces_areanumber or null(float)
organizationobject or null(Organization)
taxation_unit_numberstring or null
value_adjustment_codestring or null
consider_under_constructionboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
parking_lotobject or null(Parkinglot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, outdoor_area

This field, or at least one of the following fields must be set: building, outdoor_area

value_yearinteger or null(int32)[ 1900 .. 9000 ]
customer_columnsanyread-only
tax_valueanyread-only
outdoor_areaobject or null(Outdoorarea)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: building, parking_lot

This field, or at least one of the following fields must be set: building, parking_lot

pending_monitor_approval_amountanyread-only
taxation_typeanyread-only
buildingobject or null(Building)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: parking_lot, outdoor_area

This field, or at least one of the following fields must be set: parking_lot, outdoor_area

yearly_rentnumber or null(float)
Response
application/json
{
  "value_adjustment_motivation": "string",
  "tags": null,
  "spaces_area": 0.1,
  "for_year": 1900,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "taxation_unit_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "value_adjustment_code": "string",
  "pre_adjusted_value": 0.1,
  "consider_under_construction": true,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "parking_lot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "value": 0.1,
  "taxation_record": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "value_year": 1900,
  "structure_operation_type": 0,
  "customer_columns": null,
  "tax_value": null,
  "outdoor_area": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "taxation_type": null,
  "building": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "yearly_rent": 0.1
}

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.