Skip to content

Contracts (2.0.0)

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

Apartmentcontract

Operations

Parkingspotcontract

Operations

Contractcancellationreason

Operations

Outdoorsectioncontract

Operations

Industrialpremisescontract

Operations

Blockcontract

Operations

Contractcancellationposition

Operations

Contracttransfernotation

Operations

Othercontract

Operations

Signedcontractdocument

Operations

Contractcancellationconfiguration

Operations

Create 'Contractcancellationconfiguration'

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
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
curl -i -X POST \
  https://dev.api.pigello.io/contracts/contractcancellationconfiguration/ \
  -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",
    "title": "string",
    "allow_pending_re_negotations": true,
    "require_predetermined_cancellation_reason": true,
    "require_answered_external_personal_information_sharing": true,
    "require_tenant_approval_on_landlord_issued_cancellation": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "require_signature_for_cancellations": true,
    "allow_regular_termination": true,
    "allowed_cancellation_reasons": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Successful creation

Bodyapplication/json
titlestring<= 255 charactersrequired
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
created_atstring(date-time)read-only
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
Response
application/json
{
  "custom_id": "string",
  "title": "string",
  "allow_pending_re_negotations": true,
  "require_predetermined_cancellation_reason": true,
  "require_answered_external_personal_information_sharing": true,
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "customer_columns": null,
  "require_tenant_approval_on_landlord_issued_cancellation": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "require_signature_for_cancellations": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allow_regular_termination": true,
  "allowed_cancellation_reasons": [
    { … }
  ]
}

List 'Contractcancellationconfiguration'

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
allow_pending_re_negotationsany

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

allow_regular_terminationany

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

allowed_cancellation_reasonsany

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

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

require_answered_external_personal_information_sharingany

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

require_predetermined_cancellation_reasonany

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

require_signature_for_cancellationsany

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

require_tenant_approval_on_landlord_issued_cancellationany

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

curl -i -X GET \
  'https://dev.api.pigello.io/contracts/contractcancellationconfiguration/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
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
created_atstring(date-time)read-only
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
]
Response
application/json
[
  {
    "custom_id": "string",
    "title": "string",
    "allow_pending_re_negotations": true,
    "require_predetermined_cancellation_reason": true,
    "require_answered_external_personal_information_sharing": true,
    "created_at": "2019-08-24T14:15:22Z",
    "tags": null,
    "customer_columns": null,
    "require_tenant_approval_on_landlord_issued_cancellation": true,
    "organization": { … },
    "require_signature_for_cancellations": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "allow_regular_termination": true,
    "allowed_cancellation_reasons": [ … ]
  }
]

Bulk write 'Contractcancellationconfiguration'

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
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
]
curl -i -X POST \
  https://dev.api.pigello.io/contracts/contractcancellationconfiguration/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",
      "title": "string",
      "allow_pending_re_negotations": true,
      "require_predetermined_cancellation_reason": true,
      "require_answered_external_personal_information_sharing": true,
      "require_tenant_approval_on_landlord_issued_cancellation": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "require_signature_for_cancellations": true,
      "allow_regular_termination": true,
      "allowed_cancellation_reasons": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ]
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
titlestring<= 255 charactersrequired
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
created_atstring(date-time)read-only
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
]
Response
application/json
[
  {
    "custom_id": "string",
    "title": "string",
    "allow_pending_re_negotations": true,
    "require_predetermined_cancellation_reason": true,
    "require_answered_external_personal_information_sharing": true,
    "created_at": "2019-08-24T14:15:22Z",
    "tags": null,
    "customer_columns": null,
    "require_tenant_approval_on_landlord_issued_cancellation": true,
    "organization": { … },
    "require_signature_for_cancellations": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "allow_regular_termination": true,
    "allowed_cancellation_reasons": [ … ]
  }
]

Get 'Contractcancellationconfiguration'

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
curl -i -X GET \
  'https://dev.api.pigello.io/contracts/contractcancellationconfiguration/{pk}/' \
  -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 selection

Bodyapplication/json
titlestring<= 255 charactersrequired
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
created_atstring(date-time)read-only
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
Response
application/json
{
  "custom_id": "string",
  "title": "string",
  "allow_pending_re_negotations": true,
  "require_predetermined_cancellation_reason": true,
  "require_answered_external_personal_information_sharing": true,
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "customer_columns": null,
  "require_tenant_approval_on_landlord_issued_cancellation": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "require_signature_for_cancellations": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allow_regular_termination": true,
  "allowed_cancellation_reasons": [
    { … }
  ]
}

Update 'Contractcancellationconfiguration'

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
titlestring<= 255 charactersrequired
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
curl -i -X PATCH \
  'https://dev.api.pigello.io/contracts/contractcancellationconfiguration/{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 '{
    "custom_id": "string",
    "title": "string",
    "allow_pending_re_negotations": true,
    "require_predetermined_cancellation_reason": true,
    "require_answered_external_personal_information_sharing": true,
    "require_tenant_approval_on_landlord_issued_cancellation": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "require_signature_for_cancellations": true,
    "allow_regular_termination": true,
    "allowed_cancellation_reasons": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ]
  }'

Responses

Successful update

Bodyapplication/json
titlestring<= 255 charactersrequired
require_tenant_approval_on_landlord_issued_cancellationbooleanrequired
require_signature_for_cancellationsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
allow_pending_re_negotationsboolean
require_predetermined_cancellation_reasonboolean
require_answered_external_personal_information_sharingboolean
created_atstring(date-time)read-only
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
allow_regular_terminationboolean
allowed_cancellation_reasonsArray of objects(Contractcancellationreason)
Response
application/json
{
  "custom_id": "string",
  "title": "string",
  "allow_pending_re_negotations": true,
  "require_predetermined_cancellation_reason": true,
  "require_answered_external_personal_information_sharing": true,
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "customer_columns": null,
  "require_tenant_approval_on_landlord_issued_cancellation": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "require_signature_for_cancellations": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "allow_regular_termination": true,
  "allowed_cancellation_reasons": [
    { … }
  ]
}

Delete 'Contractcancellationconfiguration'

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
curl -i -X DELETE \
  'https://dev.api.pigello.io/contracts/contractcancellationconfiguration/{pk}/' \
  -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 deletion

Response
No content
© Pigello. All rights reserved.