Skip to content
/
Bulk write 'Company'

Organization (2.0.0)

The 'Organization' 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

Externalclient

Operations

Externalclientcontactperson

Operations

Company

Operations

List 'Company'

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
has_brf_companyany
tagsArray of objects
auto_confirm_bookkeeping_after_daysany

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

bookkeeping_locked_toany

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

bookkeeping_month_startany

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

bookkeeping_period_startany

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

calculated_base_rent_vat_quotaany

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

calculated_usable_area_rentableany

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

calculated_usable_area_rentable_base_rent_vatany

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

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_dimension_valueany

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

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

fuiany

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

gln13_numberany

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

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

initial_bookkeeping_period_shortenedany

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

invoice_identifierany

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

managed_byany

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

minimum_invoice_numberany

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

nameany

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

org_noany

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

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

postal_addressany

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

registered_addressany

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

sni_numberany

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

tax_registeredany

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

vat_approvedany

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

vat_codeany

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

visiting_addressany

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

curl -i -X GET \
  'https://dev.api.pigello.io/organization/company/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 [
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
customer_columnsanyread-only
fuistring or null[ 29 .. 32 ] characters
tagsanyread-only
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
calculated_base_rent_vat_quotanumber(float)read-only
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
created_atstring(date-time)read-only
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
calculated_usable_area_rentablenumber(float)read-only
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

]
Response
application/json
[
  {
    "gln13_number": "stringstrings",
    "custom_dimension_value": "string",
    "customer_columns": null,
    "org_no": "stringstri",
    "name": "string",
    "fui": "stringstringstringstringstrin",
    "tags": null,
    "registered_address": { … },
    "custom_id": "string",
    "initial_bookkeeping_period_shortened": true,
    "sni_number": "20.520",
    "minimum_invoice_number": 9223372036854776000,
    "vat_code": "stringstringst",
    "tax_registered": true,
    "calculated_base_rent_vat_quota": 0.1,
    "invoice_identifier": 9999,
    "organization": { … },
    "vat_approved": true,
    "calculated_usable_area_rentable_base_rent_vat": 0.1,
    "created_at": "2019-08-24T14:15:22Z",
    "managed_by": { … },
    "auto_confirm_bookkeeping_after_days": 125,
    "bookkeeping_locked_to": "2019-08-24",
    "calculated_usable_area_rentable": 0.1,
    "logo": { … },
    "postal_address": { … },
    "bookkeeping_month_start": 1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "visiting_address": { … },
    "bookkeeping_period_start": "2019-08-24"
  }
]

Bulk write 'Company'

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 [
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
fuistring or null[ 29 .. 32 ] characters
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

]
curl -i -X POST \
  https://dev.api.pigello.io/organization/company/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 '[
    {
      "gln13_number": "stringstrings",
      "custom_dimension_value": "string",
      "org_no": "stringstri",
      "name": "string",
      "fui": "stringstringstringstringstrin",
      "registered_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "initial_bookkeeping_period_shortened": true,
      "sni_number": "20.520",
      "minimum_invoice_number": 9223372036854776000,
      "vat_code": "stringstringst",
      "tax_registered": true,
      "invoice_identifier": 9999,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "vat_approved": true,
      "managed_by": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "auto_confirm_bookkeeping_after_days": 125,
      "bookkeeping_locked_to": "2019-08-24",
      "logo": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "postal_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "bookkeeping_month_start": 1,
      "visiting_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "bookkeeping_period_start": "2019-08-24"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
customer_columnsanyread-only
fuistring or null[ 29 .. 32 ] characters
tagsanyread-only
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
calculated_base_rent_vat_quotanumber(float)read-only
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
created_atstring(date-time)read-only
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
calculated_usable_area_rentablenumber(float)read-only
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

]
Response
application/json
[
  {
    "gln13_number": "stringstrings",
    "custom_dimension_value": "string",
    "customer_columns": null,
    "org_no": "stringstri",
    "name": "string",
    "fui": "stringstringstringstringstrin",
    "tags": null,
    "registered_address": { … },
    "custom_id": "string",
    "initial_bookkeeping_period_shortened": true,
    "sni_number": "20.520",
    "minimum_invoice_number": 9223372036854776000,
    "vat_code": "stringstringst",
    "tax_registered": true,
    "calculated_base_rent_vat_quota": 0.1,
    "invoice_identifier": 9999,
    "organization": { … },
    "vat_approved": true,
    "calculated_usable_area_rentable_base_rent_vat": 0.1,
    "created_at": "2019-08-24T14:15:22Z",
    "managed_by": { … },
    "auto_confirm_bookkeeping_after_days": 125,
    "bookkeeping_locked_to": "2019-08-24",
    "calculated_usable_area_rentable": 0.1,
    "logo": { … },
    "postal_address": { … },
    "bookkeeping_month_start": 1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "visiting_address": { … },
    "bookkeeping_period_start": "2019-08-24"
  }
]

