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

Bookkeepingexportfile

Operations

Verificationgroup

Operations

Transaction

Operations

Automaticvacancyinvoicingsetting

Operations

Vacancyinvoice

Operations

Vacancyinvoicerow

Operations

Bookkeepingaccountsconfig

Operations

Paymentmethod

Operations

List 'Paymentmethod'

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
eligible_for_companiesArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
active_fromany

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

autogiro_customer_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

bookkeeping_accountany

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

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

first_payment_matching_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

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_primary_payment_methodany

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

last_payment_matching_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

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

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

target_account_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

target_bg_account_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

target_bicany

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

target_iban_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

titleany

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/accounttypes/paymentmethod/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 [
methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01345
bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_primary_payment_methodbooleanrequired
titlestring<= 255 charactersrequired
customer_columnsanyread-only
target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'

Additional Validation Information:

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

active_fromstring or null(date)
organizationobject or null(Organization)
target_bicstring or null<= 255 characters

Additional Validation Information:

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

Enum"ESSESESS""IBCASES1""FORXSES1""LUNADK2B""DNBASESX""NNSESES1""BSNOSESS""ERPFSES2""SWEDSESS""SKIASESS"
last_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
tagsanyread-only
target_iban_numberstring or null<= 36 characters'^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9...

Additional Validation Information:

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

custom_idstring or null<= 128 characters
first_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
bankanyread-only
created_atstring(date-time)read-only
autogiro_customer_numberstring or null<= 255 characters'^\d+$'

Additional Validation Information:

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

target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] characters

Additional Validation Information:

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

companyobject or null(Company)
]
Response
application/json
[
  {
    "customer_columns": null,
    "method": 0,
    "target_account_number": "string",
    "active_from": "2019-08-24",
    "organization": { … },
    "target_bic": "ESSESESS",
    "last_payment_matching_method": 0,
    "tags": null,
    "target_iban_number": "string",
    "custom_id": "string",
    "bookkeeping_account": 1000,
    "first_payment_matching_method": 0,
    "bank": null,
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_primary_payment_method": true,
    "autogiro_customer_number": "string",
    "target_bg_account_number": "strings",
    "title": "string",
    "company": { … }
  }
]

Bulk write 'Paymentmethod'

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 [
methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01345
bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]required
is_primary_payment_methodbooleanrequired
titlestring<= 255 charactersrequired
target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'

Additional Validation Information:

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

active_fromstring or null(date)
organizationobject or null(Organization)
target_bicstring or null<= 255 characters

Additional Validation Information:

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

Enum"ESSESESS""IBCASES1""FORXSES1""LUNADK2B""DNBASESX""NNSESES1""BSNOSESS""ERPFSES2""SWEDSESS""SKIASESS"
last_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
target_iban_numberstring or null<= 36 characters'^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9...

Additional Validation Information:

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

custom_idstring or null<= 128 characters
first_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
autogiro_customer_numberstring or null<= 255 characters'^\d+$'

Additional Validation Information:

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

target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] characters

Additional Validation Information:

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

companyobject or null(Company)
]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/accounttypes/paymentmethod/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 '[
    {
      "method": 0,
      "target_account_number": "string",
      "active_from": "2019-08-24",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "target_bic": "ESSESESS",
      "last_payment_matching_method": 0,
      "target_iban_number": "string",
      "custom_id": "string",
      "bookkeeping_account": 1000,
      "first_payment_matching_method": 0,
      "is_primary_payment_method": true,
      "autogiro_customer_number": "string",
      "target_bg_account_number": "strings",
      "title": "string",
      "company": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01345
bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_primary_payment_methodbooleanrequired
titlestring<= 255 charactersrequired
customer_columnsanyread-only
target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'

Additional Validation Information:

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

active_fromstring or null(date)
organizationobject or null(Organization)
target_bicstring or null<= 255 characters

Additional Validation Information:

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

Enum"ESSESESS""IBCASES1""FORXSES1""LUNADK2B""DNBASESX""NNSESES1""BSNOSESS""ERPFSES2""SWEDSESS""SKIASESS"
last_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
tagsanyread-only
target_iban_numberstring or null<= 36 characters'^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9...

Additional Validation Information:

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

custom_idstring or null<= 128 characters
first_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
bankanyread-only
created_atstring(date-time)read-only
autogiro_customer_numberstring or null<= 255 characters'^\d+$'

Additional Validation Information:

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

target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] characters

Additional Validation Information:

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

companyobject or null(Company)
]
Response
application/json
[
  {
    "customer_columns": null,
    "method": 0,
    "target_account_number": "string",
    "active_from": "2019-08-24",
    "organization": { … },
    "target_bic": "ESSESESS",
    "last_payment_matching_method": 0,
    "tags": null,
    "target_iban_number": "string",
    "custom_id": "string",
    "bookkeeping_account": 1000,
    "first_payment_matching_method": 0,
    "bank": null,
    "created_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_primary_payment_method": true,
    "autogiro_customer_number": "string",
    "target_bg_account_number": "strings",
    "title": "string",
    "company": { … }
  }
]

Get 'Paymentmethod'

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/accounting/accounttypes/paymentmethod/{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
methodinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01345
bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_primary_payment_methodbooleanrequired
titlestring<= 255 charactersrequired
customer_columnsanyread-only
target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'

Additional Validation Information:

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

active_fromstring or null(date)
organizationobject or null(Organization)
target_bicstring or null<= 255 characters

Additional Validation Information:

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

Enum"ESSESESS""IBCASES1""FORXSES1""LUNADK2B""DNBASESX""NNSESES1""BSNOSESS""ERPFSES2""SWEDSESS""SKIASESS"
last_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
tagsanyread-only
target_iban_numberstring or null<= 36 characters'^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9...

Additional Validation Information:

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

custom_idstring or null<= 128 characters
first_payment_matching_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012345
bankanyread-only
created_atstring(date-time)read-only
autogiro_customer_numberstring or null<= 255 characters'^\d+$'

Additional Validation Information:

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

target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] characters

Additional Validation Information:

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

companyobject or null(Company)
Response
application/json
{
  "customer_columns": null,
  "method": 0,
  "target_account_number": "string",
  "active_from": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "target_bic": "ESSESESS",
  "last_payment_matching_method": 0,
  "tags": null,
  "target_iban_number": "string",
  "custom_id": "string",
  "bookkeeping_account": 1000,
  "first_payment_matching_method": 0,
  "bank": null,
  "created_at": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "is_primary_payment_method": true,
  "autogiro_customer_number": "string",
  "target_bg_account_number": "strings",
  "title": "string",
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

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.