Skip to content
/
List 'Customerearningsrev...

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

Bulk write 'Customerearningsrevenuesetting'

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 [
articleobject(Article)required
article.​idstring(uuid)
reporting_month_frequencyinteger(int32)[ 1 .. 2147483647 ]required
quotanumber(float)<= 100required
reporting_month_offsetinteger(int32)[ 1 .. 2147483647 ]required
namestring<= 255 charactersrequired
custom_idstring or null<= 128 characters
pre_first_report_valuenumber(float)

Additional Validation Information:

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

firm_value_indexation_settingobject or null(Indexationsetting)
firm_value_indexation_override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
descriptionstring or null
missing_report_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_monthsinteger or null(int32)[ 1 .. 2147483647 ]
min_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_fee_intervalinteger or null(int32)[ 1 .. 2147483647 ]
report_due_notify_daysinteger or null(int32)<= 2147483647
max_valuenumber or null(float)

Additional Validation Information:

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

report_late_notify_interval_daysinteger or null(int32)<= 2147483647
missing_report_penalty_feenumber(float)
start_reporting_from_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/customerearnings/customerearningsrevenuesetting/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",
      "pre_first_report_value": 0.1,
      "firm_value_indexation_setting": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "firm_value_indexation_override_base_year": 1900,
      "description": "string",
      "missing_report_value": 0.1,
      "missing_report_penalty_months": 1,
      "min_value": 0.1,
      "missing_report_penalty_fee_interval": 1,
      "article": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "report_due_notify_days": 2147483647,
      "reporting_month_frequency": 1,
      "max_value": 0.1,
      "report_late_notify_interval_days": 2147483647,
      "missing_report_penalty_fee": 0.1,
      "quota": 100,
      "reporting_month_offset": 1,
      "start_reporting_from_month": 1,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
articleobject(Article)required
article.​idstring(uuid)
reporting_month_frequencyinteger(int32)[ 1 .. 2147483647 ]required
quotanumber(float)<= 100required
reporting_month_offsetinteger(int32)[ 1 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
custom_idstring or null<= 128 characters
pre_first_report_valuenumber(float)

Additional Validation Information:

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

firm_value_indexation_settingobject or null(Indexationsetting)
firm_value_indexation_override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
descriptionstring or null
missing_report_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_monthsinteger or null(int32)[ 1 .. 2147483647 ]
min_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_fee_intervalinteger or null(int32)[ 1 .. 2147483647 ]
pending_monitor_approval_amountanyread-only
tagsanyread-only
report_due_notify_daysinteger or null(int32)<= 2147483647
customer_columnsanyread-only
max_valuenumber or null(float)

Additional Validation Information:

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

report_late_notify_interval_daysinteger or null(int32)<= 2147483647
missing_report_penalty_feenumber(float)
created_atstring(date-time)read-only
start_reporting_from_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "custom_id": "string",
    "pre_first_report_value": 0.1,
    "firm_value_indexation_setting": { … },
    "firm_value_indexation_override_base_year": 1900,
    "description": "string",
    "missing_report_value": 0.1,
    "missing_report_penalty_months": 1,
    "min_value": 0.1,
    "missing_report_penalty_fee_interval": 1,
    "pending_monitor_approval_amount": null,
    "article": { … },
    "tags": null,
    "report_due_notify_days": 2147483647,
    "reporting_month_frequency": 1,
    "customer_columns": null,
    "max_value": 0.1,
    "report_late_notify_interval_days": 2147483647,
    "missing_report_penalty_fee": 0.1,
    "quota": 100,
    "reporting_month_offset": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "start_reporting_from_month": 1,
    "organization": { … },
    "name": "string"
  }
]

List 'Customerearningsrevenuesetting'

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
articleany

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

descriptionany

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

firm_value_indexation_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

firm_value_indexation_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

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

max_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

min_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

missing_report_penalty_feeany

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

missing_report_penalty_fee_intervalany

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

missing_report_penalty_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

missing_report_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

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

pre_first_report_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

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

report_due_notify_daysany

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

report_late_notify_interval_daysany

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

reporting_month_frequencyany

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

reporting_month_offsetany

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

start_reporting_from_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

curl -i -X GET \
  'https://dev.api.pigello.io/revenue/customerearnings/customerearningsrevenuesetting/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 [
articleobject(Article)required
article.​idstring(uuid)
reporting_month_frequencyinteger(int32)[ 1 .. 2147483647 ]required
quotanumber(float)<= 100required
reporting_month_offsetinteger(int32)[ 1 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
custom_idstring or null<= 128 characters
pre_first_report_valuenumber(float)

Additional Validation Information:

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

firm_value_indexation_settingobject or null(Indexationsetting)
firm_value_indexation_override_base_yearinteger or null(int32)[ 1900 .. 9000 ]
descriptionstring or null
missing_report_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_monthsinteger or null(int32)[ 1 .. 2147483647 ]
min_valuenumber or null(float)

Additional Validation Information:

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

missing_report_penalty_fee_intervalinteger or null(int32)[ 1 .. 2147483647 ]
pending_monitor_approval_amountanyread-only
tagsanyread-only
report_due_notify_daysinteger or null(int32)<= 2147483647
customer_columnsanyread-only
max_valuenumber or null(float)

Additional Validation Information:

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

report_late_notify_interval_daysinteger or null(int32)<= 2147483647
missing_report_penalty_feenumber(float)
created_atstring(date-time)read-only
start_reporting_from_monthinteger(int32)[ 1 .. 12 ]
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "custom_id": "string",
    "pre_first_report_value": 0.1,
    "firm_value_indexation_setting": { … },
    "firm_value_indexation_override_base_year": 1900,
    "description": "string",
    "missing_report_value": 0.1,
    "missing_report_penalty_months": 1,
    "min_value": 0.1,
    "missing_report_penalty_fee_interval": 1,
    "pending_monitor_approval_amount": null,
    "article": { … },
    "tags": null,
    "report_due_notify_days": 2147483647,
    "reporting_month_frequency": 1,
    "customer_columns": null,
    "max_value": 0.1,
    "report_late_notify_interval_days": 2147483647,
    "missing_report_penalty_fee": 0.1,
    "quota": 100,
    "reporting_month_offset": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "start_reporting_from_month": 1,
    "organization": { … },
    "name": "string"
  }
]

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
© Pigello. All rights reserved.