Skip to content
/
Bulk write 'Brfmembership...

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

Create '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
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 POST \
  https://dev.api.pigello.io/brf/transactions/brfmembershipnotation/ \
  -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 creation

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

Bulk write '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
Bodyapplication/jsonArray [
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 POST \
  https://dev.api.pigello.io/brf/transactions/brfmembershipnotation/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"
      },
      "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 bulk create/update

Bodyapplication/jsonArray [
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": { … },
    "to_date": "2019-08-24",
    "brf_company": { … },
    "tags": null,
    "created_at": "2019-08-24T14:15:22Z",
    "from_date": "2019-08-24",
    "automatic": true,
    "tenant": { … },
    "customer_columns": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "custom_id": "string"
  }
]

List '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
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
automaticany

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

brf_companyany

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

from_dateany

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

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

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

tenantany

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

to_dateany

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/brfmembershipnotation/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 [
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": { … },
    "to_date": "2019-08-24",
    "brf_company": { … },
    "tags": null,
    "created_at": "2019-08-24T14:15:22Z",
    "from_date": "2019-08-24",
    "automatic": true,
    "tenant": { … },
    "customer_columns": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "custom_id": "string"
  }
]

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.