Skip to content
/
List 'Automaticvacancyinv...

Accounting (2.0.0)

The 'Accounting' 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

Articlecategory

Operations

Articleaccountoverride

Operations

Spacecategorydimensionvalue

Operations

Dimensionconfiguration

Operations

Verification

Operations

Bookkeepingexportfile

Operations

Verificationgroup

Operations

Transaction

Operations

Automaticvacancyinvoicingsetting

Operations

Update 'Automaticvacancyinvoicingsetting'

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
for_apartmentsbooleanrequired
month_period_offsetinteger(int32)[ 1 .. 12 ]required
is_activebooleanrequired
for_industrial_premisesbooleanrequired
generation_day_in_monthinteger(int32)[ 1 .. 31 ]required
for_outdoor_sectionsbooleanrequired
for_parking_spotsbooleanrequired
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
companyobject or null(Company)
exclude_space_tagsArray of objects(Tag)
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounting/vacancies/automaticvacancyinvoicingsetting/{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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "for_apartments": true,
    "month_period_offset": 1,
    "is_active": true,
    "custom_id": "string",
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "for_industrial_premises": true,
    "generation_day_in_month": 1,
    "for_outdoor_sections": true,
    "for_parking_spots": true,
    "exclude_space_tags": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_apartmentsbooleanrequired
month_period_offsetinteger(int32)[ 1 .. 12 ]required
is_activebooleanrequired
for_industrial_premisesbooleanrequired
generation_day_in_monthinteger(int32)[ 1 .. 31 ]required
for_outdoor_sectionsbooleanrequired
for_parking_spotsbooleanrequired
organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
companyobject or null(Company)
customer_columnsanyread-only
created_atstring(date-time)read-only
tagsanyread-only
exclude_space_tagsArray of objects(Tag)
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "for_apartments": true,
  "month_period_offset": 1,
  "is_active": true,
  "custom_id": "string",
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "for_industrial_premises": true,
  "generation_day_in_month": 1,
  "for_outdoor_sections": true,
  "customer_columns": null,
  "for_parking_spots": true,
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "exclude_space_tags": [
    { … }
  ]
}

List 'Automaticvacancyinvoicingsetting'

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
eligible_for_companiesArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
companyany

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

exclude_space_tagsany

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

for_apartmentsany

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

for_industrial_premisesany

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

for_outdoor_sectionsany

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

for_parking_spotsany

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

generation_day_in_monthany

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

is_activeany

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

month_period_offsetany

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

curl -i -X GET \
  'https://dev.api.pigello.io/accounting/vacancies/automaticvacancyinvoicingsetting/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

for_apartmentsbooleanrequired
month_period_offsetinteger(int32)[ 1 .. 12 ]required
is_activebooleanrequired
for_industrial_premisesbooleanrequired
generation_day_in_monthinteger(int32)[ 1 .. 31 ]required
for_outdoor_sectionsbooleanrequired
for_parking_spotsbooleanrequired
organizationobject or null(Organization)
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
companyobject or null(Company)
customer_columnsanyread-only
created_atstring(date-time)read-only
tagsanyread-only
exclude_space_tagsArray of objects(Tag)
]
Response
application/json
[
  {
    "organization": { … },
    "pending_monitor_approval_amount": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "for_apartments": true,
    "month_period_offset": 1,
    "is_active": true,
    "custom_id": "string",
    "company": { … },
    "for_industrial_premises": true,
    "generation_day_in_month": 1,
    "for_outdoor_sections": true,
    "customer_columns": null,
    "for_parking_spots": true,
    "created_at": "2019-08-24T14:15:22Z",
    "tags": null,
    "exclude_space_tags": [ … ]
  }
]

Vacancyinvoice

Operations

Vacancyinvoicerow

Operations

Bookkeepingaccountsconfig

Operations

Paymentmethod

Operations

Autogiropayerconnection

Operations

Autogirostatus

Operations

Coinvoicenotation

Operations

Invoicerow

Operations

Invoicerecipient

Operations

Invoicepayment

Operations

Debtinvoiceevent

Operations

Debtinvoice

Operations

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Paymenttermssetting

Operations
© Pigello. All rights reserved.