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

Delete 'Invoicepayment'

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/payments/invoicepayment/{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

Update 'Invoicepayment'

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
valuenumber(float)required
companyobject(Company)required

Additional Validation Information:

This value must match with the values of these fields: company

company.​idstring(uuid)
payment_datestring(date)required

Additional Validation Information:

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

registration_datestring(date)required

Additional Validation Information:

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

skip_annullment_bookkeepingboolean
sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
reference_textstring or null
tenantobject or null(Tenant)

Additional Validation Information:

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

external_transaction_idstring or null<= 255 characters

Additional Validation Information:

Must be unique

from_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'
disable_system_bookkeepingboolean
matched_datestring or null(date)
organizationobject or null(Organization)
payment_methodobject or null(Paymentmethod)
additional_informationstring or null
annulledboolean
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

overriden_annullment_bookkeeping_datestring or null(date)
sender_namestring or null
dimensionsArray of objects or null
forced_annullment_bookkeeping_accountinteger or null(int32)[ 1000 .. 9999 ]
original_invoiceobject or null(Invoice)
ocr_numberstring or null<= 255 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounting/payments/invoicepayment/{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 '{
    "value": 0.1,
    "company": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "skip_annullment_bookkeeping": true,
    "sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "reference_text": "string",
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "payment_date": "2019-08-24",
    "external_transaction_id": "string",
    "from_account_number": "string",
    "disable_system_bookkeeping": true,
    "matched_date": "2019-08-24",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "payment_method": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "additional_information": "string",
    "registration_date": "2019-08-24",
    "annulled": true,
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "overriden_annullment_bookkeeping_date": "2019-08-24",
    "sender_name": "string",
    "dimensions": [
      null
    ],
    "forced_annullment_bookkeeping_account": 1000,
    "original_invoice": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "ocr_number": "string"
  }'

Responses

Successful update

Bodyapplication/json
valuenumber(float)required
companyobject(Company)required

Additional Validation Information:

This value must match with the values of these fields: company

company.​idstring(uuid)
used_payment_bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]read-onlyrequired
payment_datestring(date)required

Additional Validation Information:

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

used_account_configobject(Bookkeepingaccountsconfig)read-onlyrequired
used_account_config.​idstring(uuid)
registration_datestring(date)required

Additional Validation Information:

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

idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

customer_columnsanyread-only
primary_match_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum012345
skip_annullment_bookkeepingboolean
sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
reference_textstring or null
tenantobject or null(Tenant)

Additional Validation Information:

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

external_transaction_idstring or null<= 255 characters

Additional Validation Information:

Must be unique

tagsanyread-only
used_target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] charactersread-only
debt_invoiceobject or null(Debtinvoice)read-only
from_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'
disable_system_bookkeepingboolean
matched_datestring or null(date)
organizationobject or null(Organization)
used_target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'read-only
payment_methodobject or null(Paymentmethod)
additional_informationstring or null
annulledboolean
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

overriden_annullment_bookkeeping_datestring or null(date)
invoiceobject or null(Invoice)read-only
sender_namestring or null
dimensionsArray of objects or null
forced_annullment_bookkeeping_accountinteger or null(int32)[ 1000 .. 9999 ]
secondary_match_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum012345
from_creditationbooleanread-only
original_invoiceobject or null(Invoice)
created_atstring(date-time)read-only
ocr_numberstring or null<= 255 characters
split_from_paymentobject or null(Invoicepayment)read-only
Response
application/json
{
  "customer_columns": null,
  "value": 0.1,
  "primary_match_method": 0,
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_payment_bookkeeping_account": 1000,
  "skip_annullment_bookkeeping": true,
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "reference_text": "string",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "payment_date": "2019-08-24",
  "external_transaction_id": "string",
  "tags": null,
  "used_target_bg_account_number": "strings",
  "debt_invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_account_config": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "from_account_number": "string",
  "disable_system_bookkeeping": true,
  "matched_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_target_account_number": "string",
  "payment_method": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "additional_information": "string",
  "registration_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "annulled": true,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "overriden_annullment_bookkeeping_date": "2019-08-24",
  "invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "sender_name": "string",
  "dimensions": [
    null
  ],
  "forced_annullment_bookkeeping_account": 1000,
  "secondary_match_method": 0,
  "from_creditation": true,
  "original_invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "ocr_number": "string",
  "split_from_payment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get 'Invoicepayment'

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/payments/invoicepayment/{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
valuenumber(float)required
companyobject(Company)required

Additional Validation Information:

This value must match with the values of these fields: company

company.​idstring(uuid)
used_payment_bookkeeping_accountinteger(int32)[ 1000 .. 9999 ]read-onlyrequired
payment_datestring(date)required

Additional Validation Information:

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

used_account_configobject(Bookkeepingaccountsconfig)read-onlyrequired
used_account_config.​idstring(uuid)
registration_datestring(date)required

Additional Validation Information:

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

idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

customer_columnsanyread-only
primary_match_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum012345
skip_annullment_bookkeepingboolean
sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
reference_textstring or null
tenantobject or null(Tenant)

Additional Validation Information:

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

external_transaction_idstring or null<= 255 characters

Additional Validation Information:

Must be unique

tagsanyread-only
used_target_bg_account_numberstring or null(luhn)[ 7 .. 9 ] charactersread-only
debt_invoiceobject or null(Debtinvoice)read-only
from_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'
disable_system_bookkeepingboolean
matched_datestring or null(date)
organizationobject or null(Organization)
used_target_account_numberstring or null<= 36 characters'^[0-9]((-[0-9])|[0-9]){10,14}$'read-only
payment_methodobject or null(Paymentmethod)
additional_informationstring or null
annulledboolean
organization_userobject or null(Organizationuser)

Additional Validation Information:

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

overriden_annullment_bookkeeping_datestring or null(date)
invoiceobject or null(Invoice)read-only
sender_namestring or null
dimensionsArray of objects or null
forced_annullment_bookkeeping_accountinteger or null(int32)[ 1000 .. 9999 ]
secondary_match_methodinteger or null(int32)[ -2147483648 .. 2147483647 ]read-only
Enum012345
from_creditationbooleanread-only
original_invoiceobject or null(Invoice)
created_atstring(date-time)read-only
ocr_numberstring or null<= 255 characters
split_from_paymentobject or null(Invoicepayment)read-only
Response
application/json
{
  "customer_columns": null,
  "value": 0.1,
  "primary_match_method": 0,
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_payment_bookkeeping_account": 1000,
  "skip_annullment_bookkeeping": true,
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "reference_text": "string",
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "payment_date": "2019-08-24",
  "external_transaction_id": "string",
  "tags": null,
  "used_target_bg_account_number": "strings",
  "debt_invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_account_config": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "from_account_number": "string",
  "disable_system_bookkeeping": true,
  "matched_date": "2019-08-24",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "used_target_account_number": "string",
  "payment_method": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "additional_information": "string",
  "registration_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "annulled": true,
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "overriden_annullment_bookkeeping_date": "2019-08-24",
  "invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "sender_name": "string",
  "dimensions": [
    null
  ],
  "forced_annullment_bookkeeping_account": 1000,
  "secondary_match_method": 0,
  "from_creditation": true,
  "original_invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "ocr_number": "string",
  "split_from_payment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Debtinvoiceevent

Operations

Debtinvoice

Operations

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Paymenttermssetting

Operations
© Pigello. All rights reserved.