Skip to content
/
Create 'Indexationsetting...

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

List 'Indexationsetting'

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
allow_reductionany

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

base_monthany

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

calculate_with_decimalsany

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

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

debit_around_monthany

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

firm_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

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

initial_zero_value_monthsany

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

max_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

min_points_changeany

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

min_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

nameany

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

rounding_modeany

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

tablesany

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_highest_table_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/indexationsetting/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

namestring<= 255 charactersrequired
min_quotanumber or null(float)

Additional Validation Information:

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

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

initial_zero_value_monthsinteger(int32)<= 2147483647
tagsanyread-only
use_highest_table_valueboolean or null

Additional Validation Information:

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

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

customer_columnsanyread-only
custom_idstring or null<= 128 characters
calculate_with_decimalsinteger(int32)<= 2147483647
rounding_modeinteger(int32)[ -2147483648 .. 2147483647 ]
Enum012
allow_reductionboolean
base_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
firm_quotanumber or null(float)

Additional Validation Information:

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

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

debit_around_monthinteger(int32)[ 1 .. 12 ]
pending_monitor_approval_amountanyread-only
tablesArray of objects(Indexationtable)
max_quotanumber or null(float)

Additional Validation Information:

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

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

min_points_changenumber or null(float)
created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "min_quota": 0.1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initial_zero_value_months": 2147483647,
    "tags": null,
    "use_highest_table_value": true,
    "customer_columns": null,
    "custom_id": "string",
    "calculate_with_decimals": 2147483647,
    "rounding_mode": 0,
    "allow_reduction": true,
    "base_month": 1,
    "organization": { … },
    "firm_quota": 0.1,
    "debit_around_month": 1,
    "pending_monitor_approval_amount": null,
    "tables": [ … ],
    "name": "string",
    "max_quota": 0.1,
    "min_points_change": 0.1,
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Create 'Indexationsetting'

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
namestring<= 255 charactersrequired
min_quotanumber or null(float)

Additional Validation Information:

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

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

initial_zero_value_monthsinteger(int32)<= 2147483647
use_highest_table_valueboolean or null

Additional Validation Information:

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

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

custom_idstring or null<= 128 characters
calculate_with_decimalsinteger(int32)<= 2147483647
rounding_modeinteger(int32)[ -2147483648 .. 2147483647 ]
Enum012
allow_reductionboolean
base_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
firm_quotanumber or null(float)

Additional Validation Information:

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

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

debit_around_monthinteger(int32)[ 1 .. 12 ]
tablesArray of objects(Indexationtable)
max_quotanumber or null(float)

Additional Validation Information:

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

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

min_points_changenumber or null(float)
curl -i -X POST \
  https://dev.api.pigello.io/revenue/indexation/indexationsetting/ \
  -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 '{
    "min_quota": 0.1,
    "initial_zero_value_months": 2147483647,
    "use_highest_table_value": true,
    "custom_id": "string",
    "calculate_with_decimals": 2147483647,
    "rounding_mode": 0,
    "allow_reduction": true,
    "base_month": 1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "firm_quota": 0.1,
    "debit_around_month": 1,
    "tables": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "name": "string",
    "max_quota": 0.1,
    "min_points_change": 0.1
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
min_quotanumber or null(float)

Additional Validation Information:

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

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

initial_zero_value_monthsinteger(int32)<= 2147483647
tagsanyread-only
use_highest_table_valueboolean or null

Additional Validation Information:

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

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

customer_columnsanyread-only
custom_idstring or null<= 128 characters
calculate_with_decimalsinteger(int32)<= 2147483647
rounding_modeinteger(int32)[ -2147483648 .. 2147483647 ]
Enum012
allow_reductionboolean
base_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
firm_quotanumber or null(float)

Additional Validation Information:

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

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

debit_around_monthinteger(int32)[ 1 .. 12 ]
pending_monitor_approval_amountanyread-only
tablesArray of objects(Indexationtable)
max_quotanumber or null(float)

Additional Validation Information:

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

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

min_points_changenumber or null(float)
created_atstring(date-time)read-only
Response
application/json
{
  "min_quota": 0.1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initial_zero_value_months": 2147483647,
  "tags": null,
  "use_highest_table_value": true,
  "customer_columns": null,
  "custom_id": "string",
  "calculate_with_decimals": 2147483647,
  "rounding_mode": 0,
  "allow_reduction": true,
  "base_month": 1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "firm_quota": 0.1,
  "debit_around_month": 1,
  "pending_monitor_approval_amount": null,
  "tables": [
    { … }
  ],
  "name": "string",
  "max_quota": 0.1,
  "min_points_change": 0.1,
  "created_at": "2019-08-24T14:15:22Z"
}

Delete 'Indexationsetting'

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/indexation/indexationsetting/{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

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.