Skip to content
/
Create 'Invoicerecipient'

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

Create 'Invoicerecipient'

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
view_onlybooleanrequired
invoiceobject(Invoice)required
invoice.​idstring(uuid)
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
stakeholder_typestring or null
custom_idstring or null<= 128 characters
postal_addressobject or null(Address)

Additional Validation Information:

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

org_nostring or null(luhn)[ 10 .. 11 ] characters
reminder_distribution_instructionArray of objects or null
custom_postal_addressstring or null

Additional Validation Information:

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

ssnstring or null(luhn)[ 12 .. 13 ] characters
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
debt_distribution_instructionArray of objects or null
namestring or null<= 255 characters
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

organizationobject or null(Organization)
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

invoice_distribution_instructionArray of objects or null
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

curl -i -X POST \
  https://dev.api.pigello.io/accounting/invoices/invoicerecipient/ \
  -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 '{
    "stakeholder_type": "string",
    "custom_id": "string",
    "postal_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "org_no": "stringstri",
    "view_only": true,
    "reminder_distribution_instruction": [
      null
    ],
    "custom_postal_address": "string",
    "ssn": "stringstring",
    "email": "user@example.com",
    "invoice": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "phone_number": "string",
    "debt_distribution_instruction": [
      null
    ],
    "priority": -2147483648,
    "name": "string",
    "organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoice_distribution_instruction": [
      null
    ],
    "sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
view_onlybooleanrequired
invoiceobject(Invoice)required
invoice.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
stakeholder_typestring or null
custom_idstring or null<= 128 characters
postal_addressobject or null(Address)

Additional Validation Information:

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

org_nostring or null(luhn)[ 10 .. 11 ] characters
reminder_distribution_instructionArray of objects or null
custom_postal_addressstring or null

Additional Validation Information:

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

ssnstring or null(luhn)[ 12 .. 13 ] characters
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
debt_distribution_instructionArray of objects or null
namestring or null<= 255 characters
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

organizationobject or null(Organization)
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

created_atstring(date-time)read-only
invoice_distribution_instructionArray of objects or null
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

Response
application/json
{
  "stakeholder_type": "string",
  "custom_id": "string",
  "postal_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "org_no": "stringstri",
  "view_only": true,
  "reminder_distribution_instruction": [
    null
  ],
  "custom_postal_address": "string",
  "ssn": "stringstring",
  "email": "user@example.com",
  "invoice": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "phone_number": "string",
  "debt_distribution_instruction": [
    null
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "priority": -2147483648,
  "name": "string",
  "organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "invoice_distribution_instruction": [
    null
  ],
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Bulk write 'Invoicerecipient'

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 [
view_onlybooleanrequired
invoiceobject(Invoice)required
invoice.​idstring(uuid)
priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
stakeholder_typestring or null
custom_idstring or null<= 128 characters
postal_addressobject or null(Address)

Additional Validation Information:

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

org_nostring or null(luhn)[ 10 .. 11 ] characters
reminder_distribution_instructionArray of objects or null
custom_postal_addressstring or null

Additional Validation Information:

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

ssnstring or null(luhn)[ 12 .. 13 ] characters
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
debt_distribution_instructionArray of objects or null
namestring or null<= 255 characters
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

organizationobject or null(Organization)
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

invoice_distribution_instructionArray of objects or null
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

]
curl -i -X POST \
  https://dev.api.pigello.io/accounting/invoices/invoicerecipient/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 '[
    {
      "stakeholder_type": "string",
      "custom_id": "string",
      "postal_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "org_no": "stringstri",
      "view_only": true,
      "reminder_distribution_instruction": [
        null
      ],
      "custom_postal_address": "string",
      "ssn": "stringstring",
      "email": "user@example.com",
      "invoice": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "phone_number": "string",
      "debt_distribution_instruction": [
        null
      ],
      "priority": -2147483648,
      "name": "string",
      "organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoice_distribution_instruction": [
        null
      ],
      "sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
view_onlybooleanrequired
invoiceobject(Invoice)required
invoice.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
stakeholder_typestring or null
custom_idstring or null<= 128 characters
postal_addressobject or null(Address)

Additional Validation Information:

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

org_nostring or null(luhn)[ 10 .. 11 ] characters
reminder_distribution_instructionArray of objects or null
custom_postal_addressstring or null

Additional Validation Information:

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

ssnstring or null(luhn)[ 12 .. 13 ] characters
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
debt_distribution_instructionArray of objects or null
namestring or null<= 255 characters
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

organizationobject or null(Organization)
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

created_atstring(date-time)read-only
invoice_distribution_instructionArray of objects or null
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

]
Response
application/json
[
  {
    "stakeholder_type": "string",
    "custom_id": "string",
    "postal_address": { … },
    "org_no": "stringstri",
    "view_only": true,
    "reminder_distribution_instruction": [ … ],
    "custom_postal_address": "string",
    "ssn": "stringstring",
    "email": "user@example.com",
    "invoice": { … },
    "phone_number": "string",
    "debt_distribution_instruction": [ … ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "priority": -2147483648,
    "name": "string",
    "organization_user": { … },
    "organization": { … },
    "tenant": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "invoice_distribution_instruction": [ … ],
    "sub_tenant": { … }
  }
]

List 'Invoicerecipient'

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
global_realestatesArray of objects
global_segmentsArray of objects
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

custom_postal_addressany

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

emailany

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

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

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

org_noany

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

phone_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

postal_addressany

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

priorityany

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

ssnany

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

stakeholder_typeany

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

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

view_onlyany

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/invoices/invoicerecipient/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 [
view_onlybooleanrequired
invoiceobject(Invoice)required
invoice.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
stakeholder_typestring or null
custom_idstring or null<= 128 characters
postal_addressobject or null(Address)

Additional Validation Information:

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

org_nostring or null(luhn)[ 10 .. 11 ] characters
reminder_distribution_instructionArray of objects or null
custom_postal_addressstring or null

Additional Validation Information:

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

ssnstring or null(luhn)[ 12 .. 13 ] characters
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
debt_distribution_instructionArray of objects or null
namestring or null<= 255 characters
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

organizationobject or null(Organization)
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

created_atstring(date-time)read-only
invoice_distribution_instructionArray of objects or null
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

]
Response
application/json
[
  {
    "stakeholder_type": "string",
    "custom_id": "string",
    "postal_address": { … },
    "org_no": "stringstri",
    "view_only": true,
    "reminder_distribution_instruction": [ … ],
    "custom_postal_address": "string",
    "ssn": "stringstring",
    "email": "user@example.com",
    "invoice": { … },
    "phone_number": "string",
    "debt_distribution_instruction": [ … ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "priority": -2147483648,
    "name": "string",
    "organization_user": { … },
    "organization": { … },
    "tenant": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "invoice_distribution_instruction": [ … ],
    "sub_tenant": { … }
  }
]

Invoicepayment

Operations

Debtinvoiceevent

Operations

Debtinvoice

Operations

Invoicerelatedpdfconfiguration

Operations

Invoicerelatedpdffile

Operations

Invoicecreditationconnection

Operations

Automaticcontractinvoicingsetting

Operations

Contractinvoicecontent

Operations

Paymenttermssetting

Operations
© Pigello. All rights reserved.