Skip to content
/
Bulk write 'Brfcompany'

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

Create 'Brfcompany'

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
companyobject(Company)required

Additional Validation Information:

Must be unique

company.​idstring(uuid)
financial_plan_registration_datestring or null(date)
transaction_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_firm_value

financial_plan_creation_datestring or null(date)
realtor_image_common_info_textstring or null
transaction_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_quota

organizationobject or null(Organization)
pledge_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_firm_value

statutes_documentobject or null
reparation_fund_quota_feesArray of objects(Quotafee)
transaction_fee_articleobject or null(Article)
transaction_fee_debits_sellerboolean or null
pledge_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_quota

financial_plan_documentobject or null
pledge_fee_articleobject or null(Article)
reparation_fund_quotanumber or null(float)
statutes_registration_datestring or null(date)
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/brf/common/brfcompany/ \
  -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 '{
    "financial_plan_registration_date": "2019-08-24",
    "transaction_fee_quota": 0.1,
    "financial_plan_creation_date": "2019-08-24",
    "realtor_image_common_info_text": "string",
    "transaction_fee_firm_value": 0.1,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "pledge_fee_quota": 0.1,
    "statutes_document": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "reparation_fund_quota_fees": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "transaction_fee_article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "transaction_fee_debits_seller": true,
    "pledge_fee_firm_value": 0.1,
    "financial_plan_document": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "pledge_fee_article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "reparation_fund_quota": 0.1,
    "statutes_registration_date": "2019-08-24",
    "custom_id": "string",
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

companyobject(Company)required

Additional Validation Information:

Must be unique

company.​idstring(uuid)
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
financial_plan_registration_datestring or null(date)
transaction_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_firm_value

financial_plan_creation_datestring or null(date)
realtor_image_common_info_textstring or null
transaction_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_quota

organizationobject or null(Organization)
pledge_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_firm_value

statutes_documentobject or null
reparation_fund_quota_feesArray of objects(Quotafee)
transaction_fee_articleobject or null(Article)
customer_columnsanyread-only
transaction_fee_debits_sellerboolean or null
pledge_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_quota

financial_plan_documentobject or null
tagsanyread-only
pledge_fee_articleobject or null(Article)
reparation_fund_quotanumber or null(float)
statutes_registration_datestring or null(date)
custom_idstring or null<= 128 characters
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "pending_monitor_approval_amount": null,
  "financial_plan_registration_date": "2019-08-24",
  "transaction_fee_quota": 0.1,
  "financial_plan_creation_date": "2019-08-24",
  "realtor_image_common_info_text": "string",
  "transaction_fee_firm_value": 0.1,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pledge_fee_quota": 0.1,
  "statutes_document": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "reparation_fund_quota_fees": [
    { … }
  ],
  "transaction_fee_article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "transaction_fee_debits_seller": true,
  "pledge_fee_firm_value": 0.1,
  "financial_plan_document": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "tags": null,
  "pledge_fee_article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "reparation_fund_quota": 0.1,
  "statutes_registration_date": "2019-08-24",
  "custom_id": "string",
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Bulk write 'Brfcompany'

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 [
companyobject(Company)required

Additional Validation Information:

Must be unique

company.​idstring(uuid)
financial_plan_registration_datestring or null(date)
transaction_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_firm_value

financial_plan_creation_datestring or null(date)
realtor_image_common_info_textstring or null
transaction_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_quota

organizationobject or null(Organization)
pledge_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_firm_value

statutes_documentobject or null
reparation_fund_quota_feesArray of objects(Quotafee)
transaction_fee_articleobject or null(Article)
transaction_fee_debits_sellerboolean or null
pledge_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_quota

financial_plan_documentobject or null
pledge_fee_articleobject or null(Article)
reparation_fund_quotanumber or null(float)
statutes_registration_datestring or null(date)
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/brf/common/brfcompany/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 '[
    {
      "financial_plan_registration_date": "2019-08-24",
      "transaction_fee_quota": 0.1,
      "financial_plan_creation_date": "2019-08-24",
      "realtor_image_common_info_text": "string",
      "transaction_fee_firm_value": 0.1,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "pledge_fee_quota": 0.1,
      "statutes_document": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "reparation_fund_quota_fees": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "transaction_fee_article": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "transaction_fee_debits_seller": true,
      "pledge_fee_firm_value": 0.1,
      "financial_plan_document": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "pledge_fee_article": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "reparation_fund_quota": 0.1,
      "statutes_registration_date": "2019-08-24",
      "custom_id": "string",
      "company": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

companyobject(Company)required

Additional Validation Information:

Must be unique

company.​idstring(uuid)
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
financial_plan_registration_datestring or null(date)
transaction_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_firm_value

financial_plan_creation_datestring or null(date)
realtor_image_common_info_textstring or null
transaction_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_quota

organizationobject or null(Organization)
pledge_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_firm_value

statutes_documentobject or null
reparation_fund_quota_feesArray of objects(Quotafee)
transaction_fee_articleobject or null(Article)
customer_columnsanyread-only
transaction_fee_debits_sellerboolean or null
pledge_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_quota

financial_plan_documentobject or null
tagsanyread-only
pledge_fee_articleobject or null(Article)
reparation_fund_quotanumber or null(float)
statutes_registration_datestring or null(date)
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pending_monitor_approval_amount": null,
    "financial_plan_registration_date": "2019-08-24",
    "transaction_fee_quota": 0.1,
    "financial_plan_creation_date": "2019-08-24",
    "realtor_image_common_info_text": "string",
    "transaction_fee_firm_value": 0.1,
    "organization": { … },
    "pledge_fee_quota": 0.1,
    "statutes_document": { … },
    "reparation_fund_quota_fees": [ … ],
    "transaction_fee_article": { … },
    "customer_columns": null,
    "transaction_fee_debits_seller": true,
    "pledge_fee_firm_value": 0.1,
    "financial_plan_document": { … },
    "tags": null,
    "pledge_fee_article": { … },
    "reparation_fund_quota": 0.1,
    "statutes_registration_date": "2019-08-24",
    "custom_id": "string",
    "company": { … }
  }
]

