Skip to content
/
Create 'Contractcancellat...

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

Create 'Contractcancellationposition'

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
transfer_to_external_partybooleanrequired
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
readbooleanrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

curl -i -X POST \
  https://dev.api.pigello.io/contracts/contractcancellationposition/ \
  -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",
    "industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "resign": true,
    "cancellation_reason": "string",
    "issued_by_admin_attachment": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "cancellation_time": "2019-08-24T14:15:22Z",
    "lifetime_end_date": "2019-08-24",
    "message": "string",
    "external_party": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "cancelled_by_counterpart": true,
    "transition_approved": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transfer_to_external_party": true,
    "cancellation_source": 0,
    "block_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoorsection_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transfer_date": "2019-08-24",
    "closed": true,
    "issued_by_admin_on_behalf_of_party": true,
    "affects_sub_contracts": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "other_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parkingspot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "read": true,
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
statusinteger or null(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
terminationbooleanread-onlyrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
transfer_to_external_partybooleanrequired
transfer_notationobject or null(Contracttransfernotation)read-onlyrequired
transfer_notation.​idstring(uuid)
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

initiating_positionobject or null(Contractcancellationposition)read-onlyrequired
initiating_position.​idstring(uuid)
readbooleanrequired
is_preliminarybooleanread-onlyrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
created_atstring(date-time)read-only
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

Response
application/json
{
  "custom_id": "string",
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "resign": true,
  "cancellation_reason": "string",
  "status": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "termination": true,
  "issued_by_admin_attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "cancellation_time": "2019-08-24T14:15:22Z",
  "lifetime_end_date": "2019-08-24",
  "message": "string",
  "part_resignation": true,
  "transfer_request": true,
  "external_party": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancelled_by_counterpart": true,
  "transition_approved": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_to_external_party": true,
  "cancellation_source": 0,
  "transfer_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_date": "2019-08-24",
  "closed": true,
  "issued_by_admin_on_behalf_of_party": true,
  "affects_sub_contracts": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiating_position": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "other_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "read": true,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_preliminary": true
}

List 'Contractcancellationposition'

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
affects_sub_contractsany

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

apartment_contractany

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

block_contractany

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

cancellation_reasonany

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

cancellation_signed_timeany

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

cancellation_sourceany

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

cancellation_timeany

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

cancelled_by_counterpartany

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

closedany

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

external_partyany

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

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

industrial_premises_contractany

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

initiating_positionany

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_preliminaryany

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

issued_by_admin_on_behalf_of_partyany

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

lifetime_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

messageany

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

organization_userany

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

other_contractany

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

outdoorsection_contractany

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

parkingspot_contractany

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

part_resignationany

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

readany

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

resignany

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

statusany

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

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

transfer_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

transfer_notationany

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

transfer_requestany

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

transfer_to_external_partyany

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

transition_approvedany

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/contracts/contractcancellationposition/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 [
statusinteger or null(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
terminationbooleanread-onlyrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
transfer_to_external_partybooleanrequired
transfer_notationobject or null(Contracttransfernotation)read-onlyrequired
transfer_notation.​idstring(uuid)
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

initiating_positionobject or null(Contractcancellationposition)read-onlyrequired
initiating_position.​idstring(uuid)
readbooleanrequired
is_preliminarybooleanread-onlyrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
created_atstring(date-time)read-only
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

]
Response
application/json
[
  {
    "custom_id": "string",
    "industrial_premises_contract": { … },
    "apartment_contract": { … },
    "tenant": { … },
    "resign": true,
    "cancellation_reason": "string",
    "status": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "termination": true,
    "issued_by_admin_attachment": { … },
    "cancellation_time": "2019-08-24T14:15:22Z",
    "lifetime_end_date": "2019-08-24",
    "message": "string",
    "part_resignation": true,
    "transfer_request": true,
    "external_party": { … },
    "cancelled_by_counterpart": true,
    "transition_approved": true,
    "organization": { … },
    "transfer_to_external_party": true,
    "cancellation_source": 0,
    "transfer_notation": { … },
    "block_contract": { … },
    "outdoorsection_contract": { … },
    "transfer_date": "2019-08-24",
    "closed": true,
    "issued_by_admin_on_behalf_of_party": true,
    "affects_sub_contracts": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiating_position": { … },
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "other_contract": { … },
    "parkingspot_contract": { … },
    "read": true,
    "organization_user": { … },
    "is_preliminary": true
  }
]

Bulk write 'Contractcancellationposition'

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 [
transfer_to_external_partybooleanrequired
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
readbooleanrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

]
curl -i -X POST \
  https://dev.api.pigello.io/contracts/contractcancellationposition/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",
      "industrial_premises_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "apartment_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "resign": true,
      "cancellation_reason": "string",
      "issued_by_admin_attachment": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "cancellation_time": "2019-08-24T14:15:22Z",
      "lifetime_end_date": "2019-08-24",
      "message": "string",
      "external_party": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "cancelled_by_counterpart": true,
      "transition_approved": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "transfer_to_external_party": true,
      "cancellation_source": 0,
      "block_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "outdoorsection_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "transfer_date": "2019-08-24",
      "closed": true,
      "issued_by_admin_on_behalf_of_party": true,
      "affects_sub_contracts": true,
      "cancellation_signed_time": "2019-08-24T14:15:22Z",
      "other_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "parkingspot_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "read": true,
      "organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
statusinteger or null(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
terminationbooleanread-onlyrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
transfer_to_external_partybooleanrequired
transfer_notationobject or null(Contracttransfernotation)read-onlyrequired
transfer_notation.​idstring(uuid)
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

initiating_positionobject or null(Contractcancellationposition)read-onlyrequired
initiating_position.​idstring(uuid)
readbooleanrequired
is_preliminarybooleanread-onlyrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
created_atstring(date-time)read-only
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

]
Response
application/json
[
  {
    "custom_id": "string",
    "industrial_premises_contract": { … },
    "apartment_contract": { … },
    "tenant": { … },
    "resign": true,
    "cancellation_reason": "string",
    "status": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "termination": true,
    "issued_by_admin_attachment": { … },
    "cancellation_time": "2019-08-24T14:15:22Z",
    "lifetime_end_date": "2019-08-24",
    "message": "string",
    "part_resignation": true,
    "transfer_request": true,
    "external_party": { … },
    "cancelled_by_counterpart": true,
    "transition_approved": true,
    "organization": { … },
    "transfer_to_external_party": true,
    "cancellation_source": 0,
    "transfer_notation": { … },
    "block_contract": { … },
    "outdoorsection_contract": { … },
    "transfer_date": "2019-08-24",
    "closed": true,
    "issued_by_admin_on_behalf_of_party": true,
    "affects_sub_contracts": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiating_position": { … },
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "other_contract": { … },
    "parkingspot_contract": { … },
    "read": true,
    "organization_user": { … },
    "is_preliminary": true
  }
]

Get 'Contractcancellationposition'

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/contractcancellationposition/{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
statusinteger or null(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
terminationbooleanread-onlyrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
transfer_to_external_partybooleanrequired
transfer_notationobject or null(Contracttransfernotation)read-onlyrequired
transfer_notation.​idstring(uuid)
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

initiating_positionobject or null(Contractcancellationposition)read-onlyrequired
initiating_position.​idstring(uuid)
readbooleanrequired
is_preliminarybooleanread-onlyrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
created_atstring(date-time)read-only
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

Response
application/json
{
  "custom_id": "string",
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "resign": true,
  "cancellation_reason": "string",
  "status": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "termination": true,
  "issued_by_admin_attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "cancellation_time": "2019-08-24T14:15:22Z",
  "lifetime_end_date": "2019-08-24",
  "message": "string",
  "part_resignation": true,
  "transfer_request": true,
  "external_party": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancelled_by_counterpart": true,
  "transition_approved": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_to_external_party": true,
  "cancellation_source": 0,
  "transfer_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_date": "2019-08-24",
  "closed": true,
  "issued_by_admin_on_behalf_of_party": true,
  "affects_sub_contracts": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiating_position": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "other_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "read": true,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_preliminary": true
}

Delete 'Contractcancellationposition'

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/contractcancellationposition/{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

Update 'Contractcancellationposition'

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
transfer_to_external_partybooleanrequired
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
readbooleanrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

curl -i -X PATCH \
  'https://dev.api.pigello.io/contracts/contractcancellationposition/{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",
    "industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "resign": true,
    "cancellation_reason": "string",
    "issued_by_admin_attachment": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "cancellation_time": "2019-08-24T14:15:22Z",
    "lifetime_end_date": "2019-08-24",
    "message": "string",
    "external_party": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "cancelled_by_counterpart": true,
    "transition_approved": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transfer_to_external_party": true,
    "cancellation_source": 0,
    "block_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoorsection_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transfer_date": "2019-08-24",
    "closed": true,
    "issued_by_admin_on_behalf_of_party": true,
    "affects_sub_contracts": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "other_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parkingspot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "read": true,
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
statusinteger or null(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
terminationbooleanread-onlyrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
transfer_to_external_partybooleanrequired
transfer_notationobject or null(Contracttransfernotation)read-onlyrequired
transfer_notation.​idstring(uuid)
closedbooleanrequired
issued_by_admin_on_behalf_of_partybooleanrequired
affects_sub_contractsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

initiating_positionobject or null(Contractcancellationposition)read-onlyrequired
initiating_position.​idstring(uuid)
readbooleanrequired
is_preliminarybooleanread-onlyrequired
custom_idstring or null<= 128 characters
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract, other_contract

tenantobject or null(Tenant)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

This field, or at least one of the following fields must be set: organization_user

resignboolean or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: organization_user

cancellation_reasonstring or null
created_atstring(date-time)read-only
issued_by_admin_attachmentobject or null
cancellation_timestring or null(date-time)
lifetime_end_datestring or null(date)
messagestring or null<= 255 characters
external_partyobject or null(Tenant)
cancelled_by_counterpartboolean or null
transition_approvedboolean or null
organizationobject or null(Organization)
cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
block_contractobject or null(Blockcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, other_contract

outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parkingspot_contract, block_contract, other_contract

transfer_datestring or null(date)
cancellation_signed_timestring or null(date-time)
other_contractobject or null(Othercontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, parkingspot_contract, block_contract

parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoorsection_contract, block_contract, other_contract

organization_userobject or null(Organizationuser)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: tenant, resign

This field, or at least one of the following fields must be set: tenant

Response
application/json
{
  "custom_id": "string",
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "resign": true,
  "cancellation_reason": "string",
  "status": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "termination": true,
  "issued_by_admin_attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "cancellation_time": "2019-08-24T14:15:22Z",
  "lifetime_end_date": "2019-08-24",
  "message": "string",
  "part_resignation": true,
  "transfer_request": true,
  "external_party": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancelled_by_counterpart": true,
  "transition_approved": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_to_external_party": true,
  "cancellation_source": 0,
  "transfer_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_date": "2019-08-24",
  "closed": true,
  "issued_by_admin_on_behalf_of_party": true,
  "affects_sub_contracts": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiating_position": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "other_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "read": true,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_preliminary": true
}

Contracttransfernotation

Operations

Othercontract

Operations

Signedcontractdocument

Operations

Contractcancellationconfiguration

Operations
© Pigello. All rights reserved.