Skip to content

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

_slimboolean
_statisticsboolean
global_realestatesArray of any
global_segmentsArray of any
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

GET
/contracts/contractcancellationposition/list/
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&global_realestates=&global_segments=&affects_sub_contracts=%7Baffects_sub_contracts%7D&apartment_contract=%7Bapartment_contract%7D&block_contract=%7Bblock_contract%7D&cancellation_reason=%7Bcancellation_reason%7D&cancellation_signed_time=%7Bcancellation_signed_time%7D&cancellation_source=%7Bcancellation_source%7D&cancellation_time=%7Bcancellation_time%7D&cancelled_by_counterpart=%7Bcancelled_by_counterpart%7D&closed=%7Bclosed%7D&created_at=%7Bcreated_at%7D&custom_id=%7Bcustom_id%7D&external_party=%7Bexternal_party%7D&id=%7Bid%7D&industrial_premises_contract=%7Bindustrial_premises_contract%7D&initiating_position=%7Binitiating_position%7D&is_preliminary=%7Bis_preliminary%7D&issued_by_admin_on_behalf_of_party=%7Bissued_by_admin_on_behalf_of_party%7D&lifetime_end_date=%7Blifetime_end_date%7D&message=%7Bmessage%7D&organization=%7Borganization%7D&organization_user=%7Borganization_user%7D&other_contract=%7Bother_contract%7D&outdoorsection_contract=%7Boutdoorsection_contract%7D&parkingspot_contract=%7Bparkingspot_contract%7D&part_resignation=%7Bpart_resignation%7D&read=%7Bread%7D&resign=%7Bresign%7D&status=%7Bstatus%7D&tenant=%7Btenant%7D&termination=%7Btermination%7D&transfer_date=%7Btransfer_date%7D&transfer_notation=%7Btransfer_notation%7D&transfer_request=%7Btransfer_request%7D&transfer_to_external_party=%7Btransfer_to_external_party%7D&transition_approved=%7Btransition_approved%7D' \
  -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/json
Array [
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

affects_sub_contractsbooleanrequired
initiating_positionobject or null(ContractCancellationPosition)read-onlyrequired
issued_by_admin_on_behalf_of_partybooleanrequired
part_resignationbooleanread-onlyrequired
transfer_requestbooleanread-onlyrequired
terminationbooleanread-onlyrequired
is_preliminarybooleanread-onlyrequired
transfer_to_external_partybooleanrequired
closedbooleanrequired
transfer_notationobject or null(ContractTransferNotation)read-onlyrequired
readbooleanrequired
statusinteger or null, (int32), [ -2147483648 .. 2147483647 ]read-onlyrequired

Additional Validation Information:

Enum Descriptions:

  • 0 - Aborted

  • 1 - Closed

  • 2 - Pending Answer

  • 3 - Pending Approval

  • 4 - Pending Signing

Enum:01234
organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
created_atstring, (date-time)read-only
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

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

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

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

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

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

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

organization_userobject or null(OrganizationUser)

Additional Validation Information:

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

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

issued_by_admin_attachmentobject or null
transition_approvedboolean or null
resignboolean or null

Additional Validation Information:

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

external_partyobject or null(Tenant)
messagestring or null, <= 255 characters
cancellation_timestring or null, (date-time)
cancellation_reasonstring or null
cancellation_sourceinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 0 - Pigello Tenant Portal

  • 1 - Phone

  • 2 - Email

  • 3 - Postal

  • 4 - Meeting

  • 5 - Chat

  • 6 - Integration

Enum:0123456
cancellation_signed_timestring or null, (date-time)
cancelled_by_counterpartboolean or null
lifetime_end_datestring or null, (date)
transfer_datestring or null, (date)
pending_monitor_approval_amountanyread-only
]
Response
[
  {
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "apartment_contract": { … },
    "industrial_premises_contract": { … },
    "outdoorsection_contract": { … },
    "parkingspot_contract": { … },
    "block_contract": { … },
    "other_contract": { … },
    "affects_sub_contracts": true,
    "tenant": { … },
    "organization_user": { … },
    "initiating_position": { … },
    "issued_by_admin_on_behalf_of_party": true,
    "issued_by_admin_attachment": { … },
    "part_resignation": true,
    "transfer_request": true,
    "transition_approved": true,
    "termination": true,
    "is_preliminary": true,
    "resign": true,
    "transfer_to_external_party": true,
    "external_party": { … },
    "message": "string",
    "cancellation_time": "2019-08-24T14:15:22Z",
    "cancellation_reason": "string",
    "cancellation_source": 0,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "cancelled_by_counterpart": true,
    "lifetime_end_date": "2019-08-24",
    "closed": true,
    "transfer_date": "2019-08-24",
    "transfer_notation": { … },
    "read": true,
    "status": 0,
    "pending_monitor_approval_amount": null
  }
]
© Pigello. All rights reserved.