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

Create 'Brftransactionparty'

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
quotanumber(float)<= 100required
transactionobject(Brftransaction)required
transaction.​idstring(uuid)
seller_membership_leave_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: seller

buyer_membership_access_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: buyer

organizationobject or null(Organization)
sellerobject or null(Tenant)
buyerobject or null(Tenant)
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/brf/transactions/brftransactionparty/ \
  -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 '{
    "seller_membership_leave_date": "2019-08-24",
    "buyer_membership_access_date": "2019-08-24",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "seller": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "buyer": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "quota": 100,
    "custom_id": "string",
    "transaction": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

quotanumber(float)<= 100required
transactionobject(Brftransaction)required
transaction.​idstring(uuid)
seller_membership_leave_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: seller

buyer_membership_access_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: buyer

customer_columnsanyread-only
tagsanyread-only
organizationobject or null(Organization)
sellerobject or null(Tenant)
created_atstring(date-time)read-only
buyerobject or null(Tenant)
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "seller_membership_leave_date": "2019-08-24",
  "buyer_membership_access_date": "2019-08-24",
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "seller": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "buyer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "quota": 100,
  "custom_id": "string",
  "transaction": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get 'Brftransactionparty'

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/brftransactionparty/{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

quotanumber(float)<= 100required
transactionobject(Brftransaction)required
transaction.​idstring(uuid)
seller_membership_leave_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: seller

buyer_membership_access_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: buyer

customer_columnsanyread-only
tagsanyread-only
organizationobject or null(Organization)
sellerobject or null(Tenant)
created_atstring(date-time)read-only
buyerobject or null(Tenant)
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "seller_membership_leave_date": "2019-08-24",
  "buyer_membership_access_date": "2019-08-24",
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "seller": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "buyer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "quota": 100,
  "custom_id": "string",
  "transaction": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Update 'Brftransactionparty'

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
quotanumber(float)<= 100required
transactionobject(Brftransaction)required
transaction.​idstring(uuid)
seller_membership_leave_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: seller

buyer_membership_access_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: buyer

organizationobject or null(Organization)
sellerobject or null(Tenant)
buyerobject or null(Tenant)
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/brf/transactions/brftransactionparty/{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 '{
    "seller_membership_leave_date": "2019-08-24",
    "buyer_membership_access_date": "2019-08-24",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "seller": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "buyer": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "quota": 100,
    "custom_id": "string",
    "transaction": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

quotanumber(float)<= 100required
transactionobject(Brftransaction)required
transaction.​idstring(uuid)
seller_membership_leave_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: seller

buyer_membership_access_datestring or null(date)

Additional Validation Information:

This value requires that the following fields are also set: buyer

customer_columnsanyread-only
tagsanyread-only
organizationobject or null(Organization)
sellerobject or null(Tenant)
created_atstring(date-time)read-only
buyerobject or null(Tenant)
pending_monitor_approval_amountanyread-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "seller_membership_leave_date": "2019-08-24",
  "buyer_membership_access_date": "2019-08-24",
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "seller": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "buyer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "pending_monitor_approval_amount": null,
  "quota": 100,
  "custom_id": "string",
  "transaction": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Brfapartmentinvoiceconfiguration

Operations

Brfmembershipnotation

Operations

Brftransaction

Operations

Capitalcontributionnotationcollection

Operations

Capitalcontributionnotation

Operations

Transactiondeclaration

Operations
© Pigello. All rights reserved.