Skip to content
/
List 'Errandcost'

Errands (2.0.0)

The 'Errands' 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

Generalerrandaction

Operations

Generalerranddefaultdescription

Operations

Generalerrandsubtype

Operations

Generalerrandgroup

Operations

Generalerrandtype

Operations

Generalerrandactionfile

Operations

Generalerrandfile

Operations

Componentconditionvalue

Operations

Componentconditionnotation

Operations

Errandactiondefault

Operations

Inspectionerrandfault

Operations

Inspectionerrandsetting

Operations

Inspectionerrand

Operations

Inspectionerrandchecklist

Operations

Inspectionerrandfile

Operations

Inspectionerrandprotocolsetting

Operations

Inspectionerrandnote

Operations

Tenantinspectionassociation

Operations

Customerrandfieldvalue

Operations

Customerrandfieldinclusion

Operations

Customerrandfieldtype

Operations

Externalsupplier

Operations

Erranddelegationoffer

Operations

Erranddelegationinstruction

Operations

Errandcost

Operations

Bulk write 'Errandcost'

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 [
awaits_databooleanrequired
invoice_titlestring<= 255 charactersrequired
target_sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

attachmentobject or null
organizationobject or null(Organization)
articleobject or null(Article)
vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
general_errandobject or null(Generalerrand)

Additional Validation Information:

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

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

inspection_errandobject or null(Inspectionerrand)

Additional Validation Information:

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

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

unit_pricenumber or null(float)
should_be_invoicedboolean
inspection_errand_faultobject or null(Inspectionerrandfault)
target_tenantobject or null(Tenant)

Additional Validation Information:

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

unit_amountnumber or null(float)
custom_idstring or null<= 128 characters
general_errand_actionobject or null(Generalerrandaction)
target_organization_userobject or null(Organizationuser)

Additional Validation Information:

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

]
curl -i -X POST \
  https://dev.api.pigello.io/errands/costs/errandcost/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 '[
    {
      "target_sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "attachment": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "article": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "vat": 0,
      "general_errand": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "inspection_errand": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "unit_price": 0.1,
      "should_be_invoiced": true,
      "inspection_errand_fault": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "awaits_data": true,
      "target_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "unit_amount": 0.1,
      "custom_id": "string",
      "general_errand_action": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoice_title": "string",
      "target_organization_user": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
awaits_databooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

invoice_titlestring<= 255 charactersrequired
target_sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

attachmentobject or null
organizationobject or null(Organization)
articleobject or null(Article)
vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
general_errandobject or null(Generalerrand)

Additional Validation Information:

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

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

inspection_errandobject or null(Inspectionerrand)

Additional Validation Information:

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

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

created_atstring(date-time)read-only
unit_pricenumber or null(float)
should_be_invoicedboolean
inspection_errand_faultobject or null(Inspectionerrandfault)
target_tenantobject or null(Tenant)

Additional Validation Information:

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

unit_amountnumber or null(float)
custom_idstring or null<= 128 characters
general_errand_actionobject or null(Generalerrandaction)
target_organization_userobject or null(Organizationuser)

Additional Validation Information:

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

]
Response
application/json
[
  {
    "target_sub_tenant": { … },
    "attachment": { … },
    "organization": { … },
    "article": { … },
    "vat": 0,
    "general_errand": { … },
    "inspection_errand": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "unit_price": 0.1,
    "should_be_invoiced": true,
    "inspection_errand_fault": { … },
    "awaits_data": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "target_tenant": { … },
    "unit_amount": 0.1,
    "custom_id": "string",
    "general_errand_action": { … },
    "invoice_title": "string",
    "target_organization_user": { … }
  }
]

List 'Errandcost'

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

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

awaits_dataany

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

general_errandany

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

general_errand_actionany

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

inspection_errandany

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

inspection_errand_faultany

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

invoice_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

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

should_be_invoicedany

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

target_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

target_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

target_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

unit_amountany

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

unit_priceany

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

