Skip to content

Revenue (2.0.0)

The 'Revenue' application of the Core API

Languages
Servers
https://{environment}.pigello.io

Othercontractrevenueincreaserow

Operations

List 'Othercontractrevenueincreaserow'

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
actual_increase_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

collectionany

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

from_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

merge_rows_after_invoice_periodsany

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

merged_revenue_rowany

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

pre_merge_revenue_rowany

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

retroactive_contract_rowany

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

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

retroactivity_month_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

revenue_row_sourceany

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_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

value_calculation_inputany

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

value_calculation_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

curl -i -X GET \
  'https://dev.api.pigello.io/revenue/revenueincreases/othercontractrevenueincreaserow/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 [
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
actual_increase_valuenumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
value_calculation_inputnumber(float)required
revenue_row_sourceobject(Othercontractrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
from_datestring(date)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

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

Bulk write 'Othercontractrevenueincreaserow'

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 [
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
actual_increase_valuenumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
value_calculation_inputnumber(float)required
revenue_row_sourceobject(Othercontractrevenuerow)required

Additional Validation Information:

Must be unique

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

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
actual_increase_valuenumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
value_calculation_inputnumber(float)required
revenue_row_sourceobject(Othercontractrevenuerow)required

Additional Validation Information:

Must be unique

revenue_row_source.​idstring(uuid)
from_datestring(date)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

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

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

Retroactiveoutdoorsectionrevenueproposal

Operations

Retroactiveapartmentrevenueproposal

Operations

Retroactiveindustrialpremisesrevenueproposal

Operations

Automaticdistributiontaxationconnector

Operations

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations