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

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

Create '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/json
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/ \
  -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 creation

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

Update '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
Bodyapplication/json
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 PATCH \
  'https://dev.api.pigello.io/accounting/contracts/contractinvoicecontent/{pk}/' \
  -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 update

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

Delete '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 DELETE \
  '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 deletion

Response
No content

Paymenttermssetting

Operations
© Pigello. All rights reserved.