Skip to content
/
Bulk write 'Articlecatego...

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

Create 'Articlecategory'

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
archivedboolean
consider_base_rentboolean
organizationobject or null(Organization)
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/accounting/articles/articlecategory/ \
  -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 '{
    "archived": true,
    "consider_base_rent": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "name": "string",
    "display_order": -2147483648,
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
archivedboolean
consider_base_rentboolean
customer_columnsanyread-only
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
Response
application/json
{
  "archived": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "consider_base_rent": true,
  "customer_columns": null,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "name": "string",
  "tags": null,
  "created_at": "2019-08-24T14:15:22Z",
  "display_order": -2147483648,
  "custom_id": "string"
}

Bulk write 'Articlecategory'

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
archivedboolean
consider_base_rentboolean
organizationobject or null(Organization)
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/articles/articlecategory/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 '[
    {
      "archived": true,
      "consider_base_rent": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string",
      "display_order": -2147483648,
      "custom_id": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
archivedboolean
consider_base_rentboolean
customer_columnsanyread-only
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "archived": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "consider_base_rent": true,
    "customer_columns": null,
    "organization": { … },
    "name": "string",
    "tags": null,
    "created_at": "2019-08-24T14:15:22Z",
    "display_order": -2147483648,
    "custom_id": "string"
  }
]

List 'Articlecategory'

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

consider_base_rentany

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

display_orderany

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

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

curl -i -X GET \
  'https://dev.api.pigello.io/accounting/articles/articlecategory/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
archivedboolean
consider_base_rentboolean
customer_columnsanyread-only
organizationobject or null(Organization)
tagsanyread-only
created_atstring(date-time)read-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "archived": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "consider_base_rent": true,
    "customer_columns": null,
    "organization": { … },
    "name": "string",
    "tags": null,
    "created_at": "2019-08-24T14:15:22Z",
    "display_order": -2147483648,
    "custom_id": "string"
  }
]

Articleaccountoverride

Operations

Spacecategorydimensionvalue

Operations

Dimensionconfiguration

Operations

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.