Skip to content
/
Create 'Apartmentrevenuei...

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

Create 'Apartmentrevenueincreaserow'

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
collectionobject(Revenueincreasecollection)required
collection.​idstring(uuid)
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
value_calculation_inputnumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
actual_increase_valuenumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
revenue_row_sourceobject(Apartmentrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/revenueincreases/apartmentrevenueincreaserow/ \
  -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 '{
    "collection": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "value_calculation_method": 0,
    "value_calculation_input": 0.1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "retroactivity_method": 0,
    "actual_increase_value": 0.1,
    "rounding_method": 0,
    "custom_id": "string",
    "from_date": "2019-08-24",
    "merge_rows_after_invoice_periods": 2147483647,
    "revenue_row_source": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "retroactivity_month_amount": 1
  }'

Responses

Successful creation

Bodyapplication/json
collectionobject(Revenueincreasecollection)required
collection.​idstring(uuid)
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
value_calculation_inputnumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
actual_increase_valuenumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
revenue_row_sourceobject(Apartmentrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
pending_monitor_approval_amountanyread-only
tagsanyread-only
organizationobject or null(Organization)
pre_merge_revenue_rowobject or null(Apartmentrevenuerow)read-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
merged_revenue_rowobject or null(Apartmentrevenuerow)read-only
retroactive_contract_rowsArray of objects(Apartmentcontractrevenuerow)read-only
created_atstring(date-time)read-only
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
retroactive_block_contract_rowsArray of objects(Blockcontractrevenuerow)read-only
Response
application/json
{
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "value_calculation_method": 0,
  "value_calculation_input": 0.1,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_method": 0,
  "actual_increase_value": 0.1,
  "rounding_method": 0,
  "pre_merge_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "merged_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactive_contract_rows": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24",
  "merge_rows_after_invoice_periods": 2147483647,
  "revenue_row_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_month_amount": 1,
  "retroactive_block_contract_rows": [
    { … }
  ]
}

Update 'Apartmentrevenueincreaserow'

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
collectionobject(Revenueincreasecollection)required
collection.​idstring(uuid)
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
value_calculation_inputnumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
actual_increase_valuenumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
revenue_row_sourceobject(Apartmentrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
curl -i -X PATCH \
  'https://dev.api.pigello.io/revenue/revenueincreases/apartmentrevenueincreaserow/{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 '{
    "collection": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "value_calculation_method": 0,
    "value_calculation_input": 0.1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "retroactivity_method": 0,
    "actual_increase_value": 0.1,
    "rounding_method": 0,
    "custom_id": "string",
    "from_date": "2019-08-24",
    "merge_rows_after_invoice_periods": 2147483647,
    "revenue_row_source": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "retroactivity_month_amount": 1
  }'

Responses

Successful update

Bodyapplication/json
collectionobject(Revenueincreasecollection)required
collection.​idstring(uuid)
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
value_calculation_inputnumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
actual_increase_valuenumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
revenue_row_sourceobject(Apartmentrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
pending_monitor_approval_amountanyread-only
tagsanyread-only
organizationobject or null(Organization)
pre_merge_revenue_rowobject or null(Apartmentrevenuerow)read-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
merged_revenue_rowobject or null(Apartmentrevenuerow)read-only
retroactive_contract_rowsArray of objects(Apartmentcontractrevenuerow)read-only
created_atstring(date-time)read-only
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
retroactive_block_contract_rowsArray of objects(Blockcontractrevenuerow)read-only
Response
application/json
{
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "value_calculation_method": 0,
  "value_calculation_input": 0.1,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_method": 0,
  "actual_increase_value": 0.1,
  "rounding_method": 0,
  "pre_merge_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "merged_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactive_contract_rows": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24",
  "merge_rows_after_invoice_periods": 2147483647,
  "revenue_row_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_month_amount": 1,
  "retroactive_block_contract_rows": [
    { … }
  ]
}

Get 'Apartmentrevenueincreaserow'

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/revenueincreases/apartmentrevenueincreaserow/{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
collectionobject(Revenueincreasecollection)required
collection.​idstring(uuid)
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
value_calculation_inputnumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
actual_increase_valuenumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
revenue_row_sourceobject(Apartmentrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
pending_monitor_approval_amountanyread-only
tagsanyread-only
organizationobject or null(Organization)
pre_merge_revenue_rowobject or null(Apartmentrevenuerow)read-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
merged_revenue_rowobject or null(Apartmentrevenuerow)read-only
retroactive_contract_rowsArray of objects(Apartmentcontractrevenuerow)read-only
created_atstring(date-time)read-only
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
retroactive_block_contract_rowsArray of objects(Blockcontractrevenuerow)read-only
Response
application/json
{
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "value_calculation_method": 0,
  "value_calculation_input": 0.1,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_method": 0,
  "actual_increase_value": 0.1,
  "rounding_method": 0,
  "pre_merge_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "custom_id": "string",
  "merged_revenue_row": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactive_contract_rows": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24",
  "merge_rows_after_invoice_periods": 2147483647,
  "revenue_row_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "retroactivity_month_amount": 1,
  "retroactive_block_contract_rows": [
    { … }
  ]
}

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