Skip to content
/
Create 'Revenueincreaseco...

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

Bulk write 'Revenueincreasecollection'

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 [
value_calculation_inputnumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
namestring<= 255 charactersrequired
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
document_fileobject or null
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/revenue/revenueincreases/revenueincreasecollection/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 '[
    {
      "retroactivity_month_amount": 1,
      "value_calculation_input": 0.1,
      "rounding_method": 0,
      "from_date": "2019-08-24",
      "retroactivity_method": 0,
      "name": "string",
      "value_calculation_method": 0,
      "document_file": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "merge_rows_after_invoice_periods": 2147483647
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
value_calculation_inputnumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
namestring<= 255 charactersrequired
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
created_atstring(date-time)read-only
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
customer_columnsanyread-only
document_fileobject or null
tagsanyread-only
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "retroactivity_month_amount": 1,
    "value_calculation_input": 0.1,
    "rounding_method": 0,
    "from_date": "2019-08-24",
    "customer_columns": null,
    "retroactivity_method": 0,
    "name": "string",
    "value_calculation_method": 0,
    "document_file": { … },
    "tags": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "custom_id": "string",
    "merge_rows_after_invoice_periods": 2147483647
  }
]

Create 'Revenueincreasecollection'

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
value_calculation_inputnumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
namestring<= 255 charactersrequired
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
document_fileobject or null
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/revenue/revenueincreases/revenueincreasecollection/ \
  -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 '{
    "retroactivity_month_amount": 1,
    "value_calculation_input": 0.1,
    "rounding_method": 0,
    "from_date": "2019-08-24",
    "retroactivity_method": 0,
    "name": "string",
    "value_calculation_method": 0,
    "document_file": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "merge_rows_after_invoice_periods": 2147483647
  }'

Responses

Successful creation

Bodyapplication/json
value_calculation_inputnumber(float)required
rounding_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
from_datestring(date)required
retroactivity_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
namestring<= 255 charactersrequired
value_calculation_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012345
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

merge_rows_after_invoice_periodsinteger(int32)<= 2147483647required
created_atstring(date-time)read-only
retroactivity_month_amountinteger or null(int32)[ 1 .. 2147483647 ]
customer_columnsanyread-only
document_fileobject or null
tagsanyread-only
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "retroactivity_month_amount": 1,
  "value_calculation_input": 0.1,
  "rounding_method": 0,
  "from_date": "2019-08-24",
  "customer_columns": null,
  "retroactivity_method": 0,
  "name": "string",
  "value_calculation_method": 0,
  "document_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "merge_rows_after_invoice_periods": 2147483647
}

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.