Skip to content
/
Create 'Debtinvoice'

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

Autogiropayerconnection

Operations

Autogirostatus

Operations

Coinvoicenotation

Operations

Invoicerow

Operations

Invoicerecipient

Operations

Invoicepayment

Operations

Debtinvoiceevent

Operations

Debtinvoice

Operations

Create 'Debtinvoice'

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
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01
due_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date, attested_date

debt_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date, interest_rate_start_date

invoiceobject(Invoice)required
invoice.​idstring(uuid)
organizationobject or null(Organization)
attested_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date

debt_stageinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
interest_rate_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date

interest_ratenumber(float)
disable_system_bookkeepingboolean
annulledboolean
custom_idstring or null<= 128 characters
feenumber(float)
auto_distribute_on_annullmentboolean
eviction_on_bailiffboolean
inform_social_committee_on_bailiffboolean
curl -i -X POST \
  https://dev.api.pigello.io/accounting/debt/debtinvoice/ \
  -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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "attested_date": "2019-08-24",
    "debt_stage": 0,
    "interest_rate_start_date": "2019-08-24",
    "interest_rate": 0.1,
    "disable_system_bookkeeping": true,
    "kind": 0,
    "annulled": true,
    "custom_id": "string",
    "fee": 0.1,
    "auto_distribute_on_annullment": true,
    "eviction_on_bailiff": true,
    "due_date": "2019-08-24",
    "debt_date": "2019-08-24",
    "inform_social_committee_on_bailiff": true,
    "invoice": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01
due_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date, attested_date

debt_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date, interest_rate_start_date

invoiceobject(Invoice)required
invoice.​idstring(uuid)
organizationobject or null(Organization)
tagsanyread-only
attested_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date

debt_stageinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
interest_rate_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date

interest_ratenumber(float)
disable_system_bookkeepingboolean
annulledboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
feenumber(float)
distribution_datestring or null(date)read-only
auto_distribute_on_annullmentboolean
eviction_on_bailiffboolean
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
closed_timestring or null(date-time)read-only
inform_social_committee_on_bailiffboolean
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tags": null,
  "attested_date": "2019-08-24",
  "debt_stage": 0,
  "interest_rate_start_date": "2019-08-24",
  "interest_rate": 0.1,
  "disable_system_bookkeeping": true,
  "kind": 0,
  "annulled": true,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "fee": 0.1,
  "distribution_date": "2019-08-24",
  "auto_distribute_on_annullment": true,
  "eviction_on_bailiff": true,
  "customer_columns": null,
  "pending_monitor_approval_amount": null,
  "due_date": "2019-08-24",
  "debt_date": "2019-08-24",
  "closed_time": "2019-08-24T14:15:22Z",
  "inform_social_committee_on_bailiff": true,
  "invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Bulk write 'Debtinvoice'

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 [
kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01
due_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date, attested_date

debt_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date, interest_rate_start_date

invoiceobject(Invoice)required
invoice.​idstring(uuid)
organizationobject or null(Organization)
attested_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date

debt_stageinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
interest_rate_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date

interest_ratenumber(float)
disable_system_bookkeepingboolean
annulledboolean
custom_idstring or null<= 128 characters
feenumber(float)
auto_distribute_on_annullmentboolean
eviction_on_bailiffboolean
inform_social_committee_on_bailiffboolean
]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/debt/debtinvoice/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 '[
    {
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "attested_date": "2019-08-24",
      "debt_stage": 0,
      "interest_rate_start_date": "2019-08-24",
      "interest_rate": 0.1,
      "disable_system_bookkeeping": true,
      "kind": 0,
      "annulled": true,
      "custom_id": "string",
      "fee": 0.1,
      "auto_distribute_on_annullment": true,
      "eviction_on_bailiff": true,
      "due_date": "2019-08-24",
      "debt_date": "2019-08-24",
      "inform_social_committee_on_bailiff": true,
      "invoice": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01
due_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date, attested_date

debt_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date, interest_rate_start_date

invoiceobject(Invoice)required
invoice.​idstring(uuid)
organizationobject or null(Organization)
tagsanyread-only
attested_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date

debt_stageinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
interest_rate_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date

interest_ratenumber(float)
disable_system_bookkeepingboolean
annulledboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
feenumber(float)
distribution_datestring or null(date)read-only
auto_distribute_on_annullmentboolean
eviction_on_bailiffboolean
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
closed_timestring or null(date-time)read-only
inform_social_committee_on_bailiffboolean
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "tags": null,
    "attested_date": "2019-08-24",
    "debt_stage": 0,
    "interest_rate_start_date": "2019-08-24",
    "interest_rate": 0.1,
    "disable_system_bookkeeping": true,
    "kind": 0,
    "annulled": true,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "fee": 0.1,
    "distribution_date": "2019-08-24",
    "auto_distribute_on_annullment": true,
    "eviction_on_bailiff": true,
    "customer_columns": null,
    "pending_monitor_approval_amount": null,
    "due_date": "2019-08-24",
    "debt_date": "2019-08-24",
    "closed_time": "2019-08-24T14:15:22Z",
    "inform_social_committee_on_bailiff": true,
    "invoice": { … }
  }
]

List 'Debtinvoice'

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
annulledany

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

attested_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

auto_distribute_on_annullmentany

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

closed_timeany

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

debt_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

debt_stageany

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

disable_system_bookkeepingany

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

distribution_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

due_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

eviction_on_bailiffany

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

feeany

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

inform_social_committee_on_bailiffany

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

interest_rateany

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

interest_rate_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

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

curl -i -X GET \
  'https://dev.api.pigello.io/accounting/debt/debtinvoice/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

kindinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum01
due_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date, attested_date

debt_datestring(date)required

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date, interest_rate_start_date

invoiceobject(Invoice)required
invoice.​idstring(uuid)
organizationobject or null(Organization)
tagsanyread-only
attested_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: due_date

debt_stageinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
interest_rate_start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: debt_date

interest_ratenumber(float)
disable_system_bookkeepingboolean
annulledboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
feenumber(float)
distribution_datestring or null(date)read-only
auto_distribute_on_annullmentboolean
eviction_on_bailiffboolean
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
closed_timestring or null(date-time)read-only
inform_social_committee_on_bailiffboolean
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "tags": null,
    "attested_date": "2019-08-24",
    "debt_stage": 0,
    "interest_rate_start_date": "2019-08-24",
    "interest_rate": 0.1,
    "disable_system_bookkeeping": true,
    "kind": 0,
    "annulled": true,
    "created_at": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "fee": 0.1,
    "distribution_date": "2019-08-24",
    "auto_distribute_on_annullment": true,
    "eviction_on_bailiff": true,
    "customer_columns": null,
    "pending_monitor_approval_amount": null,
    "due_date": "2019-08-24",
    "debt_date": "2019-08-24",
    "closed_time": "2019-08-24T14:15:22Z",
    "inform_social_committee_on_bailiff": true,
    "invoice": { … }
  }
]

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Paymenttermssetting

Operations
© Pigello. All rights reserved.