Skip to content

Contracts (2.0.0)

The 'Contracts' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Apartmentcontract

Operations

Parkingspotcontract

Operations

Contractcancellationreason

Operations

Outdoorsectioncontract

Operations

Industrialpremisescontract

Operations

Blockcontract

Operations

Contractcancellationposition

Operations

Contracttransfernotation

Operations

Othercontract

Operations

Signedcontractdocument

Operations

Bulk write 'Signedcontractdocument'

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 [
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/contracts/signedcontractdocument/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 '[
    {
      "category": 0,
      "content_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "document_file": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "category": 0,
    "content_type": { … },
    "custom_id": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "organization": { … },
    "document_file": { … }
  }
]

Create 'Signedcontractdocument'

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
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/contracts/signedcontractdocument/ \
  -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 '{
    "category": 0,
    "content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "document_file": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    }
  }'

Responses

Successful creation

Bodyapplication/json
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
Response
application/json
{
  "category": 0,
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "document_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  }
}

Get 'Signedcontractdocument'

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/signedcontractdocument/{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
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
Response
application/json
{
  "category": 0,
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "document_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  }
}

Delete 'Signedcontractdocument'

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/signedcontractdocument/{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 'Signedcontractdocument'

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
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/contracts/signedcontractdocument/{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 '{
    "category": 0,
    "content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "document_file": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    }
  }'

Responses

Successful update

Bodyapplication/json
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
object_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

document_fileobjectrequired
document_file.​namestring

wanted filename of the file

document_file.​md5_hashstring

base64 encoded md5hash of the file

document_file.​getstring(url)
document_file.​postobject
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
Response
application/json
{
  "category": 0,
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "document_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  }
}

Contractcancellationconfiguration

Operations
© Pigello. All rights reserved.