Skip to content

Get 'ApartmentContract'

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

Additional Validation Information:

Enum Descriptions:

  • 0 - Active

  • 1 - Active Further

  • 2 - Active Definite End

  • 3 - Cancelled Pending Negotiation

  • 4 - Cancelled Pending

  • 5 - Cancelled Negotiation

  • 6 - Cancelled

  • 7 - Owner Warning

  • 8 - Counterpart Warning

  • 9 - Upcoming

  • 10 - Not Signed

  • 11 - Inactive Cancellation Not Signed

  • 12 - Inactive

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

start_datestring or null, (date)

Additional Validation Information:

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

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

renewed_tostring or null, (date)read-only
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_signed_time, cancellation_time

owner_notification_interval_weeksinteger, (int32), <= 2147483647
counterpart_notification_interval_weeksinteger, (int32), <= 2147483647
renew_interval_weeksinteger or null, (int32), <= 2147483647
renew_indefinetelyboolean
owner_warning_interval_weeksinteger or null, (int32), <= 2147483647
counterpart_warning_interval_weeksinteger or null, (int32), <= 2147483647
last_owner_notification_datestring or null, (date)read-only
last_counterpart_notification_datestring or null, (date)read-only
owner_warning_datestring or null, (date)read-only
counterpart_warning_datestring or null, (date)read-only
cancellation_timestring or null, (date-time)

Additional Validation Information:

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

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

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

cancelled_by_counterpartboolean or null

Additional Validation Information:

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

Enum Descriptions:

  • 0 - Pigello Tenant Portal

  • 1 - Phone

  • 2 - Email

  • 3 - Postal

  • 4 - Meeting

  • 5 - Chat

  • 6 - Integration

Enum:0123456
cancellation_reasonstring or null

Additional Validation Information:

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

cancellation_commentstring or null

Additional Validation Information:

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

pending_re_negotiationsboolean
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

Enum Descriptions:

  • -1 - Previous

  • 0 - Current

  • 1 - Upcoming

Enum:-101
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_period_fromstring or null, (date)

Additional Validation Information:

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

invoicing_customer_referencestring or null, <= 255 characters
invoicing_markingstring 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

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

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

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

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

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

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_attempt_autogiroboolean
invoicing_default_vatinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 0 - Vat 0

  • 6 - Vat 6

  • 12 - Vat 12

  • 25 - Vat 25

Enum:061225
invoicing_is_internalboolean
custom_dimension_valuestring or null, <= 255 characters
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

negotiation_succession_contractobject or null(ApartmentContract)
has_base_rent_vatbooleanread-only
archivedboolean
tenantobject or null(Tenant)

Additional Validation Information:

This value must not match with the values of these fields: bi_tenants

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_outdoorsection_contract, main_brf_invoiceable

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_outdoorsection_contract, main_brf_invoiceable

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_brf_invoiceable

main_brf_invoiceableobject or null(BrfApartmentInvoiceConfiguration)

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

bi_tenantsArray of objects(Tenant)
tagsanyread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
Response
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "id_number": "string",
  "is_draft": true,
  "signed_time": "2019-08-24T14:15:22Z",
  "start_date": "2019-08-24",
  "initial_end_date": "2019-08-24",
  "renewed_to": "2019-08-24",
  "lifetime_end_date": "2019-08-24",
  "owner_notification_interval_weeks": 2147483647,
  "counterpart_notification_interval_weeks": 2147483647,
  "renew_interval_weeks": 2147483647,
  "renew_indefinetely": true,
  "owner_warning_interval_weeks": 2147483647,
  "counterpart_warning_interval_weeks": 2147483647,
  "last_owner_notification_date": "2019-08-24",
  "last_counterpart_notification_date": "2019-08-24",
  "owner_warning_date": "2019-08-24",
  "counterpart_warning_date": "2019-08-24",
  "cancellation_time": "2019-08-24T14:15:22Z",
  "cancellation_signed_time": "2019-08-24T14:15:22Z",
  "cancelled_by_counterpart": true,
  "cancellation_source": 0,
  "cancellation_reason": "string",
  "cancellation_comment": "string",
  "pending_re_negotiations": true,
  "status": 0,
  "invoicing_period": -1,
  "invoice_month_interval": 1,
  "invoicing_period_from": "2019-08-24",
  "invoicing_customer_reference": "string",
  "invoicing_marking": "string",
  "invoicing_debt_distribution_pushed_until": "2019-08-24",
  "invoicing_debt_blocked": true,
  "invoicing_reminder_distribution_pushed_until": "2019-08-24",
  "invoicing_reminder_blocked": true,
  "invoicing_interest_fee_blocked": true,
  "invoicing_automatic_creation_paused": true,
  "invoice_merge_non_base_rent_in_view": true,
  "invoice_merge_index_in_view": true,
  "invoice_merge_base_rent_in_view": true,
  "invoicing_attempt_autogiro": true,
  "invoicing_default_vat": 0,
  "invoicing_is_internal": true,
  "custom_dimension_value": "string",
  "co_invoice": true,
  "negotiation_succession_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "has_base_rent_vat": true,
  "archived": true,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "space": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_outdoorsection_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "main_brf_invoiceable": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bi_tenants": [
    { … }
  ],
  "tags": null,
  "customer_columns": null,
  "pending_monitor_approval_amount": null
}
© Pigello. All rights reserved.