Skip to content
/
Bulk write 'Spacebaserent...

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

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Create 'Spacebaserentvatstatusnotation'

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
as_ofstring(date-time)required
has_base_rent_vatbooleanrequired
custom_idstring or null<= 128 characters
notestring or null
created_byobject or null(Organizationuser)
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, outdoor_section

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section

outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, parking_spot

organizationobject or null(Organization)
industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: apartment, parking_spot, outdoor_section

curl -i -X POST \
  https://dev.api.pigello.io/objects/vatkeys/spacebaserentvatstatusnotation/ \
  -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 '{
    "custom_id": "string",
    "note": "string",
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "as_of": "2019-08-24T14:15:22Z",
    "apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "has_base_rent_vat": true,
    "parking_spot": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoor_section": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "industrial_premises": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

as_ofstring(date-time)required
has_base_rent_vatbooleanrequired
custom_idstring or null<= 128 characters
notestring or null
created_byobject or null(Organizationuser)
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, outdoor_section

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section

created_atstring(date-time)read-only
outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, parking_spot

organizationobject or null(Organization)
industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: apartment, parking_spot, outdoor_section

Response
application/json
{
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "note": "string",
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "as_of": "2019-08-24T14:15:22Z",
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "has_base_rent_vat": true,
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Bulk write 'Spacebaserentvatstatusnotation'

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 [
as_ofstring(date-time)required
has_base_rent_vatbooleanrequired
custom_idstring or null<= 128 characters
notestring or null
created_byobject or null(Organizationuser)
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, outdoor_section

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section

outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, parking_spot

organizationobject or null(Organization)
industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: apartment, parking_spot, outdoor_section

]
curl -i -X POST \
  https://dev.api.pigello.io/objects/vatkeys/spacebaserentvatstatusnotation/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 '[
    {
      "custom_id": "string",
      "note": "string",
      "created_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "as_of": "2019-08-24T14:15:22Z",
      "apartment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "has_base_rent_vat": true,
      "parking_spot": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "outdoor_section": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "industrial_premises": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

as_ofstring(date-time)required
has_base_rent_vatbooleanrequired
custom_idstring or null<= 128 characters
notestring or null
created_byobject or null(Organizationuser)
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, outdoor_section

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section

created_atstring(date-time)read-only
outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, parking_spot

organizationobject or null(Organization)
industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: apartment, parking_spot, outdoor_section

]
Response
application/json
[
  {
    "custom_id": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "note": "string",
    "created_by": { … },
    "as_of": "2019-08-24T14:15:22Z",
    "apartment": { … },
    "has_base_rent_vat": true,
    "parking_spot": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "outdoor_section": { … },
    "organization": { … },
    "industrial_premises": { … }
  }
]

List 'Spacebaserentvatstatusnotation'

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
global_realestatesArray of objects
global_segmentsArray of objects
apartmentany

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

as_ofany

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

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

created_byany

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

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

has_base_rent_vatany

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

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

industrial_premisesany

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

noteany

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

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_sectionany

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_spotany

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

curl -i -X GET \
  'https://dev.api.pigello.io/objects/vatkeys/spacebaserentvatstatusnotation/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

as_ofstring(date-time)required
has_base_rent_vatbooleanrequired
custom_idstring or null<= 128 characters
notestring or null
created_byobject or null(Organizationuser)
apartmentobject or null(Apartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: industrial_premises, parking_spot, outdoor_section

parking_spotobject or null(Parkingspot)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, outdoor_section

This field, or at least one of the following fields must be set: apartment, industrial_premises, outdoor_section

created_atstring(date-time)read-only
outdoor_sectionobject or null(Outdoorsection)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, industrial_premises, parking_spot

This field, or at least one of the following fields must be set: apartment, industrial_premises, parking_spot

organizationobject or null(Organization)
industrial_premisesobject or null(Industrialpremises)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment, parking_spot, outdoor_section

This field, or at least one of the following fields must be set: apartment, parking_spot, outdoor_section

]
Response
application/json
[
  {
    "custom_id": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "note": "string",
    "created_by": { … },
    "as_of": "2019-08-24T14:15:22Z",
    "apartment": { … },
    "has_base_rent_vat": true,
    "parking_spot": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "outdoor_section": { … },
    "organization": { … },
    "industrial_premises": { … }
  }
]

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.