Skip to content

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

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

Get 'Automaticdistributiontype'

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 GET \
  'https://dev.api.pigello.io/revenue/distribution/automaticdistributiontype/{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 selection

Bodyapplication/json
namestring<= 255 charactersrequired
distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
articleobject(Article)required
article.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

unit_pricenumber or null(float)

Additional Validation Information:

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

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

outdoor_areasArray of objects(Outdoorarea)
tags_filterArray of objects(Tag)
unit_amountnumber or null(float)

Additional Validation Information:

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

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

pending_monitor_approval_amountanyread-only
brf_apartment_categoriesArray of objects or null
apartment_categoriesArray of objects or null
tagsanyread-only
minimum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: maximum_distributed_total

maximum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: minimum_distributed_total

customer_columnsanyread-only
buildingsArray of objects(Building)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
outdoor_section_categoriesArray of objects or null
organizationobject or null(Organization)
parking_lotsArray of objects(Parkinglot)
industrial_premises_categoriesArray of objects or null
target_contractsboolean
recalculate_on_historical_space_area_notationsboolean
parking_spot_categoriesArray of objects or null
Response
application/json
{
  "unit_price": 0.1,
  "outdoor_areas": [
    { … }
  ],
  "tags_filter": [
    { … }
  ],
  "unit_amount": 0.1,
  "pending_monitor_approval_amount": null,
  "brf_apartment_categories": [
    null
  ],
  "apartment_categories": [
    null
  ],
  "name": "string",
  "tags": null,
  "distribution_method": 0,
  "minimum_distributed_total": 0.1,
  "maximum_distributed_total": 0.1,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "buildings": [
    { … }
  ],
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "outdoor_section_categories": [
    null
  ],
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_lots": [
    { … }
  ],
  "industrial_premises_categories": [
    null
  ],
  "target_contracts": true,
  "recalculate_on_historical_space_area_notations": true,
  "parking_spot_categories": [
    null
  ]
}

Update 'Automaticdistributiontype'

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
Bodyapplication/json
namestring<= 255 charactersrequired
distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
articleobject(Article)required
article.​idstring(uuid)
unit_pricenumber or null(float)

Additional Validation Information:

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

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

outdoor_areasArray of objects(Outdoorarea)
tags_filterArray of objects(Tag)
unit_amountnumber or null(float)

Additional Validation Information:

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

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

brf_apartment_categoriesArray of objects or null
apartment_categoriesArray of objects or null
minimum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: maximum_distributed_total

maximum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: minimum_distributed_total

buildingsArray of objects(Building)
custom_idstring or null<= 128 characters
outdoor_section_categoriesArray of objects or null
organizationobject or null(Organization)
parking_lotsArray of objects(Parkinglot)
industrial_premises_categoriesArray of objects or null
target_contractsboolean
recalculate_on_historical_space_area_notationsboolean
parking_spot_categoriesArray of objects or null
curl -i -X PATCH \
  'https://dev.api.pigello.io/revenue/distribution/automaticdistributiontype/{pk}/' \
  -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 '{
    "unit_price": 0.1,
    "outdoor_areas": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "tags_filter": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "unit_amount": 0.1,
    "brf_apartment_categories": [
      null
    ],
    "apartment_categories": [
      null
    ],
    "name": "string",
    "distribution_method": 0,
    "minimum_distributed_total": 0.1,
    "maximum_distributed_total": 0.1,
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "buildings": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "custom_id": "string",
    "outdoor_section_categories": [
      null
    ],
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_lots": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "industrial_premises_categories": [
      null
    ],
    "target_contracts": true,
    "recalculate_on_historical_space_area_notations": true,
    "parking_spot_categories": [
      null
    ]
  }'

Responses

Successful update

Bodyapplication/json
namestring<= 255 charactersrequired
distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123456789
articleobject(Article)required
article.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

unit_pricenumber or null(float)

Additional Validation Information:

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

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

outdoor_areasArray of objects(Outdoorarea)
tags_filterArray of objects(Tag)
unit_amountnumber or null(float)

Additional Validation Information:

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

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

pending_monitor_approval_amountanyread-only
brf_apartment_categoriesArray of objects or null
apartment_categoriesArray of objects or null
tagsanyread-only
minimum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: maximum_distributed_total

maximum_distributed_totalnumber or null(float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: minimum_distributed_total

customer_columnsanyread-only
buildingsArray of objects(Building)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
outdoor_section_categoriesArray of objects or null
organizationobject or null(Organization)
parking_lotsArray of objects(Parkinglot)
industrial_premises_categoriesArray of objects or null
target_contractsboolean
recalculate_on_historical_space_area_notationsboolean
parking_spot_categoriesArray of objects or null
Response
application/json
{
  "unit_price": 0.1,
  "outdoor_areas": [
    { … }
  ],
  "tags_filter": [
    { … }
  ],
  "unit_amount": 0.1,
  "pending_monitor_approval_amount": null,
  "brf_apartment_categories": [
    null
  ],
  "apartment_categories": [
    null
  ],
  "name": "string",
  "tags": null,
  "distribution_method": 0,
  "minimum_distributed_total": 0.1,
  "maximum_distributed_total": 0.1,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "buildings": [
    { … }
  ],
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "outdoor_section_categories": [
    null
  ],
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parking_lots": [
    { … }
  ],
  "industrial_premises_categories": [
    null
  ],
  "target_contracts": true,
  "recalculate_on_historical_space_area_notations": true,
  "parking_spot_categories": [
    null
  ]
}

Delete 'Automaticdistributiontype'

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/revenue/distribution/automaticdistributiontype/{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

Automaticdistributionquota

Operations
© Pigello. All rights reserved.