Skip to content

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

Verification

Operations

List 'Verification'

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
connected_integration_applicationsArray of objects
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
integration_applications_not_connectedArray of objects
tagsArray of objects
bookkeeping_dateany

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

creditsany

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

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

debt_invoiceany

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

descriptionany

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

eventany

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

exported_for_import_in_fileany

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

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

invoiceany

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

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

overriden_bookkeeping_dateany

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

paymentany

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

registration_dateany

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

vacancy_invoiceany

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

verification_groupany

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

verification_serieany

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

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

Additional Validation Information:

Must be unique

bookkeeping_datestring(date)required
verification_seriestringrequired
registration_datestring(date)required
invoiceobject or null(Invoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: payment, debt_invoice

This field, or at least one of the following fields must be set: payment, debt_invoice

organizationobject or null(Organization)
kindinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum34
custom_idstring or null<= 128 characters
verification_groupobject or null(Verificationgroup)read-only
paymentobject or null(Invoicepayment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, debt_invoice

This field, or at least one of the following fields must be set: invoice, debt_invoice

creditsobject or null(Verification)read-only
vacancy_invoiceobject or null(Vacancyinvoice)read-only
eventinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum01234
overriden_bookkeeping_datestring or null(date)read-only
exported_for_import_in_fileobject or null(Bookkeepingexportfile)read-only
tagsanyread-only
created_atstring(date-time)read-only
debt_invoiceobject or null(Debtinvoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, payment

This field, or at least one of the following fields must be set: invoice, payment

customer_columnsanyread-only
]
Response
application/json
[
  {
    "invoice": { … },
    "organization": { … },
    "kind": 3,
    "custom_id": "string",
    "verification_group": { … },
    "payment": { … },
    "credits": { … },
    "vacancy_invoice": { … },
    "description": "string",
    "event": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "overriden_bookkeeping_date": "2019-08-24",
    "bookkeeping_date": "2019-08-24",
    "exported_for_import_in_file": { … },
    "tags": null,
    "verification_serie": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "debt_invoice": { … },
    "customer_columns": null,
    "registration_date": "2019-08-24"
  }
]

Bulk write 'Verification'

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 [
descriptionstringrequired
bookkeeping_datestring(date)required
verification_seriestringrequired
registration_datestring(date)required
invoiceobject or null(Invoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: payment, debt_invoice

This field, or at least one of the following fields must be set: payment, debt_invoice

organizationobject or null(Organization)
custom_idstring or null<= 128 characters
paymentobject or null(Invoicepayment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, debt_invoice

This field, or at least one of the following fields must be set: invoice, debt_invoice

debt_invoiceobject or null(Debtinvoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, payment

This field, or at least one of the following fields must be set: invoice, payment

]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/bookkeeping/verification/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 '[
    {
      "invoice": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "payment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "description": "string",
      "bookkeeping_date": "2019-08-24",
      "verification_serie": "string",
      "debt_invoice": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "registration_date": "2019-08-24"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
descriptionstringrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

bookkeeping_datestring(date)required
verification_seriestringrequired
registration_datestring(date)required
invoiceobject or null(Invoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: payment, debt_invoice

This field, or at least one of the following fields must be set: payment, debt_invoice

organizationobject or null(Organization)
kindinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum34
custom_idstring or null<= 128 characters
verification_groupobject or null(Verificationgroup)read-only
paymentobject or null(Invoicepayment)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, debt_invoice

This field, or at least one of the following fields must be set: invoice, debt_invoice

creditsobject or null(Verification)read-only
vacancy_invoiceobject or null(Vacancyinvoice)read-only
eventinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum01234
overriden_bookkeeping_datestring or null(date)read-only
exported_for_import_in_fileobject or null(Bookkeepingexportfile)read-only
tagsanyread-only
created_atstring(date-time)read-only
debt_invoiceobject or null(Debtinvoice)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: invoice, payment

This field, or at least one of the following fields must be set: invoice, payment

customer_columnsanyread-only
]
Response
application/json
[
  {
    "invoice": { … },
    "organization": { … },
    "kind": 3,
    "custom_id": "string",
    "verification_group": { … },
    "payment": { … },
    "credits": { … },
    "vacancy_invoice": { … },
    "description": "string",
    "event": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "overriden_bookkeeping_date": "2019-08-24",
    "bookkeeping_date": "2019-08-24",
    "exported_for_import_in_file": { … },
    "tags": null,
    "verification_serie": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "debt_invoice": { … },
    "customer_columns": null,
    "registration_date": "2019-08-24"
  }
]

Delete 'Verification'

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/accounting/bookkeeping/verification/{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

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.