Skip to content
/
Bulk write 'Othercontract...

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

Delete 'Othercontract'

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/othercontract/{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 'Othercontract'

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
id_numberstring<= 255 charactersrequired
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/contracts/othercontract/{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 '{
    "owner_warning_interval_weeks": 2147483647,
    "signed_time": "2019-08-24T14:15:22Z",
    "invoice_merge_base_rent_in_view": true,
    "invoicing_use_rent_invoice": true,
    "invoicing_period": 0,
    "co_invoice": true,
    "main_apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "renew_indefinetely": true,
    "invoice_month_interval": 1,
    "invoicing_marking": "string",
    "main_parkingspot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "relates_to_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "main_industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_attempt_autogiro": true,
    "cancelled_by_counterpart": true,
    "start_date": "2019-08-24",
    "lifetime_end_date": "2019-08-24",
    "archived": true,
    "invoicing_automatic_creation_paused": true,
    "id_number": "string",
    "invoicing_payment_terms": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_customer_reference": "string",
    "cancellation_reason": "string",
    "renew_interval_weeks": 2147483647,
    "cancellation_time": "2019-08-24T14:15:22Z",
    "invoicing_reminder_blocked": true,
    "invoicing_contract_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_dimension_value": "string",
    "invoicing_debt_distribution_pushed_until": "2019-08-24",
    "owner_notification_interval_weeks": 2147483647,
    "initial_end_date": "2019-08-24",
    "invoicing_period_from": "2019-08-24",
    "negotiation_succession_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_reminder_distribution_pushed_until": "2019-08-24",
    "tenant_counterpart": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_default_vat": 0,
    "counterpart_warning_interval_weeks": 2147483647,
    "invoicing_interest_fee_blocked": true,
    "main_outdoorsection_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
    "invoice_merge_non_base_rent_in_view": true,
    "invoice_merge_index_in_view": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_debt_blocked": true,
    "pending_re_negotiations": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "cancellation_source": 0,
    "cancellation_comment": "string",
    "is_draft": true,
    "counterpart_notification_interval_weeks": 2147483647,
    "custom_id": "string"
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

id_numberstring<= 255 charactersrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
owner_warning_datestring or null(date)read-only
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tagsanyread-only
pending_monitor_approval_amountanyread-only
invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

counterpart_warning_datestring or null(date)read-only
renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

created_atstring(date-time)read-only
last_counterpart_notification_datestring or null(date)read-only
custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

customer_columnsanyread-only
last_owner_notification_datestring or null(date)read-only
main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

renewed_tostring or null(date)read-only
relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

has_base_rent_vatbooleanread-only
pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
Response
application/json
{
  "owner_warning_date": "2019-08-24",
  "owner_warning_interval_weeks": 2147483647,
  "signed_time": "2019-08-24T14:15:22Z",
  "invoice_merge_base_rent_in_view": true,
  "invoicing_use_rent_invoice": true,
  "invoicing_period": 0,
  "co_invoice": true,
  "main_apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renew_indefinetely": true,
  "invoice_month_interval": 1,
  "invoicing_marking": "string",
  "main_parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "relates_to_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_attempt_autogiro": true,
  "cancelled_by_counterpart": true,
  "start_date": "2019-08-24",
  "lifetime_end_date": "2019-08-24",
  "archived": true,
  "invoicing_automatic_creation_paused": true,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "id_number": "string",
  "pending_monitor_approval_amount": null,
  "invoicing_payment_terms": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_customer_reference": "string",
  "cancellation_reason": "string",
  "counterpart_warning_date": "2019-08-24",
  "renew_interval_weeks": 2147483647,
  "cancellation_time": "2019-08-24T14:15:22Z",
  "invoicing_reminder_blocked": true,
  "invoicing_contract_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_counterpart_notification_date": "2019-08-24",
  "custom_dimension_value": "string",
  "invoicing_debt_distribution_pushed_until": "2019-08-24",
  "owner_notification_interval_weeks": 2147483647,
  "initial_end_date": "2019-08-24",
  "invoicing_period_from": "2019-08-24",
  "negotiation_succession_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_reminder_distribution_pushed_until": "2019-08-24",
  "tenant_counterpart": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_default_vat": 0,
  "counterpart_warning_interval_weeks": 2147483647,
  "status": 0,
  "invoicing_interest_fee_blocked": true,
  "customer_columns": null,
  "last_owner_notification_date": "2019-08-24",
  "main_outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renewed_to": "2019-08-24",
  "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
  "invoice_merge_non_base_rent_in_view": true,
  "invoice_merge_index_in_view": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_debt_blocked": true,
  "has_base_rent_vat": true,
  "pending_re_negotiations": true,
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "cancellation_source": 0,
  "cancellation_comment": "string",
  "is_draft": true,
  "counterpart_notification_interval_weeks": 2147483647,
  "custom_id": "string"
}

Get 'Othercontract'

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

id_numberstring<= 255 charactersrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
owner_warning_datestring or null(date)read-only
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tagsanyread-only
pending_monitor_approval_amountanyread-only
invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

counterpart_warning_datestring or null(date)read-only
renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

created_atstring(date-time)read-only
last_counterpart_notification_datestring or null(date)read-only
custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

customer_columnsanyread-only
last_owner_notification_datestring or null(date)read-only
main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

renewed_tostring or null(date)read-only
relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

has_base_rent_vatbooleanread-only
pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
Response
application/json
{
  "owner_warning_date": "2019-08-24",
  "owner_warning_interval_weeks": 2147483647,
  "signed_time": "2019-08-24T14:15:22Z",
  "invoice_merge_base_rent_in_view": true,
  "invoicing_use_rent_invoice": true,
  "invoicing_period": 0,
  "co_invoice": true,
  "main_apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renew_indefinetely": true,
  "invoice_month_interval": 1,
  "invoicing_marking": "string",
  "main_parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "relates_to_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_attempt_autogiro": true,
  "cancelled_by_counterpart": true,
  "start_date": "2019-08-24",
  "lifetime_end_date": "2019-08-24",
  "archived": true,
  "invoicing_automatic_creation_paused": true,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "id_number": "string",
  "pending_monitor_approval_amount": null,
  "invoicing_payment_terms": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_customer_reference": "string",
  "cancellation_reason": "string",
  "counterpart_warning_date": "2019-08-24",
  "renew_interval_weeks": 2147483647,
  "cancellation_time": "2019-08-24T14:15:22Z",
  "invoicing_reminder_blocked": true,
  "invoicing_contract_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_counterpart_notification_date": "2019-08-24",
  "custom_dimension_value": "string",
  "invoicing_debt_distribution_pushed_until": "2019-08-24",
  "owner_notification_interval_weeks": 2147483647,
  "initial_end_date": "2019-08-24",
  "invoicing_period_from": "2019-08-24",
  "negotiation_succession_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_reminder_distribution_pushed_until": "2019-08-24",
  "tenant_counterpart": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_default_vat": 0,
  "counterpart_warning_interval_weeks": 2147483647,
  "status": 0,
  "invoicing_interest_fee_blocked": true,
  "customer_columns": null,
  "last_owner_notification_date": "2019-08-24",
  "main_outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renewed_to": "2019-08-24",
  "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
  "invoice_merge_non_base_rent_in_view": true,
  "invoice_merge_index_in_view": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_debt_blocked": true,
  "has_base_rent_vat": true,
  "pending_re_negotiations": true,
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "cancellation_source": 0,
  "cancellation_comment": "string",
  "is_draft": true,
  "counterpart_notification_interval_weeks": 2147483647,
  "custom_id": "string"
}

List 'Othercontract'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
archivedany

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_commentany

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

co_invoiceany

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

counterpart_notification_interval_weeksany

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

counterpart_warning_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

counterpart_warning_interval_weeksany

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

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_dimension_valueany

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

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

has_base_rent_vatany

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

id_numberany

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

initial_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

invoice_merge_base_rent_in_viewany

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

invoice_merge_index_in_viewany

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

invoice_merge_non_base_rent_in_viewany

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

invoice_month_intervalany

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

invoicing_attempt_autogiroany

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

invoicing_automatic_creation_pausedany

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

invoicing_companyany

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

invoicing_contract_settingany

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

invoicing_customer_referenceany

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

invoicing_debt_blockedany

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

invoicing_debt_distribution_pushed_untilany

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

invoicing_default_vatany

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

invoicing_interest_fee_blockedany

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

invoicing_markingany

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

invoicing_payment_termsany

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

invoicing_periodany

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

invoicing_period_fromany

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

invoicing_reminder_blockedany

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

invoicing_reminder_distribution_pushed_untilany

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

invoicing_use_rent_invoiceany

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_draftany

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

last_counterpart_notification_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

last_owner_notification_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

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

main_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

main_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

main_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

main_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

negotiation_succession_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

owner_notification_interval_weeksany

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

owner_warning_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

owner_warning_interval_weeksany

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

pending_re_negotiationsany

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

relates_to_content_typeany

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

relates_to_object_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

renew_indefinetelyany

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

renew_interval_weeksany

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

renewed_toany

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

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

start_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

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

tenant_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

curl -i -X GET \
  'https://dev.api.pigello.io/contracts/othercontract/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

id_numberstring<= 255 charactersrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
owner_warning_datestring or null(date)read-only
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tagsanyread-only
pending_monitor_approval_amountanyread-only
invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

counterpart_warning_datestring or null(date)read-only
renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

created_atstring(date-time)read-only
last_counterpart_notification_datestring or null(date)read-only
custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

customer_columnsanyread-only
last_owner_notification_datestring or null(date)read-only
main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

renewed_tostring or null(date)read-only
relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

has_base_rent_vatbooleanread-only
pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "owner_warning_date": "2019-08-24",
    "owner_warning_interval_weeks": 2147483647,
    "signed_time": "2019-08-24T14:15:22Z",
    "invoice_merge_base_rent_in_view": true,
    "invoicing_use_rent_invoice": true,
    "invoicing_period": 0,
    "co_invoice": true,
    "main_apartment_contract": { … },
    "renew_indefinetely": true,
    "invoice_month_interval": 1,
    "invoicing_marking": "string",
    "main_parkingspot_contract": { … },
    "relates_to_content_type": { … },
    "main_industrial_premises_contract": { … },
    "invoicing_attempt_autogiro": true,
    "cancelled_by_counterpart": true,
    "start_date": "2019-08-24",
    "lifetime_end_date": "2019-08-24",
    "archived": true,
    "invoicing_automatic_creation_paused": true,
    "tags": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "id_number": "string",
    "pending_monitor_approval_amount": null,
    "invoicing_payment_terms": { … },
    "invoicing_customer_reference": "string",
    "cancellation_reason": "string",
    "counterpart_warning_date": "2019-08-24",
    "renew_interval_weeks": 2147483647,
    "cancellation_time": "2019-08-24T14:15:22Z",
    "invoicing_reminder_blocked": true,
    "invoicing_contract_setting": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "last_counterpart_notification_date": "2019-08-24",
    "custom_dimension_value": "string",
    "invoicing_debt_distribution_pushed_until": "2019-08-24",
    "owner_notification_interval_weeks": 2147483647,
    "initial_end_date": "2019-08-24",
    "invoicing_period_from": "2019-08-24",
    "negotiation_succession_contract": { … },
    "invoicing_reminder_distribution_pushed_until": "2019-08-24",
    "tenant_counterpart": { … },
    "invoicing_default_vat": 0,
    "counterpart_warning_interval_weeks": 2147483647,
    "status": 0,
    "invoicing_interest_fee_blocked": true,
    "customer_columns": null,
    "last_owner_notification_date": "2019-08-24",
    "main_outdoorsection_contract": { … },
    "invoicing_company": { … },
    "renewed_to": "2019-08-24",
    "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
    "invoice_merge_non_base_rent_in_view": true,
    "invoice_merge_index_in_view": true,
    "organization": { … },
    "invoicing_debt_blocked": true,
    "has_base_rent_vat": true,
    "pending_re_negotiations": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "cancellation_source": 0,
    "cancellation_comment": "string",
    "is_draft": true,
    "counterpart_notification_interval_weeks": 2147483647,
    "custom_id": "string"
  }
]

