Skip to content
/
Create 'Brfcompanyannualr...

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

Create 'Brfcompanyannualreport'

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
for_yearinteger(int32)[ 1900 .. 2147483647 ]required
brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/brf/common/brfcompanyannualreport/ \
  -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 '{
    "for_year": 1900,
    "custom_id": "string",
    "brf_company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "file_data": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
for_yearinteger(int32)[ 1900 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
customer_columnsanyread-only
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
tagsanyread-only
Response
application/json
{
  "customer_columns": null,
  "for_year": 1900,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "brf_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "file_data": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null
}

Get 'Brfcompanyannualreport'

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/brfcompanyannualreport/{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
for_yearinteger(int32)[ 1900 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
customer_columnsanyread-only
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
tagsanyread-only
Response
application/json
{
  "customer_columns": null,
  "for_year": 1900,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "brf_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "file_data": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null
}

Update 'Brfcompanyannualreport'

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
for_yearinteger(int32)[ 1900 .. 2147483647 ]required
brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/brf/common/brfcompanyannualreport/{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 '{
    "for_year": 1900,
    "custom_id": "string",
    "brf_company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "file_data": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
for_yearinteger(int32)[ 1900 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

brf_companyobject(Brfcompany)required
brf_company.​idstring(uuid)
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
customer_columnsanyread-only
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
tagsanyread-only
Response
application/json
{
  "customer_columns": null,
  "for_year": 1900,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "brf_company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "file_data": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null
}

Quotafee

Operations

Quotacollection

Operations

Quotanotation

Operations

Brftransactionparty

Operations

Brfapartmentinvoiceconfiguration

Operations

Brfmembershipnotation

Operations

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.