Skip to content
/
Bulk write 'Subtenanttena...

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

Subtenanttenantconnection

Operations

List 'Subtenanttenantconnection'

Request

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

Additional Validation Information:

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

_page_sizeinteger(int32)

Additional Validation Information:

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

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

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_activeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

parent_sub_tenantany

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

prefer_invoice_view_onlyany

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

stakeholder_typeany

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

sub_tenantany

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

tenantany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/accounts/users/customer/subtenanttenantconnection/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject(Tenant)required
tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
reminder_distribution_instructionArray of objects or null
organizationobject or null(Organization)
is_activeboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
tagsanyread-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
invoice_distribution_instructionArray of objects or null
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
prefer_invoice_view_onlyboolean
parent_sub_tenantobject or null(Subtenant)
debt_distribution_instructionArray of objects or null
]
Response
application/json
[
  {
    "reminder_distribution_instruction": [ … ],
    "organization": { … },
    "is_active": true,
    "category": 0,
    "tags": null,
    "sub_tenant": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_columns": null,
    "tenant": { … },
    "custom_id": "string",
    "invoice_distribution_instruction": [ … ],
    "stakeholder_type": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pending_monitor_approval_amount": null,
    "prefer_invoice_view_only": true,
    "parent_sub_tenant": { … },
    "debt_distribution_instruction": [ … ]
  }
]

Bulk write 'Subtenanttenantconnection'

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)
tenantobject(Tenant)required
tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
reminder_distribution_instructionArray of objects or null
organizationobject or null(Organization)
is_activeboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
invoice_distribution_instructionArray of objects or null
prefer_invoice_view_onlyboolean
parent_sub_tenantobject or null(Subtenant)
debt_distribution_instructionArray of objects or null
]
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/subtenanttenantconnection/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 '[
    {
      "reminder_distribution_instruction": [
        null
      ],
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "is_active": true,
      "category": 0,
      "sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "invoice_distribution_instruction": [
        null
      ],
      "stakeholder_type": 0,
      "prefer_invoice_view_only": true,
      "parent_sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "debt_distribution_instruction": [
        null
      ]
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject(Tenant)required
tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
reminder_distribution_instructionArray of objects or null
organizationobject or null(Organization)
is_activeboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
tagsanyread-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
invoice_distribution_instructionArray of objects or null
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
prefer_invoice_view_onlyboolean
parent_sub_tenantobject or null(Subtenant)
debt_distribution_instructionArray of objects or null
]
Response
application/json
[
  {
    "reminder_distribution_instruction": [ … ],
    "organization": { … },
    "is_active": true,
    "category": 0,
    "tags": null,
    "sub_tenant": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_columns": null,
    "tenant": { … },
    "custom_id": "string",
    "invoice_distribution_instruction": [ … ],
    "stakeholder_type": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pending_monitor_approval_amount": null,
    "prefer_invoice_view_only": true,
    "parent_sub_tenant": { … },
    "debt_distribution_instruction": [ … ]
  }
]

Create 'Subtenanttenantconnection'

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)
tenantobject(Tenant)required
tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
reminder_distribution_instructionArray of objects or null
organizationobject or null(Organization)
is_activeboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
custom_idstring or null<= 128 characters
invoice_distribution_instructionArray of objects or null
prefer_invoice_view_onlyboolean
parent_sub_tenantobject or null(Subtenant)
debt_distribution_instructionArray of objects or null
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/subtenanttenantconnection/ \
  -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 '{
    "reminder_distribution_instruction": [
      null
    ],
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "is_active": true,
    "category": 0,
    "sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "invoice_distribution_instruction": [
      null
    ],
    "stakeholder_type": 0,
    "prefer_invoice_view_only": true,
    "parent_sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "debt_distribution_instruction": [
      null
    ]
  }'

Responses

Successful creation

Bodyapplication/json
sub_tenantobject(Subtenant)required
sub_tenant.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject(Tenant)required
tenant.​idstring(uuid)
stakeholder_typeinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
reminder_distribution_instructionArray of objects or null
organizationobject or null(Organization)
is_activeboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456789
tagsanyread-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
invoice_distribution_instructionArray of objects or null
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
prefer_invoice_view_onlyboolean
parent_sub_tenantobject or null(Subtenant)
debt_distribution_instructionArray of objects or null
Response
application/json
{
  "reminder_distribution_instruction": [
    null
  ],
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_active": true,
  "category": 0,
  "tags": null,
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "customer_columns": null,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "invoice_distribution_instruction": [
    null
  ],
  "stakeholder_type": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pending_monitor_approval_amount": null,
  "prefer_invoice_view_only": true,
  "parent_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "debt_distribution_instruction": [
    null
  ]
}

Tenant

Operations

Organizationuser

Operations

Subtenant

Operations

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.