vatany

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/errands/costs/errandcost/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 [
awaits_databooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

invoice_titlestring<= 255 charactersrequired
target_sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

attachmentobject or null
organizationobject or null(Organization)
articleobject or null(Article)
vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
general_errandobject or null(Generalerrand)

Additional Validation Information:

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

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

inspection_errandobject or null(Inspectionerrand)

Additional Validation Information:

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

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

created_atstring(date-time)read-only
unit_pricenumber or null(float)
should_be_invoicedboolean
inspection_errand_faultobject or null(Inspectionerrandfault)
target_tenantobject or null(Tenant)

Additional Validation Information:

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

unit_amountnumber or null(float)
custom_idstring or null<= 128 characters
general_errand_actionobject or null(Generalerrandaction)
target_organization_userobject or null(Organizationuser)

Additional Validation Information:

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

]
Response
application/json
[
  {
    "target_sub_tenant": { … },
    "attachment": { … },
    "organization": { … },
    "article": { … },
    "vat": 0,
    "general_errand": { … },
    "inspection_errand": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "unit_price": 0.1,
    "should_be_invoiced": true,
    "inspection_errand_fault": { … },
    "awaits_data": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "target_tenant": { … },
    "unit_amount": 0.1,
    "custom_id": "string",
    "general_errand_action": { … },
    "invoice_title": "string",
    "target_organization_user": { … }
  }
]

Update 'Errandcost'

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
awaits_databooleanrequired
invoice_titlestring<= 255 charactersrequired
target_sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

attachmentobject or null
organizationobject or null(Organization)
articleobject or null(Article)
vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
general_errandobject or null(Generalerrand)

Additional Validation Information:

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

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

inspection_errandobject or null(Inspectionerrand)

Additional Validation Information:

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

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

unit_pricenumber or null(float)
should_be_invoicedboolean
inspection_errand_faultobject or null(Inspectionerrandfault)
target_tenantobject or null(Tenant)

Additional Validation Information:

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

unit_amountnumber or null(float)
custom_idstring or null<= 128 characters
general_errand_actionobject or null(Generalerrandaction)
target_organization_userobject or null(Organizationuser)

Additional Validation Information:

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

curl -i -X PATCH \
  'https://dev.api.pigello.io/errands/costs/errandcost/{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 '{
    "target_sub_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "attachment": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "vat": 0,
    "general_errand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "inspection_errand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "unit_price": 0.1,
    "should_be_invoiced": true,
    "inspection_errand_fault": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "awaits_data": true,
    "target_tenant": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "unit_amount": 0.1,
    "custom_id": "string",
    "general_errand_action": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoice_title": "string",
    "target_organization_user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful update

Bodyapplication/json
awaits_databooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

invoice_titlestring<= 255 charactersrequired
target_sub_tenantobject or null(Subtenant)

Additional Validation Information:

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

attachmentobject or null
organizationobject or null(Organization)
articleobject or null(Article)
vatinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum025126
general_errandobject or null(Generalerrand)

Additional Validation Information:

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

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

inspection_errandobject or null(Inspectionerrand)

Additional Validation Information:

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

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

created_atstring(date-time)read-only
unit_pricenumber or null(float)
should_be_invoicedboolean
inspection_errand_faultobject or null(Inspectionerrandfault)
target_tenantobject or null(Tenant)

Additional Validation Information:

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

unit_amountnumber or null(float)
custom_idstring or null<= 128 characters
general_errand_actionobject or null(Generalerrandaction)
target_organization_userobject or null(Organizationuser)

Additional Validation Information:

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

Response
application/json
{
  "target_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "attachment": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "vat": 0,
  "general_errand": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "inspection_errand": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "unit_price": 0.1,
  "should_be_invoiced": true,
  "inspection_errand_fault": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "awaits_data": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "target_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "unit_amount": 0.1,
  "custom_id": "string",
  "general_errand_action": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoice_title": "string",
  "target_organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}
© Pigello. All rights reserved.