Skip to content

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

Transactiondeclaration

Operations

List 'Transactiondeclaration'

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

earliest_aquired_quotaany

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

earliest_purchase_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

has_gift_related_purchaseany

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

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_correctionany

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_gift_related_sellany

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

sell_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

sell_quotaany

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

sellerany

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

specification_idany

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

statusany

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

total_capital_contributionany

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

total_purchase_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

total_sell_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

transactionany

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/brf/capitalcontributions/transactiondeclaration/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

total_purchase_valuenumber(float)read-onlyrequired
is_gift_related_sellbooleanread-onlyrequired
sellerobject(Tenant)read-onlyrequired
seller.​idstring(uuid)
earliest_aquired_quotanumber(float)read-onlyrequired
sell_datestring(date)read-onlyrequired
has_gift_related_purchasebooleanread-onlyrequired
specification_idinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired

Additional Validation Information:

Must be unique

total_capital_contributionnumber(float)read-onlyrequired
total_sell_valuenumber(float)read-onlyrequired
is_correctionbooleanread-onlyrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
sell_quotanumber(float)read-onlyrequired
earliest_purchase_datestring(date)read-onlyrequired
transactionobject or null(Brftransaction)read-only
pdf_preview_fileobject or nullread-only
customer_columnsanyread-only
generated_files_urlsanyread-only
organizationobject or null(Organization)
overriden_brf_apartment_fieldsobject or nullread-only
tagsanyread-only
custom_idstring or null<= 128 characters
overriden_brf_transaction_fieldsobject or nullread-only
created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "transaction": { … },
    "total_purchase_value": 0.1,
    "is_gift_related_sell": true,
    "pdf_preview_file": { … },
    "seller": { … },
    "customer_columns": null,
    "earliest_aquired_quota": 0.1,
    "sell_date": "2019-08-24",
    "has_gift_related_purchase": true,
    "specification_id": -2147483648,
    "generated_files_urls": null,
    "organization": { … },
    "total_capital_contribution": 0.1,
    "overriden_brf_apartment_fields": {},
    "total_sell_value": 0.1,
    "tags": null,
    "is_correction": true,
    "status": 0,
    "custom_id": "string",
    "overriden_brf_transaction_fields": {},
    "created_at": "2019-08-24T14:15:22Z",
    "sell_quota": 0.1,
    "earliest_purchase_date": "2019-08-24"
  }
]

Bulk write 'Transactiondeclaration'

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 [
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/brf/capitalcontributions/transactiondeclaration/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 '[
    {
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "status": 0,
      "custom_id": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

total_purchase_valuenumber(float)read-onlyrequired
is_gift_related_sellbooleanread-onlyrequired
sellerobject(Tenant)read-onlyrequired
seller.​idstring(uuid)
earliest_aquired_quotanumber(float)read-onlyrequired
sell_datestring(date)read-onlyrequired
has_gift_related_purchasebooleanread-onlyrequired
specification_idinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired

Additional Validation Information:

Must be unique

total_capital_contributionnumber(float)read-onlyrequired
total_sell_valuenumber(float)read-onlyrequired
is_correctionbooleanread-onlyrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
sell_quotanumber(float)read-onlyrequired
earliest_purchase_datestring(date)read-onlyrequired
transactionobject or null(Brftransaction)read-only
pdf_preview_fileobject or nullread-only
customer_columnsanyread-only
generated_files_urlsanyread-only
organizationobject or null(Organization)
overriden_brf_apartment_fieldsobject or nullread-only
tagsanyread-only
custom_idstring or null<= 128 characters
overriden_brf_transaction_fieldsobject or nullread-only
created_atstring(date-time)read-only
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "transaction": { … },
    "total_purchase_value": 0.1,
    "is_gift_related_sell": true,
    "pdf_preview_file": { … },
    "seller": { … },
    "customer_columns": null,
    "earliest_aquired_quota": 0.1,
    "sell_date": "2019-08-24",
    "has_gift_related_purchase": true,
    "specification_id": -2147483648,
    "generated_files_urls": null,
    "organization": { … },
    "total_capital_contribution": 0.1,
    "overriden_brf_apartment_fields": {},
    "total_sell_value": 0.1,
    "tags": null,
    "is_correction": true,
    "status": 0,
    "custom_id": "string",
    "overriden_brf_transaction_fields": {},
    "created_at": "2019-08-24T14:15:22Z",
    "sell_quota": 0.1,
    "earliest_purchase_date": "2019-08-24"
  }
]

Get 'Transactiondeclaration'

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 GET \
  'https://dev.api.pigello.io/brf/capitalcontributions/transactiondeclaration/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

total_purchase_valuenumber(float)read-onlyrequired
is_gift_related_sellbooleanread-onlyrequired
sellerobject(Tenant)read-onlyrequired
seller.​idstring(uuid)
earliest_aquired_quotanumber(float)read-onlyrequired
sell_datestring(date)read-onlyrequired
has_gift_related_purchasebooleanread-onlyrequired
specification_idinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired

Additional Validation Information:

Must be unique

total_capital_contributionnumber(float)read-onlyrequired
total_sell_valuenumber(float)read-onlyrequired
is_correctionbooleanread-onlyrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum0123
sell_quotanumber(float)read-onlyrequired
earliest_purchase_datestring(date)read-onlyrequired
transactionobject or null(Brftransaction)read-only
pdf_preview_fileobject or nullread-only
customer_columnsanyread-only
generated_files_urlsanyread-only
organizationobject or null(Organization)
overriden_brf_apartment_fieldsobject or nullread-only
tagsanyread-only
custom_idstring or null<= 128 characters
overriden_brf_transaction_fieldsobject or nullread-only
created_atstring(date-time)read-only
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "transaction": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "total_purchase_value": 0.1,
  "is_gift_related_sell": true,
  "pdf_preview_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "seller": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "earliest_aquired_quota": 0.1,
  "sell_date": "2019-08-24",
  "has_gift_related_purchase": true,
  "specification_id": -2147483648,
  "generated_files_urls": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "total_capital_contribution": 0.1,
  "overriden_brf_apartment_fields": {},
  "total_sell_value": 0.1,
  "tags": null,
  "is_correction": true,
  "status": 0,
  "custom_id": "string",
  "overriden_brf_transaction_fields": {},
  "created_at": "2019-08-24T14:15:22Z",
  "sell_quota": 0.1,
  "earliest_purchase_date": "2019-08-24"
}
© Pigello. All rights reserved.