Bulk write 'Othercontract'

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 [
id_numberstring<= 255 charactersrequired
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/contracts/othercontract/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 '[
    {
      "owner_warning_interval_weeks": 2147483647,
      "signed_time": "2019-08-24T14:15:22Z",
      "invoice_merge_base_rent_in_view": true,
      "invoicing_use_rent_invoice": true,
      "invoicing_period": 0,
      "co_invoice": true,
      "main_apartment_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "renew_indefinetely": true,
      "invoice_month_interval": 1,
      "invoicing_marking": "string",
      "main_parkingspot_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "relates_to_content_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "main_industrial_premises_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_attempt_autogiro": true,
      "cancelled_by_counterpart": true,
      "start_date": "2019-08-24",
      "lifetime_end_date": "2019-08-24",
      "archived": true,
      "invoicing_automatic_creation_paused": true,
      "id_number": "string",
      "invoicing_payment_terms": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_customer_reference": "string",
      "cancellation_reason": "string",
      "renew_interval_weeks": 2147483647,
      "cancellation_time": "2019-08-24T14:15:22Z",
      "invoicing_reminder_blocked": true,
      "invoicing_contract_setting": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_dimension_value": "string",
      "invoicing_debt_distribution_pushed_until": "2019-08-24",
      "owner_notification_interval_weeks": 2147483647,
      "initial_end_date": "2019-08-24",
      "invoicing_period_from": "2019-08-24",
      "negotiation_succession_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_reminder_distribution_pushed_until": "2019-08-24",
      "tenant_counterpart": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_default_vat": 0,
      "counterpart_warning_interval_weeks": 2147483647,
      "invoicing_interest_fee_blocked": true,
      "main_outdoorsection_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_company": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
      "invoice_merge_non_base_rent_in_view": true,
      "invoice_merge_index_in_view": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoicing_debt_blocked": true,
      "pending_re_negotiations": true,
      "cancellation_signed_time": "2019-08-24T14:15:22Z",
      "cancellation_source": 0,
      "cancellation_comment": "string",
      "is_draft": true,
      "counterpart_notification_interval_weeks": 2147483647,
      "custom_id": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

id_numberstring<= 255 charactersrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
owner_warning_datestring or null(date)read-only
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tagsanyread-only
pending_monitor_approval_amountanyread-only
invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

counterpart_warning_datestring or null(date)read-only
renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

created_atstring(date-time)read-only
last_counterpart_notification_datestring or null(date)read-only
custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

customer_columnsanyread-only
last_owner_notification_datestring or null(date)read-only
main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

renewed_tostring or null(date)read-only
relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

has_base_rent_vatbooleanread-only
pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "owner_warning_date": "2019-08-24",
    "owner_warning_interval_weeks": 2147483647,
    "signed_time": "2019-08-24T14:15:22Z",
    "invoice_merge_base_rent_in_view": true,
    "invoicing_use_rent_invoice": true,
    "invoicing_period": 0,
    "co_invoice": true,
    "main_apartment_contract": { … },
    "renew_indefinetely": true,
    "invoice_month_interval": 1,
    "invoicing_marking": "string",
    "main_parkingspot_contract": { … },
    "relates_to_content_type": { … },
    "main_industrial_premises_contract": { … },
    "invoicing_attempt_autogiro": true,
    "cancelled_by_counterpart": true,
    "start_date": "2019-08-24",
    "lifetime_end_date": "2019-08-24",
    "archived": true,
    "invoicing_automatic_creation_paused": true,
    "tags": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "id_number": "string",
    "pending_monitor_approval_amount": null,
    "invoicing_payment_terms": { … },
    "invoicing_customer_reference": "string",
    "cancellation_reason": "string",
    "counterpart_warning_date": "2019-08-24",
    "renew_interval_weeks": 2147483647,
    "cancellation_time": "2019-08-24T14:15:22Z",
    "invoicing_reminder_blocked": true,
    "invoicing_contract_setting": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "last_counterpart_notification_date": "2019-08-24",
    "custom_dimension_value": "string",
    "invoicing_debt_distribution_pushed_until": "2019-08-24",
    "owner_notification_interval_weeks": 2147483647,
    "initial_end_date": "2019-08-24",
    "invoicing_period_from": "2019-08-24",
    "negotiation_succession_contract": { … },
    "invoicing_reminder_distribution_pushed_until": "2019-08-24",
    "tenant_counterpart": { … },
    "invoicing_default_vat": 0,
    "counterpart_warning_interval_weeks": 2147483647,
    "status": 0,
    "invoicing_interest_fee_blocked": true,
    "customer_columns": null,
    "last_owner_notification_date": "2019-08-24",
    "main_outdoorsection_contract": { … },
    "invoicing_company": { … },
    "renewed_to": "2019-08-24",
    "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
    "invoice_merge_non_base_rent_in_view": true,
    "invoice_merge_index_in_view": true,
    "organization": { … },
    "invoicing_debt_blocked": true,
    "has_base_rent_vat": true,
    "pending_re_negotiations": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "cancellation_source": 0,
    "cancellation_comment": "string",
    "is_draft": true,
    "counterpart_notification_interval_weeks": 2147483647,
    "custom_id": "string"
  }
]