List 'Brfcompany'

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
companyany

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

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

financial_plan_creation_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

financial_plan_registration_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

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

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

pledge_fee_articleany

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

pledge_fee_firm_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

pledge_fee_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

realtor_image_common_info_textany

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

reparation_fund_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

reparation_fund_quota_feesany

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

statutes_registration_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

transaction_fee_articleany

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

transaction_fee_debits_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

transaction_fee_firm_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

transaction_fee_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

curl -i -X GET \
  'https://dev.api.pigello.io/brf/common/brfcompany/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

companyobject(Company)required

Additional Validation Information:

Must be unique

company.​idstring(uuid)
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
financial_plan_registration_datestring or null(date)
transaction_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_firm_value

financial_plan_creation_datestring or null(date)
realtor_image_common_info_textstring or null
transaction_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: transaction_fee_quota

organizationobject or null(Organization)
pledge_fee_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_firm_value

statutes_documentobject or null
reparation_fund_quota_feesArray of objects(Quotafee)
transaction_fee_articleobject or null(Article)
customer_columnsanyread-only
transaction_fee_debits_sellerboolean or null
pledge_fee_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: pledge_fee_quota

financial_plan_documentobject or null
tagsanyread-only
pledge_fee_articleobject or null(Article)
reparation_fund_quotanumber or null(float)
statutes_registration_datestring or null(date)
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pending_monitor_approval_amount": null,
    "financial_plan_registration_date": "2019-08-24",
    "transaction_fee_quota": 0.1,
    "financial_plan_creation_date": "2019-08-24",
    "realtor_image_common_info_text": "string",
    "transaction_fee_firm_value": 0.1,
    "organization": { … },
    "pledge_fee_quota": 0.1,
    "statutes_document": { … },
    "reparation_fund_quota_fees": [ … ],
    "transaction_fee_article": { … },
    "customer_columns": null,
    "transaction_fee_debits_seller": true,
    "pledge_fee_firm_value": 0.1,
    "financial_plan_document": { … },
    "tags": null,
    "pledge_fee_article": { … },
    "reparation_fund_quota": 0.1,
    "statutes_registration_date": "2019-08-24",
    "custom_id": "string",
    "company": { … }
  }
]

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
© Pigello. All rights reserved.