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

Retroactiveoutdoorsectionrevenueproposal

Operations

Retroactiveapartmentrevenueproposal

Operations

Retroactiveindustrialpremisesrevenueproposal

Operations

Automaticdistributiontaxationconnector

Operations

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Get 'Blockcontractrevenuerow'

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/revenuerows/blockcontractrevenuerow/{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)
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

contractobject(Blockcontract)required
contract.​idstring(uuid)
unit_pricenumber(float)required
unit_amountnumber(float)required
organizationobject or null(Organization)
customer_columnsanyread-only
ignore_retroactivity_tostring or null(date)
excempt_from_monthsArray of objects or null
pending_monitor_approval_amountanyread-only
custom_dimension_valuestring or null<= 255 characters
applied_indexation_usageanyread-only
tagsanyread-only
measurement_seriesobject or null(Measurementseries)read-only
created_atstring(date-time)read-only
indexation_usageobject or null(Indexationsettingusage)read-only
customer_earnings_settingobject or null(Customerearningsrevenuesetting)read-only
periods_adjusts_total_amountboolean
accounted_end_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_start_date

This value requires that the following fields are also set: start_date, end_date

end_datestring or null(date)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

customer_earnings_reportobject or null(Customerearningsreport)read-only
custom_idstring or null<= 128 characters
is_customer_earnings_report_penaltybooleanread-only
accounted_start_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_end_date

This value requires that the following fields are also set: start_date, end_date

Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "ignore_retroactivity_to": "2019-08-24",
  "excempt_from_months": [
    null
  ],
  "pending_monitor_approval_amount": null,
  "custom_dimension_value": "string",
  "applied_indexation_usage": null,
  "tags": null,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "measurement_series": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "indexation_usage": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_earnings_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "periods_adjusts_total_amount": true,
  "accounted_end_date": "2019-08-24",
  "end_date": "2019-08-24",
  "start_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer_earnings_report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "is_customer_earnings_report_penalty": true,
  "contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "unit_price": 0.1,
  "unit_amount": 0.1,
  "accounted_start_date": "2019-08-24"
}

Update 'Blockcontractrevenuerow'

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)
titlestring<= 255 charactersrequired
contractobject(Blockcontract)required
contract.​idstring(uuid)
unit_pricenumber(float)required
unit_amountnumber(float)required
organizationobject or null(Organization)
ignore_retroactivity_tostring or null(date)
excempt_from_monthsArray of objects or null
custom_dimension_valuestring or null<= 255 characters
periods_adjusts_total_amountboolean
accounted_end_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_start_date

This value requires that the following fields are also set: start_date, end_date

end_datestring or null(date)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
accounted_start_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_end_date

This value requires that the following fields are also set: start_date, end_date

curl -i -X PATCH \
  'https://dev.api.pigello.io/revenue/revenuerows/blockcontractrevenuerow/{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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "ignore_retroactivity_to": "2019-08-24",
    "excempt_from_months": [
      null
    ],
    "custom_dimension_value": "string",
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "title": "string",
    "periods_adjusts_total_amount": true,
    "accounted_end_date": "2019-08-24",
    "end_date": "2019-08-24",
    "start_date": "2019-08-24",
    "custom_id": "string",
    "contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "unit_price": 0.1,
    "unit_amount": 0.1,
    "accounted_start_date": "2019-08-24"
  }'

Responses

Successful update

Bodyapplication/json
articleobject(Article)required
article.​idstring(uuid)
titlestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

contractobject(Blockcontract)required
contract.​idstring(uuid)
unit_pricenumber(float)required
unit_amountnumber(float)required
organizationobject or null(Organization)
customer_columnsanyread-only
ignore_retroactivity_tostring or null(date)
excempt_from_monthsArray of objects or null
pending_monitor_approval_amountanyread-only
custom_dimension_valuestring or null<= 255 characters
applied_indexation_usageanyread-only
tagsanyread-only
measurement_seriesobject or null(Measurementseries)read-only
created_atstring(date-time)read-only
indexation_usageobject or null(Indexationsettingusage)read-only
customer_earnings_settingobject or null(Customerearningsrevenuesetting)read-only
periods_adjusts_total_amountboolean
accounted_end_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_start_date

This value requires that the following fields are also set: start_date, end_date

end_datestring or null(date)

Additional Validation Information:

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

start_datestring or null(date)

Additional Validation Information:

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

customer_earnings_reportobject or null(Customerearningsreport)read-only
custom_idstring or null<= 128 characters
is_customer_earnings_report_penaltybooleanread-only
accounted_start_datestring or null(date)

Additional Validation Information:

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

This value must be set together with the following fields: accounted_end_date

This value requires that the following fields are also set: start_date, end_date

Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "ignore_retroactivity_to": "2019-08-24",
  "excempt_from_months": [
    null
  ],
  "pending_monitor_approval_amount": null,
  "custom_dimension_value": "string",
  "applied_indexation_usage": null,
  "tags": null,
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "measurement_series": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "indexation_usage": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_earnings_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "periods_adjusts_total_amount": true,
  "accounted_end_date": "2019-08-24",
  "end_date": "2019-08-24",
  "start_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer_earnings_report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "is_customer_earnings_report_penalty": true,
  "contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "unit_price": 0.1,
  "unit_amount": 0.1,
  "accounted_start_date": "2019-08-24"
}

Delete 'Blockcontractrevenuerow'

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/revenuerows/blockcontractrevenuerow/{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

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations
© Pigello. All rights reserved.