Skip to content
/
List 'Contracttransfernot...

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

Get 'Contracttransfernotation'

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/contracttransfernotation/{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
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transfer_performedbooleanrequired
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)
created_atstring(date-time)read-only
organizationobject or null(Organization)
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

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

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

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

custom_idstring or null<= 128 characters
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

Response
application/json
{
  "outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "other_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "transfer_performed": true,
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Delete 'Contracttransfernotation'

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/contracttransfernotation/{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 'Contracttransfernotation'

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_performedbooleanrequired
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)
organizationobject or null(Organization)
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

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

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

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

custom_idstring or null<= 128 characters
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

curl -i -X PATCH \
  'https://dev.api.pigello.io/contracts/contracttransfernotation/{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 '{
    "outdoorsection_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transfer_date": "2019-08-24",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "other_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "block_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parkingspot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "transfer_performed": true,
    "apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transfer_performedbooleanrequired
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)
created_atstring(date-time)read-only
organizationobject or null(Organization)
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

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

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

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

custom_idstring or null<= 128 characters
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

Response
application/json
{
  "outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transfer_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "other_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "transfer_performed": true,
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

List 'Contracttransfernotation'

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

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

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

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

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

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_performedany

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/contracttransfernotation/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transfer_performedbooleanrequired
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)
created_atstring(date-time)read-only
organizationobject or null(Organization)
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

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

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

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

custom_idstring or null<= 128 characters
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

]
Response
application/json
[
  {
    "outdoorsection_contract": { … },
    "transfer_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "organization": { … },
    "other_contract": { … },
    "industrial_premises_contract": { … },
    "block_contract": { … },
    "parkingspot_contract": { … },
    "custom_id": "string",
    "transfer_performed": true,
    "apartment_contract": { … }
  }
]

Othercontract

Operations

Signedcontractdocument

Operations

Contractcancellationconfiguration

Operations
© Pigello. All rights reserved.