Create 'Company'

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
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
fuistring or null[ 29 .. 32 ] characters
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

curl -i -X POST \
  https://dev.api.pigello.io/organization/company/ \
  -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 '{
    "gln13_number": "stringstrings",
    "custom_dimension_value": "string",
    "org_no": "stringstri",
    "name": "string",
    "fui": "stringstringstringstringstrin",
    "registered_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "initial_bookkeeping_period_shortened": true,
    "sni_number": "20.520",
    "minimum_invoice_number": 9223372036854776000,
    "vat_code": "stringstringst",
    "tax_registered": true,
    "invoice_identifier": 9999,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "vat_approved": true,
    "managed_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "auto_confirm_bookkeeping_after_days": 125,
    "bookkeeping_locked_to": "2019-08-24",
    "logo": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "postal_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "bookkeeping_month_start": 1,
    "visiting_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "bookkeeping_period_start": "2019-08-24"
  }'

Responses

Successful creation

Bodyapplication/json
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
customer_columnsanyread-only
fuistring or null[ 29 .. 32 ] characters
tagsanyread-only
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
calculated_base_rent_vat_quotanumber(float)read-only
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
created_atstring(date-time)read-only
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
calculated_usable_area_rentablenumber(float)read-only
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

Response
application/json
{
  "gln13_number": "stringstrings",
  "custom_dimension_value": "string",
  "customer_columns": null,
  "org_no": "stringstri",
  "name": "string",
  "fui": "stringstringstringstringstrin",
  "tags": null,
  "registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "initial_bookkeeping_period_shortened": true,
  "sni_number": "20.520",
  "minimum_invoice_number": 9223372036854776000,
  "vat_code": "stringstringst",
  "tax_registered": true,
  "calculated_base_rent_vat_quota": 0.1,
  "invoice_identifier": 9999,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "vat_approved": true,
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "managed_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "auto_confirm_bookkeeping_after_days": 125,
  "bookkeeping_locked_to": "2019-08-24",
  "calculated_usable_area_rentable": 0.1,
  "logo": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "postal_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_month_start": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "visiting_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_period_start": "2019-08-24"
}