Create 'Othercontract'

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
id_numberstring<= 255 charactersrequired
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/contracts/othercontract/ \
  -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 '{
    "owner_warning_interval_weeks": 2147483647,
    "signed_time": "2019-08-24T14:15:22Z",
    "invoice_merge_base_rent_in_view": true,
    "invoicing_use_rent_invoice": true,
    "invoicing_period": 0,
    "co_invoice": true,
    "main_apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "renew_indefinetely": true,
    "invoice_month_interval": 1,
    "invoicing_marking": "string",
    "main_parkingspot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "relates_to_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "main_industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_attempt_autogiro": true,
    "cancelled_by_counterpart": true,
    "start_date": "2019-08-24",
    "lifetime_end_date": "2019-08-24",
    "archived": true,
    "invoicing_automatic_creation_paused": true,
    "id_number": "string",
    "invoicing_payment_terms": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_customer_reference": "string",
    "cancellation_reason": "string",
    "renew_interval_weeks": 2147483647,
    "cancellation_time": "2019-08-24T14:15:22Z",
    "invoicing_reminder_blocked": true,
    "invoicing_contract_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_dimension_value": "string",
    "invoicing_debt_distribution_pushed_until": "2019-08-24",
    "owner_notification_interval_weeks": 2147483647,
    "initial_end_date": "2019-08-24",
    "invoicing_period_from": "2019-08-24",
    "negotiation_succession_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_reminder_distribution_pushed_until": "2019-08-24",
    "tenant_counterpart": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_default_vat": 0,
    "counterpart_warning_interval_weeks": 2147483647,
    "invoicing_interest_fee_blocked": true,
    "main_outdoorsection_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
    "invoice_merge_non_base_rent_in_view": true,
    "invoice_merge_index_in_view": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_debt_blocked": true,
    "pending_re_negotiations": true,
    "cancellation_signed_time": "2019-08-24T14:15:22Z",
    "cancellation_source": 0,
    "cancellation_comment": "string",
    "is_draft": true,
    "counterpart_notification_interval_weeks": 2147483647,
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

