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

Delete 'Brfapartmentinvoiceconfiguration'

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/brfapartmentinvoiceconfiguration/{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 'Brfapartmentinvoiceconfiguration'

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
tenantsArray of objects(Tenant)required
tenants[].​idstring(uuid)
invoice_month_intervalinteger(int32)[ 1 .. 2147483647 ]required
configuration_idstring<= 255 charactersrequired
period_fromstring(date)required

Additional Validation Information:

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

brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
invoicing_periodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01-1
reminder_distribution_pushed_untilstring or null(date)
period_tostring or null(date)

Additional Validation Information:

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

automatic_creation_pausedboolean
interest_fee_blockedboolean or null
reminder_blockedboolean or null
debt_blockedboolean or null
markingstring or null<= 255 characters
customer_referencestring or null<= 255 characters
invoicing_attempt_autogiroboolean
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
custom_idstring or null<= 128 characters
debt_distribution_pushed_untilstring or null(date)
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/brf/transactions/brfapartmentinvoiceconfiguration/{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 '{
    "reminder_distribution_pushed_until": "2019-08-24",
    "period_to": "2019-08-24",
    "automatic_creation_paused": true,
    "tenants": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "invoice_month_interval": 1,
    "interest_fee_blocked": true,
    "reminder_blocked": true,
    "debt_blocked": true,
    "marking": "string",
    "customer_reference": "string",
    "invoicing_attempt_autogiro": true,
    "configuration_id": "string",
    "period_from": "2019-08-24",
    "invoicing_default_vat": 0,
    "custom_id": "string",
    "brf_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoicing_period": 0,
    "debt_distribution_pushed_until": "2019-08-24",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantsArray of objects(Tenant)required
tenants[].​idstring(uuid)
invoice_month_intervalinteger(int32)[ 1 .. 2147483647 ]required
configuration_idstring<= 255 charactersrequired
period_fromstring(date)required

Additional Validation Information:

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

brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
invoicing_periodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01-1
reminder_distribution_pushed_untilstring or null(date)
period_tostring or null(date)

Additional Validation Information:

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

automatic_creation_pausedboolean
interest_fee_blockedboolean or null
reminder_blockedboolean or null
debt_blockedboolean or null
markingstring or null<= 255 characters
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
customer_referencestring or null<= 255 characters
invoicing_attempt_autogiroboolean
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
tagsanyread-only
custom_idstring or null<= 128 characters
customer_columnsanyread-only
debt_distribution_pushed_untilstring or null(date)
organizationobject or null(Organization)
Response
application/json
{
  "reminder_distribution_pushed_until": "2019-08-24",
  "period_to": "2019-08-24",
  "automatic_creation_paused": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenants": [
    { … }
  ],
  "invoice_month_interval": 1,
  "interest_fee_blocked": true,
  "reminder_blocked": true,
  "debt_blocked": true,
  "marking": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "pending_monitor_approval_amount": null,
  "customer_reference": "string",
  "invoicing_attempt_autogiro": true,
  "configuration_id": "string",
  "period_from": "2019-08-24",
  "invoicing_default_vat": 0,
  "tags": null,
  "custom_id": "string",
  "customer_columns": null,
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_period": 0,
  "debt_distribution_pushed_until": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get 'Brfapartmentinvoiceconfiguration'

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/brfapartmentinvoiceconfiguration/{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
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantsArray of objects(Tenant)required
tenants[].​idstring(uuid)
invoice_month_intervalinteger(int32)[ 1 .. 2147483647 ]required
configuration_idstring<= 255 charactersrequired
period_fromstring(date)required

Additional Validation Information:

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

brf_apartmentobject(Brfapartment)required
brf_apartment.​idstring(uuid)
invoicing_periodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01-1
reminder_distribution_pushed_untilstring or null(date)
period_tostring or null(date)

Additional Validation Information:

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

automatic_creation_pausedboolean
interest_fee_blockedboolean or null
reminder_blockedboolean or null
debt_blockedboolean or null
markingstring or null<= 255 characters
created_atstring(date-time)read-only
pending_monitor_approval_amountanyread-only
customer_referencestring or null<= 255 characters
invoicing_attempt_autogiroboolean
invoicing_default_vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
tagsanyread-only
custom_idstring or null<= 128 characters
customer_columnsanyread-only
debt_distribution_pushed_untilstring or null(date)
organizationobject or null(Organization)
Response
application/json
{
  "reminder_distribution_pushed_until": "2019-08-24",
  "period_to": "2019-08-24",
  "automatic_creation_paused": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tenants": [
    { … }
  ],
  "invoice_month_interval": 1,
  "interest_fee_blocked": true,
  "reminder_blocked": true,
  "debt_blocked": true,
  "marking": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "pending_monitor_approval_amount": null,
  "customer_reference": "string",
  "invoicing_attempt_autogiro": true,
  "configuration_id": "string",
  "period_from": "2019-08-24",
  "invoicing_default_vat": 0,
  "tags": null,
  "custom_id": "string",
  "customer_columns": null,
  "brf_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoicing_period": 0,
  "debt_distribution_pushed_until": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Brfmembershipnotation

Operations

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.