Skip to content
/
List 'Invoicepayment'

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

Bulk write '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
Bodyapplication/jsonArray [
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 POST \
  https://dev.api.pigello.io/accounting/payments/invoicepayment/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 '[
    {
      "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 bulk create/update

Bodyapplication/jsonArray [
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": { … },
    "used_payment_bookkeeping_account": 1000,
    "skip_annullment_bookkeeping": true,
    "sub_tenant": { … },
    "custom_id": "string",
    "reference_text": "string",
    "tenant": { … },
    "payment_date": "2019-08-24",
    "external_transaction_id": "string",
    "tags": null,
    "used_target_bg_account_number": "strings",
    "debt_invoice": { … },
    "used_account_config": { … },
    "from_account_number": "string",
    "disable_system_bookkeeping": true,
    "matched_date": "2019-08-24",
    "organization": { … },
    "used_target_account_number": "string",
    "payment_method": { … },
    "additional_information": "string",
    "registration_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "annulled": true,
    "organization_user": { … },
    "overriden_annullment_bookkeeping_date": "2019-08-24",
    "invoice": { … },
    "sender_name": "string",
    "dimensions": [ … ],
    "forced_annullment_bookkeeping_account": 1000,
    "secondary_match_method": 0,
    "from_creditation": true,
    "original_invoice": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "ocr_number": "string",
    "split_from_payment": { … }
  }
]

List '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
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
invoices_indirectArray of objects
is_overpaymentany
is_unhandledany
is_unmatchedany
tagsArray of objects
additional_informationany

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

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

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

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

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

external_transaction_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

forced_annullment_bookkeeping_accountany

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_account_numberany

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

from_creditationany

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

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

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

matched_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

ocr_numberany

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

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

organization_userany

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

original_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

overriden_annullment_bookkeeping_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

payment_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

payment_methodany

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

primary_match_methodany

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

reference_textany

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

registration_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

secondary_match_methodany

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

sender_nameany

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

skip_annullment_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

split_from_paymentany

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

sub_tenantany

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

tenantany

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

used_account_configany

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

used_payment_bookkeeping_accountany

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

used_target_account_numberany

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

used_target_bg_account_numberany

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

valueany

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/payments/invoicepayment/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 [
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": { … },
    "used_payment_bookkeeping_account": 1000,
    "skip_annullment_bookkeeping": true,
    "sub_tenant": { … },
    "custom_id": "string",
    "reference_text": "string",
    "tenant": { … },
    "payment_date": "2019-08-24",
    "external_transaction_id": "string",
    "tags": null,
    "used_target_bg_account_number": "strings",
    "debt_invoice": { … },
    "used_account_config": { … },
    "from_account_number": "string",
    "disable_system_bookkeeping": true,
    "matched_date": "2019-08-24",
    "organization": { … },
    "used_target_account_number": "string",
    "payment_method": { … },
    "additional_information": "string",
    "registration_date": "2019-08-24",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "annulled": true,
    "organization_user": { … },
    "overriden_annullment_bookkeeping_date": "2019-08-24",
    "invoice": { … },
    "sender_name": "string",
    "dimensions": [ … ],
    "forced_annullment_bookkeeping_account": 1000,
    "secondary_match_method": 0,
    "from_creditation": true,
    "original_invoice": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "ocr_number": "string",
    "split_from_payment": { … }
  }
]

Create '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
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 POST \
  https://dev.api.pigello.io/accounting/payments/invoicepayment/ \
  -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 creation

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.