Skip to content
/
Bulk write 'Indexationset...

Revenue (2.0.0)

The 'Revenue' 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

Othercontractrevenueincreaserow

Operations

Industrialpremisesrevenueincreaserow

Operations

Parkingspotcontractrevenueincreaserow

Operations

Outdoorsectionrevenueincreaserow

Operations

Parkingspotrevenueincreaserow

Operations

Apartmentrevenueincreaserow

Operations

Outdoorsectioncontractrevenueincreaserow

Operations

Apartmentcontractrevenueincreaserow

Operations

Revenueincreasecollection

Operations

Industrialpremisescontractrevenueincreaserow

Operations

Customerearningsreport

Operations

Customerearningsrevenuesetting

Operations

Indexationsettingusage

Operations

List 'Indexationsettingusage'

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
apartment_contract_revenue_rowany

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

block_contract_revenue_rowany

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

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_premises_contract_revenue_rowany

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

other_contract_revenue_rowany

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_section_contract_revenue_rowany

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

override_base_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

parking_spot_contract_revenue_rowany

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

revenue_base_value_firm_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

revenue_base_value_quotaany

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

settingany

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

use_revenue_row_as_max_base_valueany

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/revenue/indexation/indexationsettingusage/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 [
settingobject(Indexationsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

industrial_premises_contract_revenue_rowobject or null(Industrialpremisescontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

tagsanyread-only
apartment_contract_revenue_rowobject or null(Apartmentcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

parking_spot_contract_revenue_rowobject or null(Parkingspotcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
other_contract_revenue_rowobject or null(Othercontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

organizationobject or null(Organization)
customer_columnsanyread-only
override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
use_revenue_row_as_max_base_valueboolean or null

Additional Validation Information:

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

block_contract_revenue_rowobject or null(Blockcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

revenue_base_value_quotanumber or null(float)

Additional Validation Information:

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

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

revenue_base_value_firm_valuenumber or null(float)

Additional Validation Information:

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

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

outdoor_section_contract_revenue_rowobject or null(Outdoorsectioncontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "industrial_premises_contract_revenue_row": { … },
    "setting": { … },
    "tags": null,
    "apartment_contract_revenue_row": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "parking_spot_contract_revenue_row": { … },
    "pending_monitor_approval_amount": null,
    "custom_id": "string",
    "other_contract_revenue_row": { … },
    "organization": { … },
    "customer_columns": null,
    "override_base_year": 1900,
    "use_revenue_row_as_max_base_value": true,
    "block_contract_revenue_row": { … },
    "revenue_base_value_quota": 0.1,
    "revenue_base_value_firm_value": 0.1,
    "outdoor_section_contract_revenue_row": { … },
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Bulk write 'Indexationsettingusage'

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 [
settingobject(Indexationsetting)required
setting.​idstring(uuid)
industrial_premises_contract_revenue_rowobject or null(Industrialpremisescontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

apartment_contract_revenue_rowobject or null(Apartmentcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

parking_spot_contract_revenue_rowobject or null(Parkingspotcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

custom_idstring or null<= 128 characters
other_contract_revenue_rowobject or null(Othercontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

organizationobject or null(Organization)
override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
use_revenue_row_as_max_base_valueboolean or null

Additional Validation Information:

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

block_contract_revenue_rowobject or null(Blockcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

revenue_base_value_quotanumber or null(float)

Additional Validation Information:

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

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

revenue_base_value_firm_valuenumber or null(float)

Additional Validation Information:

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

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

outdoor_section_contract_revenue_rowobject or null(Outdoorsectioncontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/indexation/indexationsettingusage/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 '[
    {
      "industrial_premises_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "setting": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "apartment_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "parking_spot_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "other_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "override_base_year": 1900,
      "use_revenue_row_as_max_base_value": true,
      "block_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "revenue_base_value_quota": 0.1,
      "revenue_base_value_firm_value": 0.1,
      "outdoor_section_contract_revenue_row": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
settingobject(Indexationsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

industrial_premises_contract_revenue_rowobject or null(Industrialpremisescontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

tagsanyread-only
apartment_contract_revenue_rowobject or null(Apartmentcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

parking_spot_contract_revenue_rowobject or null(Parkingspotcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
other_contract_revenue_rowobject or null(Othercontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

organizationobject or null(Organization)
customer_columnsanyread-only
override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
use_revenue_row_as_max_base_valueboolean or null

Additional Validation Information:

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

block_contract_revenue_rowobject or null(Blockcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

revenue_base_value_quotanumber or null(float)

Additional Validation Information:

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

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

revenue_base_value_firm_valuenumber or null(float)

Additional Validation Information:

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

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

outdoor_section_contract_revenue_rowobject or null(Outdoorsectioncontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "industrial_premises_contract_revenue_row": { … },
    "setting": { … },
    "tags": null,
    "apartment_contract_revenue_row": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "parking_spot_contract_revenue_row": { … },
    "pending_monitor_approval_amount": null,
    "custom_id": "string",
    "other_contract_revenue_row": { … },
    "organization": { … },
    "customer_columns": null,
    "override_base_year": 1900,
    "use_revenue_row_as_max_base_value": true,
    "block_contract_revenue_row": { … },
    "revenue_base_value_quota": 0.1,
    "revenue_base_value_firm_value": 0.1,
    "outdoor_section_contract_revenue_row": { … },
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Create 'Indexationsettingusage'

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
settingobject(Indexationsetting)required
setting.​idstring(uuid)
industrial_premises_contract_revenue_rowobject or null(Industrialpremisescontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

apartment_contract_revenue_rowobject or null(Apartmentcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

parking_spot_contract_revenue_rowobject or null(Parkingspotcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

custom_idstring or null<= 128 characters
other_contract_revenue_rowobject or null(Othercontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

organizationobject or null(Organization)
override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
use_revenue_row_as_max_base_valueboolean or null

Additional Validation Information:

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

block_contract_revenue_rowobject or null(Blockcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

revenue_base_value_quotanumber or null(float)

Additional Validation Information:

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

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

revenue_base_value_firm_valuenumber or null(float)

Additional Validation Information:

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

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

outdoor_section_contract_revenue_rowobject or null(Outdoorsectioncontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

curl -i -X POST \
  https://dev.api.pigello.io/revenue/indexation/indexationsettingusage/ \
  -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 '{
    "industrial_premises_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "apartment_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "other_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "override_base_year": 1900,
    "use_revenue_row_as_max_base_value": true,
    "block_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "revenue_base_value_quota": 0.1,
    "revenue_base_value_firm_value": 0.1,
    "outdoor_section_contract_revenue_row": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
settingobject(Indexationsetting)required
setting.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

industrial_premises_contract_revenue_rowobject or null(Industrialpremisescontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

tagsanyread-only
apartment_contract_revenue_rowobject or null(Apartmentcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

parking_spot_contract_revenue_rowobject or null(Parkingspotcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
other_contract_revenue_rowobject or null(Othercontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, block_contract_revenue_row

organizationobject or null(Organization)
customer_columnsanyread-only
override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
use_revenue_row_as_max_base_valueboolean or null

Additional Validation Information:

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

block_contract_revenue_rowobject or null(Blockcontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, outdoor_section_contract_revenue_row, other_contract_revenue_row

revenue_base_value_quotanumber or null(float)

Additional Validation Information:

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

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

revenue_base_value_firm_valuenumber or null(float)

Additional Validation Information:

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

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

outdoor_section_contract_revenue_rowobject or null(Outdoorsectioncontractrevenuerow)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

This field, or at least one of the following fields must be set: apartment_contract_revenue_row, industrial_premises_contract_revenue_row, parking_spot_contract_revenue_row, other_contract_revenue_row, block_contract_revenue_row

created_atstring(date-time)read-only
Response
application/json
{
  "industrial_premises_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "apartment_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "parking_spot_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "custom_id": "string",
  "other_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "override_base_year": 1900,
  "use_revenue_row_as_max_base_value": true,
  "block_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "revenue_base_value_quota": 0.1,
  "revenue_base_value_firm_value": 0.1,
  "outdoor_section_contract_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z"
}

Indexationsetting

Operations

Indexationtable

Operations

Indexationtablerow

Operations

Retroactiveparkingspotrevenueproposal

Operations

Retroactivebrfapartmentrevenueproposal

Operations

Retroactiveoutdoorsectionrevenueproposal

Operations

Retroactiveapartmentrevenueproposal

Operations

Retroactiveindustrialpremisesrevenueproposal

Operations

Automaticdistributiontaxationconnector

Operations

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations
© Pigello. All rights reserved.