Skip to content
/
Bulk write 'Brftransactio...

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

Get 'Brftransaction'

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/transactions/brftransaction/{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
transaction_feenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transaction_idstring<= 255 charactersrequired
move_in_timestring(date-time)required

Additional Validation Information:

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

transaction_timestring(date-time)required

Additional Validation Information:

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

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
purchase_valuenumber(float)required
organizationobject or null(Organization)
tagsanyread-only
customer_columnsanyread-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
documentobject or null
pending_monitor_approval_amountanyread-only
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "transaction_fee": 0.1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "transaction_id": "string",
  "move_in_time": "2019-08-24T14:15:22Z",
  "transaction_time": "2019-08-24T14:15:22Z",
  "kind": 0,
  "tags": null,
  "customer_columns": null,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "purchase_value": 0.1,
  "document": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "pending_monitor_approval_amount": null
}

Bulk write 'Brftransaction'

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 [
transaction_feenumber(float)required
transaction_idstring<= 255 charactersrequired
move_in_timestring(date-time)required

Additional Validation Information:

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

transaction_timestring(date-time)required

Additional Validation Information:

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

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
purchase_valuenumber(float)required
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
documentobject or null
]
curl -i -X POST \
  https://dev.api.pigello.io/brf/transactions/brftransaction/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"
      },
      "transaction_fee": 0.1,
      "transaction_id": "string",
      "move_in_time": "2019-08-24T14:15:22Z",
      "transaction_time": "2019-08-24T14:15:22Z",
      "kind": 0,
      "custom_id": "string",
      "brf_apartment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "purchase_value": 0.1,
      "document": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
transaction_feenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transaction_idstring<= 255 charactersrequired
move_in_timestring(date-time)required

Additional Validation Information:

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

transaction_timestring(date-time)required

Additional Validation Information:

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

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
purchase_valuenumber(float)required
organizationobject or null(Organization)
tagsanyread-only
customer_columnsanyread-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
documentobject or null
pending_monitor_approval_amountanyread-only
]
Response
application/json
[
  {
    "organization": { … },
    "transaction_fee": 0.1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "transaction_id": "string",
    "move_in_time": "2019-08-24T14:15:22Z",
    "transaction_time": "2019-08-24T14:15:22Z",
    "kind": 0,
    "tags": null,
    "customer_columns": null,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "brf_apartment": { … },
    "purchase_value": 0.1,
    "document": { … },
    "pending_monitor_approval_amount": null
  }
]

List 'Brftransaction'

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

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

move_in_timeany

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

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

transaction_feeany

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

transaction_timeany

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/transactions/brftransaction/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 [
transaction_feenumber(float)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

transaction_idstring<= 255 charactersrequired
move_in_timestring(date-time)required

Additional Validation Information:

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

transaction_timestring(date-time)required

Additional Validation Information:

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

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
purchase_valuenumber(float)required
organizationobject or null(Organization)
tagsanyread-only
customer_columnsanyread-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
documentobject or null
pending_monitor_approval_amountanyread-only
]
Response
application/json
[
  {
    "organization": { … },
    "transaction_fee": 0.1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "transaction_id": "string",
    "move_in_time": "2019-08-24T14:15:22Z",
    "transaction_time": "2019-08-24T14:15:22Z",
    "kind": 0,
    "tags": null,
    "customer_columns": null,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "brf_apartment": { … },
    "purchase_value": 0.1,
    "document": { … },
    "pending_monitor_approval_amount": null
  }
]

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.