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

Create 'Brfapartmentrevenuerow'

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
titlestring<= 255 charactersrequired
articleobject(Article)required
article.​idstring(uuid)
spaceobject(Brfapartment)required
space.​idstring(uuid)
unit_amountnumber(float)required
unit_pricenumber(float)required
custom_dimension_valuestring or null<= 255 characters
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

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

ignore_retroactivity_tostring or null(date)
organizationobject or null(Organization)
periods_adjusts_total_amountboolean
excempt_from_monthsArray of objects or null
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

custom_idstring or null<= 128 characters
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

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

Responses

Successful creation

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

Additional Validation Information:

Must be unique

unit_pricenumber(float)required
created_atstring(date-time)read-only
custom_dimension_valuestring or null<= 255 characters
space_renovation_notationobject or null(Spacerenovationnotation)read-only
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

automatic_distribution_quotaobject or null(Automaticdistributionquota)read-only
structure_renovation_notationobject or null(Structurerenovationnotation)read-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

ignore_retroactivity_tostring or null(date)
organizationobject or null(Organization)
periods_adjusts_total_amountboolean
excempt_from_monthsArray of objects or null
pending_monitor_approval_amountanyread-only
tagsanyread-only
quota_notationobject or null(Quotanotation)read-only
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

custom_idstring or null<= 128 characters
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

quota_feeobject or null(Quotafee)read-only
automatic_distribution_valueobject or null(Automaticdistributiontypevalue)read-only
customer_columnsanyread-only
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "custom_dimension_value": "string",
  "space_renovation_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "accounted_end_date": "2019-08-24",
  "automatic_distribution_quota": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "structure_renovation_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "accounted_start_date": "2019-08-24",
  "ignore_retroactivity_to": "2019-08-24",
  "title": "string",
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "periods_adjusts_total_amount": true,
  "space": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "excempt_from_months": [
    null
  ],
  "pending_monitor_approval_amount": null,
  "tags": null,
  "unit_amount": 0.1,
  "quota_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "end_date": "2019-08-24",
  "custom_id": "string",
  "start_date": "2019-08-24",
  "quota_fee": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "unit_price": 0.1,
  "automatic_distribution_value": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null
}

List 'Brfapartmentrevenuerow'

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

accounted_start_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

articleany

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

automatic_distribution_quotaany

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

automatic_distribution_valueany

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_dimension_valueany

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

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

end_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

ignore_retroactivity_toany

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

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

periods_adjusts_total_amountany

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

quota_feeany

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

quota_notationany

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

spaceany

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

space_renovation_notationany

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

start_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

structure_renovation_notationany

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

titleany

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

unit_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

unit_priceany

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/revenuerows/brfapartmentrevenuerow/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 [
titlestring<= 255 charactersrequired
articleobject(Article)required
article.​idstring(uuid)
spaceobject(Brfapartment)required
space.​idstring(uuid)
unit_amountnumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

unit_pricenumber(float)required
created_atstring(date-time)read-only
custom_dimension_valuestring or null<= 255 characters
space_renovation_notationobject or null(Spacerenovationnotation)read-only
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

automatic_distribution_quotaobject or null(Automaticdistributionquota)read-only
structure_renovation_notationobject or null(Structurerenovationnotation)read-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

ignore_retroactivity_tostring or null(date)
organizationobject or null(Organization)
periods_adjusts_total_amountboolean
excempt_from_monthsArray of objects or null
pending_monitor_approval_amountanyread-only
tagsanyread-only
quota_notationobject or null(Quotanotation)read-only
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

custom_idstring or null<= 128 characters
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

quota_feeobject or null(Quotafee)read-only
automatic_distribution_valueobject or null(Automaticdistributiontypevalue)read-only
customer_columnsanyread-only
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "custom_dimension_value": "string",
    "space_renovation_notation": { … },
    "accounted_end_date": "2019-08-24",
    "automatic_distribution_quota": { … },
    "structure_renovation_notation": { … },
    "accounted_start_date": "2019-08-24",
    "ignore_retroactivity_to": "2019-08-24",
    "title": "string",
    "article": { … },
    "organization": { … },
    "periods_adjusts_total_amount": true,
    "space": { … },
    "excempt_from_months": [ … ],
    "pending_monitor_approval_amount": null,
    "tags": null,
    "unit_amount": 0.1,
    "quota_notation": { … },
    "end_date": "2019-08-24",
    "custom_id": "string",
    "start_date": "2019-08-24",
    "quota_fee": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "unit_price": 0.1,
    "automatic_distribution_value": { … },
    "customer_columns": null
  }
]

Bulk write 'Brfapartmentrevenuerow'

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 [
titlestring<= 255 charactersrequired
articleobject(Article)required
article.​idstring(uuid)
spaceobject(Brfapartment)required
space.​idstring(uuid)
unit_amountnumber(float)required
unit_pricenumber(float)required
custom_dimension_valuestring or null<= 255 characters
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

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

ignore_retroactivity_tostring or null(date)
organizationobject or null(Organization)
periods_adjusts_total_amountboolean
excempt_from_monthsArray of objects or null
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

custom_idstring or null<= 128 characters
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

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

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
titlestring<= 255 charactersrequired
articleobject(Article)required
article.​idstring(uuid)
spaceobject(Brfapartment)required
space.​idstring(uuid)
unit_amountnumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

unit_pricenumber(float)required
created_atstring(date-time)read-only
custom_dimension_valuestring or null<= 255 characters
space_renovation_notationobject or null(Spacerenovationnotation)read-only
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

automatic_distribution_quotaobject or null(Automaticdistributionquota)read-only
structure_renovation_notationobject or null(Structurerenovationnotation)read-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

ignore_retroactivity_tostring or null(date)
organizationobject or null(Organization)
periods_adjusts_total_amountboolean
excempt_from_monthsArray of objects or null
pending_monitor_approval_amountanyread-only
tagsanyread-only
quota_notationobject or null(Quotanotation)read-only
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

custom_idstring or null<= 128 characters
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

quota_feeobject or null(Quotafee)read-only
automatic_distribution_valueobject or null(Automaticdistributiontypevalue)read-only
customer_columnsanyread-only
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "custom_dimension_value": "string",
    "space_renovation_notation": { … },
    "accounted_end_date": "2019-08-24",
    "automatic_distribution_quota": { … },
    "structure_renovation_notation": { … },
    "accounted_start_date": "2019-08-24",
    "ignore_retroactivity_to": "2019-08-24",
    "title": "string",
    "article": { … },
    "organization": { … },
    "periods_adjusts_total_amount": true,
    "space": { … },
    "excempt_from_months": [ … ],
    "pending_monitor_approval_amount": null,
    "tags": null,
    "unit_amount": 0.1,
    "quota_notation": { … },
    "end_date": "2019-08-24",
    "custom_id": "string",
    "start_date": "2019-08-24",
    "quota_fee": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "unit_price": 0.1,
    "automatic_distribution_value": { … },
    "customer_columns": null
  }
]

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations
© Pigello. All rights reserved.