The 'Contracts' application of the Core API
/
Bulk write 'Apartmentcont...
Contracts (2.0.0)
Download OpenAPI description
Languages
Servers
https://{environment}.pigello.io
Bodyapplication/jsonArray [
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
- https://dev.api.pigello.io/contracts/apartmentcontract/list/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://dev.api.pigello.io/contracts/apartmentcontract/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 '[
{
"archived": true,
"invoice_merge_non_base_rent_in_view": true,
"invoice_month_interval": 1,
"cancelled_by_counterpart": true,
"invoicing_period": 0,
"cancellation_source": 0,
"bi_tenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_reminder_blocked": true,
"invoicing_reminder_distribution_pushed_until": "2019-08-24",
"start_date": "2019-08-24",
"cancellation_comment": "string",
"invoice_merge_base_rent_in_view": true,
"owner_notification_interval_weeks": 2147483647,
"cancellation_reason": "string",
"negotiation_succession_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoicing_marking": "string",
"main_apartment_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"main_brf_invoiceable": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"pending_re_negotiations": true,
"space": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"cancellation_time": "2019-08-24T14:15:22Z",
"co_invoice": true,
"invoicing_default_vat": 0,
"invoicing_period_from": "2019-08-24",
"is_draft": true,
"counterpart_warning_interval_weeks": 2147483647,
"main_industrial_premises_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"initial_end_date": "2019-08-24",
"invoicing_automatic_creation_paused": true,
"counterpart_notification_interval_weeks": 2147483647,
"id_number": "string",
"organization": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"renew_indefinetely": true,
"invoicing_customer_reference": "string",
"invoicing_debt_distribution_pushed_until": "2019-08-24",
"allowed_target_audiences": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_attempt_autogiro": true,
"owner_warning_interval_weeks": 2147483647,
"cancellation_signed_time": "2019-08-24T14:15:22Z",
"lifetime_end_date": "2019-08-24",
"invoicing_interest_fee_blocked": true,
"signed_time": "2019-08-24T14:15:22Z",
"invoicing_debt_blocked": true,
"renew_interval_weeks": 2147483647,
"custom_dimension_value": "string",
"main_outdoorsection_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"terms": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoice_merge_index_in_view": true,
"custom_id": "string"
}
]'Successful bulk create/update
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Response
application/json
[ { "archived": true, "last_counterpart_notification_date": "2019-08-24", "invoice_merge_non_base_rent_in_view": true, "invoice_month_interval": 1, "cancelled_by_counterpart": true, "invoicing_period": 0, "cancellation_source": 0, "bi_tenants": [ … ], "counterpart_warning_date": "2019-08-24", "invoicing_reminder_blocked": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicing_reminder_distribution_pushed_until": "2019-08-24", "start_date": "2019-08-24", "cancellation_comment": "string", "pending_monitor_approval_amount": null, "invoice_merge_base_rent_in_view": true, "owner_notification_interval_weeks": 2147483647, "cancellation_reason": "string", "negotiation_succession_contract": { … }, "invoicing_marking": "string", "main_apartment_contract": { … }, "main_brf_invoiceable": { … }, "has_base_rent_vat": true, "owner_warning_date": "2019-08-24", "pending_re_negotiations": true, "space": { … }, "cancellation_time": "2019-08-24T14:15:22Z", "co_invoice": true, "invoicing_default_vat": 0, "invoicing_period_from": "2019-08-24", "is_draft": true, "counterpart_warning_interval_weeks": 2147483647, "main_industrial_premises_contract": { … }, "created_at": "2019-08-24T14:15:22Z", "initial_end_date": "2019-08-24", "tags": null, "invoicing_automatic_creation_paused": true, "counterpart_notification_interval_weeks": 2147483647, "id_number": "string", "organization": { … }, "status": 0, "tenant": { … }, "renewed_to": "2019-08-24", "last_owner_notification_date": "2019-08-24", "renew_indefinetely": true, "invoicing_customer_reference": "string", "invoicing_debt_distribution_pushed_until": "2019-08-24", "allowed_target_audiences": [ … ], "invoicing_attempt_autogiro": true, "customer_columns": null, "owner_warning_interval_weeks": 2147483647, "cancellation_signed_time": "2019-08-24T14:15:22Z", "lifetime_end_date": "2019-08-24", "invoicing_interest_fee_blocked": true, "signed_time": "2019-08-24T14:15:22Z", "invoicing_debt_blocked": true, "renew_interval_weeks": 2147483647, "custom_dimension_value": "string", "main_outdoorsection_contract": { … }, "terms": { … }, "invoice_merge_index_in_view": true, "custom_id": "string" } ]
Query
Additional Validation Information:
This value must be set together with the following fields: _page_size
Additional Validation Information:
This value must be set together with the following fields: _page
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
- https://dev.api.pigello.io/contracts/apartmentcontract/list/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://dev.api.pigello.io/contracts/apartmentcontract/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'Successful query
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Response
application/json
[ { "archived": true, "last_counterpart_notification_date": "2019-08-24", "invoice_merge_non_base_rent_in_view": true, "invoice_month_interval": 1, "cancelled_by_counterpart": true, "invoicing_period": 0, "cancellation_source": 0, "bi_tenants": [ … ], "counterpart_warning_date": "2019-08-24", "invoicing_reminder_blocked": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicing_reminder_distribution_pushed_until": "2019-08-24", "start_date": "2019-08-24", "cancellation_comment": "string", "pending_monitor_approval_amount": null, "invoice_merge_base_rent_in_view": true, "owner_notification_interval_weeks": 2147483647, "cancellation_reason": "string", "negotiation_succession_contract": { … }, "invoicing_marking": "string", "main_apartment_contract": { … }, "main_brf_invoiceable": { … }, "has_base_rent_vat": true, "owner_warning_date": "2019-08-24", "pending_re_negotiations": true, "space": { … }, "cancellation_time": "2019-08-24T14:15:22Z", "co_invoice": true, "invoicing_default_vat": 0, "invoicing_period_from": "2019-08-24", "is_draft": true, "counterpart_warning_interval_weeks": 2147483647, "main_industrial_premises_contract": { … }, "created_at": "2019-08-24T14:15:22Z", "initial_end_date": "2019-08-24", "tags": null, "invoicing_automatic_creation_paused": true, "counterpart_notification_interval_weeks": 2147483647, "id_number": "string", "organization": { … }, "status": 0, "tenant": { … }, "renewed_to": "2019-08-24", "last_owner_notification_date": "2019-08-24", "renew_indefinetely": true, "invoicing_customer_reference": "string", "invoicing_debt_distribution_pushed_until": "2019-08-24", "allowed_target_audiences": [ … ], "invoicing_attempt_autogiro": true, "customer_columns": null, "owner_warning_interval_weeks": 2147483647, "cancellation_signed_time": "2019-08-24T14:15:22Z", "lifetime_end_date": "2019-08-24", "invoicing_interest_fee_blocked": true, "signed_time": "2019-08-24T14:15:22Z", "invoicing_debt_blocked": true, "renew_interval_weeks": 2147483647, "custom_dimension_value": "string", "main_outdoorsection_contract": { … }, "terms": { … }, "invoice_merge_index_in_view": true, "custom_id": "string" } ]
Bodyapplication/json
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
- https://dev.api.pigello.io/contracts/apartmentcontract/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://dev.api.pigello.io/contracts/apartmentcontract/ \
-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 '{
"archived": true,
"invoice_merge_non_base_rent_in_view": true,
"invoice_month_interval": 1,
"cancelled_by_counterpart": true,
"invoicing_period": 0,
"cancellation_source": 0,
"bi_tenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_reminder_blocked": true,
"invoicing_reminder_distribution_pushed_until": "2019-08-24",
"start_date": "2019-08-24",
"cancellation_comment": "string",
"invoice_merge_base_rent_in_view": true,
"owner_notification_interval_weeks": 2147483647,
"cancellation_reason": "string",
"negotiation_succession_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoicing_marking": "string",
"main_apartment_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"main_brf_invoiceable": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"pending_re_negotiations": true,
"space": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"cancellation_time": "2019-08-24T14:15:22Z",
"co_invoice": true,
"invoicing_default_vat": 0,
"invoicing_period_from": "2019-08-24",
"is_draft": true,
"counterpart_warning_interval_weeks": 2147483647,
"main_industrial_premises_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"initial_end_date": "2019-08-24",
"invoicing_automatic_creation_paused": true,
"counterpart_notification_interval_weeks": 2147483647,
"id_number": "string",
"organization": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"renew_indefinetely": true,
"invoicing_customer_reference": "string",
"invoicing_debt_distribution_pushed_until": "2019-08-24",
"allowed_target_audiences": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_attempt_autogiro": true,
"owner_warning_interval_weeks": 2147483647,
"cancellation_signed_time": "2019-08-24T14:15:22Z",
"lifetime_end_date": "2019-08-24",
"invoicing_interest_fee_blocked": true,
"signed_time": "2019-08-24T14:15:22Z",
"invoicing_debt_blocked": true,
"renew_interval_weeks": 2147483647,
"custom_dimension_value": "string",
"main_outdoorsection_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"terms": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoice_merge_index_in_view": true,
"custom_id": "string"
}'Successful creation
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Response
application/json
{ "archived": true, "last_counterpart_notification_date": "2019-08-24", "invoice_merge_non_base_rent_in_view": true, "invoice_month_interval": 1, "cancelled_by_counterpart": true, "invoicing_period": 0, "cancellation_source": 0, "bi_tenants": [ { … } ], "counterpart_warning_date": "2019-08-24", "invoicing_reminder_blocked": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicing_reminder_distribution_pushed_until": "2019-08-24", "start_date": "2019-08-24", "cancellation_comment": "string", "pending_monitor_approval_amount": null, "invoice_merge_base_rent_in_view": true, "owner_notification_interval_weeks": 2147483647, "cancellation_reason": "string", "negotiation_succession_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoicing_marking": "string", "main_apartment_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "main_brf_invoiceable": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "has_base_rent_vat": true, "owner_warning_date": "2019-08-24", "pending_re_negotiations": true, "space": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "cancellation_time": "2019-08-24T14:15:22Z", "co_invoice": true, "invoicing_default_vat": 0, "invoicing_period_from": "2019-08-24", "is_draft": true, "counterpart_warning_interval_weeks": 2147483647, "main_industrial_premises_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "created_at": "2019-08-24T14:15:22Z", "initial_end_date": "2019-08-24", "tags": null, "invoicing_automatic_creation_paused": true, "counterpart_notification_interval_weeks": 2147483647, "id_number": "string", "organization": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "status": 0, "tenant": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "renewed_to": "2019-08-24", "last_owner_notification_date": "2019-08-24", "renew_indefinetely": true, "invoicing_customer_reference": "string", "invoicing_debt_distribution_pushed_until": "2019-08-24", "allowed_target_audiences": [ { … } ], "invoicing_attempt_autogiro": true, "customer_columns": null, "owner_warning_interval_weeks": 2147483647, "cancellation_signed_time": "2019-08-24T14:15:22Z", "lifetime_end_date": "2019-08-24", "invoicing_interest_fee_blocked": true, "signed_time": "2019-08-24T14:15:22Z", "invoicing_debt_blocked": true, "renew_interval_weeks": 2147483647, "custom_dimension_value": "string", "main_outdoorsection_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "terms": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoice_merge_index_in_view": true, "custom_id": "string" }
- https://dev.api.pigello.io/contracts/apartmentcontract/{pk}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'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'- https://dev.api.pigello.io/contracts/apartmentcontract/{pk}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Successful selection
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Response
application/json
{ "archived": true, "last_counterpart_notification_date": "2019-08-24", "invoice_merge_non_base_rent_in_view": true, "invoice_month_interval": 1, "cancelled_by_counterpart": true, "invoicing_period": 0, "cancellation_source": 0, "bi_tenants": [ { … } ], "counterpart_warning_date": "2019-08-24", "invoicing_reminder_blocked": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicing_reminder_distribution_pushed_until": "2019-08-24", "start_date": "2019-08-24", "cancellation_comment": "string", "pending_monitor_approval_amount": null, "invoice_merge_base_rent_in_view": true, "owner_notification_interval_weeks": 2147483647, "cancellation_reason": "string", "negotiation_succession_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoicing_marking": "string", "main_apartment_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "main_brf_invoiceable": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "has_base_rent_vat": true, "owner_warning_date": "2019-08-24", "pending_re_negotiations": true, "space": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "cancellation_time": "2019-08-24T14:15:22Z", "co_invoice": true, "invoicing_default_vat": 0, "invoicing_period_from": "2019-08-24", "is_draft": true, "counterpart_warning_interval_weeks": 2147483647, "main_industrial_premises_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "created_at": "2019-08-24T14:15:22Z", "initial_end_date": "2019-08-24", "tags": null, "invoicing_automatic_creation_paused": true, "counterpart_notification_interval_weeks": 2147483647, "id_number": "string", "organization": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "status": 0, "tenant": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "renewed_to": "2019-08-24", "last_owner_notification_date": "2019-08-24", "renew_indefinetely": true, "invoicing_customer_reference": "string", "invoicing_debt_distribution_pushed_until": "2019-08-24", "allowed_target_audiences": [ { … } ], "invoicing_attempt_autogiro": true, "customer_columns": null, "owner_warning_interval_weeks": 2147483647, "cancellation_signed_time": "2019-08-24T14:15:22Z", "lifetime_end_date": "2019-08-24", "invoicing_interest_fee_blocked": true, "signed_time": "2019-08-24T14:15:22Z", "invoicing_debt_blocked": true, "renew_interval_weeks": 2147483647, "custom_dimension_value": "string", "main_outdoorsection_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "terms": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoice_merge_index_in_view": true, "custom_id": "string" }
Bodyapplication/json
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
- https://dev.api.pigello.io/contracts/apartmentcontract/{pk}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://dev.api.pigello.io/contracts/apartmentcontract/{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 '{
"archived": true,
"invoice_merge_non_base_rent_in_view": true,
"invoice_month_interval": 1,
"cancelled_by_counterpart": true,
"invoicing_period": 0,
"cancellation_source": 0,
"bi_tenants": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_reminder_blocked": true,
"invoicing_reminder_distribution_pushed_until": "2019-08-24",
"start_date": "2019-08-24",
"cancellation_comment": "string",
"invoice_merge_base_rent_in_view": true,
"owner_notification_interval_weeks": 2147483647,
"cancellation_reason": "string",
"negotiation_succession_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoicing_marking": "string",
"main_apartment_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"main_brf_invoiceable": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"pending_re_negotiations": true,
"space": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"cancellation_time": "2019-08-24T14:15:22Z",
"co_invoice": true,
"invoicing_default_vat": 0,
"invoicing_period_from": "2019-08-24",
"is_draft": true,
"counterpart_warning_interval_weeks": 2147483647,
"main_industrial_premises_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"initial_end_date": "2019-08-24",
"invoicing_automatic_creation_paused": true,
"counterpart_notification_interval_weeks": 2147483647,
"id_number": "string",
"organization": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"tenant": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"renew_indefinetely": true,
"invoicing_customer_reference": "string",
"invoicing_debt_distribution_pushed_until": "2019-08-24",
"allowed_target_audiences": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
],
"invoicing_attempt_autogiro": true,
"owner_warning_interval_weeks": 2147483647,
"cancellation_signed_time": "2019-08-24T14:15:22Z",
"lifetime_end_date": "2019-08-24",
"invoicing_interest_fee_blocked": true,
"signed_time": "2019-08-24T14:15:22Z",
"invoicing_debt_blocked": true,
"renew_interval_weeks": 2147483647,
"custom_dimension_value": "string",
"main_outdoorsection_contract": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"terms": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"invoice_merge_index_in_view": true,
"custom_id": "string"
}'Successful update
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set together with the following fields: invoice_month_interval, invoicing_period_from
Enum01-1
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Enum0123456
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: initial_end_date, signed_time
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value requires that the following fields are also set: cancellation_time
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
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: lifetime_end_date, cancellation_signed_time, signed_time
This value requires that the following fields are also set: start_date, signed_time, cancelled_by_counterpart
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set together with the following fields: invoicing_period, invoice_month_interval
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must not match with the values of these fields: bi_tenants
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
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, lifetime_end_date
This value requires that the following fields are also set: cancellation_time
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_signed_time, cancellation_time
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Additional Validation Information:
This value must be set in an proper order, in relation to the following fields: cancellation_time, start_date
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
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
Additional Validation Information:
This value requires that the following fields are also set: invoicing_period, invoice_month_interval, invoicing_period_from
Response
application/json
{ "archived": true, "last_counterpart_notification_date": "2019-08-24", "invoice_merge_non_base_rent_in_view": true, "invoice_month_interval": 1, "cancelled_by_counterpart": true, "invoicing_period": 0, "cancellation_source": 0, "bi_tenants": [ { … } ], "counterpart_warning_date": "2019-08-24", "invoicing_reminder_blocked": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invoicing_reminder_distribution_pushed_until": "2019-08-24", "start_date": "2019-08-24", "cancellation_comment": "string", "pending_monitor_approval_amount": null, "invoice_merge_base_rent_in_view": true, "owner_notification_interval_weeks": 2147483647, "cancellation_reason": "string", "negotiation_succession_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoicing_marking": "string", "main_apartment_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "main_brf_invoiceable": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "has_base_rent_vat": true, "owner_warning_date": "2019-08-24", "pending_re_negotiations": true, "space": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "cancellation_time": "2019-08-24T14:15:22Z", "co_invoice": true, "invoicing_default_vat": 0, "invoicing_period_from": "2019-08-24", "is_draft": true, "counterpart_warning_interval_weeks": 2147483647, "main_industrial_premises_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "created_at": "2019-08-24T14:15:22Z", "initial_end_date": "2019-08-24", "tags": null, "invoicing_automatic_creation_paused": true, "counterpart_notification_interval_weeks": 2147483647, "id_number": "string", "organization": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "status": 0, "tenant": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "renewed_to": "2019-08-24", "last_owner_notification_date": "2019-08-24", "renew_indefinetely": true, "invoicing_customer_reference": "string", "invoicing_debt_distribution_pushed_until": "2019-08-24", "allowed_target_audiences": [ { … } ], "invoicing_attempt_autogiro": true, "customer_columns": null, "owner_warning_interval_weeks": 2147483647, "cancellation_signed_time": "2019-08-24T14:15:22Z", "lifetime_end_date": "2019-08-24", "invoicing_interest_fee_blocked": true, "signed_time": "2019-08-24T14:15:22Z", "invoicing_debt_blocked": true, "renew_interval_weeks": 2147483647, "custom_dimension_value": "string", "main_outdoorsection_contract": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "terms": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }, "invoice_merge_index_in_view": true, "custom_id": "string" }
- https://dev.api.pigello.io/accounting/contracts/preview/apartmentcontract/{organization_id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://dev.api.pigello.io/accounting/contracts/preview/apartmentcontract/{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'- https://dev.api.pigello.io/accounting/contracts/perform/apartmentcontract/{organization_id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://dev.api.pigello.io/accounting/contracts/perform/apartmentcontract/{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'