Skip to content
/
Bulk write 'Dimensionconf...

Accounting (2.0.0)

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

Articlecategory

Operations

Articleaccountoverride

Operations

Spacecategorydimensionvalue

Operations

Dimensionconfiguration

Operations

List 'Dimensionconfiguration'

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
global_realestatesArray of objects
global_segmentsArray of objects
archivedany

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

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

default_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

default_vacancy_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

dimension_idany

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

dimension_value_methodany

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

exclude_for_accountsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: empty, Supports negation (via !): True

Operator: isnull, 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

is_activeany

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

kindany

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

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

requiredany

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/accounting/bookkeeping/dimensionconfiguration/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 [
namestring<= 255 charactersrequired
dimension_value_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum12345678910
dimension_idinteger(int32)[ 1 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

created_atstring(date-time)read-only
exclude_for_accountsArray of integers or null(int32)unique
companyobject or null(Company)
default_dimension_valuestring or null<= 255 characters
archivedboolean
custom_idstring or null<= 128 characters
default_vacancy_dimension_valuestring or null<= 255 characters
requiredboolean
is_activeboolean
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "exclude_for_accounts": [ … ],
    "name": "string",
    "company": { … },
    "dimension_value_method": 0,
    "default_dimension_value": "string",
    "kind": 1,
    "archived": true,
    "custom_id": "string",
    "default_vacancy_dimension_value": "string",
    "dimension_id": 1,
    "required": true,
    "is_active": true,
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

Bulk write 'Dimensionconfiguration'

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 [
namestring<= 255 charactersrequired
dimension_value_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum12345678910
dimension_idinteger(int32)[ 1 .. 2147483647 ]required
exclude_for_accountsArray of integers or null(int32)unique
companyobject or null(Company)
default_dimension_valuestring or null<= 255 characters
archivedboolean
custom_idstring or null<= 128 characters
default_vacancy_dimension_valuestring or null<= 255 characters
requiredboolean
is_activeboolean
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/bookkeeping/dimensionconfiguration/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 '[
    {
      "exclude_for_accounts": [
        0
      ],
      "name": "string",
      "company": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "dimension_value_method": 0,
      "default_dimension_value": "string",
      "kind": 1,
      "archived": true,
      "custom_id": "string",
      "default_vacancy_dimension_value": "string",
      "dimension_id": 1,
      "required": true,
      "is_active": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
dimension_value_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum12345678910
dimension_idinteger(int32)[ 1 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

created_atstring(date-time)read-only
exclude_for_accountsArray of integers or null(int32)unique
companyobject or null(Company)
default_dimension_valuestring or null<= 255 characters
archivedboolean
custom_idstring or null<= 128 characters
default_vacancy_dimension_valuestring or null<= 255 characters
requiredboolean
is_activeboolean
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "exclude_for_accounts": [ … ],
    "name": "string",
    "company": { … },
    "dimension_value_method": 0,
    "default_dimension_value": "string",
    "kind": 1,
    "archived": true,
    "custom_id": "string",
    "default_vacancy_dimension_value": "string",
    "dimension_id": 1,
    "required": true,
    "is_active": true,
    "organization": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

Create 'Dimensionconfiguration'

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
namestring<= 255 charactersrequired
dimension_value_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum12345678910
dimension_idinteger(int32)[ 1 .. 2147483647 ]required
exclude_for_accountsArray of integers or null(int32)unique
companyobject or null(Company)
default_dimension_valuestring or null<= 255 characters
archivedboolean
custom_idstring or null<= 128 characters
default_vacancy_dimension_valuestring or null<= 255 characters
requiredboolean
is_activeboolean
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/accounting/bookkeeping/dimensionconfiguration/ \
  -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 '{
    "exclude_for_accounts": [
      0
    ],
    "name": "string",
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "dimension_value_method": 0,
    "default_dimension_value": "string",
    "kind": 1,
    "archived": true,
    "custom_id": "string",
    "default_vacancy_dimension_value": "string",
    "dimension_id": 1,
    "required": true,
    "is_active": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
namestring<= 255 charactersrequired
dimension_value_methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum12345678910
dimension_idinteger(int32)[ 1 .. 2147483647 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

created_atstring(date-time)read-only
exclude_for_accountsArray of integers or null(int32)unique
companyobject or null(Company)
default_dimension_valuestring or null<= 255 characters
archivedboolean
custom_idstring or null<= 128 characters
default_vacancy_dimension_valuestring or null<= 255 characters
requiredboolean
is_activeboolean
organizationobject or null(Organization)
Response
application/json
{
  "created_at": "2019-08-24T14:15:22Z",
  "exclude_for_accounts": [
    0
  ],
  "name": "string",
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "dimension_value_method": 0,
  "default_dimension_value": "string",
  "kind": 1,
  "archived": true,
  "custom_id": "string",
  "default_vacancy_dimension_value": "string",
  "dimension_id": 1,
  "required": true,
  "is_active": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Verification

Operations

Bookkeepingexportfile

Operations

Verificationgroup

Operations

Transaction

Operations

Automaticvacancyinvoicingsetting

Operations

Vacancyinvoice

Operations

Vacancyinvoicerow

Operations

Bookkeepingaccountsconfig

Operations

Paymentmethod

Operations

Autogiropayerconnection

Operations

Autogirostatus

Operations

Coinvoicenotation

Operations

Invoicerow

Operations

Invoicerecipient

Operations

Invoicepayment

Operations

Debtinvoiceevent

Operations

Debtinvoice

Operations

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Paymenttermssetting

Operations
© Pigello. All rights reserved.