Skip to content
/
Create 'Capitalcontributi...

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

Create '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/json
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/ \
  -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 creation

Bodyapplication/json
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": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registered_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "used_quota_collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "customer_columns": null,
  "as_of_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Update '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
Path
pkstringwrite-onlyrequired
Bodyapplication/json
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 PATCH \
  'https://dev.api.pigello.io/brf/capitalcontributions/capitalcontributionnotation/{pk}/' \
  -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 update

Bodyapplication/json
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": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registered_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "used_quota_collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "customer_columns": null,
  "as_of_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get '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
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/brf/capitalcontributions/capitalcontributionnotation/{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
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": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registered_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "used_quota_collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "customer_columns": null,
  "as_of_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Transactiondeclaration

Operations
© Pigello. All rights reserved.