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

Get '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
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/revenue/customerearnings/customerearningsrevenuesetting/{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
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": {
    "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,
  "pending_monitor_approval_amount": null,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "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": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string"
}

Delete '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
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/revenue/customerearnings/customerearningsrevenuesetting/{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

Update '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
Path
pkstringwrite-onlyrequired
Bodyapplication/json
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 PATCH \
  'https://dev.api.pigello.io/revenue/customerearnings/customerearningsrevenuesetting/{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 '{
    "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 update

Bodyapplication/json
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": {
    "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,
  "pending_monitor_approval_amount": null,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "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": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "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.