Skip to content
/
List 'Bookkeepingexportfi...

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

List 'Bookkeepingexportfile'

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

company_bookkeeping_period_endany

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

company_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

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

excluded_already_imported_verificationsany

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

file_formatany

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

filtered_end_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

filtered_on_bookkeeping_dateany

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

filtered_start_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

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

included_unattestedany

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

included_verification_amountany

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

intended_for_importany

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

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

payment_verifications_filterany

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/bookkeepingexportfile/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 [
filtered_on_bookkeeping_datebooleanrequired
companyobject(Company)required
company.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

intended_for_importbooleanrequired
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
filtered_end_datestring(date)required
excluded_already_imported_verificationsbooleanrequired
included_unattestedbooleanrequired
file_formatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
company_bookkeeping_period_startstring or null(date)
filtered_start_datestring or null(date)
customer_columnsanyread-only
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
tagsanyread-only
company_bookkeeping_period_endstring or null(date)
payment_verifications_filterboolean or null
included_verification_amountinteger or null(int32)[ -2147483648 .. 2147483647 ]
]
Response
application/json
[
  {
    "company_bookkeeping_period_start": "2019-08-24",
    "filtered_on_bookkeeping_date": true,
    "company": { … },
    "filtered_start_date": "2019-08-24",
    "customer_columns": null,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "intended_for_import": true,
    "organization": { … },
    "custom_id": "string",
    "file_data": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "tags": null,
    "company_bookkeeping_period_end": "2019-08-24",
    "payment_verifications_filter": true,
    "filtered_end_date": "2019-08-24",
    "excluded_already_imported_verifications": true,
    "included_unattested": true,
    "included_verification_amount": -2147483648,
    "file_format": 0
  }
]

Get 'Bookkeepingexportfile'

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/bookkeeping/bookkeepingexportfile/{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
filtered_on_bookkeeping_datebooleanrequired
companyobject(Company)required
company.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

intended_for_importbooleanrequired
file_dataobjectrequired
file_data.​namestring

wanted filename of the file

file_data.​md5_hashstring

base64 encoded md5hash of the file

file_data.​getstring(url)
file_data.​postobject
filtered_end_datestring(date)required
excluded_already_imported_verificationsbooleanrequired
included_unattestedbooleanrequired
file_formatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
company_bookkeeping_period_startstring or null(date)
filtered_start_datestring or null(date)
customer_columnsanyread-only
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
tagsanyread-only
company_bookkeeping_period_endstring or null(date)
payment_verifications_filterboolean or null
included_verification_amountinteger or null(int32)[ -2147483648 .. 2147483647 ]
Response
application/json
{
  "company_bookkeeping_period_start": "2019-08-24",
  "filtered_on_bookkeeping_date": true,
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "filtered_start_date": "2019-08-24",
  "customer_columns": null,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "intended_for_import": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "file_data": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "tags": null,
  "company_bookkeeping_period_end": "2019-08-24",
  "payment_verifications_filter": true,
  "filtered_end_date": "2019-08-24",
  "excluded_already_imported_verifications": true,
  "included_unattested": true,
  "included_verification_amount": -2147483648,
  "file_format": 0
}

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.