Skip to content
/
List 'Capitalcontribution...

Brf (2.0.0)

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

Brfapartmentpledge

Operations

Brfcompany

Operations

Brfcompanycontactperson

Operations

Brfapartmentreparationfunddeposit

Operations

Brfcompanydebt

Operations

Realbrfcompanynotation

Operations

Brfcompanyannualreport

Operations

Quotafee

Operations

Quotacollection

Operations

Quotanotation

Operations

Brftransactionparty

Operations

Brfapartmentinvoiceconfiguration

Operations

Brfmembershipnotation

Operations

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Bulk write 'Capitalcontributionnotation'

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 [
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
valuenumber(float)required
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
as_of_datestring(date)required
commentstring or null
registered_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
collectionobject or null(Capitalcontributionnotationcollection)
used_quota_collectionobject or null(Quotacollection)
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/brf/capitalcontributions/capitalcontributionnotation/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 '[
    {
      "kind": 0,
      "comment": "string",
      "value": 0.1,
      "brf_apartment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "registered_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "collection": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "used_quota_collection": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "as_of_date": "2019-08-24",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
valuenumber(float)required
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

as_of_datestring(date)required
commentstring or null
registered_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
collectionobject or null(Capitalcontributionnotationcollection)
pending_monitor_approval_amountanyread-only
used_quota_collectionobject or null(Quotacollection)
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "kind": 0,
    "comment": "string",
    "value": 0.1,
    "brf_apartment": { … },
    "registered_by": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "collection": { … },
    "pending_monitor_approval_amount": null,
    "used_quota_collection": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tags": null,
    "customer_columns": null,
    "as_of_date": "2019-08-24",
    "organization": { … }
  }
]

List 'Capitalcontributionnotation'

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
as_of_dateany

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

Additional operators:

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

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

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

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

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

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

brf_apartmentany

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

collectionany

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

commentany

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

Additional operators:

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

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

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

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

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

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

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

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

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

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

kindany

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

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

registered_byany

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

used_quota_collectionany

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

valueany

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

curl -i -X GET \
  'https://dev.api.pigello.io/brf/capitalcontributions/capitalcontributionnotation/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 [
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
valuenumber(float)required
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

as_of_datestring(date)required
commentstring or null
registered_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
collectionobject or null(Capitalcontributionnotationcollection)
pending_monitor_approval_amountanyread-only
used_quota_collectionobject or null(Quotacollection)
tagsanyread-only
customer_columnsanyread-only
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "kind": 0,
    "comment": "string",
    "value": 0.1,
    "brf_apartment": { … },
    "registered_by": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "collection": { … },
    "pending_monitor_approval_amount": null,
    "used_quota_collection": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tags": null,
    "customer_columns": null,
    "as_of_date": "2019-08-24",
    "organization": { … }
  }
]

Transactiondeclaration

Operations
© Pigello. All rights reserved.