Skip to content
/
Create 'Subtenantcontract...

Accounts (2.0.0)

The 'Accounts' 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

Subtenantcontractconnection

Operations

Delete 'Subtenantcontractconnection'

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/accounts/users/customer/subtenantcontractconnection/{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

Create 'Subtenantcontractconnection'

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
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
custom_idstring or null<= 128 characters
apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

reminder_distribution_instructionArray of objects or null
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

start_datestring or null(date)

Additional Validation Information:

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

parent_sub_tenantobject or null(Subtenant)
parking_spot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

signed_timestring or null(date-time)
debt_distribution_instructionArray of objects or null
invoice_distribution_instructionArray of objects or null
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

outdoor_section_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
organizationobject or null(Organization)
brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

prefer_invoice_view_onlyboolean
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/subtenantcontractconnection/ \
  -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 '{
    "custom_id": "string",
    "apartment_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "reminder_distribution_instruction": [
      null
    ],
    "end_date": "2019-08-24",
    "start_date": "2019-08-24",
    "parent_sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "parking_spot_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "signed_time": "2019-08-24T14:15:22Z",
    "debt_distribution_instruction": [
      null
    ],
    "invoice_distribution_instruction": [
      null
    ],
    "industrial_premises_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "outdoor_section_contract": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "category": 0,
    "stakeholder_type": 0,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "prefer_invoice_view_only": true
  }'

Responses

Successful creation

Bodyapplication/json
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

reminder_distribution_instructionArray of objects or null
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

start_datestring or null(date)

Additional Validation Information:

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

parent_sub_tenantobject or null(Subtenant)
created_atstring(date-time)read-only
parking_spot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

contract_start_datestring or null(date)read-only
signed_timestring or null(date-time)
debt_distribution_instructionArray of objects or null
invoice_distribution_instructionArray of objects or null
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

customer_columnsanyread-only
tagsanyread-only
contract_end_datestring or null(date)read-only
outdoor_section_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
organizationobject or null(Organization)
brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

pending_monitor_approval_amountanyread-only
prefer_invoice_view_onlyboolean
Response
application/json
{
  "custom_id": "string",
  "apartment_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "reminder_distribution_instruction": [
    null
  ],
  "status": 0,
  "end_date": "2019-08-24",
  "start_date": "2019-08-24",
  "parent_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "parking_spot_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "contract_start_date": "2019-08-24",
  "signed_time": "2019-08-24T14:15:22Z",
  "debt_distribution_instruction": [
    null
  ],
  "invoice_distribution_instruction": [
    null
  ],
  "industrial_premises_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "tags": null,
  "contract_end_date": "2019-08-24",
  "outdoor_section_contract": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "category": 0,
  "stakeholder_type": 0,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "prefer_invoice_view_only": true
}

Bulk write 'Subtenantcontractconnection'

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 [
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
custom_idstring or null<= 128 characters
apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

reminder_distribution_instructionArray of objects or null
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

start_datestring or null(date)

Additional Validation Information:

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

parent_sub_tenantobject or null(Subtenant)
parking_spot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

signed_timestring or null(date-time)
debt_distribution_instructionArray of objects or null
invoice_distribution_instructionArray of objects or null
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

outdoor_section_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
organizationobject or null(Organization)
brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

prefer_invoice_view_onlyboolean
]
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/subtenantcontractconnection/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 '[
    {
      "custom_id": "string",
      "apartment_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "reminder_distribution_instruction": [
        null
      ],
      "end_date": "2019-08-24",
      "start_date": "2019-08-24",
      "parent_sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "parking_spot_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "signed_time": "2019-08-24T14:15:22Z",
      "debt_distribution_instruction": [
        null
      ],
      "invoice_distribution_instruction": [
        null
      ],
      "industrial_premises_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "outdoor_section_contract": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "category": 0,
      "stakeholder_type": 0,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "brf_apartment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "prefer_invoice_view_only": true
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum01234
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
apartment_contractobject or null(Apartmentcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: industrial_premises_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

reminder_distribution_instructionArray of objects or null
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

start_datestring or null(date)

Additional Validation Information:

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

parent_sub_tenantobject or null(Subtenant)
created_atstring(date-time)read-only
parking_spot_contractobject or null(Parkingspotcontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, outdoor_section_contract, brf_apartment

contract_start_datestring or null(date)read-only
signed_timestring or null(date-time)
debt_distribution_instructionArray of objects or null
invoice_distribution_instructionArray of objects or null
industrial_premises_contractobject or null(Industrialpremisescontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, parking_spot_contract, outdoor_section_contract, brf_apartment

customer_columnsanyread-only
tagsanyread-only
contract_end_datestring or null(date)read-only
outdoor_section_contractobject or null(Outdoorsectioncontract)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, brf_apartment

categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
organizationobject or null(Organization)
brf_apartmentobject or null(Brfapartment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

This field, or at least one of the following fields must be set: apartment_contract, industrial_premises_contract, parking_spot_contract, outdoor_section_contract

pending_monitor_approval_amountanyread-only
prefer_invoice_view_onlyboolean
]
Response
application/json
[
  {
    "custom_id": "string",
    "apartment_contract": { … },
    "reminder_distribution_instruction": [ … ],
    "status": 0,
    "end_date": "2019-08-24",
    "start_date": "2019-08-24",
    "parent_sub_tenant": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "parking_spot_contract": { … },
    "contract_start_date": "2019-08-24",
    "signed_time": "2019-08-24T14:15:22Z",
    "debt_distribution_instruction": [ … ],
    "invoice_distribution_instruction": [ … ],
    "industrial_premises_contract": { … },
    "customer_columns": null,
    "tags": null,
    "contract_end_date": "2019-08-24",
    "outdoor_section_contract": { … },
    "sub_tenant": { … },
    "category": 0,
    "stakeholder_type": 0,
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "brf_apartment": { … },
    "pending_monitor_approval_amount": null,
    "prefer_invoice_view_only": true
  }
]

Subtenanttenantconnection

Operations

Tenant

Operations

Organizationuser

Operations

Subtenant

Operations

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.