Get 'Company'

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/organization/company/{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
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
customer_columnsanyread-only
fuistring or null[ 29 .. 32 ] characters
tagsanyread-only
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
calculated_base_rent_vat_quotanumber(float)read-only
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
created_atstring(date-time)read-only
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
calculated_usable_area_rentablenumber(float)read-only
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

Response
application/json
{
  "gln13_number": "stringstrings",
  "custom_dimension_value": "string",
  "customer_columns": null,
  "org_no": "stringstri",
  "name": "string",
  "fui": "stringstringstringstringstrin",
  "tags": null,
  "registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "initial_bookkeeping_period_shortened": true,
  "sni_number": "20.520",
  "minimum_invoice_number": 9223372036854776000,
  "vat_code": "stringstringst",
  "tax_registered": true,
  "calculated_base_rent_vat_quota": 0.1,
  "invoice_identifier": 9999,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "vat_approved": true,
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "managed_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "auto_confirm_bookkeeping_after_days": 125,
  "bookkeeping_locked_to": "2019-08-24",
  "calculated_usable_area_rentable": 0.1,
  "logo": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "postal_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_month_start": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "visiting_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_period_start": "2019-08-24"
}

Update 'Company'

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
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
fuistring or null[ 29 .. 32 ] characters
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

curl -i -X PATCH \
  'https://dev.api.pigello.io/organization/company/{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 '{
    "gln13_number": "stringstrings",
    "custom_dimension_value": "string",
    "org_no": "stringstri",
    "name": "string",
    "fui": "stringstringstringstringstrin",
    "registered_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "initial_bookkeeping_period_shortened": true,
    "sni_number": "20.520",
    "minimum_invoice_number": 9223372036854776000,
    "vat_code": "stringstringst",
    "tax_registered": true,
    "invoice_identifier": 9999,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "vat_approved": true,
    "managed_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "auto_confirm_bookkeeping_after_days": 125,
    "bookkeeping_locked_to": "2019-08-24",
    "logo": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "postal_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "bookkeeping_month_start": 1,
    "visiting_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "bookkeeping_period_start": "2019-08-24"
  }'

Responses

Successful update

Bodyapplication/json
org_nostring(luhn)[ 10 .. 11 ] charactersrequired
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
custom_dimension_valuestring or null<= 255 characters
customer_columnsanyread-only
fuistring or null[ 29 .. 32 ] characters
tagsanyread-only
registered_addressobject or null(Address)
custom_idstring or null<= 128 characters
initial_bookkeeping_period_shortenedboolean or null

Additional Validation Information:

This value must be set together with the following fields: bookkeeping_period_start

sni_numberstring or null<= 6 characters
Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
minimum_invoice_numberinteger or null(int32)<= 9223372036854776000
vat_codestring or null= 14 characters
tax_registeredboolean or null
calculated_base_rent_vat_quotanumber(float)read-only
invoice_identifierinteger or null(int32)<= 9999
organizationobject or null(Organization)
vat_approvedboolean or null
calculated_usable_area_rentable_base_rent_vatnumber(float)read-only
created_atstring(date-time)read-only
managed_byobject or null(Externalclient)
auto_confirm_bookkeeping_after_daysinteger or null(int32)<= 125
bookkeeping_locked_tostring or null(date)
calculated_usable_area_rentablenumber(float)read-only
logoobject or null
postal_addressobject or null(Address)
bookkeeping_month_startinteger(int32)[ 1 .. 12 ]
visiting_addressobject or null(Address)
bookkeeping_period_startstring or null(date)

Additional Validation Information:

This value must be set together with the following fields: initial_bookkeeping_period_shortened

Response
application/json
{
  "gln13_number": "stringstrings",
  "custom_dimension_value": "string",
  "customer_columns": null,
  "org_no": "stringstri",
  "name": "string",
  "fui": "stringstringstringstringstrin",
  "tags": null,
  "registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "initial_bookkeeping_period_shortened": true,
  "sni_number": "20.520",
  "minimum_invoice_number": 9223372036854776000,
  "vat_code": "stringstringst",
  "tax_registered": true,
  "calculated_base_rent_vat_quota": 0.1,
  "invoice_identifier": 9999,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "vat_approved": true,
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "managed_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "auto_confirm_bookkeeping_after_days": 125,
  "bookkeeping_locked_to": "2019-08-24",
  "calculated_usable_area_rentable": 0.1,
  "logo": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "postal_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_month_start": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "visiting_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "bookkeeping_period_start": "2019-08-24"
}

Delete 'Company'

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/organization/company/{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
© Pigello. All rights reserved.