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

Automaticdistributionquota

Operations

Bulk write 'Automaticdistributionquota'

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 [
quotanumber(float)<= 100required
monitored_action_object_idstring or null(uuid)
custom_idstring or null<= 128 characters
monitored_action_content_typeobject or null(Contenttype)
organizationobject or null(Organization)
acceptedboolean or null
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/distribution/automaticdistributionquota/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 '[
    {
      "monitored_action_object_id": "cf11e46b-5a6e-425c-93ae-570f8f82eb05",
      "custom_id": "string",
      "monitored_action_content_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "quota": 100,
      "accepted": true
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
distribution_typeobject(Automaticdistributiontype)read-onlyrequired
distribution_type.​idstring(uuid)
quotanumber(float)<= 100required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
from_datestring(date)read-only
industrial_premisesobject or null(Industrialpremises)read-only

Additional Validation Information:

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

monitored_action_object_idstring or null(uuid)
apartmentobject or null(Apartment)read-only

Additional Validation Information:

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

brf_apartmentobject or null(Brfapartment)read-only

Additional Validation Information:

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

outdoor_sectionobject or null(Outdoorsection)read-only

Additional Validation Information:

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

custom_idstring or null<= 128 characters
monitored_action_content_typeobject or null(Contenttype)
hiddenbooleanread-only
organizationobject or null(Organization)
customer_columnsanyread-only
acceptedboolean or null
tagsanyread-only
parking_spotobject or null(Parkingspot)read-only

Additional Validation Information:

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

created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "from_date": "2019-08-24",
    "industrial_premises": { … },
    "monitored_action_object_id": "cf11e46b-5a6e-425c-93ae-570f8f82eb05",
    "apartment": { … },
    "brf_apartment": { … },
    "outdoor_section": { … },
    "distribution_type": { … },
    "custom_id": "string",
    "monitored_action_content_type": { … },
    "hidden": true,
    "organization": { … },
    "quota": 100,
    "customer_columns": null,
    "accepted": true,
    "tags": null,
    "parking_spot": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "for_distribution_method": 0
  }
]

List 'Automaticdistributionquota'

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
acceptedany

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

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

brf_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

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

distribution_typeany

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

for_distribution_methodany

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

from_dateany

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

hiddenany

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

monitored_action_content_typeany

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

monitored_action_object_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_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

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

curl -i -X GET \
  'https://dev.api.pigello.io/revenue/distribution/automaticdistributionquota/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 [
distribution_typeobject(Automaticdistributiontype)read-onlyrequired
distribution_type.​idstring(uuid)
quotanumber(float)<= 100required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
from_datestring(date)read-only
industrial_premisesobject or null(Industrialpremises)read-only

Additional Validation Information:

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

monitored_action_object_idstring or null(uuid)
apartmentobject or null(Apartment)read-only

Additional Validation Information:

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

brf_apartmentobject or null(Brfapartment)read-only

Additional Validation Information:

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

outdoor_sectionobject or null(Outdoorsection)read-only

Additional Validation Information:

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

custom_idstring or null<= 128 characters
monitored_action_content_typeobject or null(Contenttype)
hiddenbooleanread-only
organizationobject or null(Organization)
customer_columnsanyread-only
acceptedboolean or null
tagsanyread-only
parking_spotobject or null(Parkingspot)read-only

Additional Validation Information:

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

created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "from_date": "2019-08-24",
    "industrial_premises": { … },
    "monitored_action_object_id": "cf11e46b-5a6e-425c-93ae-570f8f82eb05",
    "apartment": { … },
    "brf_apartment": { … },
    "outdoor_section": { … },
    "distribution_type": { … },
    "custom_id": "string",
    "monitored_action_content_type": { … },
    "hidden": true,
    "organization": { … },
    "quota": 100,
    "customer_columns": null,
    "accepted": true,
    "tags": null,
    "parking_spot": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "for_distribution_method": 0
  }
]

Get 'Automaticdistributionquota'

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/automaticdistributionquota/{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
distribution_typeobject(Automaticdistributiontype)read-onlyrequired
distribution_type.​idstring(uuid)
quotanumber(float)<= 100required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_distribution_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
from_datestring(date)read-only
industrial_premisesobject or null(Industrialpremises)read-only

Additional Validation Information:

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

monitored_action_object_idstring or null(uuid)
apartmentobject or null(Apartment)read-only

Additional Validation Information:

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

brf_apartmentobject or null(Brfapartment)read-only

Additional Validation Information:

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

outdoor_sectionobject or null(Outdoorsection)read-only

Additional Validation Information:

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

custom_idstring or null<= 128 characters
monitored_action_content_typeobject or null(Contenttype)
hiddenbooleanread-only
organizationobject or null(Organization)
customer_columnsanyread-only
acceptedboolean or null
tagsanyread-only
parking_spotobject or null(Parkingspot)read-only

Additional Validation Information:

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

created_atstring(date-time)read-only
Response
application/json
{
  "from_date": "2019-08-24",
  "industrial_premises": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "monitored_action_object_id": "cf11e46b-5a6e-425c-93ae-570f8f82eb05",
  "apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoor_section": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "distribution_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "monitored_action_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "hidden": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "quota": 100,
  "customer_columns": null,
  "accepted": true,
  "tags": null,
  "parking_spot": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "for_distribution_method": 0
}
© Pigello. All rights reserved.