Skip to content

Revenue (2.0.0)

The 'Revenue' application of the Core API

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

Bulk write 'Indexationtablerow'

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 [
valuenumber(float)required
for_datestring(date)required
tableobject(Indexationtable)required
table.​idstring(uuid)
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/indexation/indexationtablerow/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 '[
    {
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "value": 0.1,
      "for_date": "2019-08-24",
      "table": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
valuenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_datestring(date)required
tableobject(Indexationtable)required
table.​idstring(uuid)
organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
]
Response
application/json
[ { "organization": {}, "pending_monitor_approval_amount": null, "created_at": "2019-08-24T14:15:22Z", "custom_id": "string", "value": 0.1, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "for_date": "2019-08-24", "table": {} } ]

List 'Indexationtablerow'

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

for_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

tableany

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

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

curl -i -X GET \
  'https://dev.api.pigello.io/revenue/indexation/indexationtablerow/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 [
valuenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_datestring(date)required
tableobject(Indexationtable)required
table.​idstring(uuid)
organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
]
Response
application/json
[ { "organization": {}, "pending_monitor_approval_amount": null, "created_at": "2019-08-24T14:15:22Z", "custom_id": "string", "value": 0.1, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "for_date": "2019-08-24", "table": {} } ]

Retroactiveparkingspotrevenueproposal

Operations

Retroactivebrfapartmentrevenueproposal

Operations

Retroactiveoutdoorsectionrevenueproposal

Operations

Retroactiveapartmentrevenueproposal

Operations

Retroactiveindustrialpremisesrevenueproposal

Operations

Automaticdistributiontaxationconnector

Operations

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations