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

Delete 'Brfapartmentpledge'

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 DELETE \
  'https://dev.api.pigello.io/brf/common/brfapartmentpledge/{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 deletion

Response
No content

Update 'Brfapartmentpledge'

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
referencestring<= 255 charactersrequired
brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
removal_notation_datestring or null(date)
removal_notation_byobject or null(Organizationuser)
notation_byobject or null(Organizationuser)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
from_datestring or null(date)
notation_datestring or null(date)
creditorstring or null<= 255 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/brf/common/brfapartmentpledge/{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 '{
    "reference": "string",
    "removal_notation_date": "2019-08-24",
    "removal_notation_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "notation_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "from_date": "2019-08-24",
    "notation_date": "2019-08-24",
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "creditor": "string"
  }'

Responses

Successful update

Bodyapplication/json
referencestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
removal_notation_datestring or null(date)
removal_notation_byobject or null(Organizationuser)
customer_columnsanyread-only
notation_byobject or null(Organizationuser)
created_atstring(date-time)read-only
tagsanyread-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
from_datestring or null(date)
pending_monitor_approval_amountanyread-only
notation_datestring or null(date)
creditorstring or null<= 255 characters
Response
application/json
{
  "reference": "string",
  "removal_notation_date": "2019-08-24",
  "removal_notation_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "notation_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "from_date": "2019-08-24",
  "pending_monitor_approval_amount": null,
  "notation_date": "2019-08-24",
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "creditor": "string"
}

Get 'Brfapartmentpledge'

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/common/brfapartmentpledge/{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
referencestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
removal_notation_datestring or null(date)
removal_notation_byobject or null(Organizationuser)
customer_columnsanyread-only
notation_byobject or null(Organizationuser)
created_atstring(date-time)read-only
tagsanyread-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
from_datestring or null(date)
pending_monitor_approval_amountanyread-only
notation_datestring or null(date)
creditorstring or null<= 255 characters
Response
application/json
{
  "reference": "string",
  "removal_notation_date": "2019-08-24",
  "removal_notation_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "notation_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "from_date": "2019-08-24",
  "pending_monitor_approval_amount": null,
  "notation_date": "2019-08-24",
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "creditor": "string"
}

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