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

List 'Retroactivebrfapartmentrevenueproposal'

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
global_realestatesArray of objects
global_segmentsArray of objects
is_unaccepted_with_existing_revenue_rowany
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

additional_title_suffixany

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

adjusted_period_endany

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

adjusted_period_startany

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

based_on_contract_revenueany

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

based_on_space_revenueany

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

end_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

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

original_retroactivity_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

start_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

target_contractany

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

unit_amountany

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

unit_priceany

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/retroactivity/retroactivebrfapartmentrevenueproposal/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 [
unit_amountnumber(float)read-onlyrequired
unit_pricenumber(float)read-onlyrequired
target_contractobject(Brfapartmentinvoiceconfiguration)read-onlyrequired
target_contract.​idstring(uuid)
end_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

adjusted_period_endstring(date)read-onlyrequired
adjusted_period_startstring(date)read-onlyrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

start_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

is_unaccepted_with_existing_revenue_rowanyread-only
additional_title_suffixstring or null<= 64 characters
custom_idstring or null<= 128 characters
based_on_contract_revenueobject or null(Brfapartmentinvoiceconfigurationrevenuerow)read-only
organizationobject or null(Organization)
based_on_space_revenueobject or null(Brfapartmentrevenuerow)read-only
created_atstring(date-time)read-only
acceptedboolean or null
original_retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-only
Enum12345678910
]
Response
application/json
[
  {
    "unit_amount": 0.1,
    "is_unaccepted_with_existing_revenue_row": null,
    "additional_title_suffix": "string",
    "custom_id": "string",
    "unit_price": 0.1,
    "target_contract": { … },
    "end_date": "2019-08-24",
    "based_on_contract_revenue": { … },
    "organization": { … },
    "adjusted_period_end": "2019-08-24",
    "based_on_space_revenue": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "adjusted_period_start": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accepted": true,
    "start_date": "2019-08-24",
    "original_retroactivity_method": 1
  }
]

Bulk write 'Retroactivebrfapartmentrevenueproposal'

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 [
end_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

start_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

additional_title_suffixstring or null<= 64 characters
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
acceptedboolean or null
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/retroactivity/retroactivebrfapartmentrevenueproposal/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 '[
    {
      "additional_title_suffix": "string",
      "custom_id": "string",
      "end_date": "2019-08-24",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "accepted": true,
      "start_date": "2019-08-24"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
unit_amountnumber(float)read-onlyrequired
unit_pricenumber(float)read-onlyrequired
target_contractobject(Brfapartmentinvoiceconfiguration)read-onlyrequired
target_contract.​idstring(uuid)
end_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

adjusted_period_endstring(date)read-onlyrequired
adjusted_period_startstring(date)read-onlyrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

start_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

is_unaccepted_with_existing_revenue_rowanyread-only
additional_title_suffixstring or null<= 64 characters
custom_idstring or null<= 128 characters
based_on_contract_revenueobject or null(Brfapartmentinvoiceconfigurationrevenuerow)read-only
organizationobject or null(Organization)
based_on_space_revenueobject or null(Brfapartmentrevenuerow)read-only
created_atstring(date-time)read-only
acceptedboolean or null
original_retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-only
Enum12345678910
]
Response
application/json
[
  {
    "unit_amount": 0.1,
    "is_unaccepted_with_existing_revenue_row": null,
    "additional_title_suffix": "string",
    "custom_id": "string",
    "unit_price": 0.1,
    "target_contract": { … },
    "end_date": "2019-08-24",
    "based_on_contract_revenue": { … },
    "organization": { … },
    "adjusted_period_end": "2019-08-24",
    "based_on_space_revenue": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "adjusted_period_start": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accepted": true,
    "start_date": "2019-08-24",
    "original_retroactivity_method": 1
  }
]

Get 'Retroactivebrfapartmentrevenueproposal'

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/retroactivity/retroactivebrfapartmentrevenueproposal/{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
unit_amountnumber(float)read-onlyrequired
unit_pricenumber(float)read-onlyrequired
target_contractobject(Brfapartmentinvoiceconfiguration)read-onlyrequired
target_contract.​idstring(uuid)
end_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

adjusted_period_endstring(date)read-onlyrequired
adjusted_period_startstring(date)read-onlyrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

start_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

is_unaccepted_with_existing_revenue_rowanyread-only
additional_title_suffixstring or null<= 64 characters
custom_idstring or null<= 128 characters
based_on_contract_revenueobject or null(Brfapartmentinvoiceconfigurationrevenuerow)read-only
organizationobject or null(Organization)
based_on_space_revenueobject or null(Brfapartmentrevenuerow)read-only
created_atstring(date-time)read-only
acceptedboolean or null
original_retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]read-only
Enum12345678910
Response
application/json
{
  "unit_amount": 0.1,
  "is_unaccepted_with_existing_revenue_row": null,
  "additional_title_suffix": "string",
  "custom_id": "string",
  "unit_price": 0.1,
  "target_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "end_date": "2019-08-24",
  "based_on_contract_revenue": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "adjusted_period_end": "2019-08-24",
  "based_on_space_revenue": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "adjusted_period_start": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accepted": true,
  "start_date": "2019-08-24",
  "original_retroactivity_method": 1
}

Retroactiveoutdoorsectionrevenueproposal

Operations

Retroactiveapartmentrevenueproposal

Operations

Retroactiveindustrialpremisesrevenueproposal

Operations

Automaticdistributiontaxationconnector

Operations

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations
© Pigello. All rights reserved.