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

Get 'Brfmembershipnotation'

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/brfmembershipnotation/{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
brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
tenantobject(Tenant)required
tenant.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

organizationobject or null(Organization)
to_datestring or null(date)

Additional Validation Information:

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

tagsanyread-only
created_atstring(date-time)read-only
from_datestring or null(date)

Additional Validation Information:

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

automaticbooleanread-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "to_date": "2019-08-24",
  "brf_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "created_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24",
  "automatic": true,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string"
}

Update 'Brfmembershipnotation'

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
brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
tenantobject(Tenant)required
tenant.​idstring(uuid)
organizationobject or null(Organization)
to_datestring or null(date)

Additional Validation Information:

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

from_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/brf/transactions/brfmembershipnotation/{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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "to_date": "2019-08-24",
    "brf_company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "from_date": "2019-08-24",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string"
  }'

Responses

Successful update

Bodyapplication/json
brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
tenantobject(Tenant)required
tenant.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

organizationobject or null(Organization)
to_datestring or null(date)

Additional Validation Information:

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

tagsanyread-only
created_atstring(date-time)read-only
from_datestring or null(date)

Additional Validation Information:

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

automaticbooleanread-only
customer_columnsanyread-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "to_date": "2019-08-24",
  "brf_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "created_at": "2019-08-24T14:15:22Z",
  "from_date": "2019-08-24",
  "automatic": true,
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string"
}

Delete 'Brfmembershipnotation'

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/transactions/brfmembershipnotation/{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

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.