id_numberstring<= 255 charactersrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
owner_warning_datestring or null(date)read-only
owner_warning_interval_weeksinteger or null(int32)<= 2147483647
signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date

invoice_merge_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_use_rent_invoiceboolean
invoicing_periodinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoice_month_interval, invoicing_period_from

Enum01-1
co_invoiceboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

main_apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

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

renew_indefinetelyboolean
invoice_month_intervalinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoicing_period_from

invoicing_markingstring or null<= 255 characters
main_parkingspot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

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

relates_to_content_typeobject or null(Contenttype)
main_industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

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

invoicing_attempt_autogiroboolean
cancelled_by_counterpartboolean or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time

lifetime_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: cancellation_time, cancellation_signed_time

archivedboolean
invoicing_automatic_creation_pausedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tagsanyread-only
pending_monitor_approval_amountanyread-only
invoicing_payment_termsobject or null(Paymenttermssetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_contract_setting

invoicing_customer_referencestring or null<= 255 characters
cancellation_reasonstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

counterpart_warning_datestring or null(date)read-only
renew_interval_weeksinteger or null(int32)<= 2147483647
cancellation_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signed_time, lifetime_end_date, cancellation_signed_time

This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart

invoicing_reminder_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoicing_contract_settingobject or null(Automaticcontractinvoicingsetting)

Additional Validation Information:

This value must be set together with the following fields: invoicing_company, invoicing_payment_terms

created_atstring(date-time)read-only
last_counterpart_notification_datestring or null(date)read-only
custom_dimension_valuestring or null<= 255 characters
invoicing_debt_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_reminder_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

owner_notification_interval_weeksinteger(int32)<= 2147483647
initial_end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

invoicing_period_fromstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: invoicing_period, invoice_month_interval

negotiation_succession_contractobject or null(Othercontract)
invoicing_reminder_distribution_pushed_untilstring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: invoicing_debt_distribution_pushed_until

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

tenant_counterpartobject or null(Tenant)
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
counterpart_warning_interval_weeksinteger or null(int32)<= 2147483647
invoicing_interest_fee_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

customer_columnsanyread-only
last_owner_notification_datestring or null(date)read-only
main_outdoorsection_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

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

invoicing_companyobject or null(Company)

Additional Validation Information:

This value must be set together with the following fields: invoicing_payment_terms, invoicing_contract_setting

renewed_tostring or null(date)read-only
relates_to_object_idstring or null(uuid)
invoice_merge_non_base_rent_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

invoice_merge_index_in_viewboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

organizationobject or null(Organization)
invoicing_debt_blockedboolean or null

Additional Validation Information:

This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from

has_base_rent_vatbooleanread-only
pending_re_negotiationsboolean
cancellation_signed_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_time

This value requires that the following fields are also set: cancellation_time

cancellation_sourceinteger or null(int32)[ -2147483648 .. 2147483647 ]

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

Enum0123456
cancellation_commentstring or null

Additional Validation Information:

This value requires that the following fields are also set: cancellation_time

is_draftboolean
counterpart_notification_interval_weeksinteger(int32)<= 2147483647
custom_idstring or null<= 128 characters
Response
application/json
{
  "owner_warning_date": "2019-08-24",
  "owner_warning_interval_weeks": 2147483647,
  "signed_time": "2019-08-24T14:15:22Z",
  "invoice_merge_base_rent_in_view": true,
  "invoicing_use_rent_invoice": true,
  "invoicing_period": 0,
  "co_invoice": true,
  "main_apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renew_indefinetely": true,
  "invoice_month_interval": 1,
  "invoicing_marking": "string",
  "main_parkingspot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "relates_to_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_attempt_autogiro": true,
  "cancelled_by_counterpart": true,
  "start_date": "2019-08-24",
  "lifetime_end_date": "2019-08-24",
  "archived": true,
  "invoicing_automatic_creation_paused": true,
  "tags": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "id_number": "string",
  "pending_monitor_approval_amount": null,
  "invoicing_payment_terms": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_customer_reference": "string",
  "cancellation_reason": "string",
  "counterpart_warning_date": "2019-08-24",
  "renew_interval_weeks": 2147483647,
  "cancellation_time": "2019-08-24T14:15:22Z",
  "invoicing_reminder_blocked": true,
  "invoicing_contract_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "last_counterpart_notification_date": "2019-08-24",
  "custom_dimension_value": "string",
  "invoicing_debt_distribution_pushed_until": "2019-08-24",
  "owner_notification_interval_weeks": 2147483647,
  "initial_end_date": "2019-08-24",
  "invoicing_period_from": "2019-08-24",
  "negotiation_succession_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_reminder_distribution_pushed_until": "2019-08-24",
  "tenant_counterpart": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_default_vat": 0,
  "counterpart_warning_interval_weeks": 2147483647,
  "status": 0,
  "invoicing_interest_fee_blocked": true,
  "customer_columns": null,
  "last_owner_notification_date": "2019-08-24",
  "main_outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "renewed_to": "2019-08-24",
  "relates_to_object_id": "1147f122-da11-46cc-b4af-c91e04e76bef",
  "invoice_merge_non_base_rent_in_view": true,
  "invoice_merge_index_in_view": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_debt_blocked": true,
  "has_base_rent_vat": true,
  "pending_re_negotiations": true,
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "cancellation_source": 0,
  "cancellation_comment": "string",
  "is_draft": true,
  "counterpart_notification_interval_weeks": 2147483647,
  "custom_id": "string"
}

/accounting/contracts/perform/othercontract/{organization_id}/

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
organization_idstringwrite-onlyrequired
Bodyapplication/json
any
curl -i -X POST \
  'https://dev.api.pigello.io/accounting/contracts/perform/othercontract/{organization_id}/' \
  -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'

Responses

Successful creation

Bodyapplication/json
any
Response
application/json
null

/accounting/contracts/preview/othercontract/{organization_id}/

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
organization_idstringwrite-onlyrequired
Bodyapplication/json
any
curl -i -X POST \
  'https://dev.api.pigello.io/accounting/contracts/preview/othercontract/{organization_id}/' \
  -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'

Responses

Successful creation

Bodyapplication/json
any
Response
application/json
null

Signedcontractdocument

Operations

Contractcancellationconfiguration

Operations
© Pigello. All rights reserved.