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

Update 'Parkingspotcontractrevenueincreaserow'

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
value_calculation_inputnumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
from_datestring(date)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
revenue_row_sourceobject(Parkingspotcontractrevenuerow)required

Additional Validation Information:

Must be unique

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

Responses

Successful update

Bodyapplication/json
value_calculation_inputnumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
from_datestring(date)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

revenue_row_sourceobject(Parkingspotcontractrevenuerow)required

Additional Validation Information:

Must be unique

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

Get 'Parkingspotcontractrevenueincreaserow'

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/parkingspotcontractrevenueincreaserow/{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
value_calculation_inputnumber(float)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
from_datestring(date)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

revenue_row_sourceobject(Parkingspotcontractrevenuerow)required

Additional Validation Information:

Must be unique

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

Delete 'Parkingspotcontractrevenueincreaserow'

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/revenueincreases/parkingspotcontractrevenueincreaserow/{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

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