Skip to content
/
Bulk write 'Contractinvoi...

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

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Get 'Contractinvoicecontent'

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/contracts/contractinvoicecontent/{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
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

to_invoice_datestring or null(date)

Additional Validation Information:

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

contract_lifecycle_restrictioninteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
text_background_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_color

from_invoice_datestring or null(date)

Additional Validation Information:

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

organizationobject or null(Organization)
companyobject or null(Company)
text_contentstring or null

Additional Validation Information:

This value must be set together with the following fields: text_title, text_background_color, text_color

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

attachmentobject or null

Additional Validation Information:

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

contract_typesArray of objects(Contenttype)
tags_filterArray of objects(Tag)
customer_columnsanyread-only
text_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_background_color

tagsanyread-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
text_titlestring or null<= 255 characters

Additional Validation Information:

This value must be set together with the following fields: text_content, text_background_color, text_color

Response
application/json
{
  "to_invoice_date": "2019-08-24",
  "contract_lifecycle_restriction": 0,
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "text_background_color": "string",
  "from_invoice_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "text_content": "string",
  "attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "contract_types": [
    { … }
  ],
  "tags_filter": [
    { … }
  ],
  "customer_columns": null,
  "text_color": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "tags": null,
  "display_order": -2147483648,
  "text_title": "string"
}

Bulk write 'Contractinvoicecontent'

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 [
to_invoice_datestring or null(date)

Additional Validation Information:

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

contract_lifecycle_restrictioninteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01
custom_idstring or null<= 128 characters
text_background_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_color

from_invoice_datestring or null(date)

Additional Validation Information:

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

organizationobject or null(Organization)
companyobject or null(Company)
text_contentstring or null

Additional Validation Information:

This value must be set together with the following fields: text_title, text_background_color, text_color

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

attachmentobject or null

Additional Validation Information:

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

contract_typesArray of objects(Contenttype)
tags_filterArray of objects(Tag)
text_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_background_color

display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
text_titlestring or null<= 255 characters

Additional Validation Information:

This value must be set together with the following fields: text_content, text_background_color, text_color

]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/contracts/contractinvoicecontent/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 '[
    {
      "to_invoice_date": "2019-08-24",
      "contract_lifecycle_restriction": 0,
      "custom_id": "string",
      "text_background_color": "string",
      "from_invoice_date": "2019-08-24",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "company": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "text_content": "string",
      "attachment": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "contract_types": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "tags_filter": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "text_color": "string",
      "display_order": -2147483648,
      "text_title": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

to_invoice_datestring or null(date)

Additional Validation Information:

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

contract_lifecycle_restrictioninteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
text_background_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_color

from_invoice_datestring or null(date)

Additional Validation Information:

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

organizationobject or null(Organization)
companyobject or null(Company)
text_contentstring or null

Additional Validation Information:

This value must be set together with the following fields: text_title, text_background_color, text_color

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

attachmentobject or null

Additional Validation Information:

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

contract_typesArray of objects(Contenttype)
tags_filterArray of objects(Tag)
customer_columnsanyread-only
text_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_background_color

tagsanyread-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
text_titlestring or null<= 255 characters

Additional Validation Information:

This value must be set together with the following fields: text_content, text_background_color, text_color

]
Response
application/json
[
  {
    "to_invoice_date": "2019-08-24",
    "contract_lifecycle_restriction": 0,
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "text_background_color": "string",
    "from_invoice_date": "2019-08-24",
    "organization": { … },
    "company": { … },
    "text_content": "string",
    "attachment": { … },
    "contract_types": [ … ],
    "tags_filter": [ … ],
    "customer_columns": null,
    "text_color": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tags": null,
    "display_order": -2147483648,
    "text_title": "string"
  }
]

List 'Contractinvoicecontent'

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

contract_lifecycle_restrictionany

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

contract_typesany

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

from_invoice_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

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

tags_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

text_background_colorany

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

text_colorany

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

text_contentany

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

text_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

to_invoice_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

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

to_invoice_datestring or null(date)

Additional Validation Information:

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

contract_lifecycle_restrictioninteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum01
custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
text_background_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_color

from_invoice_datestring or null(date)

Additional Validation Information:

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

organizationobject or null(Organization)
companyobject or null(Company)
text_contentstring or null

Additional Validation Information:

This value must be set together with the following fields: text_title, text_background_color, text_color

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

attachmentobject or null

Additional Validation Information:

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

contract_typesArray of objects(Contenttype)
tags_filterArray of objects(Tag)
customer_columnsanyread-only
text_colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'

Additional Validation Information:

This value must be set together with the following fields: text_title, text_content, text_background_color

tagsanyread-only
display_orderinteger or null(int32)[ -2147483648 .. 2147483647 ]
text_titlestring or null<= 255 characters

Additional Validation Information:

This value must be set together with the following fields: text_content, text_background_color, text_color

]
Response
application/json
[
  {
    "to_invoice_date": "2019-08-24",
    "contract_lifecycle_restriction": 0,
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "text_background_color": "string",
    "from_invoice_date": "2019-08-24",
    "organization": { … },
    "company": { … },
    "text_content": "string",
    "attachment": { … },
    "contract_types": [ … ],
    "tags_filter": [ … ],
    "customer_columns": null,
    "text_color": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "tags": null,
    "display_order": -2147483648,
    "text_title": "string"
  }
]

Paymenttermssetting

Operations
© Pigello. All rights reserved.