Skip to content
/
Create 'Customerearningsr...

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

List 'Customerearningsreport'

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
accountant_company_nameany

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

accountant_work_emailany

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

accountant_work_phoneany

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

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

descriptionany

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

gross_valueany

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

includes_subletted_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

org_noany

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

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

period_endany

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

period_startany

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

reported_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

tenantany

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

valueany

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/customerearnings/customerearningsreport/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 [
valuenumber(float)required
period_startstring(date)required

Additional Validation Information:

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

gross_valuenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

period_endstring(date)required

Additional Validation Information:

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

tenantobject(Tenant)required
tenant.​idstring(uuid)
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
descriptionstring or null
accountant_company_namestring or null<= 255 characters
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
includes_subletted_spaceboolean
accountant_work_phonestring or null<= 36 characters'^\+?1?\d{7,15}$'
tagsanyread-only
reported_atstring(date-time)read-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
accountant_work_emailstring or null(email)<= 254 characters
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "description": "string",
    "accountant_company_name": "string",
    "value": 0.1,
    "period_start": "2019-08-24",
    "gross_value": 0.1,
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "includes_subletted_space": true,
    "accountant_work_phone": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tags": null,
    "reported_at": "2019-08-24T14:15:22Z",
    "period_end": "2019-08-24",
    "customer_columns": null,
    "tenant": { … },
    "pending_monitor_approval_amount": null,
    "accountant_work_email": "user@example.com",
    "org_no": "stringstri",
    "organization": { … }
  }
]

Create 'Customerearningsreport'

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
valuenumber(float)required
period_startstring(date)required

Additional Validation Information:

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

gross_valuenumber(float)required
period_endstring(date)required

Additional Validation Information:

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

tenantobject(Tenant)required
tenant.​idstring(uuid)
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
descriptionstring or null
accountant_company_namestring or null<= 255 characters
custom_idstring or null<= 128 characters
includes_subletted_spaceboolean
accountant_work_phonestring or null<= 36 characters'^\+?1?\d{7,15}$'
accountant_work_emailstring or null(email)<= 254 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/revenue/customerearnings/customerearningsreport/ \
  -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 '{
    "description": "string",
    "accountant_company_name": "string",
    "value": 0.1,
    "period_start": "2019-08-24",
    "gross_value": 0.1,
    "custom_id": "string",
    "includes_subletted_space": true,
    "accountant_work_phone": "string",
    "period_end": "2019-08-24",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "accountant_work_email": "user@example.com",
    "org_no": "stringstri",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
valuenumber(float)required
period_startstring(date)required

Additional Validation Information:

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

gross_valuenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

period_endstring(date)required

Additional Validation Information:

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

tenantobject(Tenant)required
tenant.​idstring(uuid)
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
descriptionstring or null
accountant_company_namestring or null<= 255 characters
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
includes_subletted_spaceboolean
accountant_work_phonestring or null<= 36 characters'^\+?1?\d{7,15}$'
tagsanyread-only
reported_atstring(date-time)read-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
accountant_work_emailstring or null(email)<= 254 characters
organizationobject or null(Organization)
Response
application/json
{
  "description": "string",
  "accountant_company_name": "string",
  "value": 0.1,
  "period_start": "2019-08-24",
  "gross_value": 0.1,
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "includes_subletted_space": true,
  "accountant_work_phone": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "reported_at": "2019-08-24T14:15:22Z",
  "period_end": "2019-08-24",
  "customer_columns": null,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "accountant_work_email": "user@example.com",
  "org_no": "stringstri",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Update 'Customerearningsreport'

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
valuenumber(float)required
period_startstring(date)required

Additional Validation Information:

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

gross_valuenumber(float)required
period_endstring(date)required

Additional Validation Information:

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

tenantobject(Tenant)required
tenant.​idstring(uuid)
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
descriptionstring or null
accountant_company_namestring or null<= 255 characters
custom_idstring or null<= 128 characters
includes_subletted_spaceboolean
accountant_work_phonestring or null<= 36 characters'^\+?1?\d{7,15}$'
accountant_work_emailstring or null(email)<= 254 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/revenue/customerearnings/customerearningsreport/{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 '{
    "description": "string",
    "accountant_company_name": "string",
    "value": 0.1,
    "period_start": "2019-08-24",
    "gross_value": 0.1,
    "custom_id": "string",
    "includes_subletted_space": true,
    "accountant_work_phone": "string",
    "period_end": "2019-08-24",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "accountant_work_email": "user@example.com",
    "org_no": "stringstri",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
valuenumber(float)required
period_startstring(date)required

Additional Validation Information:

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

gross_valuenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

period_endstring(date)required

Additional Validation Information:

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

tenantobject(Tenant)required
tenant.​idstring(uuid)
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
descriptionstring or null
accountant_company_namestring or null<= 255 characters
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
includes_subletted_spaceboolean
accountant_work_phonestring or null<= 36 characters'^\+?1?\d{7,15}$'
tagsanyread-only
reported_atstring(date-time)read-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
accountant_work_emailstring or null(email)<= 254 characters
organizationobject or null(Organization)
Response
application/json
{
  "description": "string",
  "accountant_company_name": "string",
  "value": 0.1,
  "period_start": "2019-08-24",
  "gross_value": 0.1,
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "includes_subletted_space": true,
  "accountant_work_phone": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "reported_at": "2019-08-24T14:15:22Z",
  "period_end": "2019-08-24",
  "customer_columns": null,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "accountant_work_email": "user@example.com",
  "org_no": "stringstri",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

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.