Skip to content
/
Bulk write 'Automaticdist...

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

Create 'Automaticdistributiontaxationconnector'

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
data_collectioninteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
distribution_type_targetobject(Automaticdistributiontype)required

Additional Validation Information:

Must be unique

distribution_type_target.​idstring(uuid)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
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

use_last_known_value_as_fallbackboolean
curl -i -X POST \
  https://dev.api.pigello.io/revenue/dataconnectors/automaticdistributiontaxationconnector/ \
  -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_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "data_collection": 0,
    "end_date": "2019-08-24",
    "distribution_type_target": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "start_date": "2019-08-24",
    "use_last_known_value_as_fallback": true
  }'

Responses

Successful creation

Bodyapplication/json
data_collectioninteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

distribution_type_targetobject(Automaticdistributiontype)required

Additional Validation Information:

Must be unique

distribution_type_target.​idstring(uuid)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
created_atstring(date-time)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

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

use_last_known_value_as_fallbackboolean
Response
application/json
{
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "data_collection": 0,
  "end_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "distribution_type_target": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "start_date": "2019-08-24",
  "use_last_known_value_as_fallback": true
}

Bulk write 'Automaticdistributiontaxationconnector'

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 [
data_collectioninteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
distribution_type_targetobject(Automaticdistributiontype)required

Additional Validation Information:

Must be unique

distribution_type_target.​idstring(uuid)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
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

use_last_known_value_as_fallbackboolean
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/dataconnectors/automaticdistributiontaxationconnector/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_id": "string",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "data_collection": 0,
      "end_date": "2019-08-24",
      "distribution_type_target": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "start_date": "2019-08-24",
      "use_last_known_value_as_fallback": true
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
data_collectioninteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

distribution_type_targetobject(Automaticdistributiontype)required

Additional Validation Information:

Must be unique

distribution_type_target.​idstring(uuid)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
created_atstring(date-time)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

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

use_last_known_value_as_fallbackboolean
]
Response
application/json
[
  {
    "custom_id": "string",
    "organization": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "data_collection": 0,
    "end_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "distribution_type_target": { … },
    "start_date": "2019-08-24",
    "use_last_known_value_as_fallback": true
  }
]

List 'Automaticdistributiontaxationconnector'

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

data_collectionany

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

distribution_type_targetany

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

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

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

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

use_last_known_value_as_fallbackany

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

curl -i -X GET \
  'https://dev.api.pigello.io/revenue/dataconnectors/automaticdistributiontaxationconnector/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 [
data_collectioninteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

distribution_type_targetobject(Automaticdistributiontype)required

Additional Validation Information:

Must be unique

distribution_type_target.​idstring(uuid)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
created_atstring(date-time)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

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

use_last_known_value_as_fallbackboolean
]
Response
application/json
[
  {
    "custom_id": "string",
    "organization": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "data_collection": 0,
    "end_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "distribution_type_target": { … },
    "start_date": "2019-08-24",
    "use_last_known_value_as_fallback": true
  }
]

Brfapartmentrevenuerow

Operations

Blockcontractrevenuerow

Operations

Brfapartmentinvoiceconfigurationrevenuerow

Operations

Automaticdistributiontypevalue

Operations

Automaticdistributiontype

Operations

Automaticdistributionquota

Operations
© Pigello. All rights reserved.